babylon.module.d.ts 5.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. readonly observers: Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Extracts text content from a DOM element hierarchy
  290. * @param element defines the root element
  291. * @returns a string
  292. */
  293. static GetDOMTextContent(element: HTMLElement): string;
  294. }
  295. }
  296. declare module "babylonjs/Misc/logger" {
  297. /**
  298. * Logger used througouht the application to allow configuration of
  299. * the log level required for the messages.
  300. */
  301. export class Logger {
  302. /**
  303. * No log
  304. */
  305. static readonly NoneLogLevel: number;
  306. /**
  307. * Only message logs
  308. */
  309. static readonly MessageLogLevel: number;
  310. /**
  311. * Only warning logs
  312. */
  313. static readonly WarningLogLevel: number;
  314. /**
  315. * Only error logs
  316. */
  317. static readonly ErrorLogLevel: number;
  318. /**
  319. * All logs
  320. */
  321. static readonly AllLogLevel: number;
  322. private static _LogCache;
  323. /**
  324. * Gets a value indicating the number of loading errors
  325. * @ignorenaming
  326. */
  327. static errorsCount: number;
  328. /**
  329. * Callback called when a new log is added
  330. */
  331. static OnNewCacheEntry: (entry: string) => void;
  332. private static _AddLogEntry;
  333. private static _FormatMessage;
  334. private static _LogDisabled;
  335. private static _LogEnabled;
  336. private static _WarnDisabled;
  337. private static _WarnEnabled;
  338. private static _ErrorDisabled;
  339. private static _ErrorEnabled;
  340. /**
  341. * Log a message to the console
  342. */
  343. static Log: (message: string) => void;
  344. /**
  345. * Write a warning message to the console
  346. */
  347. static Warn: (message: string) => void;
  348. /**
  349. * Write an error message to the console
  350. */
  351. static Error: (message: string) => void;
  352. /**
  353. * Gets current log cache (list of logs)
  354. */
  355. static readonly LogCache: string;
  356. /**
  357. * Clears the log cache
  358. */
  359. static ClearLogCache(): void;
  360. /**
  361. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  362. */
  363. static LogLevels: number;
  364. }
  365. }
  366. declare module "babylonjs/Misc/typeStore" {
  367. /** @hidden */
  368. export class _TypeStore {
  369. /** @hidden */
  370. static RegisteredTypes: {
  371. [key: string]: Object;
  372. };
  373. /** @hidden */
  374. static GetClass(fqdn: string): any;
  375. }
  376. }
  377. declare module "babylonjs/Misc/stringTools" {
  378. /**
  379. * Helper to manipulate strings
  380. */
  381. export class StringTools {
  382. /**
  383. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  384. * @param str Source string
  385. * @param suffix Suffix to search for in the source string
  386. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  387. */
  388. static EndsWith(str: string, suffix: string): boolean;
  389. /**
  390. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  391. * @param str Source string
  392. * @param suffix Suffix to search for in the source string
  393. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  394. */
  395. static StartsWith(str: string, suffix: string): boolean;
  396. /**
  397. * Decodes a buffer into a string
  398. * @param buffer The buffer to decode
  399. * @returns The decoded string
  400. */
  401. static Decode(buffer: Uint8Array | Uint16Array): string;
  402. /**
  403. * Encode a buffer to a base64 string
  404. * @param buffer defines the buffer to encode
  405. * @returns the encoded string
  406. */
  407. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  408. }
  409. }
  410. declare module "babylonjs/Misc/deepCopier" {
  411. /**
  412. * Class containing a set of static utilities functions for deep copy.
  413. */
  414. export class DeepCopier {
  415. /**
  416. * Tries to copy an object by duplicating every property
  417. * @param source defines the source object
  418. * @param destination defines the target object
  419. * @param doNotCopyList defines a list of properties to avoid
  420. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  421. */
  422. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  423. }
  424. }
  425. declare module "babylonjs/Misc/precisionDate" {
  426. /**
  427. * Class containing a set of static utilities functions for precision date
  428. */
  429. export class PrecisionDate {
  430. /**
  431. * Gets either window.performance.now() if supported or Date.now() else
  432. */
  433. static readonly Now: number;
  434. }
  435. }
  436. declare module "babylonjs/Misc/devTools" {
  437. /** @hidden */
  438. export class _DevTools {
  439. static WarnImport(name: string): string;
  440. }
  441. }
  442. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  443. /**
  444. * Interface used to define the mechanism to get data from the network
  445. */
  446. export interface IWebRequest {
  447. /**
  448. * Returns client's response url
  449. */
  450. responseURL: string;
  451. /**
  452. * Returns client's status
  453. */
  454. status: number;
  455. /**
  456. * Returns client's status as a text
  457. */
  458. statusText: string;
  459. }
  460. }
  461. declare module "babylonjs/Misc/webRequest" {
  462. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  463. import { Nullable } from "babylonjs/types";
  464. /**
  465. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  466. */
  467. export class WebRequest implements IWebRequest {
  468. private _xhr;
  469. /**
  470. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  471. * i.e. when loading files, where the server/service expects an Authorization header
  472. */
  473. static CustomRequestHeaders: {
  474. [key: string]: string;
  475. };
  476. /**
  477. * Add callback functions in this array to update all the requests before they get sent to the network
  478. */
  479. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  480. private _injectCustomRequestHeaders;
  481. /**
  482. * Gets or sets a function to be called when loading progress changes
  483. */
  484. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  485. /**
  486. * Returns client's state
  487. */
  488. readonly readyState: number;
  489. /**
  490. * Returns client's status
  491. */
  492. readonly status: number;
  493. /**
  494. * Returns client's status as a text
  495. */
  496. readonly statusText: string;
  497. /**
  498. * Returns client's response
  499. */
  500. readonly response: any;
  501. /**
  502. * Returns client's response url
  503. */
  504. readonly responseURL: string;
  505. /**
  506. * Returns client's response as text
  507. */
  508. readonly responseText: string;
  509. /**
  510. * Gets or sets the expected response type
  511. */
  512. responseType: XMLHttpRequestResponseType;
  513. /** @hidden */
  514. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  515. /** @hidden */
  516. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  517. /**
  518. * Cancels any network activity
  519. */
  520. abort(): void;
  521. /**
  522. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  523. * @param body defines an optional request body
  524. */
  525. send(body?: Document | BodyInit | null): void;
  526. /**
  527. * Sets the request method, request URL
  528. * @param method defines the method to use (GET, POST, etc..)
  529. * @param url defines the url to connect with
  530. */
  531. open(method: string, url: string): void;
  532. /**
  533. * Sets the value of a request header.
  534. * @param name The name of the header whose value is to be set
  535. * @param value The value to set as the body of the header
  536. */
  537. setRequestHeader(name: string, value: string): void;
  538. /**
  539. * Get the string containing the text of a particular header's value.
  540. * @param name The name of the header
  541. * @returns The string containing the text of the given header name
  542. */
  543. getResponseHeader(name: string): Nullable<string>;
  544. }
  545. }
  546. declare module "babylonjs/Misc/fileRequest" {
  547. import { Observable } from "babylonjs/Misc/observable";
  548. /**
  549. * File request interface
  550. */
  551. export interface IFileRequest {
  552. /**
  553. * Raised when the request is complete (success or error).
  554. */
  555. onCompleteObservable: Observable<IFileRequest>;
  556. /**
  557. * Aborts the request for a file.
  558. */
  559. abort: () => void;
  560. }
  561. }
  562. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  563. /**
  564. * Define options used to create a render target texture
  565. */
  566. export class RenderTargetCreationOptions {
  567. /**
  568. * Specifies is mipmaps must be generated
  569. */
  570. generateMipMaps?: boolean;
  571. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  572. generateDepthBuffer?: boolean;
  573. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  574. generateStencilBuffer?: boolean;
  575. /** Defines texture type (int by default) */
  576. type?: number;
  577. /** Defines sampling mode (trilinear by default) */
  578. samplingMode?: number;
  579. /** Defines format (RGBA by default) */
  580. format?: number;
  581. }
  582. }
  583. declare module "babylonjs/Instrumentation/timeToken" {
  584. import { Nullable } from "babylonjs/types";
  585. /**
  586. * @hidden
  587. **/
  588. export class _TimeToken {
  589. _startTimeQuery: Nullable<WebGLQuery>;
  590. _endTimeQuery: Nullable<WebGLQuery>;
  591. _timeElapsedQuery: Nullable<WebGLQuery>;
  592. _timeElapsedQueryEnded: boolean;
  593. }
  594. }
  595. declare module "babylonjs/Engines/constants" {
  596. /** Defines the cross module used constants to avoid circular dependncies */
  597. export class Constants {
  598. /** Defines that alpha blending is disabled */
  599. static readonly ALPHA_DISABLE: number;
  600. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  601. static readonly ALPHA_ADD: number;
  602. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  603. static readonly ALPHA_COMBINE: number;
  604. /** Defines that alpha blending to DEST - SRC * DEST */
  605. static readonly ALPHA_SUBTRACT: number;
  606. /** Defines that alpha blending to SRC * DEST */
  607. static readonly ALPHA_MULTIPLY: number;
  608. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  609. static readonly ALPHA_MAXIMIZED: number;
  610. /** Defines that alpha blending to SRC + DEST */
  611. static readonly ALPHA_ONEONE: number;
  612. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  613. static readonly ALPHA_PREMULTIPLIED: number;
  614. /**
  615. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  616. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  617. */
  618. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  619. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  620. static readonly ALPHA_INTERPOLATE: number;
  621. /**
  622. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  623. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  624. */
  625. static readonly ALPHA_SCREENMODE: number;
  626. /**
  627. * Defines that alpha blending to SRC + DST
  628. * Alpha will be set to SRC ALPHA + DST ALPHA
  629. */
  630. static readonly ALPHA_ONEONE_ONEONE: number;
  631. /**
  632. * Defines that alpha blending to SRC * DST ALPHA + DST
  633. * Alpha will be set to 0
  634. */
  635. static readonly ALPHA_ALPHATOCOLOR: number;
  636. /**
  637. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  638. */
  639. static readonly ALPHA_REVERSEONEMINUS: number;
  640. /**
  641. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  642. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  643. */
  644. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  645. /**
  646. * Defines that alpha blending to SRC + DST
  647. * Alpha will be set to SRC ALPHA
  648. */
  649. static readonly ALPHA_ONEONE_ONEZERO: number;
  650. /** Defines that alpha blending equation a SUM */
  651. static readonly ALPHA_EQUATION_ADD: number;
  652. /** Defines that alpha blending equation a SUBSTRACTION */
  653. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  654. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  655. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  656. /** Defines that alpha blending equation a MAX operation */
  657. static readonly ALPHA_EQUATION_MAX: number;
  658. /** Defines that alpha blending equation a MIN operation */
  659. static readonly ALPHA_EQUATION_MIN: number;
  660. /**
  661. * Defines that alpha blending equation a DARKEN operation:
  662. * It takes the min of the src and sums the alpha channels.
  663. */
  664. static readonly ALPHA_EQUATION_DARKEN: number;
  665. /** Defines that the ressource is not delayed*/
  666. static readonly DELAYLOADSTATE_NONE: number;
  667. /** Defines that the ressource was successfully delay loaded */
  668. static readonly DELAYLOADSTATE_LOADED: number;
  669. /** Defines that the ressource is currently delay loading */
  670. static readonly DELAYLOADSTATE_LOADING: number;
  671. /** Defines that the ressource is delayed and has not started loading */
  672. static readonly DELAYLOADSTATE_NOTLOADED: number;
  673. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  674. static readonly NEVER: number;
  675. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  676. static readonly ALWAYS: number;
  677. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  678. static readonly LESS: number;
  679. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  680. static readonly EQUAL: number;
  681. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  682. static readonly LEQUAL: number;
  683. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  684. static readonly GREATER: number;
  685. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  686. static readonly GEQUAL: number;
  687. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  688. static readonly NOTEQUAL: number;
  689. /** Passed to stencilOperation to specify that stencil value must be kept */
  690. static readonly KEEP: number;
  691. /** Passed to stencilOperation to specify that stencil value must be replaced */
  692. static readonly REPLACE: number;
  693. /** Passed to stencilOperation to specify that stencil value must be incremented */
  694. static readonly INCR: number;
  695. /** Passed to stencilOperation to specify that stencil value must be decremented */
  696. static readonly DECR: number;
  697. /** Passed to stencilOperation to specify that stencil value must be inverted */
  698. static readonly INVERT: number;
  699. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  700. static readonly INCR_WRAP: number;
  701. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  702. static readonly DECR_WRAP: number;
  703. /** Texture is not repeating outside of 0..1 UVs */
  704. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  705. /** Texture is repeating outside of 0..1 UVs */
  706. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  707. /** Texture is repeating and mirrored */
  708. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  709. /** ALPHA */
  710. static readonly TEXTUREFORMAT_ALPHA: number;
  711. /** LUMINANCE */
  712. static readonly TEXTUREFORMAT_LUMINANCE: number;
  713. /** LUMINANCE_ALPHA */
  714. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  715. /** RGB */
  716. static readonly TEXTUREFORMAT_RGB: number;
  717. /** RGBA */
  718. static readonly TEXTUREFORMAT_RGBA: number;
  719. /** RED */
  720. static readonly TEXTUREFORMAT_RED: number;
  721. /** RED (2nd reference) */
  722. static readonly TEXTUREFORMAT_R: number;
  723. /** RG */
  724. static readonly TEXTUREFORMAT_RG: number;
  725. /** RED_INTEGER */
  726. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  727. /** RED_INTEGER (2nd reference) */
  728. static readonly TEXTUREFORMAT_R_INTEGER: number;
  729. /** RG_INTEGER */
  730. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  731. /** RGB_INTEGER */
  732. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  733. /** RGBA_INTEGER */
  734. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  735. /** UNSIGNED_BYTE */
  736. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  737. /** UNSIGNED_BYTE (2nd reference) */
  738. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  739. /** FLOAT */
  740. static readonly TEXTURETYPE_FLOAT: number;
  741. /** HALF_FLOAT */
  742. static readonly TEXTURETYPE_HALF_FLOAT: number;
  743. /** BYTE */
  744. static readonly TEXTURETYPE_BYTE: number;
  745. /** SHORT */
  746. static readonly TEXTURETYPE_SHORT: number;
  747. /** UNSIGNED_SHORT */
  748. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  749. /** INT */
  750. static readonly TEXTURETYPE_INT: number;
  751. /** UNSIGNED_INT */
  752. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  753. /** UNSIGNED_SHORT_4_4_4_4 */
  754. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  755. /** UNSIGNED_SHORT_5_5_5_1 */
  756. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  757. /** UNSIGNED_SHORT_5_6_5 */
  758. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  759. /** UNSIGNED_INT_2_10_10_10_REV */
  760. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  761. /** UNSIGNED_INT_24_8 */
  762. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  763. /** UNSIGNED_INT_10F_11F_11F_REV */
  764. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  765. /** UNSIGNED_INT_5_9_9_9_REV */
  766. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  767. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  768. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  769. /** nearest is mag = nearest and min = nearest and mip = nearest */
  770. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  771. /** Bilinear is mag = linear and min = linear and mip = nearest */
  772. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  773. /** Trilinear is mag = linear and min = linear and mip = linear */
  774. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  775. /** nearest is mag = nearest and min = nearest and mip = linear */
  776. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  777. /** Bilinear is mag = linear and min = linear and mip = nearest */
  778. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  779. /** Trilinear is mag = linear and min = linear and mip = linear */
  780. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  781. /** mag = nearest and min = nearest and mip = nearest */
  782. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  783. /** mag = nearest and min = linear and mip = nearest */
  784. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  785. /** mag = nearest and min = linear and mip = linear */
  786. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  787. /** mag = nearest and min = linear and mip = none */
  788. static readonly TEXTURE_NEAREST_LINEAR: number;
  789. /** mag = nearest and min = nearest and mip = none */
  790. static readonly TEXTURE_NEAREST_NEAREST: number;
  791. /** mag = linear and min = nearest and mip = nearest */
  792. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  793. /** mag = linear and min = nearest and mip = linear */
  794. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  795. /** mag = linear and min = linear and mip = none */
  796. static readonly TEXTURE_LINEAR_LINEAR: number;
  797. /** mag = linear and min = nearest and mip = none */
  798. static readonly TEXTURE_LINEAR_NEAREST: number;
  799. /** Explicit coordinates mode */
  800. static readonly TEXTURE_EXPLICIT_MODE: number;
  801. /** Spherical coordinates mode */
  802. static readonly TEXTURE_SPHERICAL_MODE: number;
  803. /** Planar coordinates mode */
  804. static readonly TEXTURE_PLANAR_MODE: number;
  805. /** Cubic coordinates mode */
  806. static readonly TEXTURE_CUBIC_MODE: number;
  807. /** Projection coordinates mode */
  808. static readonly TEXTURE_PROJECTION_MODE: number;
  809. /** Skybox coordinates mode */
  810. static readonly TEXTURE_SKYBOX_MODE: number;
  811. /** Inverse Cubic coordinates mode */
  812. static readonly TEXTURE_INVCUBIC_MODE: number;
  813. /** Equirectangular coordinates mode */
  814. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  815. /** Equirectangular Fixed coordinates mode */
  816. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  817. /** Equirectangular Fixed Mirrored coordinates mode */
  818. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  819. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  820. static readonly SCALEMODE_FLOOR: number;
  821. /** Defines that texture rescaling will look for the nearest power of 2 size */
  822. static readonly SCALEMODE_NEAREST: number;
  823. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  824. static readonly SCALEMODE_CEILING: number;
  825. /**
  826. * The dirty texture flag value
  827. */
  828. static readonly MATERIAL_TextureDirtyFlag: number;
  829. /**
  830. * The dirty light flag value
  831. */
  832. static readonly MATERIAL_LightDirtyFlag: number;
  833. /**
  834. * The dirty fresnel flag value
  835. */
  836. static readonly MATERIAL_FresnelDirtyFlag: number;
  837. /**
  838. * The dirty attribute flag value
  839. */
  840. static readonly MATERIAL_AttributesDirtyFlag: number;
  841. /**
  842. * The dirty misc flag value
  843. */
  844. static readonly MATERIAL_MiscDirtyFlag: number;
  845. /**
  846. * The all dirty flag value
  847. */
  848. static readonly MATERIAL_AllDirtyFlag: number;
  849. /**
  850. * Returns the triangle fill mode
  851. */
  852. static readonly MATERIAL_TriangleFillMode: number;
  853. /**
  854. * Returns the wireframe mode
  855. */
  856. static readonly MATERIAL_WireFrameFillMode: number;
  857. /**
  858. * Returns the point fill mode
  859. */
  860. static readonly MATERIAL_PointFillMode: number;
  861. /**
  862. * Returns the point list draw mode
  863. */
  864. static readonly MATERIAL_PointListDrawMode: number;
  865. /**
  866. * Returns the line list draw mode
  867. */
  868. static readonly MATERIAL_LineListDrawMode: number;
  869. /**
  870. * Returns the line loop draw mode
  871. */
  872. static readonly MATERIAL_LineLoopDrawMode: number;
  873. /**
  874. * Returns the line strip draw mode
  875. */
  876. static readonly MATERIAL_LineStripDrawMode: number;
  877. /**
  878. * Returns the triangle strip draw mode
  879. */
  880. static readonly MATERIAL_TriangleStripDrawMode: number;
  881. /**
  882. * Returns the triangle fan draw mode
  883. */
  884. static readonly MATERIAL_TriangleFanDrawMode: number;
  885. /**
  886. * Stores the clock-wise side orientation
  887. */
  888. static readonly MATERIAL_ClockWiseSideOrientation: number;
  889. /**
  890. * Stores the counter clock-wise side orientation
  891. */
  892. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  893. /**
  894. * Nothing
  895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  896. */
  897. static readonly ACTION_NothingTrigger: number;
  898. /**
  899. * On pick
  900. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  901. */
  902. static readonly ACTION_OnPickTrigger: number;
  903. /**
  904. * On left pick
  905. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  906. */
  907. static readonly ACTION_OnLeftPickTrigger: number;
  908. /**
  909. * On right pick
  910. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_OnRightPickTrigger: number;
  913. /**
  914. * On center pick
  915. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnCenterPickTrigger: number;
  918. /**
  919. * On pick down
  920. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnPickDownTrigger: number;
  923. /**
  924. * On double pick
  925. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnDoublePickTrigger: number;
  928. /**
  929. * On pick up
  930. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnPickUpTrigger: number;
  933. /**
  934. * On pick out.
  935. * This trigger will only be raised if you also declared a OnPickDown
  936. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  937. */
  938. static readonly ACTION_OnPickOutTrigger: number;
  939. /**
  940. * On long press
  941. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  942. */
  943. static readonly ACTION_OnLongPressTrigger: number;
  944. /**
  945. * On pointer over
  946. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  947. */
  948. static readonly ACTION_OnPointerOverTrigger: number;
  949. /**
  950. * On pointer out
  951. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPointerOutTrigger: number;
  954. /**
  955. * On every frame
  956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnEveryFrameTrigger: number;
  959. /**
  960. * On intersection enter
  961. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnIntersectionEnterTrigger: number;
  964. /**
  965. * On intersection exit
  966. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnIntersectionExitTrigger: number;
  969. /**
  970. * On key down
  971. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnKeyDownTrigger: number;
  974. /**
  975. * On key up
  976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnKeyUpTrigger: number;
  979. /**
  980. * Billboard mode will only apply to Y axis
  981. */
  982. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  983. /**
  984. * Billboard mode will apply to all axes
  985. */
  986. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  987. /**
  988. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  989. */
  990. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  991. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  992. * Test order :
  993. * Is the bounding sphere outside the frustum ?
  994. * If not, are the bounding box vertices outside the frustum ?
  995. * It not, then the cullable object is in the frustum.
  996. */
  997. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  998. /** Culling strategy : Bounding Sphere Only.
  999. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1000. * It's also less accurate than the standard because some not visible objects can still be selected.
  1001. * Test : is the bounding sphere outside the frustum ?
  1002. * If not, then the cullable object is in the frustum.
  1003. */
  1004. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1005. /** Culling strategy : Optimistic Inclusion.
  1006. * This in an inclusion test first, then the standard exclusion test.
  1007. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1008. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1009. * Anyway, it's as accurate as the standard strategy.
  1010. * Test :
  1011. * Is the cullable object bounding sphere center in the frustum ?
  1012. * If not, apply the default culling strategy.
  1013. */
  1014. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1015. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1016. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1017. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1018. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1019. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1020. * Test :
  1021. * Is the cullable object bounding sphere center in the frustum ?
  1022. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1023. */
  1024. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1025. /**
  1026. * No logging while loading
  1027. */
  1028. static readonly SCENELOADER_NO_LOGGING: number;
  1029. /**
  1030. * Minimal logging while loading
  1031. */
  1032. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1033. /**
  1034. * Summary logging while loading
  1035. */
  1036. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1037. /**
  1038. * Detailled logging while loading
  1039. */
  1040. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1041. }
  1042. }
  1043. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1044. import { Nullable } from "babylonjs/types";
  1045. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1046. /**
  1047. * This represents the required contract to create a new type of texture loader.
  1048. */
  1049. export interface IInternalTextureLoader {
  1050. /**
  1051. * Defines wether the loader supports cascade loading the different faces.
  1052. */
  1053. supportCascades: boolean;
  1054. /**
  1055. * This returns if the loader support the current file information.
  1056. * @param extension defines the file extension of the file being loaded
  1057. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1058. * @param fallback defines the fallback internal texture if any
  1059. * @param isBase64 defines whether the texture is encoded as a base64
  1060. * @param isBuffer defines whether the texture data are stored as a buffer
  1061. * @returns true if the loader can load the specified file
  1062. */
  1063. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  1064. /**
  1065. * Transform the url before loading if required.
  1066. * @param rootUrl the url of the texture
  1067. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1068. * @returns the transformed texture
  1069. */
  1070. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  1071. /**
  1072. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  1073. * @param rootUrl the url of the texture
  1074. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1075. * @returns the fallback texture
  1076. */
  1077. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  1078. /**
  1079. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  1080. * @param data contains the texture data
  1081. * @param texture defines the BabylonJS internal texture
  1082. * @param createPolynomials will be true if polynomials have been requested
  1083. * @param onLoad defines the callback to trigger once the texture is ready
  1084. * @param onError defines the callback to trigger in case of error
  1085. */
  1086. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1087. /**
  1088. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  1089. * @param data contains the texture data
  1090. * @param texture defines the BabylonJS internal texture
  1091. * @param callback defines the method to call once ready to upload
  1092. */
  1093. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1094. }
  1095. }
  1096. declare module "babylonjs/Engines/IPipelineContext" {
  1097. /**
  1098. * Class used to store and describe the pipeline context associated with an effect
  1099. */
  1100. export interface IPipelineContext {
  1101. /**
  1102. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1103. */
  1104. isAsync: boolean;
  1105. /**
  1106. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1107. */
  1108. isReady: boolean;
  1109. /** @hidden */
  1110. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1111. }
  1112. }
  1113. declare module "babylonjs/Meshes/dataBuffer" {
  1114. /**
  1115. * Class used to store gfx data (like WebGLBuffer)
  1116. */
  1117. export class DataBuffer {
  1118. /**
  1119. * Gets or sets the number of objects referencing this buffer
  1120. */
  1121. references: number;
  1122. /** Gets or sets the size of the underlying buffer */
  1123. capacity: number;
  1124. /**
  1125. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1126. */
  1127. is32Bits: boolean;
  1128. /**
  1129. * Gets the underlying buffer
  1130. */
  1131. readonly underlyingResource: any;
  1132. }
  1133. }
  1134. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1135. /** @hidden */
  1136. export interface IShaderProcessor {
  1137. attributeProcessor?: (attribute: string) => string;
  1138. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1139. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1140. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1141. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1142. lineProcessor?: (line: string, isFragment: boolean) => string;
  1143. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1144. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1145. }
  1146. }
  1147. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1148. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1149. /** @hidden */
  1150. export interface ProcessingOptions {
  1151. defines: string[];
  1152. indexParameters: any;
  1153. isFragment: boolean;
  1154. shouldUseHighPrecisionShader: boolean;
  1155. supportsUniformBuffers: boolean;
  1156. shadersRepository: string;
  1157. includesShadersStore: {
  1158. [key: string]: string;
  1159. };
  1160. processor?: IShaderProcessor;
  1161. version: string;
  1162. platformName: string;
  1163. lookForClosingBracketForUniformBuffer?: boolean;
  1164. }
  1165. }
  1166. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1167. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1168. /** @hidden */
  1169. export class ShaderCodeNode {
  1170. line: string;
  1171. children: ShaderCodeNode[];
  1172. additionalDefineKey?: string;
  1173. additionalDefineValue?: string;
  1174. isValid(preprocessors: {
  1175. [key: string]: string;
  1176. }): boolean;
  1177. process(preprocessors: {
  1178. [key: string]: string;
  1179. }, options: ProcessingOptions): string;
  1180. }
  1181. }
  1182. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1183. /** @hidden */
  1184. export class ShaderCodeCursor {
  1185. private _lines;
  1186. lineIndex: number;
  1187. readonly currentLine: string;
  1188. readonly canRead: boolean;
  1189. lines: string[];
  1190. }
  1191. }
  1192. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1193. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1194. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1195. /** @hidden */
  1196. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1197. process(preprocessors: {
  1198. [key: string]: string;
  1199. }, options: ProcessingOptions): string;
  1200. }
  1201. }
  1202. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1203. /** @hidden */
  1204. export class ShaderDefineExpression {
  1205. isTrue(preprocessors: {
  1206. [key: string]: string;
  1207. }): boolean;
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1213. /** @hidden */
  1214. export class ShaderCodeTestNode extends ShaderCodeNode {
  1215. testExpression: ShaderDefineExpression;
  1216. isValid(preprocessors: {
  1217. [key: string]: string;
  1218. }): boolean;
  1219. }
  1220. }
  1221. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1222. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1223. /** @hidden */
  1224. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1225. define: string;
  1226. not: boolean;
  1227. constructor(define: string, not?: boolean);
  1228. isTrue(preprocessors: {
  1229. [key: string]: string;
  1230. }): boolean;
  1231. }
  1232. }
  1233. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1237. leftOperand: ShaderDefineExpression;
  1238. rightOperand: ShaderDefineExpression;
  1239. isTrue(preprocessors: {
  1240. [key: string]: string;
  1241. }): boolean;
  1242. }
  1243. }
  1244. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1245. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1246. /** @hidden */
  1247. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1248. leftOperand: ShaderDefineExpression;
  1249. rightOperand: ShaderDefineExpression;
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1259. define: string;
  1260. operand: string;
  1261. testValue: string;
  1262. constructor(define: string, operand: string, testValue: string);
  1263. isTrue(preprocessors: {
  1264. [key: string]: string;
  1265. }): boolean;
  1266. }
  1267. }
  1268. declare module "babylonjs/Offline/IOfflineProvider" {
  1269. /**
  1270. * Class used to enable access to offline support
  1271. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1272. */
  1273. export interface IOfflineProvider {
  1274. /**
  1275. * Gets a boolean indicating if scene must be saved in the database
  1276. */
  1277. enableSceneOffline: boolean;
  1278. /**
  1279. * Gets a boolean indicating if textures must be saved in the database
  1280. */
  1281. enableTexturesOffline: boolean;
  1282. /**
  1283. * Open the offline support and make it available
  1284. * @param successCallback defines the callback to call on success
  1285. * @param errorCallback defines the callback to call on error
  1286. */
  1287. open(successCallback: () => void, errorCallback: () => void): void;
  1288. /**
  1289. * Loads an image from the offline support
  1290. * @param url defines the url to load from
  1291. * @param image defines the target DOM image
  1292. */
  1293. loadImage(url: string, image: HTMLImageElement): void;
  1294. /**
  1295. * Loads a file from offline support
  1296. * @param url defines the URL to load from
  1297. * @param sceneLoaded defines a callback to call on success
  1298. * @param progressCallBack defines a callback to call when progress changed
  1299. * @param errorCallback defines a callback to call on error
  1300. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1301. */
  1302. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1303. }
  1304. }
  1305. declare module "babylonjs/Misc/filesInputStore" {
  1306. /**
  1307. * Class used to help managing file picking and drag'n'drop
  1308. * File Storage
  1309. */
  1310. export class FilesInputStore {
  1311. /**
  1312. * List of files ready to be loaded
  1313. */
  1314. static FilesToLoad: {
  1315. [key: string]: File;
  1316. };
  1317. }
  1318. }
  1319. declare module "babylonjs/Misc/retryStrategy" {
  1320. import { WebRequest } from "babylonjs/Misc/webRequest";
  1321. /**
  1322. * Class used to define a retry strategy when error happens while loading assets
  1323. */
  1324. export class RetryStrategy {
  1325. /**
  1326. * Function used to defines an exponential back off strategy
  1327. * @param maxRetries defines the maximum number of retries (3 by default)
  1328. * @param baseInterval defines the interval between retries
  1329. * @returns the strategy function to use
  1330. */
  1331. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1332. }
  1333. }
  1334. declare module "babylonjs/Misc/baseError" {
  1335. /**
  1336. * @ignore
  1337. * Application error to support additional information when loading a file
  1338. */
  1339. export abstract class BaseError extends Error {
  1340. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1341. }
  1342. }
  1343. declare module "babylonjs/Misc/fileTools" {
  1344. import { WebRequest } from "babylonjs/Misc/webRequest";
  1345. import { Nullable } from "babylonjs/types";
  1346. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1347. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1348. import { BaseError } from "babylonjs/Misc/baseError";
  1349. /** @ignore */
  1350. export class LoadFileError extends BaseError {
  1351. request?: WebRequest;
  1352. file?: File;
  1353. /**
  1354. * Creates a new LoadFileError
  1355. * @param message defines the message of the error
  1356. * @param request defines the optional web request
  1357. * @param file defines the optional file
  1358. */
  1359. constructor(message: string, object?: WebRequest | File);
  1360. }
  1361. /** @ignore */
  1362. export class RequestFileError extends BaseError {
  1363. request: WebRequest;
  1364. /**
  1365. * Creates a new LoadFileError
  1366. * @param message defines the message of the error
  1367. * @param request defines the optional web request
  1368. */
  1369. constructor(message: string, request: WebRequest);
  1370. }
  1371. /** @ignore */
  1372. export class ReadFileError extends BaseError {
  1373. file: File;
  1374. /**
  1375. * Creates a new ReadFileError
  1376. * @param message defines the message of the error
  1377. * @param file defines the optional file
  1378. */
  1379. constructor(message: string, file: File);
  1380. }
  1381. /**
  1382. * @hidden
  1383. */
  1384. export class FileTools {
  1385. /**
  1386. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1387. */
  1388. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1389. /**
  1390. * Gets or sets the base URL to use to load assets
  1391. */
  1392. static BaseUrl: string;
  1393. /**
  1394. * Default behaviour for cors in the application.
  1395. * It can be a string if the expected behavior is identical in the entire app.
  1396. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1397. */
  1398. static CorsBehavior: string | ((url: string | string[]) => string);
  1399. /**
  1400. * Gets or sets a function used to pre-process url before using them to load assets
  1401. */
  1402. static PreprocessUrl: (url: string) => string;
  1403. /**
  1404. * Removes unwanted characters from an url
  1405. * @param url defines the url to clean
  1406. * @returns the cleaned url
  1407. */
  1408. private static _CleanUrl;
  1409. /**
  1410. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1411. * @param url define the url we are trying
  1412. * @param element define the dom element where to configure the cors policy
  1413. */
  1414. static SetCorsBehavior(url: string | string[], element: {
  1415. crossOrigin: string | null;
  1416. }): void;
  1417. /**
  1418. * Loads an image as an HTMLImageElement.
  1419. * @param input url string, ArrayBuffer, or Blob to load
  1420. * @param onLoad callback called when the image successfully loads
  1421. * @param onError callback called when the image fails to load
  1422. * @param offlineProvider offline provider for caching
  1423. * @param mimeType optional mime type
  1424. * @returns the HTMLImageElement of the loaded image
  1425. */
  1426. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1427. /**
  1428. * Reads a file from a File object
  1429. * @param file defines the file to load
  1430. * @param onSuccess defines the callback to call when data is loaded
  1431. * @param onProgress defines the callback to call during loading process
  1432. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1433. * @param onError defines the callback to call when an error occurs
  1434. * @returns a file request object
  1435. */
  1436. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1437. /**
  1438. * Loads a file from a url
  1439. * @param url url to load
  1440. * @param onSuccess callback called when the file successfully loads
  1441. * @param onProgress callback called while file is loading (if the server supports this mode)
  1442. * @param offlineProvider defines the offline provider for caching
  1443. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1444. * @param onError callback called when the file fails to load
  1445. * @returns a file request object
  1446. */
  1447. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1448. /**
  1449. * Loads a file
  1450. * @param url url to load
  1451. * @param onSuccess callback called when the file successfully loads
  1452. * @param onProgress callback called while file is loading (if the server supports this mode)
  1453. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1454. * @param onError callback called when the file fails to load
  1455. * @param onOpened callback called when the web request is opened
  1456. * @returns a file request object
  1457. */
  1458. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1459. /**
  1460. * Checks if the loaded document was accessed via `file:`-Protocol.
  1461. * @returns boolean
  1462. */
  1463. static IsFileURL(): boolean;
  1464. }
  1465. }
  1466. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1467. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1468. /** @hidden */
  1469. export class ShaderProcessor {
  1470. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1471. private static _ProcessPrecision;
  1472. private static _ExtractOperation;
  1473. private static _BuildSubExpression;
  1474. private static _BuildExpression;
  1475. private static _MoveCursorWithinIf;
  1476. private static _MoveCursor;
  1477. private static _EvaluatePreProcessors;
  1478. private static _PreparePreProcessors;
  1479. private static _ProcessShaderConversion;
  1480. private static _ProcessIncludes;
  1481. }
  1482. }
  1483. declare module "babylonjs/Maths/math.like" {
  1484. import { float, int, DeepImmutable } from "babylonjs/types";
  1485. /**
  1486. * @hidden
  1487. */
  1488. export interface IColor4Like {
  1489. r: float;
  1490. g: float;
  1491. b: float;
  1492. a: float;
  1493. }
  1494. /**
  1495. * @hidden
  1496. */
  1497. export interface IColor3Like {
  1498. r: float;
  1499. g: float;
  1500. b: float;
  1501. }
  1502. /**
  1503. * @hidden
  1504. */
  1505. export interface IVector4Like {
  1506. x: float;
  1507. y: float;
  1508. z: float;
  1509. w: float;
  1510. }
  1511. /**
  1512. * @hidden
  1513. */
  1514. export interface IVector3Like {
  1515. x: float;
  1516. y: float;
  1517. z: float;
  1518. }
  1519. /**
  1520. * @hidden
  1521. */
  1522. export interface IVector2Like {
  1523. x: float;
  1524. y: float;
  1525. }
  1526. /**
  1527. * @hidden
  1528. */
  1529. export interface IMatrixLike {
  1530. toArray(): DeepImmutable<Float32Array>;
  1531. updateFlag: int;
  1532. }
  1533. /**
  1534. * @hidden
  1535. */
  1536. export interface IViewportLike {
  1537. x: float;
  1538. y: float;
  1539. width: float;
  1540. height: float;
  1541. }
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IPlaneLike {
  1546. normal: IVector3Like;
  1547. d: float;
  1548. normalize(): void;
  1549. }
  1550. }
  1551. declare module "babylonjs/Materials/iEffectFallbacks" {
  1552. import { Effect } from "babylonjs/Materials/effect";
  1553. /**
  1554. * Interface used to define common properties for effect fallbacks
  1555. */
  1556. export interface IEffectFallbacks {
  1557. /**
  1558. * Removes the defines that should be removed when falling back.
  1559. * @param currentDefines defines the current define statements for the shader.
  1560. * @param effect defines the current effect we try to compile
  1561. * @returns The resulting defines with defines of the current rank removed.
  1562. */
  1563. reduce(currentDefines: string, effect: Effect): string;
  1564. /**
  1565. * Removes the fallback from the bound mesh.
  1566. */
  1567. unBindMesh(): void;
  1568. /**
  1569. * Checks to see if more fallbacks are still availible.
  1570. */
  1571. hasMoreFallbacks: boolean;
  1572. }
  1573. }
  1574. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1575. /**
  1576. * Class used to evalaute queries containing `and` and `or` operators
  1577. */
  1578. export class AndOrNotEvaluator {
  1579. /**
  1580. * Evaluate a query
  1581. * @param query defines the query to evaluate
  1582. * @param evaluateCallback defines the callback used to filter result
  1583. * @returns true if the query matches
  1584. */
  1585. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1586. private static _HandleParenthesisContent;
  1587. private static _SimplifyNegation;
  1588. }
  1589. }
  1590. declare module "babylonjs/Misc/tags" {
  1591. /**
  1592. * Class used to store custom tags
  1593. */
  1594. export class Tags {
  1595. /**
  1596. * Adds support for tags on the given object
  1597. * @param obj defines the object to use
  1598. */
  1599. static EnableFor(obj: any): void;
  1600. /**
  1601. * Removes tags support
  1602. * @param obj defines the object to use
  1603. */
  1604. static DisableFor(obj: any): void;
  1605. /**
  1606. * Gets a boolean indicating if the given object has tags
  1607. * @param obj defines the object to use
  1608. * @returns a boolean
  1609. */
  1610. static HasTags(obj: any): boolean;
  1611. /**
  1612. * Gets the tags available on a given object
  1613. * @param obj defines the object to use
  1614. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1615. * @returns the tags
  1616. */
  1617. static GetTags(obj: any, asString?: boolean): any;
  1618. /**
  1619. * Adds tags to an object
  1620. * @param obj defines the object to use
  1621. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1622. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1623. */
  1624. static AddTagsTo(obj: any, tagsString: string): void;
  1625. /**
  1626. * @hidden
  1627. */
  1628. static _AddTagTo(obj: any, tag: string): void;
  1629. /**
  1630. * Removes specific tags from a specific object
  1631. * @param obj defines the object to use
  1632. * @param tagsString defines the tags to remove
  1633. */
  1634. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1635. /**
  1636. * @hidden
  1637. */
  1638. static _RemoveTagFrom(obj: any, tag: string): void;
  1639. /**
  1640. * Defines if tags hosted on an object match a given query
  1641. * @param obj defines the object to use
  1642. * @param tagsQuery defines the tag query
  1643. * @returns a boolean
  1644. */
  1645. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1646. }
  1647. }
  1648. declare module "babylonjs/Maths/math.scalar" {
  1649. /**
  1650. * Scalar computation library
  1651. */
  1652. export class Scalar {
  1653. /**
  1654. * Two pi constants convenient for computation.
  1655. */
  1656. static TwoPi: number;
  1657. /**
  1658. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1659. * @param a number
  1660. * @param b number
  1661. * @param epsilon (default = 1.401298E-45)
  1662. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1663. */
  1664. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1665. /**
  1666. * Returns a string : the upper case translation of the number i to hexadecimal.
  1667. * @param i number
  1668. * @returns the upper case translation of the number i to hexadecimal.
  1669. */
  1670. static ToHex(i: number): string;
  1671. /**
  1672. * Returns -1 if value is negative and +1 is value is positive.
  1673. * @param value the value
  1674. * @returns the value itself if it's equal to zero.
  1675. */
  1676. static Sign(value: number): number;
  1677. /**
  1678. * Returns the value itself if it's between min and max.
  1679. * Returns min if the value is lower than min.
  1680. * Returns max if the value is greater than max.
  1681. * @param value the value to clmap
  1682. * @param min the min value to clamp to (default: 0)
  1683. * @param max the max value to clamp to (default: 1)
  1684. * @returns the clamped value
  1685. */
  1686. static Clamp(value: number, min?: number, max?: number): number;
  1687. /**
  1688. * the log2 of value.
  1689. * @param value the value to compute log2 of
  1690. * @returns the log2 of value.
  1691. */
  1692. static Log2(value: number): number;
  1693. /**
  1694. * Loops the value, so that it is never larger than length and never smaller than 0.
  1695. *
  1696. * This is similar to the modulo operator but it works with floating point numbers.
  1697. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1698. * With t = 5 and length = 2.5, the result would be 0.0.
  1699. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1700. * @param value the value
  1701. * @param length the length
  1702. * @returns the looped value
  1703. */
  1704. static Repeat(value: number, length: number): number;
  1705. /**
  1706. * Normalize the value between 0.0 and 1.0 using min and max values
  1707. * @param value value to normalize
  1708. * @param min max to normalize between
  1709. * @param max min to normalize between
  1710. * @returns the normalized value
  1711. */
  1712. static Normalize(value: number, min: number, max: number): number;
  1713. /**
  1714. * Denormalize the value from 0.0 and 1.0 using min and max values
  1715. * @param normalized value to denormalize
  1716. * @param min max to denormalize between
  1717. * @param max min to denormalize between
  1718. * @returns the denormalized value
  1719. */
  1720. static Denormalize(normalized: number, min: number, max: number): number;
  1721. /**
  1722. * Calculates the shortest difference between two given angles given in degrees.
  1723. * @param current current angle in degrees
  1724. * @param target target angle in degrees
  1725. * @returns the delta
  1726. */
  1727. static DeltaAngle(current: number, target: number): number;
  1728. /**
  1729. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1730. * @param tx value
  1731. * @param length length
  1732. * @returns The returned value will move back and forth between 0 and length
  1733. */
  1734. static PingPong(tx: number, length: number): number;
  1735. /**
  1736. * Interpolates between min and max with smoothing at the limits.
  1737. *
  1738. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1739. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1740. * @param from from
  1741. * @param to to
  1742. * @param tx value
  1743. * @returns the smooth stepped value
  1744. */
  1745. static SmoothStep(from: number, to: number, tx: number): number;
  1746. /**
  1747. * Moves a value current towards target.
  1748. *
  1749. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1750. * Negative values of maxDelta pushes the value away from target.
  1751. * @param current current value
  1752. * @param target target value
  1753. * @param maxDelta max distance to move
  1754. * @returns resulting value
  1755. */
  1756. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1757. /**
  1758. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1759. *
  1760. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1761. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1762. * @param current current value
  1763. * @param target target value
  1764. * @param maxDelta max distance to move
  1765. * @returns resulting angle
  1766. */
  1767. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1768. /**
  1769. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1770. * @param start start value
  1771. * @param end target value
  1772. * @param amount amount to lerp between
  1773. * @returns the lerped value
  1774. */
  1775. static Lerp(start: number, end: number, amount: number): number;
  1776. /**
  1777. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1778. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1779. * @param start start value
  1780. * @param end target value
  1781. * @param amount amount to lerp between
  1782. * @returns the lerped value
  1783. */
  1784. static LerpAngle(start: number, end: number, amount: number): number;
  1785. /**
  1786. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1787. * @param a start value
  1788. * @param b target value
  1789. * @param value value between a and b
  1790. * @returns the inverseLerp value
  1791. */
  1792. static InverseLerp(a: number, b: number, value: number): number;
  1793. /**
  1794. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1795. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1796. * @param value1 spline value
  1797. * @param tangent1 spline value
  1798. * @param value2 spline value
  1799. * @param tangent2 spline value
  1800. * @param amount input value
  1801. * @returns hermite result
  1802. */
  1803. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1804. /**
  1805. * Returns a random float number between and min and max values
  1806. * @param min min value of random
  1807. * @param max max value of random
  1808. * @returns random value
  1809. */
  1810. static RandomRange(min: number, max: number): number;
  1811. /**
  1812. * This function returns percentage of a number in a given range.
  1813. *
  1814. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1815. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1816. * @param number to convert to percentage
  1817. * @param min min range
  1818. * @param max max range
  1819. * @returns the percentage
  1820. */
  1821. static RangeToPercent(number: number, min: number, max: number): number;
  1822. /**
  1823. * This function returns number that corresponds to the percentage in a given range.
  1824. *
  1825. * PercentToRange(0.34,0,100) will return 34.
  1826. * @param percent to convert to number
  1827. * @param min min range
  1828. * @param max max range
  1829. * @returns the number
  1830. */
  1831. static PercentToRange(percent: number, min: number, max: number): number;
  1832. /**
  1833. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1834. * @param angle The angle to normalize in radian.
  1835. * @return The converted angle.
  1836. */
  1837. static NormalizeRadians(angle: number): number;
  1838. }
  1839. }
  1840. declare module "babylonjs/Maths/math.constants" {
  1841. /**
  1842. * Constant used to convert a value to gamma space
  1843. * @ignorenaming
  1844. */
  1845. export const ToGammaSpace: number;
  1846. /**
  1847. * Constant used to convert a value to linear space
  1848. * @ignorenaming
  1849. */
  1850. export const ToLinearSpace = 2.2;
  1851. /**
  1852. * Constant used to define the minimal number value in Babylon.js
  1853. * @ignorenaming
  1854. */
  1855. let Epsilon: number;
  1856. export { Epsilon };
  1857. }
  1858. declare module "babylonjs/Maths/math.viewport" {
  1859. /**
  1860. * Class used to represent a viewport on screen
  1861. */
  1862. export class Viewport {
  1863. /** viewport left coordinate */
  1864. x: number;
  1865. /** viewport top coordinate */
  1866. y: number;
  1867. /**viewport width */
  1868. width: number;
  1869. /** viewport height */
  1870. height: number;
  1871. /**
  1872. * Creates a Viewport object located at (x, y) and sized (width, height)
  1873. * @param x defines viewport left coordinate
  1874. * @param y defines viewport top coordinate
  1875. * @param width defines the viewport width
  1876. * @param height defines the viewport height
  1877. */
  1878. constructor(
  1879. /** viewport left coordinate */
  1880. x: number,
  1881. /** viewport top coordinate */
  1882. y: number,
  1883. /**viewport width */
  1884. width: number,
  1885. /** viewport height */
  1886. height: number);
  1887. /**
  1888. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1889. * @param renderWidth defines the rendering width
  1890. * @param renderHeight defines the rendering height
  1891. * @returns a new Viewport
  1892. */
  1893. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1894. /**
  1895. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1896. * @param renderWidth defines the rendering width
  1897. * @param renderHeight defines the rendering height
  1898. * @param ref defines the target viewport
  1899. * @returns the current viewport
  1900. */
  1901. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1902. /**
  1903. * Returns a new Viewport copied from the current one
  1904. * @returns a new Viewport
  1905. */
  1906. clone(): Viewport;
  1907. }
  1908. }
  1909. declare module "babylonjs/Misc/arrayTools" {
  1910. /**
  1911. * Class containing a set of static utilities functions for arrays.
  1912. */
  1913. export class ArrayTools {
  1914. /**
  1915. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1916. * @param size the number of element to construct and put in the array
  1917. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1918. * @returns a new array filled with new objects
  1919. */
  1920. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1921. }
  1922. }
  1923. declare module "babylonjs/Maths/math.vector" {
  1924. import { Viewport } from "babylonjs/Maths/math.viewport";
  1925. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1926. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1927. /**
  1928. * Class representing a vector containing 2 coordinates
  1929. */
  1930. export class Vector2 {
  1931. /** defines the first coordinate */
  1932. x: number;
  1933. /** defines the second coordinate */
  1934. y: number;
  1935. /**
  1936. * Creates a new Vector2 from the given x and y coordinates
  1937. * @param x defines the first coordinate
  1938. * @param y defines the second coordinate
  1939. */
  1940. constructor(
  1941. /** defines the first coordinate */
  1942. x?: number,
  1943. /** defines the second coordinate */
  1944. y?: number);
  1945. /**
  1946. * Gets a string with the Vector2 coordinates
  1947. * @returns a string with the Vector2 coordinates
  1948. */
  1949. toString(): string;
  1950. /**
  1951. * Gets class name
  1952. * @returns the string "Vector2"
  1953. */
  1954. getClassName(): string;
  1955. /**
  1956. * Gets current vector hash code
  1957. * @returns the Vector2 hash code as a number
  1958. */
  1959. getHashCode(): number;
  1960. /**
  1961. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1962. * @param array defines the source array
  1963. * @param index defines the offset in source array
  1964. * @returns the current Vector2
  1965. */
  1966. toArray(array: FloatArray, index?: number): Vector2;
  1967. /**
  1968. * Copy the current vector to an array
  1969. * @returns a new array with 2 elements: the Vector2 coordinates.
  1970. */
  1971. asArray(): number[];
  1972. /**
  1973. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1974. * @param source defines the source Vector2
  1975. * @returns the current updated Vector2
  1976. */
  1977. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1978. /**
  1979. * Sets the Vector2 coordinates with the given floats
  1980. * @param x defines the first coordinate
  1981. * @param y defines the second coordinate
  1982. * @returns the current updated Vector2
  1983. */
  1984. copyFromFloats(x: number, y: number): Vector2;
  1985. /**
  1986. * Sets the Vector2 coordinates with the given floats
  1987. * @param x defines the first coordinate
  1988. * @param y defines the second coordinate
  1989. * @returns the current updated Vector2
  1990. */
  1991. set(x: number, y: number): Vector2;
  1992. /**
  1993. * Add another vector with the current one
  1994. * @param otherVector defines the other vector
  1995. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1996. */
  1997. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1998. /**
  1999. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2000. * @param otherVector defines the other vector
  2001. * @param result defines the target vector
  2002. * @returns the unmodified current Vector2
  2003. */
  2004. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2005. /**
  2006. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2007. * @param otherVector defines the other vector
  2008. * @returns the current updated Vector2
  2009. */
  2010. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2011. /**
  2012. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2013. * @param otherVector defines the other vector
  2014. * @returns a new Vector2
  2015. */
  2016. addVector3(otherVector: Vector3): Vector2;
  2017. /**
  2018. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2019. * @param otherVector defines the other vector
  2020. * @returns a new Vector2
  2021. */
  2022. subtract(otherVector: Vector2): Vector2;
  2023. /**
  2024. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2025. * @param otherVector defines the other vector
  2026. * @param result defines the target vector
  2027. * @returns the unmodified current Vector2
  2028. */
  2029. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2030. /**
  2031. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2032. * @param otherVector defines the other vector
  2033. * @returns the current updated Vector2
  2034. */
  2035. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2036. /**
  2037. * Multiplies in place the current Vector2 coordinates by the given ones
  2038. * @param otherVector defines the other vector
  2039. * @returns the current updated Vector2
  2040. */
  2041. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2042. /**
  2043. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2044. * @param otherVector defines the other vector
  2045. * @returns a new Vector2
  2046. */
  2047. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2048. /**
  2049. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2050. * @param otherVector defines the other vector
  2051. * @param result defines the target vector
  2052. * @returns the unmodified current Vector2
  2053. */
  2054. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2055. /**
  2056. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2057. * @param x defines the first coordinate
  2058. * @param y defines the second coordinate
  2059. * @returns a new Vector2
  2060. */
  2061. multiplyByFloats(x: number, y: number): Vector2;
  2062. /**
  2063. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2064. * @param otherVector defines the other vector
  2065. * @returns a new Vector2
  2066. */
  2067. divide(otherVector: Vector2): Vector2;
  2068. /**
  2069. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2070. * @param otherVector defines the other vector
  2071. * @param result defines the target vector
  2072. * @returns the unmodified current Vector2
  2073. */
  2074. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2075. /**
  2076. * Divides the current Vector2 coordinates by the given ones
  2077. * @param otherVector defines the other vector
  2078. * @returns the current updated Vector2
  2079. */
  2080. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2081. /**
  2082. * Gets a new Vector2 with current Vector2 negated coordinates
  2083. * @returns a new Vector2
  2084. */
  2085. negate(): Vector2;
  2086. /**
  2087. * Multiply the Vector2 coordinates by scale
  2088. * @param scale defines the scaling factor
  2089. * @returns the current updated Vector2
  2090. */
  2091. scaleInPlace(scale: number): Vector2;
  2092. /**
  2093. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2094. * @param scale defines the scaling factor
  2095. * @returns a new Vector2
  2096. */
  2097. scale(scale: number): Vector2;
  2098. /**
  2099. * Scale the current Vector2 values by a factor to a given Vector2
  2100. * @param scale defines the scale factor
  2101. * @param result defines the Vector2 object where to store the result
  2102. * @returns the unmodified current Vector2
  2103. */
  2104. scaleToRef(scale: number, result: Vector2): Vector2;
  2105. /**
  2106. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2107. * @param scale defines the scale factor
  2108. * @param result defines the Vector2 object where to store the result
  2109. * @returns the unmodified current Vector2
  2110. */
  2111. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2112. /**
  2113. * Gets a boolean if two vectors are equals
  2114. * @param otherVector defines the other vector
  2115. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2116. */
  2117. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2118. /**
  2119. * Gets a boolean if two vectors are equals (using an epsilon value)
  2120. * @param otherVector defines the other vector
  2121. * @param epsilon defines the minimal distance to consider equality
  2122. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2123. */
  2124. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2125. /**
  2126. * Gets a new Vector2 from current Vector2 floored values
  2127. * @returns a new Vector2
  2128. */
  2129. floor(): Vector2;
  2130. /**
  2131. * Gets a new Vector2 from current Vector2 floored values
  2132. * @returns a new Vector2
  2133. */
  2134. fract(): Vector2;
  2135. /**
  2136. * Gets the length of the vector
  2137. * @returns the vector length (float)
  2138. */
  2139. length(): number;
  2140. /**
  2141. * Gets the vector squared length
  2142. * @returns the vector squared length (float)
  2143. */
  2144. lengthSquared(): number;
  2145. /**
  2146. * Normalize the vector
  2147. * @returns the current updated Vector2
  2148. */
  2149. normalize(): Vector2;
  2150. /**
  2151. * Gets a new Vector2 copied from the Vector2
  2152. * @returns a new Vector2
  2153. */
  2154. clone(): Vector2;
  2155. /**
  2156. * Gets a new Vector2(0, 0)
  2157. * @returns a new Vector2
  2158. */
  2159. static Zero(): Vector2;
  2160. /**
  2161. * Gets a new Vector2(1, 1)
  2162. * @returns a new Vector2
  2163. */
  2164. static One(): Vector2;
  2165. /**
  2166. * Gets a new Vector2 set from the given index element of the given array
  2167. * @param array defines the data source
  2168. * @param offset defines the offset in the data source
  2169. * @returns a new Vector2
  2170. */
  2171. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2172. /**
  2173. * Sets "result" from the given index element of the given array
  2174. * @param array defines the data source
  2175. * @param offset defines the offset in the data source
  2176. * @param result defines the target vector
  2177. */
  2178. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2179. /**
  2180. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2181. * @param value1 defines 1st point of control
  2182. * @param value2 defines 2nd point of control
  2183. * @param value3 defines 3rd point of control
  2184. * @param value4 defines 4th point of control
  2185. * @param amount defines the interpolation factor
  2186. * @returns a new Vector2
  2187. */
  2188. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2189. /**
  2190. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2191. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2192. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2193. * @param value defines the value to clamp
  2194. * @param min defines the lower limit
  2195. * @param max defines the upper limit
  2196. * @returns a new Vector2
  2197. */
  2198. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2199. /**
  2200. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2201. * @param value1 defines the 1st control point
  2202. * @param tangent1 defines the outgoing tangent
  2203. * @param value2 defines the 2nd control point
  2204. * @param tangent2 defines the incoming tangent
  2205. * @param amount defines the interpolation factor
  2206. * @returns a new Vector2
  2207. */
  2208. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2209. /**
  2210. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2211. * @param start defines the start vector
  2212. * @param end defines the end vector
  2213. * @param amount defines the interpolation factor
  2214. * @returns a new Vector2
  2215. */
  2216. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2217. /**
  2218. * Gets the dot product of the vector "left" and the vector "right"
  2219. * @param left defines first vector
  2220. * @param right defines second vector
  2221. * @returns the dot product (float)
  2222. */
  2223. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2224. /**
  2225. * Returns a new Vector2 equal to the normalized given vector
  2226. * @param vector defines the vector to normalize
  2227. * @returns a new Vector2
  2228. */
  2229. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2230. /**
  2231. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2232. * @param left defines 1st vector
  2233. * @param right defines 2nd vector
  2234. * @returns a new Vector2
  2235. */
  2236. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2237. /**
  2238. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2239. * @param left defines 1st vector
  2240. * @param right defines 2nd vector
  2241. * @returns a new Vector2
  2242. */
  2243. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2244. /**
  2245. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2246. * @param vector defines the vector to transform
  2247. * @param transformation defines the matrix to apply
  2248. * @returns a new Vector2
  2249. */
  2250. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2251. /**
  2252. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2253. * @param vector defines the vector to transform
  2254. * @param transformation defines the matrix to apply
  2255. * @param result defines the target vector
  2256. */
  2257. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2258. /**
  2259. * Determines if a given vector is included in a triangle
  2260. * @param p defines the vector to test
  2261. * @param p0 defines 1st triangle point
  2262. * @param p1 defines 2nd triangle point
  2263. * @param p2 defines 3rd triangle point
  2264. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2265. */
  2266. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2267. /**
  2268. * Gets the distance between the vectors "value1" and "value2"
  2269. * @param value1 defines first vector
  2270. * @param value2 defines second vector
  2271. * @returns the distance between vectors
  2272. */
  2273. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2274. /**
  2275. * Returns the squared distance between the vectors "value1" and "value2"
  2276. * @param value1 defines first vector
  2277. * @param value2 defines second vector
  2278. * @returns the squared distance between vectors
  2279. */
  2280. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2281. /**
  2282. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2283. * @param value1 defines first vector
  2284. * @param value2 defines second vector
  2285. * @returns a new Vector2
  2286. */
  2287. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2288. /**
  2289. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2290. * @param p defines the middle point
  2291. * @param segA defines one point of the segment
  2292. * @param segB defines the other point of the segment
  2293. * @returns the shortest distance
  2294. */
  2295. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2296. }
  2297. /**
  2298. * Classed used to store (x,y,z) vector representation
  2299. * A Vector3 is the main object used in 3D geometry
  2300. * It can represent etiher the coordinates of a point the space, either a direction
  2301. * Reminder: js uses a left handed forward facing system
  2302. */
  2303. export class Vector3 {
  2304. /**
  2305. * Defines the first coordinates (on X axis)
  2306. */
  2307. x: number;
  2308. /**
  2309. * Defines the second coordinates (on Y axis)
  2310. */
  2311. y: number;
  2312. /**
  2313. * Defines the third coordinates (on Z axis)
  2314. */
  2315. z: number;
  2316. private static _UpReadOnly;
  2317. private static _ZeroReadOnly;
  2318. /**
  2319. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2320. * @param x defines the first coordinates (on X axis)
  2321. * @param y defines the second coordinates (on Y axis)
  2322. * @param z defines the third coordinates (on Z axis)
  2323. */
  2324. constructor(
  2325. /**
  2326. * Defines the first coordinates (on X axis)
  2327. */
  2328. x?: number,
  2329. /**
  2330. * Defines the second coordinates (on Y axis)
  2331. */
  2332. y?: number,
  2333. /**
  2334. * Defines the third coordinates (on Z axis)
  2335. */
  2336. z?: number);
  2337. /**
  2338. * Creates a string representation of the Vector3
  2339. * @returns a string with the Vector3 coordinates.
  2340. */
  2341. toString(): string;
  2342. /**
  2343. * Gets the class name
  2344. * @returns the string "Vector3"
  2345. */
  2346. getClassName(): string;
  2347. /**
  2348. * Creates the Vector3 hash code
  2349. * @returns a number which tends to be unique between Vector3 instances
  2350. */
  2351. getHashCode(): number;
  2352. /**
  2353. * Creates an array containing three elements : the coordinates of the Vector3
  2354. * @returns a new array of numbers
  2355. */
  2356. asArray(): number[];
  2357. /**
  2358. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2359. * @param array defines the destination array
  2360. * @param index defines the offset in the destination array
  2361. * @returns the current Vector3
  2362. */
  2363. toArray(array: FloatArray, index?: number): Vector3;
  2364. /**
  2365. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2366. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2367. */
  2368. toQuaternion(): Quaternion;
  2369. /**
  2370. * Adds the given vector to the current Vector3
  2371. * @param otherVector defines the second operand
  2372. * @returns the current updated Vector3
  2373. */
  2374. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2375. /**
  2376. * Adds the given coordinates to the current Vector3
  2377. * @param x defines the x coordinate of the operand
  2378. * @param y defines the y coordinate of the operand
  2379. * @param z defines the z coordinate of the operand
  2380. * @returns the current updated Vector3
  2381. */
  2382. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2383. /**
  2384. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2385. * @param otherVector defines the second operand
  2386. * @returns the resulting Vector3
  2387. */
  2388. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2389. /**
  2390. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2391. * @param otherVector defines the second operand
  2392. * @param result defines the Vector3 object where to store the result
  2393. * @returns the current Vector3
  2394. */
  2395. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2396. /**
  2397. * Subtract the given vector from the current Vector3
  2398. * @param otherVector defines the second operand
  2399. * @returns the current updated Vector3
  2400. */
  2401. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2402. /**
  2403. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2404. * @param otherVector defines the second operand
  2405. * @returns the resulting Vector3
  2406. */
  2407. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2408. /**
  2409. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2410. * @param otherVector defines the second operand
  2411. * @param result defines the Vector3 object where to store the result
  2412. * @returns the current Vector3
  2413. */
  2414. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2415. /**
  2416. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2417. * @param x defines the x coordinate of the operand
  2418. * @param y defines the y coordinate of the operand
  2419. * @param z defines the z coordinate of the operand
  2420. * @returns the resulting Vector3
  2421. */
  2422. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2423. /**
  2424. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2425. * @param x defines the x coordinate of the operand
  2426. * @param y defines the y coordinate of the operand
  2427. * @param z defines the z coordinate of the operand
  2428. * @param result defines the Vector3 object where to store the result
  2429. * @returns the current Vector3
  2430. */
  2431. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2432. /**
  2433. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2434. * @returns a new Vector3
  2435. */
  2436. negate(): Vector3;
  2437. /**
  2438. * Multiplies the Vector3 coordinates by the float "scale"
  2439. * @param scale defines the multiplier factor
  2440. * @returns the current updated Vector3
  2441. */
  2442. scaleInPlace(scale: number): Vector3;
  2443. /**
  2444. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2445. * @param scale defines the multiplier factor
  2446. * @returns a new Vector3
  2447. */
  2448. scale(scale: number): Vector3;
  2449. /**
  2450. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2451. * @param scale defines the multiplier factor
  2452. * @param result defines the Vector3 object where to store the result
  2453. * @returns the current Vector3
  2454. */
  2455. scaleToRef(scale: number, result: Vector3): Vector3;
  2456. /**
  2457. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2458. * @param scale defines the scale factor
  2459. * @param result defines the Vector3 object where to store the result
  2460. * @returns the unmodified current Vector3
  2461. */
  2462. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2463. /**
  2464. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2465. * @param otherVector defines the second operand
  2466. * @returns true if both vectors are equals
  2467. */
  2468. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2469. /**
  2470. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2471. * @param otherVector defines the second operand
  2472. * @param epsilon defines the minimal distance to define values as equals
  2473. * @returns true if both vectors are distant less than epsilon
  2474. */
  2475. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2476. /**
  2477. * Returns true if the current Vector3 coordinates equals the given floats
  2478. * @param x defines the x coordinate of the operand
  2479. * @param y defines the y coordinate of the operand
  2480. * @param z defines the z coordinate of the operand
  2481. * @returns true if both vectors are equals
  2482. */
  2483. equalsToFloats(x: number, y: number, z: number): boolean;
  2484. /**
  2485. * Multiplies the current Vector3 coordinates by the given ones
  2486. * @param otherVector defines the second operand
  2487. * @returns the current updated Vector3
  2488. */
  2489. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2490. /**
  2491. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2492. * @param otherVector defines the second operand
  2493. * @returns the new Vector3
  2494. */
  2495. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2496. /**
  2497. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2498. * @param otherVector defines the second operand
  2499. * @param result defines the Vector3 object where to store the result
  2500. * @returns the current Vector3
  2501. */
  2502. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2503. /**
  2504. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2505. * @param x defines the x coordinate of the operand
  2506. * @param y defines the y coordinate of the operand
  2507. * @param z defines the z coordinate of the operand
  2508. * @returns the new Vector3
  2509. */
  2510. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2511. /**
  2512. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2513. * @param otherVector defines the second operand
  2514. * @returns the new Vector3
  2515. */
  2516. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2517. /**
  2518. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2519. * @param otherVector defines the second operand
  2520. * @param result defines the Vector3 object where to store the result
  2521. * @returns the current Vector3
  2522. */
  2523. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2524. /**
  2525. * Divides the current Vector3 coordinates by the given ones.
  2526. * @param otherVector defines the second operand
  2527. * @returns the current updated Vector3
  2528. */
  2529. divideInPlace(otherVector: Vector3): Vector3;
  2530. /**
  2531. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2532. * @param other defines the second operand
  2533. * @returns the current updated Vector3
  2534. */
  2535. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2536. /**
  2537. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2538. * @param other defines the second operand
  2539. * @returns the current updated Vector3
  2540. */
  2541. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2542. /**
  2543. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2544. * @param x defines the x coordinate of the operand
  2545. * @param y defines the y coordinate of the operand
  2546. * @param z defines the z coordinate of the operand
  2547. * @returns the current updated Vector3
  2548. */
  2549. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2550. /**
  2551. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2552. * @param x defines the x coordinate of the operand
  2553. * @param y defines the y coordinate of the operand
  2554. * @param z defines the z coordinate of the operand
  2555. * @returns the current updated Vector3
  2556. */
  2557. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2558. /**
  2559. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2560. * Check if is non uniform within a certain amount of decimal places to account for this
  2561. * @param epsilon the amount the values can differ
  2562. * @returns if the the vector is non uniform to a certain number of decimal places
  2563. */
  2564. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2565. /**
  2566. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2567. */
  2568. readonly isNonUniform: boolean;
  2569. /**
  2570. * Gets a new Vector3 from current Vector3 floored values
  2571. * @returns a new Vector3
  2572. */
  2573. floor(): Vector3;
  2574. /**
  2575. * Gets a new Vector3 from current Vector3 floored values
  2576. * @returns a new Vector3
  2577. */
  2578. fract(): Vector3;
  2579. /**
  2580. * Gets the length of the Vector3
  2581. * @returns the length of the Vector3
  2582. */
  2583. length(): number;
  2584. /**
  2585. * Gets the squared length of the Vector3
  2586. * @returns squared length of the Vector3
  2587. */
  2588. lengthSquared(): number;
  2589. /**
  2590. * Normalize the current Vector3.
  2591. * Please note that this is an in place operation.
  2592. * @returns the current updated Vector3
  2593. */
  2594. normalize(): Vector3;
  2595. /**
  2596. * Reorders the x y z properties of the vector in place
  2597. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2598. * @returns the current updated vector
  2599. */
  2600. reorderInPlace(order: string): this;
  2601. /**
  2602. * Rotates the vector around 0,0,0 by a quaternion
  2603. * @param quaternion the rotation quaternion
  2604. * @param result vector to store the result
  2605. * @returns the resulting vector
  2606. */
  2607. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2608. /**
  2609. * Rotates a vector around a given point
  2610. * @param quaternion the rotation quaternion
  2611. * @param point the point to rotate around
  2612. * @param result vector to store the result
  2613. * @returns the resulting vector
  2614. */
  2615. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2618. * The cross product is then orthogonal to both current and "other"
  2619. * @param other defines the right operand
  2620. * @returns the cross product
  2621. */
  2622. cross(other: Vector3): Vector3;
  2623. /**
  2624. * Normalize the current Vector3 with the given input length.
  2625. * Please note that this is an in place operation.
  2626. * @param len the length of the vector
  2627. * @returns the current updated Vector3
  2628. */
  2629. normalizeFromLength(len: number): Vector3;
  2630. /**
  2631. * Normalize the current Vector3 to a new vector
  2632. * @returns the new Vector3
  2633. */
  2634. normalizeToNew(): Vector3;
  2635. /**
  2636. * Normalize the current Vector3 to the reference
  2637. * @param reference define the Vector3 to update
  2638. * @returns the updated Vector3
  2639. */
  2640. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2641. /**
  2642. * Creates a new Vector3 copied from the current Vector3
  2643. * @returns the new Vector3
  2644. */
  2645. clone(): Vector3;
  2646. /**
  2647. * Copies the given vector coordinates to the current Vector3 ones
  2648. * @param source defines the source Vector3
  2649. * @returns the current updated Vector3
  2650. */
  2651. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2652. /**
  2653. * Copies the given floats to the current Vector3 coordinates
  2654. * @param x defines the x coordinate of the operand
  2655. * @param y defines the y coordinate of the operand
  2656. * @param z defines the z coordinate of the operand
  2657. * @returns the current updated Vector3
  2658. */
  2659. copyFromFloats(x: number, y: number, z: number): Vector3;
  2660. /**
  2661. * Copies the given floats to the current Vector3 coordinates
  2662. * @param x defines the x coordinate of the operand
  2663. * @param y defines the y coordinate of the operand
  2664. * @param z defines the z coordinate of the operand
  2665. * @returns the current updated Vector3
  2666. */
  2667. set(x: number, y: number, z: number): Vector3;
  2668. /**
  2669. * Copies the given float to the current Vector3 coordinates
  2670. * @param v defines the x, y and z coordinates of the operand
  2671. * @returns the current updated Vector3
  2672. */
  2673. setAll(v: number): Vector3;
  2674. /**
  2675. * Get the clip factor between two vectors
  2676. * @param vector0 defines the first operand
  2677. * @param vector1 defines the second operand
  2678. * @param axis defines the axis to use
  2679. * @param size defines the size along the axis
  2680. * @returns the clip factor
  2681. */
  2682. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2683. /**
  2684. * Get angle between two vectors
  2685. * @param vector0 angle between vector0 and vector1
  2686. * @param vector1 angle between vector0 and vector1
  2687. * @param normal direction of the normal
  2688. * @return the angle between vector0 and vector1
  2689. */
  2690. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2691. /**
  2692. * Returns a new Vector3 set from the index "offset" of the given array
  2693. * @param array defines the source array
  2694. * @param offset defines the offset in the source array
  2695. * @returns the new Vector3
  2696. */
  2697. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2698. /**
  2699. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2700. * This function is deprecated. Use FromArray instead
  2701. * @param array defines the source array
  2702. * @param offset defines the offset in the source array
  2703. * @returns the new Vector3
  2704. */
  2705. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2706. /**
  2707. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2708. * @param array defines the source array
  2709. * @param offset defines the offset in the source array
  2710. * @param result defines the Vector3 where to store the result
  2711. */
  2712. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2713. /**
  2714. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2715. * This function is deprecated. Use FromArrayToRef instead.
  2716. * @param array defines the source array
  2717. * @param offset defines the offset in the source array
  2718. * @param result defines the Vector3 where to store the result
  2719. */
  2720. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2721. /**
  2722. * Sets the given vector "result" with the given floats.
  2723. * @param x defines the x coordinate of the source
  2724. * @param y defines the y coordinate of the source
  2725. * @param z defines the z coordinate of the source
  2726. * @param result defines the Vector3 where to store the result
  2727. */
  2728. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2729. /**
  2730. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2731. * @returns a new empty Vector3
  2732. */
  2733. static Zero(): Vector3;
  2734. /**
  2735. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2736. * @returns a new unit Vector3
  2737. */
  2738. static One(): Vector3;
  2739. /**
  2740. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2741. * @returns a new up Vector3
  2742. */
  2743. static Up(): Vector3;
  2744. /**
  2745. * Gets a up Vector3 that must not be updated
  2746. */
  2747. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2748. /**
  2749. * Gets a zero Vector3 that must not be updated
  2750. */
  2751. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2752. /**
  2753. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2754. * @returns a new down Vector3
  2755. */
  2756. static Down(): Vector3;
  2757. /**
  2758. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2759. * @returns a new forward Vector3
  2760. */
  2761. static Forward(): Vector3;
  2762. /**
  2763. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2764. * @returns a new forward Vector3
  2765. */
  2766. static Backward(): Vector3;
  2767. /**
  2768. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2769. * @returns a new right Vector3
  2770. */
  2771. static Right(): Vector3;
  2772. /**
  2773. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2774. * @returns a new left Vector3
  2775. */
  2776. static Left(): Vector3;
  2777. /**
  2778. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2779. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2780. * @param vector defines the Vector3 to transform
  2781. * @param transformation defines the transformation matrix
  2782. * @returns the transformed Vector3
  2783. */
  2784. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2785. /**
  2786. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2787. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2788. * @param vector defines the Vector3 to transform
  2789. * @param transformation defines the transformation matrix
  2790. * @param result defines the Vector3 where to store the result
  2791. */
  2792. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2793. /**
  2794. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2795. * This method computes tranformed coordinates only, not transformed direction vectors
  2796. * @param x define the x coordinate of the source vector
  2797. * @param y define the y coordinate of the source vector
  2798. * @param z define the z coordinate of the source vector
  2799. * @param transformation defines the transformation matrix
  2800. * @param result defines the Vector3 where to store the result
  2801. */
  2802. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2803. /**
  2804. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2805. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2806. * @param vector defines the Vector3 to transform
  2807. * @param transformation defines the transformation matrix
  2808. * @returns the new Vector3
  2809. */
  2810. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2811. /**
  2812. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2813. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2814. * @param vector defines the Vector3 to transform
  2815. * @param transformation defines the transformation matrix
  2816. * @param result defines the Vector3 where to store the result
  2817. */
  2818. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2819. /**
  2820. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2821. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2822. * @param x define the x coordinate of the source vector
  2823. * @param y define the y coordinate of the source vector
  2824. * @param z define the z coordinate of the source vector
  2825. * @param transformation defines the transformation matrix
  2826. * @param result defines the Vector3 where to store the result
  2827. */
  2828. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2829. /**
  2830. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2831. * @param value1 defines the first control point
  2832. * @param value2 defines the second control point
  2833. * @param value3 defines the third control point
  2834. * @param value4 defines the fourth control point
  2835. * @param amount defines the amount on the spline to use
  2836. * @returns the new Vector3
  2837. */
  2838. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2839. /**
  2840. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2841. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2842. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2843. * @param value defines the current value
  2844. * @param min defines the lower range value
  2845. * @param max defines the upper range value
  2846. * @returns the new Vector3
  2847. */
  2848. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2849. /**
  2850. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2851. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2852. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2853. * @param value defines the current value
  2854. * @param min defines the lower range value
  2855. * @param max defines the upper range value
  2856. * @param result defines the Vector3 where to store the result
  2857. */
  2858. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2859. /**
  2860. * Checks if a given vector is inside a specific range
  2861. * @param v defines the vector to test
  2862. * @param min defines the minimum range
  2863. * @param max defines the maximum range
  2864. */
  2865. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2866. /**
  2867. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2868. * @param value1 defines the first control point
  2869. * @param tangent1 defines the first tangent vector
  2870. * @param value2 defines the second control point
  2871. * @param tangent2 defines the second tangent vector
  2872. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2873. * @returns the new Vector3
  2874. */
  2875. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2876. /**
  2877. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2878. * @param start defines the start value
  2879. * @param end defines the end value
  2880. * @param amount max defines amount between both (between 0 and 1)
  2881. * @returns the new Vector3
  2882. */
  2883. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2884. /**
  2885. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2886. * @param start defines the start value
  2887. * @param end defines the end value
  2888. * @param amount max defines amount between both (between 0 and 1)
  2889. * @param result defines the Vector3 where to store the result
  2890. */
  2891. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2892. /**
  2893. * Returns the dot product (float) between the vectors "left" and "right"
  2894. * @param left defines the left operand
  2895. * @param right defines the right operand
  2896. * @returns the dot product
  2897. */
  2898. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2899. /**
  2900. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2901. * The cross product is then orthogonal to both "left" and "right"
  2902. * @param left defines the left operand
  2903. * @param right defines the right operand
  2904. * @returns the cross product
  2905. */
  2906. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2907. /**
  2908. * Sets the given vector "result" with the cross product of "left" and "right"
  2909. * The cross product is then orthogonal to both "left" and "right"
  2910. * @param left defines the left operand
  2911. * @param right defines the right operand
  2912. * @param result defines the Vector3 where to store the result
  2913. */
  2914. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2915. /**
  2916. * Returns a new Vector3 as the normalization of the given vector
  2917. * @param vector defines the Vector3 to normalize
  2918. * @returns the new Vector3
  2919. */
  2920. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2921. /**
  2922. * Sets the given vector "result" with the normalization of the given first vector
  2923. * @param vector defines the Vector3 to normalize
  2924. * @param result defines the Vector3 where to store the result
  2925. */
  2926. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2927. /**
  2928. * Project a Vector3 onto screen space
  2929. * @param vector defines the Vector3 to project
  2930. * @param world defines the world matrix to use
  2931. * @param transform defines the transform (view x projection) matrix to use
  2932. * @param viewport defines the screen viewport to use
  2933. * @returns the new Vector3
  2934. */
  2935. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2936. /** @hidden */
  2937. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2938. /**
  2939. * Unproject from screen space to object space
  2940. * @param source defines the screen space Vector3 to use
  2941. * @param viewportWidth defines the current width of the viewport
  2942. * @param viewportHeight defines the current height of the viewport
  2943. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2944. * @param transform defines the transform (view x projection) matrix to use
  2945. * @returns the new Vector3
  2946. */
  2947. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2948. /**
  2949. * Unproject from screen space to object space
  2950. * @param source defines the screen space Vector3 to use
  2951. * @param viewportWidth defines the current width of the viewport
  2952. * @param viewportHeight defines the current height of the viewport
  2953. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2954. * @param view defines the view matrix to use
  2955. * @param projection defines the projection matrix to use
  2956. * @returns the new Vector3
  2957. */
  2958. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2959. /**
  2960. * Unproject from screen space to object space
  2961. * @param source defines the screen space Vector3 to use
  2962. * @param viewportWidth defines the current width of the viewport
  2963. * @param viewportHeight defines the current height of the viewport
  2964. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2965. * @param view defines the view matrix to use
  2966. * @param projection defines the projection matrix to use
  2967. * @param result defines the Vector3 where to store the result
  2968. */
  2969. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2970. /**
  2971. * Unproject from screen space to object space
  2972. * @param sourceX defines the screen space x coordinate to use
  2973. * @param sourceY defines the screen space y coordinate to use
  2974. * @param sourceZ defines the screen space z coordinate to use
  2975. * @param viewportWidth defines the current width of the viewport
  2976. * @param viewportHeight defines the current height of the viewport
  2977. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2978. * @param view defines the view matrix to use
  2979. * @param projection defines the projection matrix to use
  2980. * @param result defines the Vector3 where to store the result
  2981. */
  2982. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2983. /**
  2984. * Gets the minimal coordinate values between two Vector3
  2985. * @param left defines the first operand
  2986. * @param right defines the second operand
  2987. * @returns the new Vector3
  2988. */
  2989. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2990. /**
  2991. * Gets the maximal coordinate values between two Vector3
  2992. * @param left defines the first operand
  2993. * @param right defines the second operand
  2994. * @returns the new Vector3
  2995. */
  2996. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2997. /**
  2998. * Returns the distance between the vectors "value1" and "value2"
  2999. * @param value1 defines the first operand
  3000. * @param value2 defines the second operand
  3001. * @returns the distance
  3002. */
  3003. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3004. /**
  3005. * Returns the squared distance between the vectors "value1" and "value2"
  3006. * @param value1 defines the first operand
  3007. * @param value2 defines the second operand
  3008. * @returns the squared distance
  3009. */
  3010. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3011. /**
  3012. * Returns a new Vector3 located at the center between "value1" and "value2"
  3013. * @param value1 defines the first operand
  3014. * @param value2 defines the second operand
  3015. * @returns the new Vector3
  3016. */
  3017. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3018. /**
  3019. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3020. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3021. * to something in order to rotate it from its local system to the given target system
  3022. * Note: axis1, axis2 and axis3 are normalized during this operation
  3023. * @param axis1 defines the first axis
  3024. * @param axis2 defines the second axis
  3025. * @param axis3 defines the third axis
  3026. * @returns a new Vector3
  3027. */
  3028. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3029. /**
  3030. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3031. * @param axis1 defines the first axis
  3032. * @param axis2 defines the second axis
  3033. * @param axis3 defines the third axis
  3034. * @param ref defines the Vector3 where to store the result
  3035. */
  3036. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3037. }
  3038. /**
  3039. * Vector4 class created for EulerAngle class conversion to Quaternion
  3040. */
  3041. export class Vector4 {
  3042. /** x value of the vector */
  3043. x: number;
  3044. /** y value of the vector */
  3045. y: number;
  3046. /** z value of the vector */
  3047. z: number;
  3048. /** w value of the vector */
  3049. w: number;
  3050. /**
  3051. * Creates a Vector4 object from the given floats.
  3052. * @param x x value of the vector
  3053. * @param y y value of the vector
  3054. * @param z z value of the vector
  3055. * @param w w value of the vector
  3056. */
  3057. constructor(
  3058. /** x value of the vector */
  3059. x: number,
  3060. /** y value of the vector */
  3061. y: number,
  3062. /** z value of the vector */
  3063. z: number,
  3064. /** w value of the vector */
  3065. w: number);
  3066. /**
  3067. * Returns the string with the Vector4 coordinates.
  3068. * @returns a string containing all the vector values
  3069. */
  3070. toString(): string;
  3071. /**
  3072. * Returns the string "Vector4".
  3073. * @returns "Vector4"
  3074. */
  3075. getClassName(): string;
  3076. /**
  3077. * Returns the Vector4 hash code.
  3078. * @returns a unique hash code
  3079. */
  3080. getHashCode(): number;
  3081. /**
  3082. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3083. * @returns the resulting array
  3084. */
  3085. asArray(): number[];
  3086. /**
  3087. * Populates the given array from the given index with the Vector4 coordinates.
  3088. * @param array array to populate
  3089. * @param index index of the array to start at (default: 0)
  3090. * @returns the Vector4.
  3091. */
  3092. toArray(array: FloatArray, index?: number): Vector4;
  3093. /**
  3094. * Adds the given vector to the current Vector4.
  3095. * @param otherVector the vector to add
  3096. * @returns the updated Vector4.
  3097. */
  3098. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3099. /**
  3100. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3101. * @param otherVector the vector to add
  3102. * @returns the resulting vector
  3103. */
  3104. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3105. /**
  3106. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3107. * @param otherVector the vector to add
  3108. * @param result the vector to store the result
  3109. * @returns the current Vector4.
  3110. */
  3111. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3112. /**
  3113. * Subtract in place the given vector from the current Vector4.
  3114. * @param otherVector the vector to subtract
  3115. * @returns the updated Vector4.
  3116. */
  3117. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3118. /**
  3119. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3120. * @param otherVector the vector to add
  3121. * @returns the new vector with the result
  3122. */
  3123. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3124. /**
  3125. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3126. * @param otherVector the vector to subtract
  3127. * @param result the vector to store the result
  3128. * @returns the current Vector4.
  3129. */
  3130. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3131. /**
  3132. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3133. */
  3134. /**
  3135. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3136. * @param x value to subtract
  3137. * @param y value to subtract
  3138. * @param z value to subtract
  3139. * @param w value to subtract
  3140. * @returns new vector containing the result
  3141. */
  3142. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3143. /**
  3144. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3145. * @param x value to subtract
  3146. * @param y value to subtract
  3147. * @param z value to subtract
  3148. * @param w value to subtract
  3149. * @param result the vector to store the result in
  3150. * @returns the current Vector4.
  3151. */
  3152. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3153. /**
  3154. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3155. * @returns a new vector with the negated values
  3156. */
  3157. negate(): Vector4;
  3158. /**
  3159. * Multiplies the current Vector4 coordinates by scale (float).
  3160. * @param scale the number to scale with
  3161. * @returns the updated Vector4.
  3162. */
  3163. scaleInPlace(scale: number): Vector4;
  3164. /**
  3165. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3166. * @param scale the number to scale with
  3167. * @returns a new vector with the result
  3168. */
  3169. scale(scale: number): Vector4;
  3170. /**
  3171. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3172. * @param scale the number to scale with
  3173. * @param result a vector to store the result in
  3174. * @returns the current Vector4.
  3175. */
  3176. scaleToRef(scale: number, result: Vector4): Vector4;
  3177. /**
  3178. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3179. * @param scale defines the scale factor
  3180. * @param result defines the Vector4 object where to store the result
  3181. * @returns the unmodified current Vector4
  3182. */
  3183. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3184. /**
  3185. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3186. * @param otherVector the vector to compare against
  3187. * @returns true if they are equal
  3188. */
  3189. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3190. /**
  3191. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3192. * @param otherVector vector to compare against
  3193. * @param epsilon (Default: very small number)
  3194. * @returns true if they are equal
  3195. */
  3196. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3197. /**
  3198. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3199. * @param x x value to compare against
  3200. * @param y y value to compare against
  3201. * @param z z value to compare against
  3202. * @param w w value to compare against
  3203. * @returns true if equal
  3204. */
  3205. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3206. /**
  3207. * Multiplies in place the current Vector4 by the given one.
  3208. * @param otherVector vector to multiple with
  3209. * @returns the updated Vector4.
  3210. */
  3211. multiplyInPlace(otherVector: Vector4): Vector4;
  3212. /**
  3213. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3214. * @param otherVector vector to multiple with
  3215. * @returns resulting new vector
  3216. */
  3217. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3218. /**
  3219. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3220. * @param otherVector vector to multiple with
  3221. * @param result vector to store the result
  3222. * @returns the current Vector4.
  3223. */
  3224. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3225. /**
  3226. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3227. * @param x x value multiply with
  3228. * @param y y value multiply with
  3229. * @param z z value multiply with
  3230. * @param w w value multiply with
  3231. * @returns resulting new vector
  3232. */
  3233. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3234. /**
  3235. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3236. * @param otherVector vector to devide with
  3237. * @returns resulting new vector
  3238. */
  3239. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3240. /**
  3241. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3242. * @param otherVector vector to devide with
  3243. * @param result vector to store the result
  3244. * @returns the current Vector4.
  3245. */
  3246. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3247. /**
  3248. * Divides the current Vector3 coordinates by the given ones.
  3249. * @param otherVector vector to devide with
  3250. * @returns the updated Vector3.
  3251. */
  3252. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3253. /**
  3254. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3255. * @param other defines the second operand
  3256. * @returns the current updated Vector4
  3257. */
  3258. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3259. /**
  3260. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3261. * @param other defines the second operand
  3262. * @returns the current updated Vector4
  3263. */
  3264. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3265. /**
  3266. * Gets a new Vector4 from current Vector4 floored values
  3267. * @returns a new Vector4
  3268. */
  3269. floor(): Vector4;
  3270. /**
  3271. * Gets a new Vector4 from current Vector3 floored values
  3272. * @returns a new Vector4
  3273. */
  3274. fract(): Vector4;
  3275. /**
  3276. * Returns the Vector4 length (float).
  3277. * @returns the length
  3278. */
  3279. length(): number;
  3280. /**
  3281. * Returns the Vector4 squared length (float).
  3282. * @returns the length squared
  3283. */
  3284. lengthSquared(): number;
  3285. /**
  3286. * Normalizes in place the Vector4.
  3287. * @returns the updated Vector4.
  3288. */
  3289. normalize(): Vector4;
  3290. /**
  3291. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3292. * @returns this converted to a new vector3
  3293. */
  3294. toVector3(): Vector3;
  3295. /**
  3296. * Returns a new Vector4 copied from the current one.
  3297. * @returns the new cloned vector
  3298. */
  3299. clone(): Vector4;
  3300. /**
  3301. * Updates the current Vector4 with the given one coordinates.
  3302. * @param source the source vector to copy from
  3303. * @returns the updated Vector4.
  3304. */
  3305. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3306. /**
  3307. * Updates the current Vector4 coordinates with the given floats.
  3308. * @param x float to copy from
  3309. * @param y float to copy from
  3310. * @param z float to copy from
  3311. * @param w float to copy from
  3312. * @returns the updated Vector4.
  3313. */
  3314. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3315. /**
  3316. * Updates the current Vector4 coordinates with the given floats.
  3317. * @param x float to set from
  3318. * @param y float to set from
  3319. * @param z float to set from
  3320. * @param w float to set from
  3321. * @returns the updated Vector4.
  3322. */
  3323. set(x: number, y: number, z: number, w: number): Vector4;
  3324. /**
  3325. * Copies the given float to the current Vector3 coordinates
  3326. * @param v defines the x, y, z and w coordinates of the operand
  3327. * @returns the current updated Vector3
  3328. */
  3329. setAll(v: number): Vector4;
  3330. /**
  3331. * Returns a new Vector4 set from the starting index of the given array.
  3332. * @param array the array to pull values from
  3333. * @param offset the offset into the array to start at
  3334. * @returns the new vector
  3335. */
  3336. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3337. /**
  3338. * Updates the given vector "result" from the starting index of the given array.
  3339. * @param array the array to pull values from
  3340. * @param offset the offset into the array to start at
  3341. * @param result the vector to store the result in
  3342. */
  3343. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3344. /**
  3345. * Updates the given vector "result" from the starting index of the given Float32Array.
  3346. * @param array the array to pull values from
  3347. * @param offset the offset into the array to start at
  3348. * @param result the vector to store the result in
  3349. */
  3350. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3351. /**
  3352. * Updates the given vector "result" coordinates from the given floats.
  3353. * @param x float to set from
  3354. * @param y float to set from
  3355. * @param z float to set from
  3356. * @param w float to set from
  3357. * @param result the vector to the floats in
  3358. */
  3359. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3360. /**
  3361. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3362. * @returns the new vector
  3363. */
  3364. static Zero(): Vector4;
  3365. /**
  3366. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3367. * @returns the new vector
  3368. */
  3369. static One(): Vector4;
  3370. /**
  3371. * Returns a new normalized Vector4 from the given one.
  3372. * @param vector the vector to normalize
  3373. * @returns the vector
  3374. */
  3375. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3376. /**
  3377. * Updates the given vector "result" from the normalization of the given one.
  3378. * @param vector the vector to normalize
  3379. * @param result the vector to store the result in
  3380. */
  3381. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3382. /**
  3383. * Returns a vector with the minimum values from the left and right vectors
  3384. * @param left left vector to minimize
  3385. * @param right right vector to minimize
  3386. * @returns a new vector with the minimum of the left and right vector values
  3387. */
  3388. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3389. /**
  3390. * Returns a vector with the maximum values from the left and right vectors
  3391. * @param left left vector to maximize
  3392. * @param right right vector to maximize
  3393. * @returns a new vector with the maximum of the left and right vector values
  3394. */
  3395. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3396. /**
  3397. * Returns the distance (float) between the vectors "value1" and "value2".
  3398. * @param value1 value to calulate the distance between
  3399. * @param value2 value to calulate the distance between
  3400. * @return the distance between the two vectors
  3401. */
  3402. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3403. /**
  3404. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3405. * @param value1 value to calulate the distance between
  3406. * @param value2 value to calulate the distance between
  3407. * @return the distance between the two vectors squared
  3408. */
  3409. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3410. /**
  3411. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3412. * @param value1 value to calulate the center between
  3413. * @param value2 value to calulate the center between
  3414. * @return the center between the two vectors
  3415. */
  3416. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3417. /**
  3418. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3419. * This methods computes transformed normalized direction vectors only.
  3420. * @param vector the vector to transform
  3421. * @param transformation the transformation matrix to apply
  3422. * @returns the new vector
  3423. */
  3424. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3425. /**
  3426. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3427. * This methods computes transformed normalized direction vectors only.
  3428. * @param vector the vector to transform
  3429. * @param transformation the transformation matrix to apply
  3430. * @param result the vector to store the result in
  3431. */
  3432. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3433. /**
  3434. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3435. * This methods computes transformed normalized direction vectors only.
  3436. * @param x value to transform
  3437. * @param y value to transform
  3438. * @param z value to transform
  3439. * @param w value to transform
  3440. * @param transformation the transformation matrix to apply
  3441. * @param result the vector to store the results in
  3442. */
  3443. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3444. /**
  3445. * Creates a new Vector4 from a Vector3
  3446. * @param source defines the source data
  3447. * @param w defines the 4th component (default is 0)
  3448. * @returns a new Vector4
  3449. */
  3450. static FromVector3(source: Vector3, w?: number): Vector4;
  3451. }
  3452. /**
  3453. * Class used to store quaternion data
  3454. * @see https://en.wikipedia.org/wiki/Quaternion
  3455. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  3456. */
  3457. export class Quaternion {
  3458. /** defines the first component (0 by default) */
  3459. x: number;
  3460. /** defines the second component (0 by default) */
  3461. y: number;
  3462. /** defines the third component (0 by default) */
  3463. z: number;
  3464. /** defines the fourth component (1.0 by default) */
  3465. w: number;
  3466. /**
  3467. * Creates a new Quaternion from the given floats
  3468. * @param x defines the first component (0 by default)
  3469. * @param y defines the second component (0 by default)
  3470. * @param z defines the third component (0 by default)
  3471. * @param w defines the fourth component (1.0 by default)
  3472. */
  3473. constructor(
  3474. /** defines the first component (0 by default) */
  3475. x?: number,
  3476. /** defines the second component (0 by default) */
  3477. y?: number,
  3478. /** defines the third component (0 by default) */
  3479. z?: number,
  3480. /** defines the fourth component (1.0 by default) */
  3481. w?: number);
  3482. /**
  3483. * Gets a string representation for the current quaternion
  3484. * @returns a string with the Quaternion coordinates
  3485. */
  3486. toString(): string;
  3487. /**
  3488. * Gets the class name of the quaternion
  3489. * @returns the string "Quaternion"
  3490. */
  3491. getClassName(): string;
  3492. /**
  3493. * Gets a hash code for this quaternion
  3494. * @returns the quaternion hash code
  3495. */
  3496. getHashCode(): number;
  3497. /**
  3498. * Copy the quaternion to an array
  3499. * @returns a new array populated with 4 elements from the quaternion coordinates
  3500. */
  3501. asArray(): number[];
  3502. /**
  3503. * Check if two quaternions are equals
  3504. * @param otherQuaternion defines the second operand
  3505. * @return true if the current quaternion and the given one coordinates are strictly equals
  3506. */
  3507. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3508. /**
  3509. * Clone the current quaternion
  3510. * @returns a new quaternion copied from the current one
  3511. */
  3512. clone(): Quaternion;
  3513. /**
  3514. * Copy a quaternion to the current one
  3515. * @param other defines the other quaternion
  3516. * @returns the updated current quaternion
  3517. */
  3518. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3519. /**
  3520. * Updates the current quaternion with the given float coordinates
  3521. * @param x defines the x coordinate
  3522. * @param y defines the y coordinate
  3523. * @param z defines the z coordinate
  3524. * @param w defines the w coordinate
  3525. * @returns the updated current quaternion
  3526. */
  3527. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3528. /**
  3529. * Updates the current quaternion from the given float coordinates
  3530. * @param x defines the x coordinate
  3531. * @param y defines the y coordinate
  3532. * @param z defines the z coordinate
  3533. * @param w defines the w coordinate
  3534. * @returns the updated current quaternion
  3535. */
  3536. set(x: number, y: number, z: number, w: number): Quaternion;
  3537. /**
  3538. * Adds two quaternions
  3539. * @param other defines the second operand
  3540. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3541. */
  3542. add(other: DeepImmutable<Quaternion>): Quaternion;
  3543. /**
  3544. * Add a quaternion to the current one
  3545. * @param other defines the quaternion to add
  3546. * @returns the current quaternion
  3547. */
  3548. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3549. /**
  3550. * Subtract two quaternions
  3551. * @param other defines the second operand
  3552. * @returns a new quaternion as the subtraction result of the given one from the current one
  3553. */
  3554. subtract(other: Quaternion): Quaternion;
  3555. /**
  3556. * Multiplies the current quaternion by a scale factor
  3557. * @param value defines the scale factor
  3558. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3559. */
  3560. scale(value: number): Quaternion;
  3561. /**
  3562. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3563. * @param scale defines the scale factor
  3564. * @param result defines the Quaternion object where to store the result
  3565. * @returns the unmodified current quaternion
  3566. */
  3567. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3568. /**
  3569. * Multiplies in place the current quaternion by a scale factor
  3570. * @param value defines the scale factor
  3571. * @returns the current modified quaternion
  3572. */
  3573. scaleInPlace(value: number): Quaternion;
  3574. /**
  3575. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3576. * @param scale defines the scale factor
  3577. * @param result defines the Quaternion object where to store the result
  3578. * @returns the unmodified current quaternion
  3579. */
  3580. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3581. /**
  3582. * Multiplies two quaternions
  3583. * @param q1 defines the second operand
  3584. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3585. */
  3586. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3587. /**
  3588. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3589. * @param q1 defines the second operand
  3590. * @param result defines the target quaternion
  3591. * @returns the current quaternion
  3592. */
  3593. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3594. /**
  3595. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3596. * @param q1 defines the second operand
  3597. * @returns the currentupdated quaternion
  3598. */
  3599. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3600. /**
  3601. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3602. * @param ref defines the target quaternion
  3603. * @returns the current quaternion
  3604. */
  3605. conjugateToRef(ref: Quaternion): Quaternion;
  3606. /**
  3607. * Conjugates in place (1-q) the current quaternion
  3608. * @returns the current updated quaternion
  3609. */
  3610. conjugateInPlace(): Quaternion;
  3611. /**
  3612. * Conjugates in place (1-q) the current quaternion
  3613. * @returns a new quaternion
  3614. */
  3615. conjugate(): Quaternion;
  3616. /**
  3617. * Gets length of current quaternion
  3618. * @returns the quaternion length (float)
  3619. */
  3620. length(): number;
  3621. /**
  3622. * Normalize in place the current quaternion
  3623. * @returns the current updated quaternion
  3624. */
  3625. normalize(): Quaternion;
  3626. /**
  3627. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3628. * @param order is a reserved parameter and is ignore for now
  3629. * @returns a new Vector3 containing the Euler angles
  3630. */
  3631. toEulerAngles(order?: string): Vector3;
  3632. /**
  3633. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3634. * @param result defines the vector which will be filled with the Euler angles
  3635. * @param order is a reserved parameter and is ignore for now
  3636. * @returns the current unchanged quaternion
  3637. */
  3638. toEulerAnglesToRef(result: Vector3): Quaternion;
  3639. /**
  3640. * Updates the given rotation matrix with the current quaternion values
  3641. * @param result defines the target matrix
  3642. * @returns the current unchanged quaternion
  3643. */
  3644. toRotationMatrix(result: Matrix): Quaternion;
  3645. /**
  3646. * Updates the current quaternion from the given rotation matrix values
  3647. * @param matrix defines the source matrix
  3648. * @returns the current updated quaternion
  3649. */
  3650. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3651. /**
  3652. * Creates a new quaternion from a rotation matrix
  3653. * @param matrix defines the source matrix
  3654. * @returns a new quaternion created from the given rotation matrix values
  3655. */
  3656. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3657. /**
  3658. * Updates the given quaternion with the given rotation matrix values
  3659. * @param matrix defines the source matrix
  3660. * @param result defines the target quaternion
  3661. */
  3662. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3663. /**
  3664. * Returns the dot product (float) between the quaternions "left" and "right"
  3665. * @param left defines the left operand
  3666. * @param right defines the right operand
  3667. * @returns the dot product
  3668. */
  3669. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3670. /**
  3671. * Checks if the two quaternions are close to each other
  3672. * @param quat0 defines the first quaternion to check
  3673. * @param quat1 defines the second quaternion to check
  3674. * @returns true if the two quaternions are close to each other
  3675. */
  3676. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3677. /**
  3678. * Creates an empty quaternion
  3679. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3680. */
  3681. static Zero(): Quaternion;
  3682. /**
  3683. * Inverse a given quaternion
  3684. * @param q defines the source quaternion
  3685. * @returns a new quaternion as the inverted current quaternion
  3686. */
  3687. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3688. /**
  3689. * Inverse a given quaternion
  3690. * @param q defines the source quaternion
  3691. * @param result the quaternion the result will be stored in
  3692. * @returns the result quaternion
  3693. */
  3694. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3695. /**
  3696. * Creates an identity quaternion
  3697. * @returns the identity quaternion
  3698. */
  3699. static Identity(): Quaternion;
  3700. /**
  3701. * Gets a boolean indicating if the given quaternion is identity
  3702. * @param quaternion defines the quaternion to check
  3703. * @returns true if the quaternion is identity
  3704. */
  3705. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3706. /**
  3707. * Creates a quaternion from a rotation around an axis
  3708. * @param axis defines the axis to use
  3709. * @param angle defines the angle to use
  3710. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3711. */
  3712. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3713. /**
  3714. * Creates a rotation around an axis and stores it into the given quaternion
  3715. * @param axis defines the axis to use
  3716. * @param angle defines the angle to use
  3717. * @param result defines the target quaternion
  3718. * @returns the target quaternion
  3719. */
  3720. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3721. /**
  3722. * Creates a new quaternion from data stored into an array
  3723. * @param array defines the data source
  3724. * @param offset defines the offset in the source array where the data starts
  3725. * @returns a new quaternion
  3726. */
  3727. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3728. /**
  3729. * Create a quaternion from Euler rotation angles
  3730. * @param x Pitch
  3731. * @param y Yaw
  3732. * @param z Roll
  3733. * @returns the new Quaternion
  3734. */
  3735. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3736. /**
  3737. * Updates a quaternion from Euler rotation angles
  3738. * @param x Pitch
  3739. * @param y Yaw
  3740. * @param z Roll
  3741. * @param result the quaternion to store the result
  3742. * @returns the updated quaternion
  3743. */
  3744. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3745. /**
  3746. * Create a quaternion from Euler rotation vector
  3747. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3748. * @returns the new Quaternion
  3749. */
  3750. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3751. /**
  3752. * Updates a quaternion from Euler rotation vector
  3753. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3754. * @param result the quaternion to store the result
  3755. * @returns the updated quaternion
  3756. */
  3757. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3758. /**
  3759. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3760. * @param yaw defines the rotation around Y axis
  3761. * @param pitch defines the rotation around X axis
  3762. * @param roll defines the rotation around Z axis
  3763. * @returns the new quaternion
  3764. */
  3765. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3766. /**
  3767. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3768. * @param yaw defines the rotation around Y axis
  3769. * @param pitch defines the rotation around X axis
  3770. * @param roll defines the rotation around Z axis
  3771. * @param result defines the target quaternion
  3772. */
  3773. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3774. /**
  3775. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3776. * @param alpha defines the rotation around first axis
  3777. * @param beta defines the rotation around second axis
  3778. * @param gamma defines the rotation around third axis
  3779. * @returns the new quaternion
  3780. */
  3781. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3782. /**
  3783. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3784. * @param alpha defines the rotation around first axis
  3785. * @param beta defines the rotation around second axis
  3786. * @param gamma defines the rotation around third axis
  3787. * @param result defines the target quaternion
  3788. */
  3789. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3790. /**
  3791. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  3792. * @param axis1 defines the first axis
  3793. * @param axis2 defines the second axis
  3794. * @param axis3 defines the third axis
  3795. * @returns the new quaternion
  3796. */
  3797. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3798. /**
  3799. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  3800. * @param axis1 defines the first axis
  3801. * @param axis2 defines the second axis
  3802. * @param axis3 defines the third axis
  3803. * @param ref defines the target quaternion
  3804. */
  3805. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3806. /**
  3807. * Interpolates between two quaternions
  3808. * @param left defines first quaternion
  3809. * @param right defines second quaternion
  3810. * @param amount defines the gradient to use
  3811. * @returns the new interpolated quaternion
  3812. */
  3813. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3814. /**
  3815. * Interpolates between two quaternions and stores it into a target quaternion
  3816. * @param left defines first quaternion
  3817. * @param right defines second quaternion
  3818. * @param amount defines the gradient to use
  3819. * @param result defines the target quaternion
  3820. */
  3821. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3822. /**
  3823. * Interpolate between two quaternions using Hermite interpolation
  3824. * @param value1 defines first quaternion
  3825. * @param tangent1 defines the incoming tangent
  3826. * @param value2 defines second quaternion
  3827. * @param tangent2 defines the outgoing tangent
  3828. * @param amount defines the target quaternion
  3829. * @returns the new interpolated quaternion
  3830. */
  3831. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3832. }
  3833. /**
  3834. * Class used to store matrix data (4x4)
  3835. */
  3836. export class Matrix {
  3837. private static _updateFlagSeed;
  3838. private static _identityReadOnly;
  3839. private _isIdentity;
  3840. private _isIdentityDirty;
  3841. private _isIdentity3x2;
  3842. private _isIdentity3x2Dirty;
  3843. /**
  3844. * Gets the update flag of the matrix which is an unique number for the matrix.
  3845. * It will be incremented every time the matrix data change.
  3846. * You can use it to speed the comparison between two versions of the same matrix.
  3847. */
  3848. updateFlag: number;
  3849. private readonly _m;
  3850. /**
  3851. * Gets the internal data of the matrix
  3852. */
  3853. readonly m: DeepImmutable<Float32Array>;
  3854. /** @hidden */
  3855. _markAsUpdated(): void;
  3856. /** @hidden */
  3857. private _updateIdentityStatus;
  3858. /**
  3859. * Creates an empty matrix (filled with zeros)
  3860. */
  3861. constructor();
  3862. /**
  3863. * Check if the current matrix is identity
  3864. * @returns true is the matrix is the identity matrix
  3865. */
  3866. isIdentity(): boolean;
  3867. /**
  3868. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3869. * @returns true is the matrix is the identity matrix
  3870. */
  3871. isIdentityAs3x2(): boolean;
  3872. /**
  3873. * Gets the determinant of the matrix
  3874. * @returns the matrix determinant
  3875. */
  3876. determinant(): number;
  3877. /**
  3878. * Returns the matrix as a Float32Array
  3879. * @returns the matrix underlying array
  3880. */
  3881. toArray(): DeepImmutable<Float32Array>;
  3882. /**
  3883. * Returns the matrix as a Float32Array
  3884. * @returns the matrix underlying array.
  3885. */
  3886. asArray(): DeepImmutable<Float32Array>;
  3887. /**
  3888. * Inverts the current matrix in place
  3889. * @returns the current inverted matrix
  3890. */
  3891. invert(): Matrix;
  3892. /**
  3893. * Sets all the matrix elements to zero
  3894. * @returns the current matrix
  3895. */
  3896. reset(): Matrix;
  3897. /**
  3898. * Adds the current matrix with a second one
  3899. * @param other defines the matrix to add
  3900. * @returns a new matrix as the addition of the current matrix and the given one
  3901. */
  3902. add(other: DeepImmutable<Matrix>): Matrix;
  3903. /**
  3904. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3905. * @param other defines the matrix to add
  3906. * @param result defines the target matrix
  3907. * @returns the current matrix
  3908. */
  3909. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3910. /**
  3911. * Adds in place the given matrix to the current matrix
  3912. * @param other defines the second operand
  3913. * @returns the current updated matrix
  3914. */
  3915. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3916. /**
  3917. * Sets the given matrix to the current inverted Matrix
  3918. * @param other defines the target matrix
  3919. * @returns the unmodified current matrix
  3920. */
  3921. invertToRef(other: Matrix): Matrix;
  3922. /**
  3923. * add a value at the specified position in the current Matrix
  3924. * @param index the index of the value within the matrix. between 0 and 15.
  3925. * @param value the value to be added
  3926. * @returns the current updated matrix
  3927. */
  3928. addAtIndex(index: number, value: number): Matrix;
  3929. /**
  3930. * mutiply the specified position in the current Matrix by a value
  3931. * @param index the index of the value within the matrix. between 0 and 15.
  3932. * @param value the value to be added
  3933. * @returns the current updated matrix
  3934. */
  3935. multiplyAtIndex(index: number, value: number): Matrix;
  3936. /**
  3937. * Inserts the translation vector (using 3 floats) in the current matrix
  3938. * @param x defines the 1st component of the translation
  3939. * @param y defines the 2nd component of the translation
  3940. * @param z defines the 3rd component of the translation
  3941. * @returns the current updated matrix
  3942. */
  3943. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3944. /**
  3945. * Adds the translation vector (using 3 floats) in the current matrix
  3946. * @param x defines the 1st component of the translation
  3947. * @param y defines the 2nd component of the translation
  3948. * @param z defines the 3rd component of the translation
  3949. * @returns the current updated matrix
  3950. */
  3951. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3952. /**
  3953. * Inserts the translation vector in the current matrix
  3954. * @param vector3 defines the translation to insert
  3955. * @returns the current updated matrix
  3956. */
  3957. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3958. /**
  3959. * Gets the translation value of the current matrix
  3960. * @returns a new Vector3 as the extracted translation from the matrix
  3961. */
  3962. getTranslation(): Vector3;
  3963. /**
  3964. * Fill a Vector3 with the extracted translation from the matrix
  3965. * @param result defines the Vector3 where to store the translation
  3966. * @returns the current matrix
  3967. */
  3968. getTranslationToRef(result: Vector3): Matrix;
  3969. /**
  3970. * Remove rotation and scaling part from the matrix
  3971. * @returns the updated matrix
  3972. */
  3973. removeRotationAndScaling(): Matrix;
  3974. /**
  3975. * Multiply two matrices
  3976. * @param other defines the second operand
  3977. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3978. */
  3979. multiply(other: DeepImmutable<Matrix>): Matrix;
  3980. /**
  3981. * Copy the current matrix from the given one
  3982. * @param other defines the source matrix
  3983. * @returns the current updated matrix
  3984. */
  3985. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3986. /**
  3987. * Populates the given array from the starting index with the current matrix values
  3988. * @param array defines the target array
  3989. * @param offset defines the offset in the target array where to start storing values
  3990. * @returns the current matrix
  3991. */
  3992. copyToArray(array: Float32Array, offset?: number): Matrix;
  3993. /**
  3994. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3995. * @param other defines the second operand
  3996. * @param result defines the matrix where to store the multiplication
  3997. * @returns the current matrix
  3998. */
  3999. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4000. /**
  4001. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4002. * @param other defines the second operand
  4003. * @param result defines the array where to store the multiplication
  4004. * @param offset defines the offset in the target array where to start storing values
  4005. * @returns the current matrix
  4006. */
  4007. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  4008. /**
  4009. * Check equality between this matrix and a second one
  4010. * @param value defines the second matrix to compare
  4011. * @returns true is the current matrix and the given one values are strictly equal
  4012. */
  4013. equals(value: DeepImmutable<Matrix>): boolean;
  4014. /**
  4015. * Clone the current matrix
  4016. * @returns a new matrix from the current matrix
  4017. */
  4018. clone(): Matrix;
  4019. /**
  4020. * Returns the name of the current matrix class
  4021. * @returns the string "Matrix"
  4022. */
  4023. getClassName(): string;
  4024. /**
  4025. * Gets the hash code of the current matrix
  4026. * @returns the hash code
  4027. */
  4028. getHashCode(): number;
  4029. /**
  4030. * Decomposes the current Matrix into a translation, rotation and scaling components
  4031. * @param scale defines the scale vector3 given as a reference to update
  4032. * @param rotation defines the rotation quaternion given as a reference to update
  4033. * @param translation defines the translation vector3 given as a reference to update
  4034. * @returns true if operation was successful
  4035. */
  4036. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4037. /**
  4038. * Gets specific row of the matrix
  4039. * @param index defines the number of the row to get
  4040. * @returns the index-th row of the current matrix as a new Vector4
  4041. */
  4042. getRow(index: number): Nullable<Vector4>;
  4043. /**
  4044. * Sets the index-th row of the current matrix to the vector4 values
  4045. * @param index defines the number of the row to set
  4046. * @param row defines the target vector4
  4047. * @returns the updated current matrix
  4048. */
  4049. setRow(index: number, row: Vector4): Matrix;
  4050. /**
  4051. * Compute the transpose of the matrix
  4052. * @returns the new transposed matrix
  4053. */
  4054. transpose(): Matrix;
  4055. /**
  4056. * Compute the transpose of the matrix and store it in a given matrix
  4057. * @param result defines the target matrix
  4058. * @returns the current matrix
  4059. */
  4060. transposeToRef(result: Matrix): Matrix;
  4061. /**
  4062. * Sets the index-th row of the current matrix with the given 4 x float values
  4063. * @param index defines the row index
  4064. * @param x defines the x component to set
  4065. * @param y defines the y component to set
  4066. * @param z defines the z component to set
  4067. * @param w defines the w component to set
  4068. * @returns the updated current matrix
  4069. */
  4070. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4071. /**
  4072. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4073. * @param scale defines the scale factor
  4074. * @returns a new matrix
  4075. */
  4076. scale(scale: number): Matrix;
  4077. /**
  4078. * Scale the current matrix values by a factor to a given result matrix
  4079. * @param scale defines the scale factor
  4080. * @param result defines the matrix to store the result
  4081. * @returns the current matrix
  4082. */
  4083. scaleToRef(scale: number, result: Matrix): Matrix;
  4084. /**
  4085. * Scale the current matrix values by a factor and add the result to a given matrix
  4086. * @param scale defines the scale factor
  4087. * @param result defines the Matrix to store the result
  4088. * @returns the current matrix
  4089. */
  4090. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4091. /**
  4092. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4093. * @param ref matrix to store the result
  4094. */
  4095. toNormalMatrix(ref: Matrix): void;
  4096. /**
  4097. * Gets only rotation part of the current matrix
  4098. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4099. */
  4100. getRotationMatrix(): Matrix;
  4101. /**
  4102. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4103. * @param result defines the target matrix to store data to
  4104. * @returns the current matrix
  4105. */
  4106. getRotationMatrixToRef(result: Matrix): Matrix;
  4107. /**
  4108. * Toggles model matrix from being right handed to left handed in place and vice versa
  4109. */
  4110. toggleModelMatrixHandInPlace(): void;
  4111. /**
  4112. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4113. */
  4114. toggleProjectionMatrixHandInPlace(): void;
  4115. /**
  4116. * Creates a matrix from an array
  4117. * @param array defines the source array
  4118. * @param offset defines an offset in the source array
  4119. * @returns a new Matrix set from the starting index of the given array
  4120. */
  4121. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4122. /**
  4123. * Copy the content of an array into a given matrix
  4124. * @param array defines the source array
  4125. * @param offset defines an offset in the source array
  4126. * @param result defines the target matrix
  4127. */
  4128. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4129. /**
  4130. * Stores an array into a matrix after having multiplied each component by a given factor
  4131. * @param array defines the source array
  4132. * @param offset defines the offset in the source array
  4133. * @param scale defines the scaling factor
  4134. * @param result defines the target matrix
  4135. */
  4136. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  4137. /**
  4138. * Gets an identity matrix that must not be updated
  4139. */
  4140. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  4141. /**
  4142. * Stores a list of values (16) inside a given matrix
  4143. * @param initialM11 defines 1st value of 1st row
  4144. * @param initialM12 defines 2nd value of 1st row
  4145. * @param initialM13 defines 3rd value of 1st row
  4146. * @param initialM14 defines 4th value of 1st row
  4147. * @param initialM21 defines 1st value of 2nd row
  4148. * @param initialM22 defines 2nd value of 2nd row
  4149. * @param initialM23 defines 3rd value of 2nd row
  4150. * @param initialM24 defines 4th value of 2nd row
  4151. * @param initialM31 defines 1st value of 3rd row
  4152. * @param initialM32 defines 2nd value of 3rd row
  4153. * @param initialM33 defines 3rd value of 3rd row
  4154. * @param initialM34 defines 4th value of 3rd row
  4155. * @param initialM41 defines 1st value of 4th row
  4156. * @param initialM42 defines 2nd value of 4th row
  4157. * @param initialM43 defines 3rd value of 4th row
  4158. * @param initialM44 defines 4th value of 4th row
  4159. * @param result defines the target matrix
  4160. */
  4161. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4162. /**
  4163. * Creates new matrix from a list of values (16)
  4164. * @param initialM11 defines 1st value of 1st row
  4165. * @param initialM12 defines 2nd value of 1st row
  4166. * @param initialM13 defines 3rd value of 1st row
  4167. * @param initialM14 defines 4th value of 1st row
  4168. * @param initialM21 defines 1st value of 2nd row
  4169. * @param initialM22 defines 2nd value of 2nd row
  4170. * @param initialM23 defines 3rd value of 2nd row
  4171. * @param initialM24 defines 4th value of 2nd row
  4172. * @param initialM31 defines 1st value of 3rd row
  4173. * @param initialM32 defines 2nd value of 3rd row
  4174. * @param initialM33 defines 3rd value of 3rd row
  4175. * @param initialM34 defines 4th value of 3rd row
  4176. * @param initialM41 defines 1st value of 4th row
  4177. * @param initialM42 defines 2nd value of 4th row
  4178. * @param initialM43 defines 3rd value of 4th row
  4179. * @param initialM44 defines 4th value of 4th row
  4180. * @returns the new matrix
  4181. */
  4182. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4183. /**
  4184. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4185. * @param scale defines the scale vector3
  4186. * @param rotation defines the rotation quaternion
  4187. * @param translation defines the translation vector3
  4188. * @returns a new matrix
  4189. */
  4190. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4191. /**
  4192. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4193. * @param scale defines the scale vector3
  4194. * @param rotation defines the rotation quaternion
  4195. * @param translation defines the translation vector3
  4196. * @param result defines the target matrix
  4197. */
  4198. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4199. /**
  4200. * Creates a new identity matrix
  4201. * @returns a new identity matrix
  4202. */
  4203. static Identity(): Matrix;
  4204. /**
  4205. * Creates a new identity matrix and stores the result in a given matrix
  4206. * @param result defines the target matrix
  4207. */
  4208. static IdentityToRef(result: Matrix): void;
  4209. /**
  4210. * Creates a new zero matrix
  4211. * @returns a new zero matrix
  4212. */
  4213. static Zero(): Matrix;
  4214. /**
  4215. * Creates a new rotation matrix for "angle" radians around the X axis
  4216. * @param angle defines the angle (in radians) to use
  4217. * @return the new matrix
  4218. */
  4219. static RotationX(angle: number): Matrix;
  4220. /**
  4221. * Creates a new matrix as the invert of a given matrix
  4222. * @param source defines the source matrix
  4223. * @returns the new matrix
  4224. */
  4225. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4226. /**
  4227. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4228. * @param angle defines the angle (in radians) to use
  4229. * @param result defines the target matrix
  4230. */
  4231. static RotationXToRef(angle: number, result: Matrix): void;
  4232. /**
  4233. * Creates a new rotation matrix for "angle" radians around the Y axis
  4234. * @param angle defines the angle (in radians) to use
  4235. * @return the new matrix
  4236. */
  4237. static RotationY(angle: number): Matrix;
  4238. /**
  4239. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4240. * @param angle defines the angle (in radians) to use
  4241. * @param result defines the target matrix
  4242. */
  4243. static RotationYToRef(angle: number, result: Matrix): void;
  4244. /**
  4245. * Creates a new rotation matrix for "angle" radians around the Z axis
  4246. * @param angle defines the angle (in radians) to use
  4247. * @return the new matrix
  4248. */
  4249. static RotationZ(angle: number): Matrix;
  4250. /**
  4251. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4252. * @param angle defines the angle (in radians) to use
  4253. * @param result defines the target matrix
  4254. */
  4255. static RotationZToRef(angle: number, result: Matrix): void;
  4256. /**
  4257. * Creates a new rotation matrix for "angle" radians around the given axis
  4258. * @param axis defines the axis to use
  4259. * @param angle defines the angle (in radians) to use
  4260. * @return the new matrix
  4261. */
  4262. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4263. /**
  4264. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4265. * @param axis defines the axis to use
  4266. * @param angle defines the angle (in radians) to use
  4267. * @param result defines the target matrix
  4268. */
  4269. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4270. /**
  4271. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4272. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4273. * @param from defines the vector to align
  4274. * @param to defines the vector to align to
  4275. * @param result defines the target matrix
  4276. */
  4277. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4278. /**
  4279. * Creates a rotation matrix
  4280. * @param yaw defines the yaw angle in radians (Y axis)
  4281. * @param pitch defines the pitch angle in radians (X axis)
  4282. * @param roll defines the roll angle in radians (X axis)
  4283. * @returns the new rotation matrix
  4284. */
  4285. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4286. /**
  4287. * Creates a rotation matrix and stores it in a given matrix
  4288. * @param yaw defines the yaw angle in radians (Y axis)
  4289. * @param pitch defines the pitch angle in radians (X axis)
  4290. * @param roll defines the roll angle in radians (X axis)
  4291. * @param result defines the target matrix
  4292. */
  4293. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4294. /**
  4295. * Creates a scaling matrix
  4296. * @param x defines the scale factor on X axis
  4297. * @param y defines the scale factor on Y axis
  4298. * @param z defines the scale factor on Z axis
  4299. * @returns the new matrix
  4300. */
  4301. static Scaling(x: number, y: number, z: number): Matrix;
  4302. /**
  4303. * Creates a scaling matrix and stores it in a given matrix
  4304. * @param x defines the scale factor on X axis
  4305. * @param y defines the scale factor on Y axis
  4306. * @param z defines the scale factor on Z axis
  4307. * @param result defines the target matrix
  4308. */
  4309. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4310. /**
  4311. * Creates a translation matrix
  4312. * @param x defines the translation on X axis
  4313. * @param y defines the translation on Y axis
  4314. * @param z defines the translationon Z axis
  4315. * @returns the new matrix
  4316. */
  4317. static Translation(x: number, y: number, z: number): Matrix;
  4318. /**
  4319. * Creates a translation matrix and stores it in a given matrix
  4320. * @param x defines the translation on X axis
  4321. * @param y defines the translation on Y axis
  4322. * @param z defines the translationon Z axis
  4323. * @param result defines the target matrix
  4324. */
  4325. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4326. /**
  4327. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4328. * @param startValue defines the start value
  4329. * @param endValue defines the end value
  4330. * @param gradient defines the gradient factor
  4331. * @returns the new matrix
  4332. */
  4333. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4334. /**
  4335. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4336. * @param startValue defines the start value
  4337. * @param endValue defines the end value
  4338. * @param gradient defines the gradient factor
  4339. * @param result defines the Matrix object where to store data
  4340. */
  4341. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4342. /**
  4343. * Builds a new matrix whose values are computed by:
  4344. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4345. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4346. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4347. * @param startValue defines the first matrix
  4348. * @param endValue defines the second matrix
  4349. * @param gradient defines the gradient between the two matrices
  4350. * @returns the new matrix
  4351. */
  4352. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4353. /**
  4354. * Update a matrix to values which are computed by:
  4355. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4356. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4357. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4358. * @param startValue defines the first matrix
  4359. * @param endValue defines the second matrix
  4360. * @param gradient defines the gradient between the two matrices
  4361. * @param result defines the target matrix
  4362. */
  4363. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4364. /**
  4365. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4366. * This function works in left handed mode
  4367. * @param eye defines the final position of the entity
  4368. * @param target defines where the entity should look at
  4369. * @param up defines the up vector for the entity
  4370. * @returns the new matrix
  4371. */
  4372. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4373. /**
  4374. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4375. * This function works in left handed mode
  4376. * @param eye defines the final position of the entity
  4377. * @param target defines where the entity should look at
  4378. * @param up defines the up vector for the entity
  4379. * @param result defines the target matrix
  4380. */
  4381. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4382. /**
  4383. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4384. * This function works in right handed mode
  4385. * @param eye defines the final position of the entity
  4386. * @param target defines where the entity should look at
  4387. * @param up defines the up vector for the entity
  4388. * @returns the new matrix
  4389. */
  4390. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4391. /**
  4392. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4393. * This function works in right handed mode
  4394. * @param eye defines the final position of the entity
  4395. * @param target defines where the entity should look at
  4396. * @param up defines the up vector for the entity
  4397. * @param result defines the target matrix
  4398. */
  4399. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4400. /**
  4401. * Create a left-handed orthographic projection matrix
  4402. * @param width defines the viewport width
  4403. * @param height defines the viewport height
  4404. * @param znear defines the near clip plane
  4405. * @param zfar defines the far clip plane
  4406. * @returns a new matrix as a left-handed orthographic projection matrix
  4407. */
  4408. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4409. /**
  4410. * Store a left-handed orthographic projection to a given matrix
  4411. * @param width defines the viewport width
  4412. * @param height defines the viewport height
  4413. * @param znear defines the near clip plane
  4414. * @param zfar defines the far clip plane
  4415. * @param result defines the target matrix
  4416. */
  4417. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4418. /**
  4419. * Create a left-handed orthographic projection matrix
  4420. * @param left defines the viewport left coordinate
  4421. * @param right defines the viewport right coordinate
  4422. * @param bottom defines the viewport bottom coordinate
  4423. * @param top defines the viewport top coordinate
  4424. * @param znear defines the near clip plane
  4425. * @param zfar defines the far clip plane
  4426. * @returns a new matrix as a left-handed orthographic projection matrix
  4427. */
  4428. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4429. /**
  4430. * Stores a left-handed orthographic projection into a given matrix
  4431. * @param left defines the viewport left coordinate
  4432. * @param right defines the viewport right coordinate
  4433. * @param bottom defines the viewport bottom coordinate
  4434. * @param top defines the viewport top coordinate
  4435. * @param znear defines the near clip plane
  4436. * @param zfar defines the far clip plane
  4437. * @param result defines the target matrix
  4438. */
  4439. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4440. /**
  4441. * Creates a right-handed orthographic projection matrix
  4442. * @param left defines the viewport left coordinate
  4443. * @param right defines the viewport right coordinate
  4444. * @param bottom defines the viewport bottom coordinate
  4445. * @param top defines the viewport top coordinate
  4446. * @param znear defines the near clip plane
  4447. * @param zfar defines the far clip plane
  4448. * @returns a new matrix as a right-handed orthographic projection matrix
  4449. */
  4450. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4451. /**
  4452. * Stores a right-handed orthographic projection into a given matrix
  4453. * @param left defines the viewport left coordinate
  4454. * @param right defines the viewport right coordinate
  4455. * @param bottom defines the viewport bottom coordinate
  4456. * @param top defines the viewport top coordinate
  4457. * @param znear defines the near clip plane
  4458. * @param zfar defines the far clip plane
  4459. * @param result defines the target matrix
  4460. */
  4461. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4462. /**
  4463. * Creates a left-handed perspective projection matrix
  4464. * @param width defines the viewport width
  4465. * @param height defines the viewport height
  4466. * @param znear defines the near clip plane
  4467. * @param zfar defines the far clip plane
  4468. * @returns a new matrix as a left-handed perspective projection matrix
  4469. */
  4470. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4471. /**
  4472. * Creates a left-handed perspective projection matrix
  4473. * @param fov defines the horizontal field of view
  4474. * @param aspect defines the aspect ratio
  4475. * @param znear defines the near clip plane
  4476. * @param zfar defines the far clip plane
  4477. * @returns a new matrix as a left-handed perspective projection matrix
  4478. */
  4479. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4480. /**
  4481. * Stores a left-handed perspective projection into a given matrix
  4482. * @param fov defines the horizontal field of view
  4483. * @param aspect defines the aspect ratio
  4484. * @param znear defines the near clip plane
  4485. * @param zfar defines the far clip plane
  4486. * @param result defines the target matrix
  4487. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4488. */
  4489. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4490. /**
  4491. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4492. * @param fov defines the horizontal field of view
  4493. * @param aspect defines the aspect ratio
  4494. * @param znear defines the near clip plane
  4495. * @param zfar not used as infinity is used as far clip
  4496. * @param result defines the target matrix
  4497. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4498. */
  4499. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4500. /**
  4501. * Creates a right-handed perspective projection matrix
  4502. * @param fov defines the horizontal field of view
  4503. * @param aspect defines the aspect ratio
  4504. * @param znear defines the near clip plane
  4505. * @param zfar defines the far clip plane
  4506. * @returns a new matrix as a right-handed perspective projection matrix
  4507. */
  4508. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4509. /**
  4510. * Stores a right-handed perspective projection into a given matrix
  4511. * @param fov defines the horizontal field of view
  4512. * @param aspect defines the aspect ratio
  4513. * @param znear defines the near clip plane
  4514. * @param zfar defines the far clip plane
  4515. * @param result defines the target matrix
  4516. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4517. */
  4518. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4519. /**
  4520. * Stores a right-handed perspective projection into a given matrix
  4521. * @param fov defines the horizontal field of view
  4522. * @param aspect defines the aspect ratio
  4523. * @param znear defines the near clip plane
  4524. * @param zfar not used as infinity is used as far clip
  4525. * @param result defines the target matrix
  4526. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4527. */
  4528. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4529. /**
  4530. * Stores a perspective projection for WebVR info a given matrix
  4531. * @param fov defines the field of view
  4532. * @param znear defines the near clip plane
  4533. * @param zfar defines the far clip plane
  4534. * @param result defines the target matrix
  4535. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4536. */
  4537. static PerspectiveFovWebVRToRef(fov: {
  4538. upDegrees: number;
  4539. downDegrees: number;
  4540. leftDegrees: number;
  4541. rightDegrees: number;
  4542. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4543. /**
  4544. * Computes a complete transformation matrix
  4545. * @param viewport defines the viewport to use
  4546. * @param world defines the world matrix
  4547. * @param view defines the view matrix
  4548. * @param projection defines the projection matrix
  4549. * @param zmin defines the near clip plane
  4550. * @param zmax defines the far clip plane
  4551. * @returns the transformation matrix
  4552. */
  4553. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4554. /**
  4555. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4556. * @param matrix defines the matrix to use
  4557. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4558. */
  4559. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  4560. /**
  4561. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4562. * @param matrix defines the matrix to use
  4563. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4564. */
  4565. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  4566. /**
  4567. * Compute the transpose of a given matrix
  4568. * @param matrix defines the matrix to transpose
  4569. * @returns the new matrix
  4570. */
  4571. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4572. /**
  4573. * Compute the transpose of a matrix and store it in a target matrix
  4574. * @param matrix defines the matrix to transpose
  4575. * @param result defines the target matrix
  4576. */
  4577. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4578. /**
  4579. * Computes a reflection matrix from a plane
  4580. * @param plane defines the reflection plane
  4581. * @returns a new matrix
  4582. */
  4583. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4584. /**
  4585. * Computes a reflection matrix from a plane
  4586. * @param plane defines the reflection plane
  4587. * @param result defines the target matrix
  4588. */
  4589. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4590. /**
  4591. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4592. * @param xaxis defines the value of the 1st axis
  4593. * @param yaxis defines the value of the 2nd axis
  4594. * @param zaxis defines the value of the 3rd axis
  4595. * @param result defines the target matrix
  4596. */
  4597. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4598. /**
  4599. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4600. * @param quat defines the quaternion to use
  4601. * @param result defines the target matrix
  4602. */
  4603. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4604. }
  4605. /**
  4606. * @hidden
  4607. */
  4608. export class TmpVectors {
  4609. static Vector2: Vector2[];
  4610. static Vector3: Vector3[];
  4611. static Vector4: Vector4[];
  4612. static Quaternion: Quaternion[];
  4613. static Matrix: Matrix[];
  4614. }
  4615. }
  4616. declare module "babylonjs/Maths/math.path" {
  4617. import { DeepImmutable, Nullable } from "babylonjs/types";
  4618. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4619. /**
  4620. * Defines potential orientation for back face culling
  4621. */
  4622. export enum Orientation {
  4623. /**
  4624. * Clockwise
  4625. */
  4626. CW = 0,
  4627. /** Counter clockwise */
  4628. CCW = 1
  4629. }
  4630. /** Class used to represent a Bezier curve */
  4631. export class BezierCurve {
  4632. /**
  4633. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4634. * @param t defines the time
  4635. * @param x1 defines the left coordinate on X axis
  4636. * @param y1 defines the left coordinate on Y axis
  4637. * @param x2 defines the right coordinate on X axis
  4638. * @param y2 defines the right coordinate on Y axis
  4639. * @returns the interpolated value
  4640. */
  4641. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4642. }
  4643. /**
  4644. * Defines angle representation
  4645. */
  4646. export class Angle {
  4647. private _radians;
  4648. /**
  4649. * Creates an Angle object of "radians" radians (float).
  4650. * @param radians the angle in radians
  4651. */
  4652. constructor(radians: number);
  4653. /**
  4654. * Get value in degrees
  4655. * @returns the Angle value in degrees (float)
  4656. */
  4657. degrees(): number;
  4658. /**
  4659. * Get value in radians
  4660. * @returns the Angle value in radians (float)
  4661. */
  4662. radians(): number;
  4663. /**
  4664. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  4665. * @param a defines first vector
  4666. * @param b defines second vector
  4667. * @returns a new Angle
  4668. */
  4669. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4670. /**
  4671. * Gets a new Angle object from the given float in radians
  4672. * @param radians defines the angle value in radians
  4673. * @returns a new Angle
  4674. */
  4675. static FromRadians(radians: number): Angle;
  4676. /**
  4677. * Gets a new Angle object from the given float in degrees
  4678. * @param degrees defines the angle value in degrees
  4679. * @returns a new Angle
  4680. */
  4681. static FromDegrees(degrees: number): Angle;
  4682. }
  4683. /**
  4684. * This represents an arc in a 2d space.
  4685. */
  4686. export class Arc2 {
  4687. /** Defines the start point of the arc */
  4688. startPoint: Vector2;
  4689. /** Defines the mid point of the arc */
  4690. midPoint: Vector2;
  4691. /** Defines the end point of the arc */
  4692. endPoint: Vector2;
  4693. /**
  4694. * Defines the center point of the arc.
  4695. */
  4696. centerPoint: Vector2;
  4697. /**
  4698. * Defines the radius of the arc.
  4699. */
  4700. radius: number;
  4701. /**
  4702. * Defines the angle of the arc (from mid point to end point).
  4703. */
  4704. angle: Angle;
  4705. /**
  4706. * Defines the start angle of the arc (from start point to middle point).
  4707. */
  4708. startAngle: Angle;
  4709. /**
  4710. * Defines the orientation of the arc (clock wise/counter clock wise).
  4711. */
  4712. orientation: Orientation;
  4713. /**
  4714. * Creates an Arc object from the three given points : start, middle and end.
  4715. * @param startPoint Defines the start point of the arc
  4716. * @param midPoint Defines the midlle point of the arc
  4717. * @param endPoint Defines the end point of the arc
  4718. */
  4719. constructor(
  4720. /** Defines the start point of the arc */
  4721. startPoint: Vector2,
  4722. /** Defines the mid point of the arc */
  4723. midPoint: Vector2,
  4724. /** Defines the end point of the arc */
  4725. endPoint: Vector2);
  4726. }
  4727. /**
  4728. * Represents a 2D path made up of multiple 2D points
  4729. */
  4730. export class Path2 {
  4731. private _points;
  4732. private _length;
  4733. /**
  4734. * If the path start and end point are the same
  4735. */
  4736. closed: boolean;
  4737. /**
  4738. * Creates a Path2 object from the starting 2D coordinates x and y.
  4739. * @param x the starting points x value
  4740. * @param y the starting points y value
  4741. */
  4742. constructor(x: number, y: number);
  4743. /**
  4744. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4745. * @param x the added points x value
  4746. * @param y the added points y value
  4747. * @returns the updated Path2.
  4748. */
  4749. addLineTo(x: number, y: number): Path2;
  4750. /**
  4751. * 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.
  4752. * @param midX middle point x value
  4753. * @param midY middle point y value
  4754. * @param endX end point x value
  4755. * @param endY end point y value
  4756. * @param numberOfSegments (default: 36)
  4757. * @returns the updated Path2.
  4758. */
  4759. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  4760. /**
  4761. * Closes the Path2.
  4762. * @returns the Path2.
  4763. */
  4764. close(): Path2;
  4765. /**
  4766. * Gets the sum of the distance between each sequential point in the path
  4767. * @returns the Path2 total length (float).
  4768. */
  4769. length(): number;
  4770. /**
  4771. * Gets the points which construct the path
  4772. * @returns the Path2 internal array of points.
  4773. */
  4774. getPoints(): Vector2[];
  4775. /**
  4776. * Retreives the point at the distance aways from the starting point
  4777. * @param normalizedLengthPosition the length along the path to retreive the point from
  4778. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  4779. */
  4780. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  4781. /**
  4782. * Creates a new path starting from an x and y position
  4783. * @param x starting x value
  4784. * @param y starting y value
  4785. * @returns a new Path2 starting at the coordinates (x, y).
  4786. */
  4787. static StartingAt(x: number, y: number): Path2;
  4788. }
  4789. /**
  4790. * Represents a 3D path made up of multiple 3D points
  4791. */
  4792. export class Path3D {
  4793. /**
  4794. * an array of Vector3, the curve axis of the Path3D
  4795. */
  4796. path: Vector3[];
  4797. private _curve;
  4798. private _distances;
  4799. private _tangents;
  4800. private _normals;
  4801. private _binormals;
  4802. private _raw;
  4803. private _alignTangentsWithPath;
  4804. private readonly _pointAtData;
  4805. /**
  4806. * new Path3D(path, normal, raw)
  4807. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  4808. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  4809. * @param path an array of Vector3, the curve axis of the Path3D
  4810. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  4811. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  4812. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  4813. */
  4814. constructor(
  4815. /**
  4816. * an array of Vector3, the curve axis of the Path3D
  4817. */
  4818. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  4819. /**
  4820. * Returns the Path3D array of successive Vector3 designing its curve.
  4821. * @returns the Path3D array of successive Vector3 designing its curve.
  4822. */
  4823. getCurve(): Vector3[];
  4824. /**
  4825. * Returns the Path3D array of successive Vector3 designing its curve.
  4826. * @returns the Path3D array of successive Vector3 designing its curve.
  4827. */
  4828. getPoints(): Vector3[];
  4829. /**
  4830. * @returns the computed length (float) of the path.
  4831. */
  4832. length(): number;
  4833. /**
  4834. * Returns an array populated with tangent vectors on each Path3D curve point.
  4835. * @returns an array populated with tangent vectors on each Path3D curve point.
  4836. */
  4837. getTangents(): Vector3[];
  4838. /**
  4839. * Returns an array populated with normal vectors on each Path3D curve point.
  4840. * @returns an array populated with normal vectors on each Path3D curve point.
  4841. */
  4842. getNormals(): Vector3[];
  4843. /**
  4844. * Returns an array populated with binormal vectors on each Path3D curve point.
  4845. * @returns an array populated with binormal vectors on each Path3D curve point.
  4846. */
  4847. getBinormals(): Vector3[];
  4848. /**
  4849. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  4850. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  4851. */
  4852. getDistances(): number[];
  4853. /**
  4854. * Returns an interpolated point along this path
  4855. * @param position the position of the point along this path, from 0.0 to 1.0
  4856. * @returns a new Vector3 as the point
  4857. */
  4858. getPointAt(position: number): Vector3;
  4859. /**
  4860. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  4861. * @param position the position of the point along this path, from 0.0 to 1.0
  4862. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  4863. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  4864. */
  4865. getTangentAt(position: number, interpolated?: boolean): Vector3;
  4866. /**
  4867. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  4868. * @param position the position of the point along this path, from 0.0 to 1.0
  4869. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  4870. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  4871. */
  4872. getNormalAt(position: number, interpolated?: boolean): Vector3;
  4873. /**
  4874. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  4875. * @param position the position of the point along this path, from 0.0 to 1.0
  4876. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  4877. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  4878. */
  4879. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  4880. /**
  4881. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  4882. * @param position the position of the point along this path, from 0.0 to 1.0
  4883. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  4884. */
  4885. getDistanceAt(position: number): number;
  4886. /**
  4887. * Returns the array index of the previous point of an interpolated point along this path
  4888. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  4889. * @returns the array index
  4890. */
  4891. getPreviousPointIndexAt(position: number): number;
  4892. /**
  4893. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  4894. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  4895. * @returns the sub position
  4896. */
  4897. getSubPositionAt(position: number): number;
  4898. /**
  4899. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  4900. * @param target the vector of which to get the closest position to
  4901. * @returns the position of the closest virtual point on this path to the target vector
  4902. */
  4903. getClosestPositionTo(target: Vector3): number;
  4904. /**
  4905. * Returns a sub path (slice) of this path
  4906. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  4907. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  4908. * @returns a sub path (slice) of this path
  4909. */
  4910. slice(start?: number, end?: number): Path3D;
  4911. /**
  4912. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  4913. * @param path path which all values are copied into the curves points
  4914. * @param firstNormal which should be projected onto the curve
  4915. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  4916. * @returns the same object updated.
  4917. */
  4918. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  4919. private _compute;
  4920. private _getFirstNonNullVector;
  4921. private _getLastNonNullVector;
  4922. private _normalVector;
  4923. /**
  4924. * Updates the point at data for an interpolated point along this curve
  4925. * @param position the position of the point along this curve, from 0.0 to 1.0
  4926. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  4927. * @returns the (updated) point at data
  4928. */
  4929. private _updatePointAtData;
  4930. /**
  4931. * Updates the point at data from the specified parameters
  4932. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  4933. * @param point the interpolated point
  4934. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  4935. */
  4936. private _setPointAtData;
  4937. /**
  4938. * Updates the point at interpolation matrix for the tangents, normals and binormals
  4939. */
  4940. private _updateInterpolationMatrix;
  4941. }
  4942. /**
  4943. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4944. * A Curve3 is designed from a series of successive Vector3.
  4945. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  4946. */
  4947. export class Curve3 {
  4948. private _points;
  4949. private _length;
  4950. /**
  4951. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  4952. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  4953. * @param v1 (Vector3) the control point
  4954. * @param v2 (Vector3) the end point of the Quadratic Bezier
  4955. * @param nbPoints (integer) the wanted number of points in the curve
  4956. * @returns the created Curve3
  4957. */
  4958. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4959. /**
  4960. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  4961. * @param v0 (Vector3) the origin point of the Cubic Bezier
  4962. * @param v1 (Vector3) the first control point
  4963. * @param v2 (Vector3) the second control point
  4964. * @param v3 (Vector3) the end point of the Cubic Bezier
  4965. * @param nbPoints (integer) the wanted number of points in the curve
  4966. * @returns the created Curve3
  4967. */
  4968. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4969. /**
  4970. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  4971. * @param p1 (Vector3) the origin point of the Hermite Spline
  4972. * @param t1 (Vector3) the tangent vector at the origin point
  4973. * @param p2 (Vector3) the end point of the Hermite Spline
  4974. * @param t2 (Vector3) the tangent vector at the end point
  4975. * @param nbPoints (integer) the wanted number of points in the curve
  4976. * @returns the created Curve3
  4977. */
  4978. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4979. /**
  4980. * Returns a Curve3 object along a CatmullRom Spline curve :
  4981. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  4982. * @param nbPoints (integer) the wanted number of points between each curve control points
  4983. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  4984. * @returns the created Curve3
  4985. */
  4986. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  4987. /**
  4988. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4989. * A Curve3 is designed from a series of successive Vector3.
  4990. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  4991. * @param points points which make up the curve
  4992. */
  4993. constructor(points: Vector3[]);
  4994. /**
  4995. * @returns the Curve3 stored array of successive Vector3
  4996. */
  4997. getPoints(): Vector3[];
  4998. /**
  4999. * @returns the computed length (float) of the curve.
  5000. */
  5001. length(): number;
  5002. /**
  5003. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5004. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5005. * curveA and curveB keep unchanged.
  5006. * @param curve the curve to continue from this curve
  5007. * @returns the newly constructed curve
  5008. */
  5009. continue(curve: DeepImmutable<Curve3>): Curve3;
  5010. private _computeLength;
  5011. }
  5012. }
  5013. declare module "babylonjs/Animations/easing" {
  5014. /**
  5015. * This represents the main contract an easing function should follow.
  5016. * Easing functions are used throughout the animation system.
  5017. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5018. */
  5019. export interface IEasingFunction {
  5020. /**
  5021. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5022. * of the easing function.
  5023. * The link below provides some of the most common examples of easing functions.
  5024. * @see https://easings.net/
  5025. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5026. * @returns the corresponding value on the curve defined by the easing function
  5027. */
  5028. ease(gradient: number): number;
  5029. }
  5030. /**
  5031. * Base class used for every default easing function.
  5032. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5033. */
  5034. export class EasingFunction implements IEasingFunction {
  5035. /**
  5036. * Interpolation follows the mathematical formula associated with the easing function.
  5037. */
  5038. static readonly EASINGMODE_EASEIN: number;
  5039. /**
  5040. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5041. */
  5042. static readonly EASINGMODE_EASEOUT: number;
  5043. /**
  5044. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5045. */
  5046. static readonly EASINGMODE_EASEINOUT: number;
  5047. private _easingMode;
  5048. /**
  5049. * Sets the easing mode of the current function.
  5050. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5051. */
  5052. setEasingMode(easingMode: number): void;
  5053. /**
  5054. * Gets the current easing mode.
  5055. * @returns the easing mode
  5056. */
  5057. getEasingMode(): number;
  5058. /**
  5059. * @hidden
  5060. */
  5061. easeInCore(gradient: number): number;
  5062. /**
  5063. * Given an input gradient between 0 and 1, this returns the corresponding value
  5064. * of the easing function.
  5065. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5066. * @returns the corresponding value on the curve defined by the easing function
  5067. */
  5068. ease(gradient: number): number;
  5069. }
  5070. /**
  5071. * Easing function with a circle shape (see link below).
  5072. * @see https://easings.net/#easeInCirc
  5073. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5074. */
  5075. export class CircleEase extends EasingFunction implements IEasingFunction {
  5076. /** @hidden */
  5077. easeInCore(gradient: number): number;
  5078. }
  5079. /**
  5080. * Easing function with a ease back shape (see link below).
  5081. * @see https://easings.net/#easeInBack
  5082. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5083. */
  5084. export class BackEase extends EasingFunction implements IEasingFunction {
  5085. /** Defines the amplitude of the function */
  5086. amplitude: number;
  5087. /**
  5088. * Instantiates a back ease easing
  5089. * @see https://easings.net/#easeInBack
  5090. * @param amplitude Defines the amplitude of the function
  5091. */
  5092. constructor(
  5093. /** Defines the amplitude of the function */
  5094. amplitude?: number);
  5095. /** @hidden */
  5096. easeInCore(gradient: number): number;
  5097. }
  5098. /**
  5099. * Easing function with a bouncing shape (see link below).
  5100. * @see https://easings.net/#easeInBounce
  5101. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5102. */
  5103. export class BounceEase extends EasingFunction implements IEasingFunction {
  5104. /** Defines the number of bounces */
  5105. bounces: number;
  5106. /** Defines the amplitude of the bounce */
  5107. bounciness: number;
  5108. /**
  5109. * Instantiates a bounce easing
  5110. * @see https://easings.net/#easeInBounce
  5111. * @param bounces Defines the number of bounces
  5112. * @param bounciness Defines the amplitude of the bounce
  5113. */
  5114. constructor(
  5115. /** Defines the number of bounces */
  5116. bounces?: number,
  5117. /** Defines the amplitude of the bounce */
  5118. bounciness?: number);
  5119. /** @hidden */
  5120. easeInCore(gradient: number): number;
  5121. }
  5122. /**
  5123. * Easing function with a power of 3 shape (see link below).
  5124. * @see https://easings.net/#easeInCubic
  5125. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5126. */
  5127. export class CubicEase extends EasingFunction implements IEasingFunction {
  5128. /** @hidden */
  5129. easeInCore(gradient: number): number;
  5130. }
  5131. /**
  5132. * Easing function with an elastic shape (see link below).
  5133. * @see https://easings.net/#easeInElastic
  5134. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5135. */
  5136. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5137. /** Defines the number of oscillations*/
  5138. oscillations: number;
  5139. /** Defines the amplitude of the oscillations*/
  5140. springiness: number;
  5141. /**
  5142. * Instantiates an elastic easing function
  5143. * @see https://easings.net/#easeInElastic
  5144. * @param oscillations Defines the number of oscillations
  5145. * @param springiness Defines the amplitude of the oscillations
  5146. */
  5147. constructor(
  5148. /** Defines the number of oscillations*/
  5149. oscillations?: number,
  5150. /** Defines the amplitude of the oscillations*/
  5151. springiness?: number);
  5152. /** @hidden */
  5153. easeInCore(gradient: number): number;
  5154. }
  5155. /**
  5156. * Easing function with an exponential shape (see link below).
  5157. * @see https://easings.net/#easeInExpo
  5158. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5159. */
  5160. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5161. /** Defines the exponent of the function */
  5162. exponent: number;
  5163. /**
  5164. * Instantiates an exponential easing function
  5165. * @see https://easings.net/#easeInExpo
  5166. * @param exponent Defines the exponent of the function
  5167. */
  5168. constructor(
  5169. /** Defines the exponent of the function */
  5170. exponent?: number);
  5171. /** @hidden */
  5172. easeInCore(gradient: number): number;
  5173. }
  5174. /**
  5175. * Easing function with a power shape (see link below).
  5176. * @see https://easings.net/#easeInQuad
  5177. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5178. */
  5179. export class PowerEase extends EasingFunction implements IEasingFunction {
  5180. /** Defines the power of the function */
  5181. power: number;
  5182. /**
  5183. * Instantiates an power base easing function
  5184. * @see https://easings.net/#easeInQuad
  5185. * @param power Defines the power of the function
  5186. */
  5187. constructor(
  5188. /** Defines the power of the function */
  5189. power?: number);
  5190. /** @hidden */
  5191. easeInCore(gradient: number): number;
  5192. }
  5193. /**
  5194. * Easing function with a power of 2 shape (see link below).
  5195. * @see https://easings.net/#easeInQuad
  5196. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5197. */
  5198. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5199. /** @hidden */
  5200. easeInCore(gradient: number): number;
  5201. }
  5202. /**
  5203. * Easing function with a power of 4 shape (see link below).
  5204. * @see https://easings.net/#easeInQuart
  5205. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5206. */
  5207. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5208. /** @hidden */
  5209. easeInCore(gradient: number): number;
  5210. }
  5211. /**
  5212. * Easing function with a power of 5 shape (see link below).
  5213. * @see https://easings.net/#easeInQuint
  5214. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5215. */
  5216. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5217. /** @hidden */
  5218. easeInCore(gradient: number): number;
  5219. }
  5220. /**
  5221. * Easing function with a sin shape (see link below).
  5222. * @see https://easings.net/#easeInSine
  5223. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5224. */
  5225. export class SineEase extends EasingFunction implements IEasingFunction {
  5226. /** @hidden */
  5227. easeInCore(gradient: number): number;
  5228. }
  5229. /**
  5230. * Easing function with a bezier shape (see link below).
  5231. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5232. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5233. */
  5234. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5235. /** Defines the x component of the start tangent in the bezier curve */
  5236. x1: number;
  5237. /** Defines the y component of the start tangent in the bezier curve */
  5238. y1: number;
  5239. /** Defines the x component of the end tangent in the bezier curve */
  5240. x2: number;
  5241. /** Defines the y component of the end tangent in the bezier curve */
  5242. y2: number;
  5243. /**
  5244. * Instantiates a bezier function
  5245. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5246. * @param x1 Defines the x component of the start tangent in the bezier curve
  5247. * @param y1 Defines the y component of the start tangent in the bezier curve
  5248. * @param x2 Defines the x component of the end tangent in the bezier curve
  5249. * @param y2 Defines the y component of the end tangent in the bezier curve
  5250. */
  5251. constructor(
  5252. /** Defines the x component of the start tangent in the bezier curve */
  5253. x1?: number,
  5254. /** Defines the y component of the start tangent in the bezier curve */
  5255. y1?: number,
  5256. /** Defines the x component of the end tangent in the bezier curve */
  5257. x2?: number,
  5258. /** Defines the y component of the end tangent in the bezier curve */
  5259. y2?: number);
  5260. /** @hidden */
  5261. easeInCore(gradient: number): number;
  5262. }
  5263. }
  5264. declare module "babylonjs/Maths/math.color" {
  5265. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5266. /**
  5267. * Class used to hold a RBG color
  5268. */
  5269. export class Color3 {
  5270. /**
  5271. * Defines the red component (between 0 and 1, default is 0)
  5272. */
  5273. r: number;
  5274. /**
  5275. * Defines the green component (between 0 and 1, default is 0)
  5276. */
  5277. g: number;
  5278. /**
  5279. * Defines the blue component (between 0 and 1, default is 0)
  5280. */
  5281. b: number;
  5282. /**
  5283. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5284. * @param r defines the red component (between 0 and 1, default is 0)
  5285. * @param g defines the green component (between 0 and 1, default is 0)
  5286. * @param b defines the blue component (between 0 and 1, default is 0)
  5287. */
  5288. constructor(
  5289. /**
  5290. * Defines the red component (between 0 and 1, default is 0)
  5291. */
  5292. r?: number,
  5293. /**
  5294. * Defines the green component (between 0 and 1, default is 0)
  5295. */
  5296. g?: number,
  5297. /**
  5298. * Defines the blue component (between 0 and 1, default is 0)
  5299. */
  5300. b?: number);
  5301. /**
  5302. * Creates a string with the Color3 current values
  5303. * @returns the string representation of the Color3 object
  5304. */
  5305. toString(): string;
  5306. /**
  5307. * Returns the string "Color3"
  5308. * @returns "Color3"
  5309. */
  5310. getClassName(): string;
  5311. /**
  5312. * Compute the Color3 hash code
  5313. * @returns an unique number that can be used to hash Color3 objects
  5314. */
  5315. getHashCode(): number;
  5316. /**
  5317. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5318. * @param array defines the array where to store the r,g,b components
  5319. * @param index defines an optional index in the target array to define where to start storing values
  5320. * @returns the current Color3 object
  5321. */
  5322. toArray(array: FloatArray, index?: number): Color3;
  5323. /**
  5324. * Returns a new Color4 object from the current Color3 and the given alpha
  5325. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5326. * @returns a new Color4 object
  5327. */
  5328. toColor4(alpha?: number): Color4;
  5329. /**
  5330. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5331. * @returns the new array
  5332. */
  5333. asArray(): number[];
  5334. /**
  5335. * Returns the luminance value
  5336. * @returns a float value
  5337. */
  5338. toLuminance(): number;
  5339. /**
  5340. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5341. * @param otherColor defines the second operand
  5342. * @returns the new Color3 object
  5343. */
  5344. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5345. /**
  5346. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5347. * @param otherColor defines the second operand
  5348. * @param result defines the Color3 object where to store the result
  5349. * @returns the current Color3
  5350. */
  5351. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5352. /**
  5353. * Determines equality between Color3 objects
  5354. * @param otherColor defines the second operand
  5355. * @returns true if the rgb values are equal to the given ones
  5356. */
  5357. equals(otherColor: DeepImmutable<Color3>): boolean;
  5358. /**
  5359. * Determines equality between the current Color3 object and a set of r,b,g values
  5360. * @param r defines the red component to check
  5361. * @param g defines the green component to check
  5362. * @param b defines the blue component to check
  5363. * @returns true if the rgb values are equal to the given ones
  5364. */
  5365. equalsFloats(r: number, g: number, b: number): boolean;
  5366. /**
  5367. * Multiplies in place each rgb value by scale
  5368. * @param scale defines the scaling factor
  5369. * @returns the updated Color3
  5370. */
  5371. scale(scale: number): Color3;
  5372. /**
  5373. * Multiplies the rgb values by scale and stores the result into "result"
  5374. * @param scale defines the scaling factor
  5375. * @param result defines the Color3 object where to store the result
  5376. * @returns the unmodified current Color3
  5377. */
  5378. scaleToRef(scale: number, result: Color3): Color3;
  5379. /**
  5380. * Scale the current Color3 values by a factor and add the result to a given Color3
  5381. * @param scale defines the scale factor
  5382. * @param result defines color to store the result into
  5383. * @returns the unmodified current Color3
  5384. */
  5385. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5386. /**
  5387. * Clamps the rgb values by the min and max values and stores the result into "result"
  5388. * @param min defines minimum clamping value (default is 0)
  5389. * @param max defines maximum clamping value (default is 1)
  5390. * @param result defines color to store the result into
  5391. * @returns the original Color3
  5392. */
  5393. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5394. /**
  5395. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5396. * @param otherColor defines the second operand
  5397. * @returns the new Color3
  5398. */
  5399. add(otherColor: DeepImmutable<Color3>): Color3;
  5400. /**
  5401. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5402. * @param otherColor defines the second operand
  5403. * @param result defines Color3 object to store the result into
  5404. * @returns the unmodified current Color3
  5405. */
  5406. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5407. /**
  5408. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5409. * @param otherColor defines the second operand
  5410. * @returns the new Color3
  5411. */
  5412. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5413. /**
  5414. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5415. * @param otherColor defines the second operand
  5416. * @param result defines Color3 object to store the result into
  5417. * @returns the unmodified current Color3
  5418. */
  5419. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5420. /**
  5421. * Copy the current object
  5422. * @returns a new Color3 copied the current one
  5423. */
  5424. clone(): Color3;
  5425. /**
  5426. * Copies the rgb values from the source in the current Color3
  5427. * @param source defines the source Color3 object
  5428. * @returns the updated Color3 object
  5429. */
  5430. copyFrom(source: DeepImmutable<Color3>): Color3;
  5431. /**
  5432. * Updates the Color3 rgb values from the given floats
  5433. * @param r defines the red component to read from
  5434. * @param g defines the green component to read from
  5435. * @param b defines the blue component to read from
  5436. * @returns the current Color3 object
  5437. */
  5438. copyFromFloats(r: number, g: number, b: number): Color3;
  5439. /**
  5440. * Updates the Color3 rgb values from the given floats
  5441. * @param r defines the red component to read from
  5442. * @param g defines the green component to read from
  5443. * @param b defines the blue component to read from
  5444. * @returns the current Color3 object
  5445. */
  5446. set(r: number, g: number, b: number): Color3;
  5447. /**
  5448. * Compute the Color3 hexadecimal code as a string
  5449. * @returns a string containing the hexadecimal representation of the Color3 object
  5450. */
  5451. toHexString(): string;
  5452. /**
  5453. * Computes a new Color3 converted from the current one to linear space
  5454. * @returns a new Color3 object
  5455. */
  5456. toLinearSpace(): Color3;
  5457. /**
  5458. * Converts current color in rgb space to HSV values
  5459. * @returns a new color3 representing the HSV values
  5460. */
  5461. toHSV(): Color3;
  5462. /**
  5463. * Converts current color in rgb space to HSV values
  5464. * @param result defines the Color3 where to store the HSV values
  5465. */
  5466. toHSVToRef(result: Color3): void;
  5467. /**
  5468. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5469. * @param convertedColor defines the Color3 object where to store the linear space version
  5470. * @returns the unmodified Color3
  5471. */
  5472. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5473. /**
  5474. * Computes a new Color3 converted from the current one to gamma space
  5475. * @returns a new Color3 object
  5476. */
  5477. toGammaSpace(): Color3;
  5478. /**
  5479. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5480. * @param convertedColor defines the Color3 object where to store the gamma space version
  5481. * @returns the unmodified Color3
  5482. */
  5483. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5484. private static _BlackReadOnly;
  5485. /**
  5486. * Convert Hue, saturation and value to a Color3 (RGB)
  5487. * @param hue defines the hue
  5488. * @param saturation defines the saturation
  5489. * @param value defines the value
  5490. * @param result defines the Color3 where to store the RGB values
  5491. */
  5492. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5493. /**
  5494. * Creates a new Color3 from the string containing valid hexadecimal values
  5495. * @param hex defines a string containing valid hexadecimal values
  5496. * @returns a new Color3 object
  5497. */
  5498. static FromHexString(hex: string): Color3;
  5499. /**
  5500. * Creates a new Color3 from the starting index of the given array
  5501. * @param array defines the source array
  5502. * @param offset defines an offset in the source array
  5503. * @returns a new Color3 object
  5504. */
  5505. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5506. /**
  5507. * Creates a new Color3 from integer values (< 256)
  5508. * @param r defines the red component to read from (value between 0 and 255)
  5509. * @param g defines the green component to read from (value between 0 and 255)
  5510. * @param b defines the blue component to read from (value between 0 and 255)
  5511. * @returns a new Color3 object
  5512. */
  5513. static FromInts(r: number, g: number, b: number): Color3;
  5514. /**
  5515. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5516. * @param start defines the start Color3 value
  5517. * @param end defines the end Color3 value
  5518. * @param amount defines the gradient value between start and end
  5519. * @returns a new Color3 object
  5520. */
  5521. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5522. /**
  5523. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5524. * @param left defines the start value
  5525. * @param right defines the end value
  5526. * @param amount defines the gradient factor
  5527. * @param result defines the Color3 object where to store the result
  5528. */
  5529. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5530. /**
  5531. * Returns a Color3 value containing a red color
  5532. * @returns a new Color3 object
  5533. */
  5534. static Red(): Color3;
  5535. /**
  5536. * Returns a Color3 value containing a green color
  5537. * @returns a new Color3 object
  5538. */
  5539. static Green(): Color3;
  5540. /**
  5541. * Returns a Color3 value containing a blue color
  5542. * @returns a new Color3 object
  5543. */
  5544. static Blue(): Color3;
  5545. /**
  5546. * Returns a Color3 value containing a black color
  5547. * @returns a new Color3 object
  5548. */
  5549. static Black(): Color3;
  5550. /**
  5551. * Gets a Color3 value containing a black color that must not be updated
  5552. */
  5553. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5554. /**
  5555. * Returns a Color3 value containing a white color
  5556. * @returns a new Color3 object
  5557. */
  5558. static White(): Color3;
  5559. /**
  5560. * Returns a Color3 value containing a purple color
  5561. * @returns a new Color3 object
  5562. */
  5563. static Purple(): Color3;
  5564. /**
  5565. * Returns a Color3 value containing a magenta color
  5566. * @returns a new Color3 object
  5567. */
  5568. static Magenta(): Color3;
  5569. /**
  5570. * Returns a Color3 value containing a yellow color
  5571. * @returns a new Color3 object
  5572. */
  5573. static Yellow(): Color3;
  5574. /**
  5575. * Returns a Color3 value containing a gray color
  5576. * @returns a new Color3 object
  5577. */
  5578. static Gray(): Color3;
  5579. /**
  5580. * Returns a Color3 value containing a teal color
  5581. * @returns a new Color3 object
  5582. */
  5583. static Teal(): Color3;
  5584. /**
  5585. * Returns a Color3 value containing a random color
  5586. * @returns a new Color3 object
  5587. */
  5588. static Random(): Color3;
  5589. }
  5590. /**
  5591. * Class used to hold a RBGA color
  5592. */
  5593. export class Color4 {
  5594. /**
  5595. * Defines the red component (between 0 and 1, default is 0)
  5596. */
  5597. r: number;
  5598. /**
  5599. * Defines the green component (between 0 and 1, default is 0)
  5600. */
  5601. g: number;
  5602. /**
  5603. * Defines the blue component (between 0 and 1, default is 0)
  5604. */
  5605. b: number;
  5606. /**
  5607. * Defines the alpha component (between 0 and 1, default is 1)
  5608. */
  5609. a: number;
  5610. /**
  5611. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5612. * @param r defines the red component (between 0 and 1, default is 0)
  5613. * @param g defines the green component (between 0 and 1, default is 0)
  5614. * @param b defines the blue component (between 0 and 1, default is 0)
  5615. * @param a defines the alpha component (between 0 and 1, default is 1)
  5616. */
  5617. constructor(
  5618. /**
  5619. * Defines the red component (between 0 and 1, default is 0)
  5620. */
  5621. r?: number,
  5622. /**
  5623. * Defines the green component (between 0 and 1, default is 0)
  5624. */
  5625. g?: number,
  5626. /**
  5627. * Defines the blue component (between 0 and 1, default is 0)
  5628. */
  5629. b?: number,
  5630. /**
  5631. * Defines the alpha component (between 0 and 1, default is 1)
  5632. */
  5633. a?: number);
  5634. /**
  5635. * Adds in place the given Color4 values to the current Color4 object
  5636. * @param right defines the second operand
  5637. * @returns the current updated Color4 object
  5638. */
  5639. addInPlace(right: DeepImmutable<Color4>): Color4;
  5640. /**
  5641. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5642. * @returns the new array
  5643. */
  5644. asArray(): number[];
  5645. /**
  5646. * Stores from the starting index in the given array the Color4 successive values
  5647. * @param array defines the array where to store the r,g,b components
  5648. * @param index defines an optional index in the target array to define where to start storing values
  5649. * @returns the current Color4 object
  5650. */
  5651. toArray(array: number[], index?: number): Color4;
  5652. /**
  5653. * Determines equality between Color4 objects
  5654. * @param otherColor defines the second operand
  5655. * @returns true if the rgba values are equal to the given ones
  5656. */
  5657. equals(otherColor: DeepImmutable<Color4>): boolean;
  5658. /**
  5659. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5660. * @param right defines the second operand
  5661. * @returns a new Color4 object
  5662. */
  5663. add(right: DeepImmutable<Color4>): Color4;
  5664. /**
  5665. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5666. * @param right defines the second operand
  5667. * @returns a new Color4 object
  5668. */
  5669. subtract(right: DeepImmutable<Color4>): Color4;
  5670. /**
  5671. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5672. * @param right defines the second operand
  5673. * @param result defines the Color4 object where to store the result
  5674. * @returns the current Color4 object
  5675. */
  5676. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5677. /**
  5678. * Creates a new Color4 with the current Color4 values multiplied by scale
  5679. * @param scale defines the scaling factor to apply
  5680. * @returns a new Color4 object
  5681. */
  5682. scale(scale: number): Color4;
  5683. /**
  5684. * Multiplies the current Color4 values by scale and stores the result in "result"
  5685. * @param scale defines the scaling factor to apply
  5686. * @param result defines the Color4 object where to store the result
  5687. * @returns the current unmodified Color4
  5688. */
  5689. scaleToRef(scale: number, result: Color4): Color4;
  5690. /**
  5691. * Scale the current Color4 values by a factor and add the result to a given Color4
  5692. * @param scale defines the scale factor
  5693. * @param result defines the Color4 object where to store the result
  5694. * @returns the unmodified current Color4
  5695. */
  5696. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5697. /**
  5698. * Clamps the rgb values by the min and max values and stores the result into "result"
  5699. * @param min defines minimum clamping value (default is 0)
  5700. * @param max defines maximum clamping value (default is 1)
  5701. * @param result defines color to store the result into.
  5702. * @returns the cuurent Color4
  5703. */
  5704. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5705. /**
  5706. * Multipy an Color4 value by another and return a new Color4 object
  5707. * @param color defines the Color4 value to multiply by
  5708. * @returns a new Color4 object
  5709. */
  5710. multiply(color: Color4): Color4;
  5711. /**
  5712. * Multipy a Color4 value by another and push the result in a reference value
  5713. * @param color defines the Color4 value to multiply by
  5714. * @param result defines the Color4 to fill the result in
  5715. * @returns the result Color4
  5716. */
  5717. multiplyToRef(color: Color4, result: Color4): Color4;
  5718. /**
  5719. * Creates a string with the Color4 current values
  5720. * @returns the string representation of the Color4 object
  5721. */
  5722. toString(): string;
  5723. /**
  5724. * Returns the string "Color4"
  5725. * @returns "Color4"
  5726. */
  5727. getClassName(): string;
  5728. /**
  5729. * Compute the Color4 hash code
  5730. * @returns an unique number that can be used to hash Color4 objects
  5731. */
  5732. getHashCode(): number;
  5733. /**
  5734. * Creates a new Color4 copied from the current one
  5735. * @returns a new Color4 object
  5736. */
  5737. clone(): Color4;
  5738. /**
  5739. * Copies the given Color4 values into the current one
  5740. * @param source defines the source Color4 object
  5741. * @returns the current updated Color4 object
  5742. */
  5743. copyFrom(source: Color4): Color4;
  5744. /**
  5745. * Copies the given float values into the current one
  5746. * @param r defines the red component to read from
  5747. * @param g defines the green component to read from
  5748. * @param b defines the blue component to read from
  5749. * @param a defines the alpha component to read from
  5750. * @returns the current updated Color4 object
  5751. */
  5752. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5753. /**
  5754. * Copies the given float values into the current one
  5755. * @param r defines the red component to read from
  5756. * @param g defines the green component to read from
  5757. * @param b defines the blue component to read from
  5758. * @param a defines the alpha component to read from
  5759. * @returns the current updated Color4 object
  5760. */
  5761. set(r: number, g: number, b: number, a: number): Color4;
  5762. /**
  5763. * Compute the Color4 hexadecimal code as a string
  5764. * @returns a string containing the hexadecimal representation of the Color4 object
  5765. */
  5766. toHexString(): string;
  5767. /**
  5768. * Computes a new Color4 converted from the current one to linear space
  5769. * @returns a new Color4 object
  5770. */
  5771. toLinearSpace(): Color4;
  5772. /**
  5773. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5774. * @param convertedColor defines the Color4 object where to store the linear space version
  5775. * @returns the unmodified Color4
  5776. */
  5777. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5778. /**
  5779. * Computes a new Color4 converted from the current one to gamma space
  5780. * @returns a new Color4 object
  5781. */
  5782. toGammaSpace(): Color4;
  5783. /**
  5784. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5785. * @param convertedColor defines the Color4 object where to store the gamma space version
  5786. * @returns the unmodified Color4
  5787. */
  5788. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5789. /**
  5790. * Creates a new Color4 from the string containing valid hexadecimal values
  5791. * @param hex defines a string containing valid hexadecimal values
  5792. * @returns a new Color4 object
  5793. */
  5794. static FromHexString(hex: string): Color4;
  5795. /**
  5796. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5797. * @param left defines the start value
  5798. * @param right defines the end value
  5799. * @param amount defines the gradient factor
  5800. * @returns a new Color4 object
  5801. */
  5802. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5803. /**
  5804. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5805. * @param left defines the start value
  5806. * @param right defines the end value
  5807. * @param amount defines the gradient factor
  5808. * @param result defines the Color4 object where to store data
  5809. */
  5810. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5811. /**
  5812. * Creates a new Color4 from a Color3 and an alpha value
  5813. * @param color3 defines the source Color3 to read from
  5814. * @param alpha defines the alpha component (1.0 by default)
  5815. * @returns a new Color4 object
  5816. */
  5817. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5818. /**
  5819. * Creates a new Color4 from the starting index element of the given array
  5820. * @param array defines the source array to read from
  5821. * @param offset defines the offset in the source array
  5822. * @returns a new Color4 object
  5823. */
  5824. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5825. /**
  5826. * Creates a new Color3 from integer values (< 256)
  5827. * @param r defines the red component to read from (value between 0 and 255)
  5828. * @param g defines the green component to read from (value between 0 and 255)
  5829. * @param b defines the blue component to read from (value between 0 and 255)
  5830. * @param a defines the alpha component to read from (value between 0 and 255)
  5831. * @returns a new Color3 object
  5832. */
  5833. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5834. /**
  5835. * Check the content of a given array and convert it to an array containing RGBA data
  5836. * If the original array was already containing count * 4 values then it is returned directly
  5837. * @param colors defines the array to check
  5838. * @param count defines the number of RGBA data to expect
  5839. * @returns an array containing count * 4 values (RGBA)
  5840. */
  5841. static CheckColors4(colors: number[], count: number): number[];
  5842. }
  5843. /**
  5844. * @hidden
  5845. */
  5846. export class TmpColors {
  5847. static Color3: Color3[];
  5848. static Color4: Color4[];
  5849. }
  5850. }
  5851. declare module "babylonjs/Animations/animationKey" {
  5852. /**
  5853. * Defines an interface which represents an animation key frame
  5854. */
  5855. export interface IAnimationKey {
  5856. /**
  5857. * Frame of the key frame
  5858. */
  5859. frame: number;
  5860. /**
  5861. * Value at the specifies key frame
  5862. */
  5863. value: any;
  5864. /**
  5865. * The input tangent for the cubic hermite spline
  5866. */
  5867. inTangent?: any;
  5868. /**
  5869. * The output tangent for the cubic hermite spline
  5870. */
  5871. outTangent?: any;
  5872. /**
  5873. * The animation interpolation type
  5874. */
  5875. interpolation?: AnimationKeyInterpolation;
  5876. }
  5877. /**
  5878. * Enum for the animation key frame interpolation type
  5879. */
  5880. export enum AnimationKeyInterpolation {
  5881. /**
  5882. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  5883. */
  5884. STEP = 1
  5885. }
  5886. }
  5887. declare module "babylonjs/Animations/animationRange" {
  5888. /**
  5889. * Represents the range of an animation
  5890. */
  5891. export class AnimationRange {
  5892. /**The name of the animation range**/
  5893. name: string;
  5894. /**The starting frame of the animation */
  5895. from: number;
  5896. /**The ending frame of the animation*/
  5897. to: number;
  5898. /**
  5899. * Initializes the range of an animation
  5900. * @param name The name of the animation range
  5901. * @param from The starting frame of the animation
  5902. * @param to The ending frame of the animation
  5903. */
  5904. constructor(
  5905. /**The name of the animation range**/
  5906. name: string,
  5907. /**The starting frame of the animation */
  5908. from: number,
  5909. /**The ending frame of the animation*/
  5910. to: number);
  5911. /**
  5912. * Makes a copy of the animation range
  5913. * @returns A copy of the animation range
  5914. */
  5915. clone(): AnimationRange;
  5916. }
  5917. }
  5918. declare module "babylonjs/Animations/animationEvent" {
  5919. /**
  5920. * Composed of a frame, and an action function
  5921. */
  5922. export class AnimationEvent {
  5923. /** The frame for which the event is triggered **/
  5924. frame: number;
  5925. /** The event to perform when triggered **/
  5926. action: (currentFrame: number) => void;
  5927. /** Specifies if the event should be triggered only once**/
  5928. onlyOnce?: boolean | undefined;
  5929. /**
  5930. * Specifies if the animation event is done
  5931. */
  5932. isDone: boolean;
  5933. /**
  5934. * Initializes the animation event
  5935. * @param frame The frame for which the event is triggered
  5936. * @param action The event to perform when triggered
  5937. * @param onlyOnce Specifies if the event should be triggered only once
  5938. */
  5939. constructor(
  5940. /** The frame for which the event is triggered **/
  5941. frame: number,
  5942. /** The event to perform when triggered **/
  5943. action: (currentFrame: number) => void,
  5944. /** Specifies if the event should be triggered only once**/
  5945. onlyOnce?: boolean | undefined);
  5946. /** @hidden */
  5947. _clone(): AnimationEvent;
  5948. }
  5949. }
  5950. declare module "babylonjs/Behaviors/behavior" {
  5951. import { Nullable } from "babylonjs/types";
  5952. /**
  5953. * Interface used to define a behavior
  5954. */
  5955. export interface Behavior<T> {
  5956. /** gets or sets behavior's name */
  5957. name: string;
  5958. /**
  5959. * Function called when the behavior needs to be initialized (after attaching it to a target)
  5960. */
  5961. init(): void;
  5962. /**
  5963. * Called when the behavior is attached to a target
  5964. * @param target defines the target where the behavior is attached to
  5965. */
  5966. attach(target: T): void;
  5967. /**
  5968. * Called when the behavior is detached from its target
  5969. */
  5970. detach(): void;
  5971. }
  5972. /**
  5973. * Interface implemented by classes supporting behaviors
  5974. */
  5975. export interface IBehaviorAware<T> {
  5976. /**
  5977. * Attach a behavior
  5978. * @param behavior defines the behavior to attach
  5979. * @returns the current host
  5980. */
  5981. addBehavior(behavior: Behavior<T>): T;
  5982. /**
  5983. * Remove a behavior from the current object
  5984. * @param behavior defines the behavior to detach
  5985. * @returns the current host
  5986. */
  5987. removeBehavior(behavior: Behavior<T>): T;
  5988. /**
  5989. * Gets a behavior using its name to search
  5990. * @param name defines the name to search
  5991. * @returns the behavior or null if not found
  5992. */
  5993. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  5994. }
  5995. }
  5996. declare module "babylonjs/Misc/smartArray" {
  5997. /**
  5998. * Defines an array and its length.
  5999. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6000. */
  6001. export interface ISmartArrayLike<T> {
  6002. /**
  6003. * The data of the array.
  6004. */
  6005. data: Array<T>;
  6006. /**
  6007. * The active length of the array.
  6008. */
  6009. length: number;
  6010. }
  6011. /**
  6012. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6013. */
  6014. export class SmartArray<T> implements ISmartArrayLike<T> {
  6015. /**
  6016. * The full set of data from the array.
  6017. */
  6018. data: Array<T>;
  6019. /**
  6020. * The active length of the array.
  6021. */
  6022. length: number;
  6023. protected _id: number;
  6024. /**
  6025. * Instantiates a Smart Array.
  6026. * @param capacity defines the default capacity of the array.
  6027. */
  6028. constructor(capacity: number);
  6029. /**
  6030. * Pushes a value at the end of the active data.
  6031. * @param value defines the object to push in the array.
  6032. */
  6033. push(value: T): void;
  6034. /**
  6035. * Iterates over the active data and apply the lambda to them.
  6036. * @param func defines the action to apply on each value.
  6037. */
  6038. forEach(func: (content: T) => void): void;
  6039. /**
  6040. * Sorts the full sets of data.
  6041. * @param compareFn defines the comparison function to apply.
  6042. */
  6043. sort(compareFn: (a: T, b: T) => number): void;
  6044. /**
  6045. * Resets the active data to an empty array.
  6046. */
  6047. reset(): void;
  6048. /**
  6049. * Releases all the data from the array as well as the array.
  6050. */
  6051. dispose(): void;
  6052. /**
  6053. * Concats the active data with a given array.
  6054. * @param array defines the data to concatenate with.
  6055. */
  6056. concat(array: any): void;
  6057. /**
  6058. * Returns the position of a value in the active data.
  6059. * @param value defines the value to find the index for
  6060. * @returns the index if found in the active data otherwise -1
  6061. */
  6062. indexOf(value: T): number;
  6063. /**
  6064. * Returns whether an element is part of the active data.
  6065. * @param value defines the value to look for
  6066. * @returns true if found in the active data otherwise false
  6067. */
  6068. contains(value: T): boolean;
  6069. private static _GlobalId;
  6070. }
  6071. /**
  6072. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6073. * The data in this array can only be present once
  6074. */
  6075. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6076. private _duplicateId;
  6077. /**
  6078. * Pushes a value at the end of the active data.
  6079. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6080. * @param value defines the object to push in the array.
  6081. */
  6082. push(value: T): void;
  6083. /**
  6084. * Pushes a value at the end of the active data.
  6085. * If the data is already present, it won t be added again
  6086. * @param value defines the object to push in the array.
  6087. * @returns true if added false if it was already present
  6088. */
  6089. pushNoDuplicate(value: T): boolean;
  6090. /**
  6091. * Resets the active data to an empty array.
  6092. */
  6093. reset(): void;
  6094. /**
  6095. * Concats the active data with a given array.
  6096. * This ensures no dupplicate will be present in the result.
  6097. * @param array defines the data to concatenate with.
  6098. */
  6099. concatWithNoDuplicate(array: any): void;
  6100. }
  6101. }
  6102. declare module "babylonjs/Cameras/cameraInputsManager" {
  6103. import { Nullable } from "babylonjs/types";
  6104. import { Camera } from "babylonjs/Cameras/camera";
  6105. /**
  6106. * @ignore
  6107. * This is a list of all the different input types that are available in the application.
  6108. * Fo instance: ArcRotateCameraGamepadInput...
  6109. */
  6110. export var CameraInputTypes: {};
  6111. /**
  6112. * This is the contract to implement in order to create a new input class.
  6113. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6114. */
  6115. export interface ICameraInput<TCamera extends Camera> {
  6116. /**
  6117. * Defines the camera the input is attached to.
  6118. */
  6119. camera: Nullable<TCamera>;
  6120. /**
  6121. * Gets the class name of the current intput.
  6122. * @returns the class name
  6123. */
  6124. getClassName(): string;
  6125. /**
  6126. * Get the friendly name associated with the input class.
  6127. * @returns the input friendly name
  6128. */
  6129. getSimpleName(): string;
  6130. /**
  6131. * Attach the input controls to a specific dom element to get the input from.
  6132. * @param element Defines the element the controls should be listened from
  6133. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6134. */
  6135. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6136. /**
  6137. * Detach the current controls from the specified dom element.
  6138. * @param element Defines the element to stop listening the inputs from
  6139. */
  6140. detachControl(element: Nullable<HTMLElement>): void;
  6141. /**
  6142. * Update the current camera state depending on the inputs that have been used this frame.
  6143. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6144. */
  6145. checkInputs?: () => void;
  6146. }
  6147. /**
  6148. * Represents a map of input types to input instance or input index to input instance.
  6149. */
  6150. export interface CameraInputsMap<TCamera extends Camera> {
  6151. /**
  6152. * Accessor to the input by input type.
  6153. */
  6154. [name: string]: ICameraInput<TCamera>;
  6155. /**
  6156. * Accessor to the input by input index.
  6157. */
  6158. [idx: number]: ICameraInput<TCamera>;
  6159. }
  6160. /**
  6161. * This represents the input manager used within a camera.
  6162. * It helps dealing with all the different kind of input attached to a camera.
  6163. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6164. */
  6165. export class CameraInputsManager<TCamera extends Camera> {
  6166. /**
  6167. * Defines the list of inputs attahed to the camera.
  6168. */
  6169. attached: CameraInputsMap<TCamera>;
  6170. /**
  6171. * Defines the dom element the camera is collecting inputs from.
  6172. * This is null if the controls have not been attached.
  6173. */
  6174. attachedElement: Nullable<HTMLElement>;
  6175. /**
  6176. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6177. */
  6178. noPreventDefault: boolean;
  6179. /**
  6180. * Defined the camera the input manager belongs to.
  6181. */
  6182. camera: TCamera;
  6183. /**
  6184. * Update the current camera state depending on the inputs that have been used this frame.
  6185. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6186. */
  6187. checkInputs: () => void;
  6188. /**
  6189. * Instantiate a new Camera Input Manager.
  6190. * @param camera Defines the camera the input manager blongs to
  6191. */
  6192. constructor(camera: TCamera);
  6193. /**
  6194. * Add an input method to a camera
  6195. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6196. * @param input camera input method
  6197. */
  6198. add(input: ICameraInput<TCamera>): void;
  6199. /**
  6200. * Remove a specific input method from a camera
  6201. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6202. * @param inputToRemove camera input method
  6203. */
  6204. remove(inputToRemove: ICameraInput<TCamera>): void;
  6205. /**
  6206. * Remove a specific input type from a camera
  6207. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6208. * @param inputType the type of the input to remove
  6209. */
  6210. removeByType(inputType: string): void;
  6211. private _addCheckInputs;
  6212. /**
  6213. * Attach the input controls to the currently attached dom element to listen the events from.
  6214. * @param input Defines the input to attach
  6215. */
  6216. attachInput(input: ICameraInput<TCamera>): void;
  6217. /**
  6218. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6219. * @param element Defines the dom element to collect the events from
  6220. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6221. */
  6222. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6223. /**
  6224. * Detach the current manager inputs controls from a specific dom element.
  6225. * @param element Defines the dom element to collect the events from
  6226. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6227. */
  6228. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6229. /**
  6230. * Rebuild the dynamic inputCheck function from the current list of
  6231. * defined inputs in the manager.
  6232. */
  6233. rebuildInputCheck(): void;
  6234. /**
  6235. * Remove all attached input methods from a camera
  6236. */
  6237. clear(): void;
  6238. /**
  6239. * Serialize the current input manager attached to a camera.
  6240. * This ensures than once parsed,
  6241. * the input associated to the camera will be identical to the current ones
  6242. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6243. */
  6244. serialize(serializedCamera: any): void;
  6245. /**
  6246. * Parses an input manager serialized JSON to restore the previous list of inputs
  6247. * and states associated to a camera.
  6248. * @param parsedCamera Defines the JSON to parse
  6249. */
  6250. parse(parsedCamera: any): void;
  6251. }
  6252. }
  6253. declare module "babylonjs/Meshes/buffer" {
  6254. import { Nullable, DataArray } from "babylonjs/types";
  6255. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6256. /**
  6257. * Class used to store data that will be store in GPU memory
  6258. */
  6259. export class Buffer {
  6260. private _engine;
  6261. private _buffer;
  6262. /** @hidden */
  6263. _data: Nullable<DataArray>;
  6264. private _updatable;
  6265. private _instanced;
  6266. private _divisor;
  6267. /**
  6268. * Gets the byte stride.
  6269. */
  6270. readonly byteStride: number;
  6271. /**
  6272. * Constructor
  6273. * @param engine the engine
  6274. * @param data the data to use for this buffer
  6275. * @param updatable whether the data is updatable
  6276. * @param stride the stride (optional)
  6277. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6278. * @param instanced whether the buffer is instanced (optional)
  6279. * @param useBytes set to true if the stride in in bytes (optional)
  6280. * @param divisor sets an optional divisor for instances (1 by default)
  6281. */
  6282. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6283. /**
  6284. * Create a new VertexBuffer based on the current buffer
  6285. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6286. * @param offset defines offset in the buffer (0 by default)
  6287. * @param size defines the size in floats of attributes (position is 3 for instance)
  6288. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6289. * @param instanced defines if the vertex buffer contains indexed data
  6290. * @param useBytes defines if the offset and stride are in bytes *
  6291. * @param divisor sets an optional divisor for instances (1 by default)
  6292. * @returns the new vertex buffer
  6293. */
  6294. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6295. /**
  6296. * Gets a boolean indicating if the Buffer is updatable?
  6297. * @returns true if the buffer is updatable
  6298. */
  6299. isUpdatable(): boolean;
  6300. /**
  6301. * Gets current buffer's data
  6302. * @returns a DataArray or null
  6303. */
  6304. getData(): Nullable<DataArray>;
  6305. /**
  6306. * Gets underlying native buffer
  6307. * @returns underlying native buffer
  6308. */
  6309. getBuffer(): Nullable<DataBuffer>;
  6310. /**
  6311. * Gets the stride in float32 units (i.e. byte stride / 4).
  6312. * May not be an integer if the byte stride is not divisible by 4.
  6313. * DEPRECATED. Use byteStride instead.
  6314. * @returns the stride in float32 units
  6315. */
  6316. getStrideSize(): number;
  6317. /**
  6318. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6319. * @param data defines the data to store
  6320. */
  6321. create(data?: Nullable<DataArray>): void;
  6322. /** @hidden */
  6323. _rebuild(): void;
  6324. /**
  6325. * Update current buffer data
  6326. * @param data defines the data to store
  6327. */
  6328. update(data: DataArray): void;
  6329. /**
  6330. * Updates the data directly.
  6331. * @param data the new data
  6332. * @param offset the new offset
  6333. * @param vertexCount the vertex count (optional)
  6334. * @param useBytes set to true if the offset is in bytes
  6335. */
  6336. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6337. /**
  6338. * Release all resources
  6339. */
  6340. dispose(): void;
  6341. }
  6342. /**
  6343. * Specialized buffer used to store vertex data
  6344. */
  6345. export class VertexBuffer {
  6346. /** @hidden */
  6347. _buffer: Buffer;
  6348. private _kind;
  6349. private _size;
  6350. private _ownsBuffer;
  6351. private _instanced;
  6352. private _instanceDivisor;
  6353. /**
  6354. * The byte type.
  6355. */
  6356. static readonly BYTE: number;
  6357. /**
  6358. * The unsigned byte type.
  6359. */
  6360. static readonly UNSIGNED_BYTE: number;
  6361. /**
  6362. * The short type.
  6363. */
  6364. static readonly SHORT: number;
  6365. /**
  6366. * The unsigned short type.
  6367. */
  6368. static readonly UNSIGNED_SHORT: number;
  6369. /**
  6370. * The integer type.
  6371. */
  6372. static readonly INT: number;
  6373. /**
  6374. * The unsigned integer type.
  6375. */
  6376. static readonly UNSIGNED_INT: number;
  6377. /**
  6378. * The float type.
  6379. */
  6380. static readonly FLOAT: number;
  6381. /**
  6382. * Gets or sets the instance divisor when in instanced mode
  6383. */
  6384. instanceDivisor: number;
  6385. /**
  6386. * Gets the byte stride.
  6387. */
  6388. readonly byteStride: number;
  6389. /**
  6390. * Gets the byte offset.
  6391. */
  6392. readonly byteOffset: number;
  6393. /**
  6394. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6395. */
  6396. readonly normalized: boolean;
  6397. /**
  6398. * Gets the data type of each component in the array.
  6399. */
  6400. readonly type: number;
  6401. /**
  6402. * Constructor
  6403. * @param engine the engine
  6404. * @param data the data to use for this vertex buffer
  6405. * @param kind the vertex buffer kind
  6406. * @param updatable whether the data is updatable
  6407. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6408. * @param stride the stride (optional)
  6409. * @param instanced whether the buffer is instanced (optional)
  6410. * @param offset the offset of the data (optional)
  6411. * @param size the number of components (optional)
  6412. * @param type the type of the component (optional)
  6413. * @param normalized whether the data contains normalized data (optional)
  6414. * @param useBytes set to true if stride and offset are in bytes (optional)
  6415. * @param divisor defines the instance divisor to use (1 by default)
  6416. */
  6417. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6418. /** @hidden */
  6419. _rebuild(): void;
  6420. /**
  6421. * Returns the kind of the VertexBuffer (string)
  6422. * @returns a string
  6423. */
  6424. getKind(): string;
  6425. /**
  6426. * Gets a boolean indicating if the VertexBuffer is updatable?
  6427. * @returns true if the buffer is updatable
  6428. */
  6429. isUpdatable(): boolean;
  6430. /**
  6431. * Gets current buffer's data
  6432. * @returns a DataArray or null
  6433. */
  6434. getData(): Nullable<DataArray>;
  6435. /**
  6436. * Gets underlying native buffer
  6437. * @returns underlying native buffer
  6438. */
  6439. getBuffer(): Nullable<DataBuffer>;
  6440. /**
  6441. * Gets the stride in float32 units (i.e. byte stride / 4).
  6442. * May not be an integer if the byte stride is not divisible by 4.
  6443. * DEPRECATED. Use byteStride instead.
  6444. * @returns the stride in float32 units
  6445. */
  6446. getStrideSize(): number;
  6447. /**
  6448. * Returns the offset as a multiple of the type byte length.
  6449. * DEPRECATED. Use byteOffset instead.
  6450. * @returns the offset in bytes
  6451. */
  6452. getOffset(): number;
  6453. /**
  6454. * Returns the number of components per vertex attribute (integer)
  6455. * @returns the size in float
  6456. */
  6457. getSize(): number;
  6458. /**
  6459. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6460. * @returns true if this buffer is instanced
  6461. */
  6462. getIsInstanced(): boolean;
  6463. /**
  6464. * Returns the instancing divisor, zero for non-instanced (integer).
  6465. * @returns a number
  6466. */
  6467. getInstanceDivisor(): number;
  6468. /**
  6469. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6470. * @param data defines the data to store
  6471. */
  6472. create(data?: DataArray): void;
  6473. /**
  6474. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6475. * This function will create a new buffer if the current one is not updatable
  6476. * @param data defines the data to store
  6477. */
  6478. update(data: DataArray): void;
  6479. /**
  6480. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6481. * Returns the directly updated WebGLBuffer.
  6482. * @param data the new data
  6483. * @param offset the new offset
  6484. * @param useBytes set to true if the offset is in bytes
  6485. */
  6486. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6487. /**
  6488. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6489. */
  6490. dispose(): void;
  6491. /**
  6492. * Enumerates each value of this vertex buffer as numbers.
  6493. * @param count the number of values to enumerate
  6494. * @param callback the callback function called for each value
  6495. */
  6496. forEach(count: number, callback: (value: number, index: number) => void): void;
  6497. /**
  6498. * Positions
  6499. */
  6500. static readonly PositionKind: string;
  6501. /**
  6502. * Normals
  6503. */
  6504. static readonly NormalKind: string;
  6505. /**
  6506. * Tangents
  6507. */
  6508. static readonly TangentKind: string;
  6509. /**
  6510. * Texture coordinates
  6511. */
  6512. static readonly UVKind: string;
  6513. /**
  6514. * Texture coordinates 2
  6515. */
  6516. static readonly UV2Kind: string;
  6517. /**
  6518. * Texture coordinates 3
  6519. */
  6520. static readonly UV3Kind: string;
  6521. /**
  6522. * Texture coordinates 4
  6523. */
  6524. static readonly UV4Kind: string;
  6525. /**
  6526. * Texture coordinates 5
  6527. */
  6528. static readonly UV5Kind: string;
  6529. /**
  6530. * Texture coordinates 6
  6531. */
  6532. static readonly UV6Kind: string;
  6533. /**
  6534. * Colors
  6535. */
  6536. static readonly ColorKind: string;
  6537. /**
  6538. * Matrix indices (for bones)
  6539. */
  6540. static readonly MatricesIndicesKind: string;
  6541. /**
  6542. * Matrix weights (for bones)
  6543. */
  6544. static readonly MatricesWeightsKind: string;
  6545. /**
  6546. * Additional matrix indices (for bones)
  6547. */
  6548. static readonly MatricesIndicesExtraKind: string;
  6549. /**
  6550. * Additional matrix weights (for bones)
  6551. */
  6552. static readonly MatricesWeightsExtraKind: string;
  6553. /**
  6554. * Deduces the stride given a kind.
  6555. * @param kind The kind string to deduce
  6556. * @returns The deduced stride
  6557. */
  6558. static DeduceStride(kind: string): number;
  6559. /**
  6560. * Gets the byte length of the given type.
  6561. * @param type the type
  6562. * @returns the number of bytes
  6563. */
  6564. static GetTypeByteLength(type: number): number;
  6565. /**
  6566. * Enumerates each value of the given parameters as numbers.
  6567. * @param data the data to enumerate
  6568. * @param byteOffset the byte offset of the data
  6569. * @param byteStride the byte stride of the data
  6570. * @param componentCount the number of components per element
  6571. * @param componentType the type of the component
  6572. * @param count the number of values to enumerate
  6573. * @param normalized whether the data is normalized
  6574. * @param callback the callback function called for each value
  6575. */
  6576. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6577. private static _GetFloatValue;
  6578. }
  6579. }
  6580. declare module "babylonjs/Collisions/intersectionInfo" {
  6581. import { Nullable } from "babylonjs/types";
  6582. /**
  6583. * @hidden
  6584. */
  6585. export class IntersectionInfo {
  6586. bu: Nullable<number>;
  6587. bv: Nullable<number>;
  6588. distance: number;
  6589. faceId: number;
  6590. subMeshId: number;
  6591. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6592. }
  6593. }
  6594. declare module "babylonjs/Maths/math.plane" {
  6595. import { DeepImmutable } from "babylonjs/types";
  6596. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6597. /**
  6598. * Represens a plane by the equation ax + by + cz + d = 0
  6599. */
  6600. export class Plane {
  6601. private static _TmpMatrix;
  6602. /**
  6603. * Normal of the plane (a,b,c)
  6604. */
  6605. normal: Vector3;
  6606. /**
  6607. * d component of the plane
  6608. */
  6609. d: number;
  6610. /**
  6611. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6612. * @param a a component of the plane
  6613. * @param b b component of the plane
  6614. * @param c c component of the plane
  6615. * @param d d component of the plane
  6616. */
  6617. constructor(a: number, b: number, c: number, d: number);
  6618. /**
  6619. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6620. */
  6621. asArray(): number[];
  6622. /**
  6623. * @returns a new plane copied from the current Plane.
  6624. */
  6625. clone(): Plane;
  6626. /**
  6627. * @returns the string "Plane".
  6628. */
  6629. getClassName(): string;
  6630. /**
  6631. * @returns the Plane hash code.
  6632. */
  6633. getHashCode(): number;
  6634. /**
  6635. * Normalize the current Plane in place.
  6636. * @returns the updated Plane.
  6637. */
  6638. normalize(): Plane;
  6639. /**
  6640. * Applies a transformation the plane and returns the result
  6641. * @param transformation the transformation matrix to be applied to the plane
  6642. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6643. */
  6644. transform(transformation: DeepImmutable<Matrix>): Plane;
  6645. /**
  6646. * Calcualtte the dot product between the point and the plane normal
  6647. * @param point point to calculate the dot product with
  6648. * @returns the dot product (float) of the point coordinates and the plane normal.
  6649. */
  6650. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6651. /**
  6652. * Updates the current Plane from the plane defined by the three given points.
  6653. * @param point1 one of the points used to contruct the plane
  6654. * @param point2 one of the points used to contruct the plane
  6655. * @param point3 one of the points used to contruct the plane
  6656. * @returns the updated Plane.
  6657. */
  6658. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6659. /**
  6660. * Checks if the plane is facing a given direction
  6661. * @param direction the direction to check if the plane is facing
  6662. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6663. * @returns True is the vector "direction" is the same side than the plane normal.
  6664. */
  6665. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6666. /**
  6667. * Calculates the distance to a point
  6668. * @param point point to calculate distance to
  6669. * @returns the signed distance (float) from the given point to the Plane.
  6670. */
  6671. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6672. /**
  6673. * Creates a plane from an array
  6674. * @param array the array to create a plane from
  6675. * @returns a new Plane from the given array.
  6676. */
  6677. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6678. /**
  6679. * Creates a plane from three points
  6680. * @param point1 point used to create the plane
  6681. * @param point2 point used to create the plane
  6682. * @param point3 point used to create the plane
  6683. * @returns a new Plane defined by the three given points.
  6684. */
  6685. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6686. /**
  6687. * Creates a plane from an origin point and a normal
  6688. * @param origin origin of the plane to be constructed
  6689. * @param normal normal of the plane to be constructed
  6690. * @returns a new Plane the normal vector to this plane at the given origin point.
  6691. * Note : the vector "normal" is updated because normalized.
  6692. */
  6693. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6694. /**
  6695. * Calculates the distance from a plane and a point
  6696. * @param origin origin of the plane to be constructed
  6697. * @param normal normal of the plane to be constructed
  6698. * @param point point to calculate distance to
  6699. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6700. */
  6701. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6702. }
  6703. }
  6704. declare module "babylonjs/Culling/boundingSphere" {
  6705. import { DeepImmutable } from "babylonjs/types";
  6706. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6707. import { Plane } from "babylonjs/Maths/math.plane";
  6708. /**
  6709. * Class used to store bounding sphere information
  6710. */
  6711. export class BoundingSphere {
  6712. /**
  6713. * Gets the center of the bounding sphere in local space
  6714. */
  6715. readonly center: Vector3;
  6716. /**
  6717. * Radius of the bounding sphere in local space
  6718. */
  6719. radius: number;
  6720. /**
  6721. * Gets the center of the bounding sphere in world space
  6722. */
  6723. readonly centerWorld: Vector3;
  6724. /**
  6725. * Radius of the bounding sphere in world space
  6726. */
  6727. radiusWorld: number;
  6728. /**
  6729. * Gets the minimum vector in local space
  6730. */
  6731. readonly minimum: Vector3;
  6732. /**
  6733. * Gets the maximum vector in local space
  6734. */
  6735. readonly maximum: Vector3;
  6736. private _worldMatrix;
  6737. private static readonly TmpVector3;
  6738. /**
  6739. * Creates a new bounding sphere
  6740. * @param min defines the minimum vector (in local space)
  6741. * @param max defines the maximum vector (in local space)
  6742. * @param worldMatrix defines the new world matrix
  6743. */
  6744. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6745. /**
  6746. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6747. * @param min defines the new minimum vector (in local space)
  6748. * @param max defines the new maximum vector (in local space)
  6749. * @param worldMatrix defines the new world matrix
  6750. */
  6751. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6752. /**
  6753. * Scale the current bounding sphere by applying a scale factor
  6754. * @param factor defines the scale factor to apply
  6755. * @returns the current bounding box
  6756. */
  6757. scale(factor: number): BoundingSphere;
  6758. /**
  6759. * Gets the world matrix of the bounding box
  6760. * @returns a matrix
  6761. */
  6762. getWorldMatrix(): DeepImmutable<Matrix>;
  6763. /** @hidden */
  6764. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6765. /**
  6766. * Tests if the bounding sphere is intersecting the frustum planes
  6767. * @param frustumPlanes defines the frustum planes to test
  6768. * @returns true if there is an intersection
  6769. */
  6770. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6771. /**
  6772. * Tests if the bounding sphere center is in between the frustum planes.
  6773. * Used for optimistic fast inclusion.
  6774. * @param frustumPlanes defines the frustum planes to test
  6775. * @returns true if the sphere center is in between the frustum planes
  6776. */
  6777. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6778. /**
  6779. * Tests if a point is inside the bounding sphere
  6780. * @param point defines the point to test
  6781. * @returns true if the point is inside the bounding sphere
  6782. */
  6783. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6784. /**
  6785. * Checks if two sphere intersct
  6786. * @param sphere0 sphere 0
  6787. * @param sphere1 sphere 1
  6788. * @returns true if the speres intersect
  6789. */
  6790. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6791. }
  6792. }
  6793. declare module "babylonjs/Culling/boundingBox" {
  6794. import { DeepImmutable } from "babylonjs/types";
  6795. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6796. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6797. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6798. import { Plane } from "babylonjs/Maths/math.plane";
  6799. /**
  6800. * Class used to store bounding box information
  6801. */
  6802. export class BoundingBox implements ICullable {
  6803. /**
  6804. * Gets the 8 vectors representing the bounding box in local space
  6805. */
  6806. readonly vectors: Vector3[];
  6807. /**
  6808. * Gets the center of the bounding box in local space
  6809. */
  6810. readonly center: Vector3;
  6811. /**
  6812. * Gets the center of the bounding box in world space
  6813. */
  6814. readonly centerWorld: Vector3;
  6815. /**
  6816. * Gets the extend size in local space
  6817. */
  6818. readonly extendSize: Vector3;
  6819. /**
  6820. * Gets the extend size in world space
  6821. */
  6822. readonly extendSizeWorld: Vector3;
  6823. /**
  6824. * Gets the OBB (object bounding box) directions
  6825. */
  6826. readonly directions: Vector3[];
  6827. /**
  6828. * Gets the 8 vectors representing the bounding box in world space
  6829. */
  6830. readonly vectorsWorld: Vector3[];
  6831. /**
  6832. * Gets the minimum vector in world space
  6833. */
  6834. readonly minimumWorld: Vector3;
  6835. /**
  6836. * Gets the maximum vector in world space
  6837. */
  6838. readonly maximumWorld: Vector3;
  6839. /**
  6840. * Gets the minimum vector in local space
  6841. */
  6842. readonly minimum: Vector3;
  6843. /**
  6844. * Gets the maximum vector in local space
  6845. */
  6846. readonly maximum: Vector3;
  6847. private _worldMatrix;
  6848. private static readonly TmpVector3;
  6849. /**
  6850. * @hidden
  6851. */
  6852. _tag: number;
  6853. /**
  6854. * Creates a new bounding box
  6855. * @param min defines the minimum vector (in local space)
  6856. * @param max defines the maximum vector (in local space)
  6857. * @param worldMatrix defines the new world matrix
  6858. */
  6859. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6860. /**
  6861. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6862. * @param min defines the new minimum vector (in local space)
  6863. * @param max defines the new maximum vector (in local space)
  6864. * @param worldMatrix defines the new world matrix
  6865. */
  6866. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6867. /**
  6868. * Scale the current bounding box by applying a scale factor
  6869. * @param factor defines the scale factor to apply
  6870. * @returns the current bounding box
  6871. */
  6872. scale(factor: number): BoundingBox;
  6873. /**
  6874. * Gets the world matrix of the bounding box
  6875. * @returns a matrix
  6876. */
  6877. getWorldMatrix(): DeepImmutable<Matrix>;
  6878. /** @hidden */
  6879. _update(world: DeepImmutable<Matrix>): void;
  6880. /**
  6881. * Tests if the bounding box is intersecting the frustum planes
  6882. * @param frustumPlanes defines the frustum planes to test
  6883. * @returns true if there is an intersection
  6884. */
  6885. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6886. /**
  6887. * Tests if the bounding box is entirely inside the frustum planes
  6888. * @param frustumPlanes defines the frustum planes to test
  6889. * @returns true if there is an inclusion
  6890. */
  6891. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6892. /**
  6893. * Tests if a point is inside the bounding box
  6894. * @param point defines the point to test
  6895. * @returns true if the point is inside the bounding box
  6896. */
  6897. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6898. /**
  6899. * Tests if the bounding box intersects with a bounding sphere
  6900. * @param sphere defines the sphere to test
  6901. * @returns true if there is an intersection
  6902. */
  6903. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  6904. /**
  6905. * Tests if the bounding box intersects with a box defined by a min and max vectors
  6906. * @param min defines the min vector to use
  6907. * @param max defines the max vector to use
  6908. * @returns true if there is an intersection
  6909. */
  6910. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  6911. /**
  6912. * Tests if two bounding boxes are intersections
  6913. * @param box0 defines the first box to test
  6914. * @param box1 defines the second box to test
  6915. * @returns true if there is an intersection
  6916. */
  6917. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  6918. /**
  6919. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  6920. * @param minPoint defines the minimum vector of the bounding box
  6921. * @param maxPoint defines the maximum vector of the bounding box
  6922. * @param sphereCenter defines the sphere center
  6923. * @param sphereRadius defines the sphere radius
  6924. * @returns true if there is an intersection
  6925. */
  6926. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  6927. /**
  6928. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  6929. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6930. * @param frustumPlanes defines the frustum planes to test
  6931. * @return true if there is an inclusion
  6932. */
  6933. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6934. /**
  6935. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  6936. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6937. * @param frustumPlanes defines the frustum planes to test
  6938. * @return true if there is an intersection
  6939. */
  6940. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6941. }
  6942. }
  6943. declare module "babylonjs/Collisions/collider" {
  6944. import { Nullable, IndicesArray } from "babylonjs/types";
  6945. import { Vector3 } from "babylonjs/Maths/math.vector";
  6946. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  6947. import { Plane } from "babylonjs/Maths/math.plane";
  6948. /** @hidden */
  6949. export class Collider {
  6950. /** Define if a collision was found */
  6951. collisionFound: boolean;
  6952. /**
  6953. * Define last intersection point in local space
  6954. */
  6955. intersectionPoint: Vector3;
  6956. /**
  6957. * Define last collided mesh
  6958. */
  6959. collidedMesh: Nullable<AbstractMesh>;
  6960. private _collisionPoint;
  6961. private _planeIntersectionPoint;
  6962. private _tempVector;
  6963. private _tempVector2;
  6964. private _tempVector3;
  6965. private _tempVector4;
  6966. private _edge;
  6967. private _baseToVertex;
  6968. private _destinationPoint;
  6969. private _slidePlaneNormal;
  6970. private _displacementVector;
  6971. /** @hidden */
  6972. _radius: Vector3;
  6973. /** @hidden */
  6974. _retry: number;
  6975. private _velocity;
  6976. private _basePoint;
  6977. private _epsilon;
  6978. /** @hidden */
  6979. _velocityWorldLength: number;
  6980. /** @hidden */
  6981. _basePointWorld: Vector3;
  6982. private _velocityWorld;
  6983. private _normalizedVelocity;
  6984. /** @hidden */
  6985. _initialVelocity: Vector3;
  6986. /** @hidden */
  6987. _initialPosition: Vector3;
  6988. private _nearestDistance;
  6989. private _collisionMask;
  6990. collisionMask: number;
  6991. /**
  6992. * Gets the plane normal used to compute the sliding response (in local space)
  6993. */
  6994. readonly slidePlaneNormal: Vector3;
  6995. /** @hidden */
  6996. _initialize(source: Vector3, dir: Vector3, e: number): void;
  6997. /** @hidden */
  6998. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  6999. /** @hidden */
  7000. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7001. /** @hidden */
  7002. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7003. /** @hidden */
  7004. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7005. /** @hidden */
  7006. _getResponse(pos: Vector3, vel: Vector3): void;
  7007. }
  7008. }
  7009. declare module "babylonjs/Culling/boundingInfo" {
  7010. import { DeepImmutable } from "babylonjs/types";
  7011. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7012. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7013. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7014. import { Plane } from "babylonjs/Maths/math.plane";
  7015. import { Collider } from "babylonjs/Collisions/collider";
  7016. /**
  7017. * Interface for cullable objects
  7018. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7019. */
  7020. export interface ICullable {
  7021. /**
  7022. * Checks if the object or part of the object is in the frustum
  7023. * @param frustumPlanes Camera near/planes
  7024. * @returns true if the object is in frustum otherwise false
  7025. */
  7026. isInFrustum(frustumPlanes: Plane[]): boolean;
  7027. /**
  7028. * Checks if a cullable object (mesh...) is in the camera frustum
  7029. * Unlike isInFrustum this cheks the full bounding box
  7030. * @param frustumPlanes Camera near/planes
  7031. * @returns true if the object is in frustum otherwise false
  7032. */
  7033. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7034. }
  7035. /**
  7036. * Info for a bounding data of a mesh
  7037. */
  7038. export class BoundingInfo implements ICullable {
  7039. /**
  7040. * Bounding box for the mesh
  7041. */
  7042. readonly boundingBox: BoundingBox;
  7043. /**
  7044. * Bounding sphere for the mesh
  7045. */
  7046. readonly boundingSphere: BoundingSphere;
  7047. private _isLocked;
  7048. private static readonly TmpVector3;
  7049. /**
  7050. * Constructs bounding info
  7051. * @param minimum min vector of the bounding box/sphere
  7052. * @param maximum max vector of the bounding box/sphere
  7053. * @param worldMatrix defines the new world matrix
  7054. */
  7055. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7056. /**
  7057. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7058. * @param min defines the new minimum vector (in local space)
  7059. * @param max defines the new maximum vector (in local space)
  7060. * @param worldMatrix defines the new world matrix
  7061. */
  7062. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7063. /**
  7064. * min vector of the bounding box/sphere
  7065. */
  7066. readonly minimum: Vector3;
  7067. /**
  7068. * max vector of the bounding box/sphere
  7069. */
  7070. readonly maximum: Vector3;
  7071. /**
  7072. * If the info is locked and won't be updated to avoid perf overhead
  7073. */
  7074. isLocked: boolean;
  7075. /**
  7076. * Updates the bounding sphere and box
  7077. * @param world world matrix to be used to update
  7078. */
  7079. update(world: DeepImmutable<Matrix>): void;
  7080. /**
  7081. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7082. * @param center New center of the bounding info
  7083. * @param extend New extend of the bounding info
  7084. * @returns the current bounding info
  7085. */
  7086. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7087. /**
  7088. * Scale the current bounding info by applying a scale factor
  7089. * @param factor defines the scale factor to apply
  7090. * @returns the current bounding info
  7091. */
  7092. scale(factor: number): BoundingInfo;
  7093. /**
  7094. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7095. * @param frustumPlanes defines the frustum to test
  7096. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7097. * @returns true if the bounding info is in the frustum planes
  7098. */
  7099. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7100. /**
  7101. * Gets the world distance between the min and max points of the bounding box
  7102. */
  7103. readonly diagonalLength: number;
  7104. /**
  7105. * Checks if a cullable object (mesh...) is in the camera frustum
  7106. * Unlike isInFrustum this cheks the full bounding box
  7107. * @param frustumPlanes Camera near/planes
  7108. * @returns true if the object is in frustum otherwise false
  7109. */
  7110. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7111. /** @hidden */
  7112. _checkCollision(collider: Collider): boolean;
  7113. /**
  7114. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7115. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7116. * @param point the point to check intersection with
  7117. * @returns if the point intersects
  7118. */
  7119. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7120. /**
  7121. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7122. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7123. * @param boundingInfo the bounding info to check intersection with
  7124. * @param precise if the intersection should be done using OBB
  7125. * @returns if the bounding info intersects
  7126. */
  7127. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7128. }
  7129. }
  7130. declare module "babylonjs/Maths/math.functions" {
  7131. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7132. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7133. /**
  7134. * Extracts minimum and maximum values from a list of indexed positions
  7135. * @param positions defines the positions to use
  7136. * @param indices defines the indices to the positions
  7137. * @param indexStart defines the start index
  7138. * @param indexCount defines the end index
  7139. * @param bias defines bias value to add to the result
  7140. * @return minimum and maximum values
  7141. */
  7142. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7143. minimum: Vector3;
  7144. maximum: Vector3;
  7145. };
  7146. /**
  7147. * Extracts minimum and maximum values from a list of positions
  7148. * @param positions defines the positions to use
  7149. * @param start defines the start index in the positions array
  7150. * @param count defines the number of positions to handle
  7151. * @param bias defines bias value to add to the result
  7152. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7153. * @return minimum and maximum values
  7154. */
  7155. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7156. minimum: Vector3;
  7157. maximum: Vector3;
  7158. };
  7159. }
  7160. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7161. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7162. /** @hidden */
  7163. export class WebGLDataBuffer extends DataBuffer {
  7164. private _buffer;
  7165. constructor(resource: WebGLBuffer);
  7166. readonly underlyingResource: any;
  7167. }
  7168. }
  7169. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7170. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7171. import { Nullable } from "babylonjs/types";
  7172. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7173. /** @hidden */
  7174. export class WebGLPipelineContext implements IPipelineContext {
  7175. engine: ThinEngine;
  7176. program: Nullable<WebGLProgram>;
  7177. context?: WebGLRenderingContext;
  7178. vertexShader?: WebGLShader;
  7179. fragmentShader?: WebGLShader;
  7180. isParallelCompiled: boolean;
  7181. onCompiled?: () => void;
  7182. transformFeedback?: WebGLTransformFeedback | null;
  7183. readonly isAsync: boolean;
  7184. readonly isReady: boolean;
  7185. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7186. }
  7187. }
  7188. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7189. import { FloatArray, Nullable } from "babylonjs/types";
  7190. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7191. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7192. module "babylonjs/Engines/thinEngine" {
  7193. interface ThinEngine {
  7194. /**
  7195. * Create an uniform buffer
  7196. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7197. * @param elements defines the content of the uniform buffer
  7198. * @returns the webGL uniform buffer
  7199. */
  7200. createUniformBuffer(elements: FloatArray): DataBuffer;
  7201. /**
  7202. * Create a dynamic uniform buffer
  7203. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7204. * @param elements defines the content of the uniform buffer
  7205. * @returns the webGL uniform buffer
  7206. */
  7207. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7208. /**
  7209. * Update an existing uniform buffer
  7210. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7211. * @param uniformBuffer defines the target uniform buffer
  7212. * @param elements defines the content to update
  7213. * @param offset defines the offset in the uniform buffer where update should start
  7214. * @param count defines the size of the data to update
  7215. */
  7216. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7217. /**
  7218. * Bind an uniform buffer to the current webGL context
  7219. * @param buffer defines the buffer to bind
  7220. */
  7221. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7222. /**
  7223. * Bind a buffer to the current webGL context at a given location
  7224. * @param buffer defines the buffer to bind
  7225. * @param location defines the index where to bind the buffer
  7226. */
  7227. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7228. /**
  7229. * Bind a specific block at a given index in a specific shader program
  7230. * @param pipelineContext defines the pipeline context to use
  7231. * @param blockName defines the block name
  7232. * @param index defines the index where to bind the block
  7233. */
  7234. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7235. }
  7236. }
  7237. }
  7238. declare module "babylonjs/Materials/uniformBuffer" {
  7239. import { Nullable, FloatArray } from "babylonjs/types";
  7240. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7241. import { Engine } from "babylonjs/Engines/engine";
  7242. import { Effect } from "babylonjs/Materials/effect";
  7243. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7244. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7245. import { Color3 } from "babylonjs/Maths/math.color";
  7246. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7247. /**
  7248. * Uniform buffer objects.
  7249. *
  7250. * Handles blocks of uniform on the GPU.
  7251. *
  7252. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7253. *
  7254. * For more information, please refer to :
  7255. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7256. */
  7257. export class UniformBuffer {
  7258. private _engine;
  7259. private _buffer;
  7260. private _data;
  7261. private _bufferData;
  7262. private _dynamic?;
  7263. private _uniformLocations;
  7264. private _uniformSizes;
  7265. private _uniformLocationPointer;
  7266. private _needSync;
  7267. private _noUBO;
  7268. private _currentEffect;
  7269. /** @hidden */
  7270. _alreadyBound: boolean;
  7271. private static _MAX_UNIFORM_SIZE;
  7272. private static _tempBuffer;
  7273. /**
  7274. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7275. * This is dynamic to allow compat with webgl 1 and 2.
  7276. * You will need to pass the name of the uniform as well as the value.
  7277. */
  7278. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7279. /**
  7280. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7281. * This is dynamic to allow compat with webgl 1 and 2.
  7282. * You will need to pass the name of the uniform as well as the value.
  7283. */
  7284. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7285. /**
  7286. * Lambda to Update a single float in a uniform buffer.
  7287. * This is dynamic to allow compat with webgl 1 and 2.
  7288. * You will need to pass the name of the uniform as well as the value.
  7289. */
  7290. updateFloat: (name: string, x: number) => void;
  7291. /**
  7292. * Lambda to Update a vec2 of float in a uniform buffer.
  7293. * This is dynamic to allow compat with webgl 1 and 2.
  7294. * You will need to pass the name of the uniform as well as the value.
  7295. */
  7296. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7297. /**
  7298. * Lambda to Update a vec3 of float in a uniform buffer.
  7299. * This is dynamic to allow compat with webgl 1 and 2.
  7300. * You will need to pass the name of the uniform as well as the value.
  7301. */
  7302. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7303. /**
  7304. * Lambda to Update a vec4 of float in a uniform buffer.
  7305. * This is dynamic to allow compat with webgl 1 and 2.
  7306. * You will need to pass the name of the uniform as well as the value.
  7307. */
  7308. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7309. /**
  7310. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7311. * This is dynamic to allow compat with webgl 1 and 2.
  7312. * You will need to pass the name of the uniform as well as the value.
  7313. */
  7314. updateMatrix: (name: string, mat: Matrix) => void;
  7315. /**
  7316. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7317. * This is dynamic to allow compat with webgl 1 and 2.
  7318. * You will need to pass the name of the uniform as well as the value.
  7319. */
  7320. updateVector3: (name: string, vector: Vector3) => void;
  7321. /**
  7322. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7323. * This is dynamic to allow compat with webgl 1 and 2.
  7324. * You will need to pass the name of the uniform as well as the value.
  7325. */
  7326. updateVector4: (name: string, vector: Vector4) => void;
  7327. /**
  7328. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7329. * This is dynamic to allow compat with webgl 1 and 2.
  7330. * You will need to pass the name of the uniform as well as the value.
  7331. */
  7332. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7333. /**
  7334. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7335. * This is dynamic to allow compat with webgl 1 and 2.
  7336. * You will need to pass the name of the uniform as well as the value.
  7337. */
  7338. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7339. /**
  7340. * Instantiates a new Uniform buffer objects.
  7341. *
  7342. * Handles blocks of uniform on the GPU.
  7343. *
  7344. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7345. *
  7346. * For more information, please refer to :
  7347. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7348. * @param engine Define the engine the buffer is associated with
  7349. * @param data Define the data contained in the buffer
  7350. * @param dynamic Define if the buffer is updatable
  7351. */
  7352. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7353. /**
  7354. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7355. * or just falling back on setUniformXXX calls.
  7356. */
  7357. readonly useUbo: boolean;
  7358. /**
  7359. * Indicates if the WebGL underlying uniform buffer is in sync
  7360. * with the javascript cache data.
  7361. */
  7362. readonly isSync: boolean;
  7363. /**
  7364. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7365. * Also, a dynamic UniformBuffer will disable cache verification and always
  7366. * update the underlying WebGL uniform buffer to the GPU.
  7367. * @returns if Dynamic, otherwise false
  7368. */
  7369. isDynamic(): boolean;
  7370. /**
  7371. * The data cache on JS side.
  7372. * @returns the underlying data as a float array
  7373. */
  7374. getData(): Float32Array;
  7375. /**
  7376. * The underlying WebGL Uniform buffer.
  7377. * @returns the webgl buffer
  7378. */
  7379. getBuffer(): Nullable<DataBuffer>;
  7380. /**
  7381. * std140 layout specifies how to align data within an UBO structure.
  7382. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7383. * for specs.
  7384. */
  7385. private _fillAlignment;
  7386. /**
  7387. * Adds an uniform in the buffer.
  7388. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7389. * for the layout to be correct !
  7390. * @param name Name of the uniform, as used in the uniform block in the shader.
  7391. * @param size Data size, or data directly.
  7392. */
  7393. addUniform(name: string, size: number | number[]): void;
  7394. /**
  7395. * Adds a Matrix 4x4 to the uniform buffer.
  7396. * @param name Name of the uniform, as used in the uniform block in the shader.
  7397. * @param mat A 4x4 matrix.
  7398. */
  7399. addMatrix(name: string, mat: Matrix): void;
  7400. /**
  7401. * Adds a vec2 to the uniform buffer.
  7402. * @param name Name of the uniform, as used in the uniform block in the shader.
  7403. * @param x Define the x component value of the vec2
  7404. * @param y Define the y component value of the vec2
  7405. */
  7406. addFloat2(name: string, x: number, y: number): void;
  7407. /**
  7408. * Adds a vec3 to the uniform buffer.
  7409. * @param name Name of the uniform, as used in the uniform block in the shader.
  7410. * @param x Define the x component value of the vec3
  7411. * @param y Define the y component value of the vec3
  7412. * @param z Define the z component value of the vec3
  7413. */
  7414. addFloat3(name: string, x: number, y: number, z: number): void;
  7415. /**
  7416. * Adds a vec3 to the uniform buffer.
  7417. * @param name Name of the uniform, as used in the uniform block in the shader.
  7418. * @param color Define the vec3 from a Color
  7419. */
  7420. addColor3(name: string, color: Color3): void;
  7421. /**
  7422. * Adds a vec4 to the uniform buffer.
  7423. * @param name Name of the uniform, as used in the uniform block in the shader.
  7424. * @param color Define the rgb components from a Color
  7425. * @param alpha Define the a component of the vec4
  7426. */
  7427. addColor4(name: string, color: Color3, alpha: number): void;
  7428. /**
  7429. * Adds a vec3 to the uniform buffer.
  7430. * @param name Name of the uniform, as used in the uniform block in the shader.
  7431. * @param vector Define the vec3 components from a Vector
  7432. */
  7433. addVector3(name: string, vector: Vector3): void;
  7434. /**
  7435. * Adds a Matrix 3x3 to the uniform buffer.
  7436. * @param name Name of the uniform, as used in the uniform block in the shader.
  7437. */
  7438. addMatrix3x3(name: string): void;
  7439. /**
  7440. * Adds a Matrix 2x2 to the uniform buffer.
  7441. * @param name Name of the uniform, as used in the uniform block in the shader.
  7442. */
  7443. addMatrix2x2(name: string): void;
  7444. /**
  7445. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7446. */
  7447. create(): void;
  7448. /** @hidden */
  7449. _rebuild(): void;
  7450. /**
  7451. * Updates the WebGL Uniform Buffer on the GPU.
  7452. * If the `dynamic` flag is set to true, no cache comparison is done.
  7453. * Otherwise, the buffer will be updated only if the cache differs.
  7454. */
  7455. update(): void;
  7456. /**
  7457. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7458. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7459. * @param data Define the flattened data
  7460. * @param size Define the size of the data.
  7461. */
  7462. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7463. private _valueCache;
  7464. private _cacheMatrix;
  7465. private _updateMatrix3x3ForUniform;
  7466. private _updateMatrix3x3ForEffect;
  7467. private _updateMatrix2x2ForEffect;
  7468. private _updateMatrix2x2ForUniform;
  7469. private _updateFloatForEffect;
  7470. private _updateFloatForUniform;
  7471. private _updateFloat2ForEffect;
  7472. private _updateFloat2ForUniform;
  7473. private _updateFloat3ForEffect;
  7474. private _updateFloat3ForUniform;
  7475. private _updateFloat4ForEffect;
  7476. private _updateFloat4ForUniform;
  7477. private _updateMatrixForEffect;
  7478. private _updateMatrixForUniform;
  7479. private _updateVector3ForEffect;
  7480. private _updateVector3ForUniform;
  7481. private _updateVector4ForEffect;
  7482. private _updateVector4ForUniform;
  7483. private _updateColor3ForEffect;
  7484. private _updateColor3ForUniform;
  7485. private _updateColor4ForEffect;
  7486. private _updateColor4ForUniform;
  7487. /**
  7488. * Sets a sampler uniform on the effect.
  7489. * @param name Define the name of the sampler.
  7490. * @param texture Define the texture to set in the sampler
  7491. */
  7492. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7493. /**
  7494. * Directly updates the value of the uniform in the cache AND on the GPU.
  7495. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7496. * @param data Define the flattened data
  7497. */
  7498. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7499. /**
  7500. * Binds this uniform buffer to an effect.
  7501. * @param effect Define the effect to bind the buffer to
  7502. * @param name Name of the uniform block in the shader.
  7503. */
  7504. bindToEffect(effect: Effect, name: string): void;
  7505. /**
  7506. * Disposes the uniform buffer.
  7507. */
  7508. dispose(): void;
  7509. }
  7510. }
  7511. declare module "babylonjs/Misc/iInspectable" {
  7512. /**
  7513. * Enum that determines the text-wrapping mode to use.
  7514. */
  7515. export enum InspectableType {
  7516. /**
  7517. * Checkbox for booleans
  7518. */
  7519. Checkbox = 0,
  7520. /**
  7521. * Sliders for numbers
  7522. */
  7523. Slider = 1,
  7524. /**
  7525. * Vector3
  7526. */
  7527. Vector3 = 2,
  7528. /**
  7529. * Quaternions
  7530. */
  7531. Quaternion = 3,
  7532. /**
  7533. * Color3
  7534. */
  7535. Color3 = 4,
  7536. /**
  7537. * String
  7538. */
  7539. String = 5
  7540. }
  7541. /**
  7542. * Interface used to define custom inspectable properties.
  7543. * This interface is used by the inspector to display custom property grids
  7544. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7545. */
  7546. export interface IInspectable {
  7547. /**
  7548. * Gets the label to display
  7549. */
  7550. label: string;
  7551. /**
  7552. * Gets the name of the property to edit
  7553. */
  7554. propertyName: string;
  7555. /**
  7556. * Gets the type of the editor to use
  7557. */
  7558. type: InspectableType;
  7559. /**
  7560. * Gets the minimum value of the property when using in "slider" mode
  7561. */
  7562. min?: number;
  7563. /**
  7564. * Gets the maximum value of the property when using in "slider" mode
  7565. */
  7566. max?: number;
  7567. /**
  7568. * Gets the setp to use when using in "slider" mode
  7569. */
  7570. step?: number;
  7571. }
  7572. }
  7573. declare module "babylonjs/Misc/timingTools" {
  7574. /**
  7575. * Class used to provide helper for timing
  7576. */
  7577. export class TimingTools {
  7578. /**
  7579. * Polyfill for setImmediate
  7580. * @param action defines the action to execute after the current execution block
  7581. */
  7582. static SetImmediate(action: () => void): void;
  7583. }
  7584. }
  7585. declare module "babylonjs/Misc/instantiationTools" {
  7586. /**
  7587. * Class used to enable instatition of objects by class name
  7588. */
  7589. export class InstantiationTools {
  7590. /**
  7591. * Use this object to register external classes like custom textures or material
  7592. * to allow the laoders to instantiate them
  7593. */
  7594. static RegisteredExternalClasses: {
  7595. [key: string]: Object;
  7596. };
  7597. /**
  7598. * Tries to instantiate a new object from a given class name
  7599. * @param className defines the class name to instantiate
  7600. * @returns the new object or null if the system was not able to do the instantiation
  7601. */
  7602. static Instantiate(className: string): any;
  7603. }
  7604. }
  7605. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7606. /**
  7607. * Define options used to create a depth texture
  7608. */
  7609. export class DepthTextureCreationOptions {
  7610. /** Specifies whether or not a stencil should be allocated in the texture */
  7611. generateStencil?: boolean;
  7612. /** Specifies whether or not bilinear filtering is enable on the texture */
  7613. bilinearFiltering?: boolean;
  7614. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7615. comparisonFunction?: number;
  7616. /** Specifies if the created texture is a cube texture */
  7617. isCube?: boolean;
  7618. }
  7619. }
  7620. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7621. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7622. import { Nullable } from "babylonjs/types";
  7623. import { Scene } from "babylonjs/scene";
  7624. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7625. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7626. module "babylonjs/Engines/thinEngine" {
  7627. interface ThinEngine {
  7628. /**
  7629. * Creates a depth stencil cube texture.
  7630. * This is only available in WebGL 2.
  7631. * @param size The size of face edge in the cube texture.
  7632. * @param options The options defining the cube texture.
  7633. * @returns The cube texture
  7634. */
  7635. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7636. /**
  7637. * Creates a cube texture
  7638. * @param rootUrl defines the url where the files to load is located
  7639. * @param scene defines the current scene
  7640. * @param files defines the list of files to load (1 per face)
  7641. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7642. * @param onLoad defines an optional callback raised when the texture is loaded
  7643. * @param onError defines an optional callback raised if there is an issue to load the texture
  7644. * @param format defines the format of the data
  7645. * @param forcedExtension defines the extension to use to pick the right loader
  7646. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7647. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7648. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7649. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7650. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7651. * @returns the cube texture as an InternalTexture
  7652. */
  7653. 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;
  7654. /**
  7655. * Creates a cube texture
  7656. * @param rootUrl defines the url where the files to load is located
  7657. * @param scene defines the current scene
  7658. * @param files defines the list of files to load (1 per face)
  7659. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7660. * @param onLoad defines an optional callback raised when the texture is loaded
  7661. * @param onError defines an optional callback raised if there is an issue to load the texture
  7662. * @param format defines the format of the data
  7663. * @param forcedExtension defines the extension to use to pick the right loader
  7664. * @returns the cube texture as an InternalTexture
  7665. */
  7666. 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;
  7667. /**
  7668. * Creates a cube texture
  7669. * @param rootUrl defines the url where the files to load is located
  7670. * @param scene defines the current scene
  7671. * @param files defines the list of files to load (1 per face)
  7672. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7673. * @param onLoad defines an optional callback raised when the texture is loaded
  7674. * @param onError defines an optional callback raised if there is an issue to load the texture
  7675. * @param format defines the format of the data
  7676. * @param forcedExtension defines the extension to use to pick the right loader
  7677. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7678. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7679. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7680. * @returns the cube texture as an InternalTexture
  7681. */
  7682. 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;
  7683. /** @hidden */
  7684. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7685. /** @hidden */
  7686. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7687. /** @hidden */
  7688. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7689. /** @hidden */
  7690. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7691. /**
  7692. * @hidden
  7693. */
  7694. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7695. }
  7696. }
  7697. }
  7698. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7699. import { Nullable } from "babylonjs/types";
  7700. import { Scene } from "babylonjs/scene";
  7701. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7702. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7703. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7704. /**
  7705. * Class for creating a cube texture
  7706. */
  7707. export class CubeTexture extends BaseTexture {
  7708. private _delayedOnLoad;
  7709. /**
  7710. * The url of the texture
  7711. */
  7712. url: string;
  7713. /**
  7714. * Gets or sets the center of the bounding box associated with the cube texture.
  7715. * It must define where the camera used to render the texture was set
  7716. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7717. */
  7718. boundingBoxPosition: Vector3;
  7719. private _boundingBoxSize;
  7720. /**
  7721. * Gets or sets the size of the bounding box associated with the cube texture
  7722. * When defined, the cubemap will switch to local mode
  7723. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7724. * @example https://www.babylonjs-playground.com/#RNASML
  7725. */
  7726. /**
  7727. * Returns the bounding box size
  7728. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7729. */
  7730. boundingBoxSize: Vector3;
  7731. protected _rotationY: number;
  7732. /**
  7733. * Sets texture matrix rotation angle around Y axis in radians.
  7734. */
  7735. /**
  7736. * Gets texture matrix rotation angle around Y axis radians.
  7737. */
  7738. rotationY: number;
  7739. /**
  7740. * Are mip maps generated for this texture or not.
  7741. */
  7742. readonly noMipmap: boolean;
  7743. private _noMipmap;
  7744. private _files;
  7745. protected _forcedExtension: Nullable<string>;
  7746. private _extensions;
  7747. private _textureMatrix;
  7748. private _format;
  7749. private _createPolynomials;
  7750. /** @hidden */
  7751. _prefiltered: boolean;
  7752. /**
  7753. * Creates a cube texture from an array of image urls
  7754. * @param files defines an array of image urls
  7755. * @param scene defines the hosting scene
  7756. * @param noMipmap specifies if mip maps are not used
  7757. * @returns a cube texture
  7758. */
  7759. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7760. /**
  7761. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7762. * @param url defines the url of the prefiltered texture
  7763. * @param scene defines the scene the texture is attached to
  7764. * @param forcedExtension defines the extension of the file if different from the url
  7765. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7766. * @return the prefiltered texture
  7767. */
  7768. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7769. /**
  7770. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7771. * as prefiltered data.
  7772. * @param rootUrl defines the url of the texture or the root name of the six images
  7773. * @param scene defines the scene the texture is attached to
  7774. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7775. * @param noMipmap defines if mipmaps should be created or not
  7776. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7777. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7778. * @param onError defines a callback triggered in case of error during load
  7779. * @param format defines the internal format to use for the texture once loaded
  7780. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7781. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7782. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7783. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7784. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7785. * @return the cube texture
  7786. */
  7787. 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);
  7788. /**
  7789. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7790. */
  7791. readonly isPrefiltered: boolean;
  7792. /**
  7793. * Get the current class name of the texture useful for serialization or dynamic coding.
  7794. * @returns "CubeTexture"
  7795. */
  7796. getClassName(): string;
  7797. /**
  7798. * Update the url (and optional buffer) of this texture if url was null during construction.
  7799. * @param url the url of the texture
  7800. * @param forcedExtension defines the extension to use
  7801. * @param onLoad callback called when the texture is loaded (defaults to null)
  7802. */
  7803. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7804. /**
  7805. * Delays loading of the cube texture
  7806. * @param forcedExtension defines the extension to use
  7807. */
  7808. delayLoad(forcedExtension?: string): void;
  7809. /**
  7810. * Returns the reflection texture matrix
  7811. * @returns the reflection texture matrix
  7812. */
  7813. getReflectionTextureMatrix(): Matrix;
  7814. /**
  7815. * Sets the reflection texture matrix
  7816. * @param value Reflection texture matrix
  7817. */
  7818. setReflectionTextureMatrix(value: Matrix): void;
  7819. /**
  7820. * Parses text to create a cube texture
  7821. * @param parsedTexture define the serialized text to read from
  7822. * @param scene defines the hosting scene
  7823. * @param rootUrl defines the root url of the cube texture
  7824. * @returns a cube texture
  7825. */
  7826. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7827. /**
  7828. * Makes a clone, or deep copy, of the cube texture
  7829. * @returns a new cube texture
  7830. */
  7831. clone(): CubeTexture;
  7832. }
  7833. }
  7834. declare module "babylonjs/Materials/materialDefines" {
  7835. /**
  7836. * Manages the defines for the Material
  7837. */
  7838. export class MaterialDefines {
  7839. /** @hidden */
  7840. protected _keys: string[];
  7841. private _isDirty;
  7842. /** @hidden */
  7843. _renderId: number;
  7844. /** @hidden */
  7845. _areLightsDirty: boolean;
  7846. /** @hidden */
  7847. _areLightsDisposed: boolean;
  7848. /** @hidden */
  7849. _areAttributesDirty: boolean;
  7850. /** @hidden */
  7851. _areTexturesDirty: boolean;
  7852. /** @hidden */
  7853. _areFresnelDirty: boolean;
  7854. /** @hidden */
  7855. _areMiscDirty: boolean;
  7856. /** @hidden */
  7857. _areImageProcessingDirty: boolean;
  7858. /** @hidden */
  7859. _normals: boolean;
  7860. /** @hidden */
  7861. _uvs: boolean;
  7862. /** @hidden */
  7863. _needNormals: boolean;
  7864. /** @hidden */
  7865. _needUVs: boolean;
  7866. [id: string]: any;
  7867. /**
  7868. * Specifies if the material needs to be re-calculated
  7869. */
  7870. readonly isDirty: boolean;
  7871. /**
  7872. * Marks the material to indicate that it has been re-calculated
  7873. */
  7874. markAsProcessed(): void;
  7875. /**
  7876. * Marks the material to indicate that it needs to be re-calculated
  7877. */
  7878. markAsUnprocessed(): void;
  7879. /**
  7880. * Marks the material to indicate all of its defines need to be re-calculated
  7881. */
  7882. markAllAsDirty(): void;
  7883. /**
  7884. * Marks the material to indicate that image processing needs to be re-calculated
  7885. */
  7886. markAsImageProcessingDirty(): void;
  7887. /**
  7888. * Marks the material to indicate the lights need to be re-calculated
  7889. * @param disposed Defines whether the light is dirty due to dispose or not
  7890. */
  7891. markAsLightDirty(disposed?: boolean): void;
  7892. /**
  7893. * Marks the attribute state as changed
  7894. */
  7895. markAsAttributesDirty(): void;
  7896. /**
  7897. * Marks the texture state as changed
  7898. */
  7899. markAsTexturesDirty(): void;
  7900. /**
  7901. * Marks the fresnel state as changed
  7902. */
  7903. markAsFresnelDirty(): void;
  7904. /**
  7905. * Marks the misc state as changed
  7906. */
  7907. markAsMiscDirty(): void;
  7908. /**
  7909. * Rebuilds the material defines
  7910. */
  7911. rebuild(): void;
  7912. /**
  7913. * Specifies if two material defines are equal
  7914. * @param other - A material define instance to compare to
  7915. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7916. */
  7917. isEqual(other: MaterialDefines): boolean;
  7918. /**
  7919. * Clones this instance's defines to another instance
  7920. * @param other - material defines to clone values to
  7921. */
  7922. cloneTo(other: MaterialDefines): void;
  7923. /**
  7924. * Resets the material define values
  7925. */
  7926. reset(): void;
  7927. /**
  7928. * Converts the material define values to a string
  7929. * @returns - String of material define information
  7930. */
  7931. toString(): string;
  7932. }
  7933. }
  7934. declare module "babylonjs/Materials/colorCurves" {
  7935. import { Effect } from "babylonjs/Materials/effect";
  7936. /**
  7937. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7938. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7939. * 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;
  7940. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7941. */
  7942. export class ColorCurves {
  7943. private _dirty;
  7944. private _tempColor;
  7945. private _globalCurve;
  7946. private _highlightsCurve;
  7947. private _midtonesCurve;
  7948. private _shadowsCurve;
  7949. private _positiveCurve;
  7950. private _negativeCurve;
  7951. private _globalHue;
  7952. private _globalDensity;
  7953. private _globalSaturation;
  7954. private _globalExposure;
  7955. /**
  7956. * Gets the global Hue value.
  7957. * 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).
  7958. */
  7959. /**
  7960. * Sets the global Hue value.
  7961. * 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).
  7962. */
  7963. globalHue: number;
  7964. /**
  7965. * Gets the global Density value.
  7966. * 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.
  7967. * Values less than zero provide a filter of opposite hue.
  7968. */
  7969. /**
  7970. * Sets the global Density value.
  7971. * 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.
  7972. * Values less than zero provide a filter of opposite hue.
  7973. */
  7974. globalDensity: number;
  7975. /**
  7976. * Gets the global Saturation value.
  7977. * 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.
  7978. */
  7979. /**
  7980. * Sets the global Saturation value.
  7981. * 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.
  7982. */
  7983. globalSaturation: number;
  7984. /**
  7985. * Gets the global Exposure value.
  7986. * 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.
  7987. */
  7988. /**
  7989. * Sets the global Exposure value.
  7990. * 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.
  7991. */
  7992. globalExposure: number;
  7993. private _highlightsHue;
  7994. private _highlightsDensity;
  7995. private _highlightsSaturation;
  7996. private _highlightsExposure;
  7997. /**
  7998. * Gets the highlights Hue value.
  7999. * 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).
  8000. */
  8001. /**
  8002. * Sets the highlights Hue value.
  8003. * 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).
  8004. */
  8005. highlightsHue: number;
  8006. /**
  8007. * Gets the highlights Density value.
  8008. * 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.
  8009. * Values less than zero provide a filter of opposite hue.
  8010. */
  8011. /**
  8012. * Sets the highlights Density value.
  8013. * 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.
  8014. * Values less than zero provide a filter of opposite hue.
  8015. */
  8016. highlightsDensity: number;
  8017. /**
  8018. * Gets the highlights Saturation value.
  8019. * 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.
  8020. */
  8021. /**
  8022. * Sets the highlights Saturation value.
  8023. * 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.
  8024. */
  8025. highlightsSaturation: number;
  8026. /**
  8027. * Gets the highlights Exposure value.
  8028. * 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.
  8029. */
  8030. /**
  8031. * Sets the highlights Exposure value.
  8032. * 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.
  8033. */
  8034. highlightsExposure: number;
  8035. private _midtonesHue;
  8036. private _midtonesDensity;
  8037. private _midtonesSaturation;
  8038. private _midtonesExposure;
  8039. /**
  8040. * Gets the midtones Hue value.
  8041. * 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).
  8042. */
  8043. /**
  8044. * Sets the midtones Hue value.
  8045. * 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).
  8046. */
  8047. midtonesHue: number;
  8048. /**
  8049. * Gets the midtones Density value.
  8050. * 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.
  8051. * Values less than zero provide a filter of opposite hue.
  8052. */
  8053. /**
  8054. * Sets the midtones Density value.
  8055. * 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.
  8056. * Values less than zero provide a filter of opposite hue.
  8057. */
  8058. midtonesDensity: number;
  8059. /**
  8060. * Gets the midtones Saturation value.
  8061. * 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.
  8062. */
  8063. /**
  8064. * Sets the midtones Saturation value.
  8065. * 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.
  8066. */
  8067. midtonesSaturation: number;
  8068. /**
  8069. * Gets the midtones Exposure value.
  8070. * 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.
  8071. */
  8072. /**
  8073. * Sets the midtones Exposure value.
  8074. * 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.
  8075. */
  8076. midtonesExposure: number;
  8077. private _shadowsHue;
  8078. private _shadowsDensity;
  8079. private _shadowsSaturation;
  8080. private _shadowsExposure;
  8081. /**
  8082. * Gets the shadows Hue value.
  8083. * 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).
  8084. */
  8085. /**
  8086. * Sets the shadows Hue value.
  8087. * 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).
  8088. */
  8089. shadowsHue: number;
  8090. /**
  8091. * Gets the shadows Density value.
  8092. * 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.
  8093. * Values less than zero provide a filter of opposite hue.
  8094. */
  8095. /**
  8096. * Sets the shadows Density value.
  8097. * 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.
  8098. * Values less than zero provide a filter of opposite hue.
  8099. */
  8100. shadowsDensity: number;
  8101. /**
  8102. * Gets the shadows Saturation value.
  8103. * 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.
  8104. */
  8105. /**
  8106. * Sets the shadows Saturation value.
  8107. * 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.
  8108. */
  8109. shadowsSaturation: number;
  8110. /**
  8111. * Gets the shadows Exposure value.
  8112. * 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.
  8113. */
  8114. /**
  8115. * Sets the shadows Exposure value.
  8116. * 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.
  8117. */
  8118. shadowsExposure: number;
  8119. /**
  8120. * Returns the class name
  8121. * @returns The class name
  8122. */
  8123. getClassName(): string;
  8124. /**
  8125. * Binds the color curves to the shader.
  8126. * @param colorCurves The color curve to bind
  8127. * @param effect The effect to bind to
  8128. * @param positiveUniform The positive uniform shader parameter
  8129. * @param neutralUniform The neutral uniform shader parameter
  8130. * @param negativeUniform The negative uniform shader parameter
  8131. */
  8132. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8133. /**
  8134. * Prepare the list of uniforms associated with the ColorCurves effects.
  8135. * @param uniformsList The list of uniforms used in the effect
  8136. */
  8137. static PrepareUniforms(uniformsList: string[]): void;
  8138. /**
  8139. * Returns color grading data based on a hue, density, saturation and exposure value.
  8140. * @param filterHue The hue of the color filter.
  8141. * @param filterDensity The density of the color filter.
  8142. * @param saturation The saturation.
  8143. * @param exposure The exposure.
  8144. * @param result The result data container.
  8145. */
  8146. private getColorGradingDataToRef;
  8147. /**
  8148. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8149. * @param value The input slider value in range [-100,100].
  8150. * @returns Adjusted value.
  8151. */
  8152. private static applyColorGradingSliderNonlinear;
  8153. /**
  8154. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8155. * @param hue The hue (H) input.
  8156. * @param saturation The saturation (S) input.
  8157. * @param brightness The brightness (B) input.
  8158. * @result An RGBA color represented as Vector4.
  8159. */
  8160. private static fromHSBToRef;
  8161. /**
  8162. * Returns a value clamped between min and max
  8163. * @param value The value to clamp
  8164. * @param min The minimum of value
  8165. * @param max The maximum of value
  8166. * @returns The clamped value.
  8167. */
  8168. private static clamp;
  8169. /**
  8170. * Clones the current color curve instance.
  8171. * @return The cloned curves
  8172. */
  8173. clone(): ColorCurves;
  8174. /**
  8175. * Serializes the current color curve instance to a json representation.
  8176. * @return a JSON representation
  8177. */
  8178. serialize(): any;
  8179. /**
  8180. * Parses the color curve from a json representation.
  8181. * @param source the JSON source to parse
  8182. * @return The parsed curves
  8183. */
  8184. static Parse(source: any): ColorCurves;
  8185. }
  8186. }
  8187. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8188. import { Observable } from "babylonjs/Misc/observable";
  8189. import { Nullable } from "babylonjs/types";
  8190. import { Color4 } from "babylonjs/Maths/math.color";
  8191. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8192. import { Effect } from "babylonjs/Materials/effect";
  8193. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8194. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8195. /**
  8196. * Interface to follow in your material defines to integrate easily the
  8197. * Image proccessing functions.
  8198. * @hidden
  8199. */
  8200. export interface IImageProcessingConfigurationDefines {
  8201. IMAGEPROCESSING: boolean;
  8202. VIGNETTE: boolean;
  8203. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8204. VIGNETTEBLENDMODEOPAQUE: boolean;
  8205. TONEMAPPING: boolean;
  8206. TONEMAPPING_ACES: boolean;
  8207. CONTRAST: boolean;
  8208. EXPOSURE: boolean;
  8209. COLORCURVES: boolean;
  8210. COLORGRADING: boolean;
  8211. COLORGRADING3D: boolean;
  8212. SAMPLER3DGREENDEPTH: boolean;
  8213. SAMPLER3DBGRMAP: boolean;
  8214. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8215. }
  8216. /**
  8217. * @hidden
  8218. */
  8219. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8220. IMAGEPROCESSING: boolean;
  8221. VIGNETTE: boolean;
  8222. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8223. VIGNETTEBLENDMODEOPAQUE: boolean;
  8224. TONEMAPPING: boolean;
  8225. TONEMAPPING_ACES: boolean;
  8226. CONTRAST: boolean;
  8227. COLORCURVES: boolean;
  8228. COLORGRADING: boolean;
  8229. COLORGRADING3D: boolean;
  8230. SAMPLER3DGREENDEPTH: boolean;
  8231. SAMPLER3DBGRMAP: boolean;
  8232. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8233. EXPOSURE: boolean;
  8234. constructor();
  8235. }
  8236. /**
  8237. * This groups together the common properties used for image processing either in direct forward pass
  8238. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8239. * or not.
  8240. */
  8241. export class ImageProcessingConfiguration {
  8242. /**
  8243. * Default tone mapping applied in BabylonJS.
  8244. */
  8245. static readonly TONEMAPPING_STANDARD: number;
  8246. /**
  8247. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8248. * to other engines rendering to increase portability.
  8249. */
  8250. static readonly TONEMAPPING_ACES: number;
  8251. /**
  8252. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8253. */
  8254. colorCurves: Nullable<ColorCurves>;
  8255. private _colorCurvesEnabled;
  8256. /**
  8257. * Gets wether the color curves effect is enabled.
  8258. */
  8259. /**
  8260. * Sets wether the color curves effect is enabled.
  8261. */
  8262. colorCurvesEnabled: boolean;
  8263. private _colorGradingTexture;
  8264. /**
  8265. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8266. */
  8267. /**
  8268. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8269. */
  8270. colorGradingTexture: Nullable<BaseTexture>;
  8271. private _colorGradingEnabled;
  8272. /**
  8273. * Gets wether the color grading effect is enabled.
  8274. */
  8275. /**
  8276. * Sets wether the color grading effect is enabled.
  8277. */
  8278. colorGradingEnabled: boolean;
  8279. private _colorGradingWithGreenDepth;
  8280. /**
  8281. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8282. */
  8283. /**
  8284. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8285. */
  8286. colorGradingWithGreenDepth: boolean;
  8287. private _colorGradingBGR;
  8288. /**
  8289. * Gets wether the color grading texture contains BGR values.
  8290. */
  8291. /**
  8292. * Sets wether the color grading texture contains BGR values.
  8293. */
  8294. colorGradingBGR: boolean;
  8295. /** @hidden */
  8296. _exposure: number;
  8297. /**
  8298. * Gets the Exposure used in the effect.
  8299. */
  8300. /**
  8301. * Sets the Exposure used in the effect.
  8302. */
  8303. exposure: number;
  8304. private _toneMappingEnabled;
  8305. /**
  8306. * Gets wether the tone mapping effect is enabled.
  8307. */
  8308. /**
  8309. * Sets wether the tone mapping effect is enabled.
  8310. */
  8311. toneMappingEnabled: boolean;
  8312. private _toneMappingType;
  8313. /**
  8314. * Gets the type of tone mapping effect.
  8315. */
  8316. /**
  8317. * Sets the type of tone mapping effect used in BabylonJS.
  8318. */
  8319. toneMappingType: number;
  8320. protected _contrast: number;
  8321. /**
  8322. * Gets the contrast used in the effect.
  8323. */
  8324. /**
  8325. * Sets the contrast used in the effect.
  8326. */
  8327. contrast: number;
  8328. /**
  8329. * Vignette stretch size.
  8330. */
  8331. vignetteStretch: number;
  8332. /**
  8333. * Vignette centre X Offset.
  8334. */
  8335. vignetteCentreX: number;
  8336. /**
  8337. * Vignette centre Y Offset.
  8338. */
  8339. vignetteCentreY: number;
  8340. /**
  8341. * Vignette weight or intensity of the vignette effect.
  8342. */
  8343. vignetteWeight: number;
  8344. /**
  8345. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8346. * if vignetteEnabled is set to true.
  8347. */
  8348. vignetteColor: Color4;
  8349. /**
  8350. * Camera field of view used by the Vignette effect.
  8351. */
  8352. vignetteCameraFov: number;
  8353. private _vignetteBlendMode;
  8354. /**
  8355. * Gets the vignette blend mode allowing different kind of effect.
  8356. */
  8357. /**
  8358. * Sets the vignette blend mode allowing different kind of effect.
  8359. */
  8360. vignetteBlendMode: number;
  8361. private _vignetteEnabled;
  8362. /**
  8363. * Gets wether the vignette effect is enabled.
  8364. */
  8365. /**
  8366. * Sets wether the vignette effect is enabled.
  8367. */
  8368. vignetteEnabled: boolean;
  8369. private _applyByPostProcess;
  8370. /**
  8371. * Gets wether the image processing is applied through a post process or not.
  8372. */
  8373. /**
  8374. * Sets wether the image processing is applied through a post process or not.
  8375. */
  8376. applyByPostProcess: boolean;
  8377. private _isEnabled;
  8378. /**
  8379. * Gets wether the image processing is enabled or not.
  8380. */
  8381. /**
  8382. * Sets wether the image processing is enabled or not.
  8383. */
  8384. isEnabled: boolean;
  8385. /**
  8386. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8387. */
  8388. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8389. /**
  8390. * Method called each time the image processing information changes requires to recompile the effect.
  8391. */
  8392. protected _updateParameters(): void;
  8393. /**
  8394. * Gets the current class name.
  8395. * @return "ImageProcessingConfiguration"
  8396. */
  8397. getClassName(): string;
  8398. /**
  8399. * Prepare the list of uniforms associated with the Image Processing effects.
  8400. * @param uniforms The list of uniforms used in the effect
  8401. * @param defines the list of defines currently in use
  8402. */
  8403. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8404. /**
  8405. * Prepare the list of samplers associated with the Image Processing effects.
  8406. * @param samplersList The list of uniforms used in the effect
  8407. * @param defines the list of defines currently in use
  8408. */
  8409. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8410. /**
  8411. * Prepare the list of defines associated to the shader.
  8412. * @param defines the list of defines to complete
  8413. * @param forPostProcess Define if we are currently in post process mode or not
  8414. */
  8415. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8416. /**
  8417. * Returns true if all the image processing information are ready.
  8418. * @returns True if ready, otherwise, false
  8419. */
  8420. isReady(): boolean;
  8421. /**
  8422. * Binds the image processing to the shader.
  8423. * @param effect The effect to bind to
  8424. * @param overrideAspectRatio Override the aspect ratio of the effect
  8425. */
  8426. bind(effect: Effect, overrideAspectRatio?: number): void;
  8427. /**
  8428. * Clones the current image processing instance.
  8429. * @return The cloned image processing
  8430. */
  8431. clone(): ImageProcessingConfiguration;
  8432. /**
  8433. * Serializes the current image processing instance to a json representation.
  8434. * @return a JSON representation
  8435. */
  8436. serialize(): any;
  8437. /**
  8438. * Parses the image processing from a json representation.
  8439. * @param source the JSON source to parse
  8440. * @return The parsed image processing
  8441. */
  8442. static Parse(source: any): ImageProcessingConfiguration;
  8443. private static _VIGNETTEMODE_MULTIPLY;
  8444. private static _VIGNETTEMODE_OPAQUE;
  8445. /**
  8446. * Used to apply the vignette as a mix with the pixel color.
  8447. */
  8448. static readonly VIGNETTEMODE_MULTIPLY: number;
  8449. /**
  8450. * Used to apply the vignette as a replacement of the pixel color.
  8451. */
  8452. static readonly VIGNETTEMODE_OPAQUE: number;
  8453. }
  8454. }
  8455. declare module "babylonjs/Shaders/postprocess.vertex" {
  8456. /** @hidden */
  8457. export var postprocessVertexShader: {
  8458. name: string;
  8459. shader: string;
  8460. };
  8461. }
  8462. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8463. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8464. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8465. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8466. module "babylonjs/Engines/thinEngine" {
  8467. interface ThinEngine {
  8468. /**
  8469. * Creates a new render target texture
  8470. * @param size defines the size of the texture
  8471. * @param options defines the options used to create the texture
  8472. * @returns a new render target texture stored in an InternalTexture
  8473. */
  8474. createRenderTargetTexture(size: number | {
  8475. width: number;
  8476. height: number;
  8477. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8478. /**
  8479. * Creates a depth stencil texture.
  8480. * This is only available in WebGL 2 or with the depth texture extension available.
  8481. * @param size The size of face edge in the texture.
  8482. * @param options The options defining the texture.
  8483. * @returns The texture
  8484. */
  8485. createDepthStencilTexture(size: number | {
  8486. width: number;
  8487. height: number;
  8488. }, options: DepthTextureCreationOptions): InternalTexture;
  8489. /** @hidden */
  8490. _createDepthStencilTexture(size: number | {
  8491. width: number;
  8492. height: number;
  8493. }, options: DepthTextureCreationOptions): InternalTexture;
  8494. }
  8495. }
  8496. }
  8497. declare module "babylonjs/Maths/math.axis" {
  8498. import { Vector3 } from "babylonjs/Maths/math.vector";
  8499. /** Defines supported spaces */
  8500. export enum Space {
  8501. /** Local (object) space */
  8502. LOCAL = 0,
  8503. /** World space */
  8504. WORLD = 1,
  8505. /** Bone space */
  8506. BONE = 2
  8507. }
  8508. /** Defines the 3 main axes */
  8509. export class Axis {
  8510. /** X axis */
  8511. static X: Vector3;
  8512. /** Y axis */
  8513. static Y: Vector3;
  8514. /** Z axis */
  8515. static Z: Vector3;
  8516. }
  8517. }
  8518. declare module "babylonjs/Cameras/targetCamera" {
  8519. import { Nullable } from "babylonjs/types";
  8520. import { Camera } from "babylonjs/Cameras/camera";
  8521. import { Scene } from "babylonjs/scene";
  8522. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8523. /**
  8524. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8525. * This is the base of the follow, arc rotate cameras and Free camera
  8526. * @see http://doc.babylonjs.com/features/cameras
  8527. */
  8528. export class TargetCamera extends Camera {
  8529. private static _RigCamTransformMatrix;
  8530. private static _TargetTransformMatrix;
  8531. private static _TargetFocalPoint;
  8532. /**
  8533. * Define the current direction the camera is moving to
  8534. */
  8535. cameraDirection: Vector3;
  8536. /**
  8537. * Define the current rotation the camera is rotating to
  8538. */
  8539. cameraRotation: Vector2;
  8540. /**
  8541. * When set, the up vector of the camera will be updated by the rotation of the camera
  8542. */
  8543. updateUpVectorFromRotation: boolean;
  8544. private _tmpQuaternion;
  8545. /**
  8546. * Define the current rotation of the camera
  8547. */
  8548. rotation: Vector3;
  8549. /**
  8550. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8551. */
  8552. rotationQuaternion: Quaternion;
  8553. /**
  8554. * Define the current speed of the camera
  8555. */
  8556. speed: number;
  8557. /**
  8558. * Add constraint to the camera to prevent it to move freely in all directions and
  8559. * around all axis.
  8560. */
  8561. noRotationConstraint: boolean;
  8562. /**
  8563. * Define the current target of the camera as an object or a position.
  8564. */
  8565. lockedTarget: any;
  8566. /** @hidden */
  8567. _currentTarget: Vector3;
  8568. /** @hidden */
  8569. _initialFocalDistance: number;
  8570. /** @hidden */
  8571. _viewMatrix: Matrix;
  8572. /** @hidden */
  8573. _camMatrix: Matrix;
  8574. /** @hidden */
  8575. _cameraTransformMatrix: Matrix;
  8576. /** @hidden */
  8577. _cameraRotationMatrix: Matrix;
  8578. /** @hidden */
  8579. _referencePoint: Vector3;
  8580. /** @hidden */
  8581. _transformedReferencePoint: Vector3;
  8582. protected _globalCurrentTarget: Vector3;
  8583. protected _globalCurrentUpVector: Vector3;
  8584. /** @hidden */
  8585. _reset: () => void;
  8586. private _defaultUp;
  8587. /**
  8588. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  8589. * This is the base of the follow, arc rotate cameras and Free camera
  8590. * @see http://doc.babylonjs.com/features/cameras
  8591. * @param name Defines the name of the camera in the scene
  8592. * @param position Defines the start position of the camera in the scene
  8593. * @param scene Defines the scene the camera belongs to
  8594. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8595. */
  8596. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8597. /**
  8598. * Gets the position in front of the camera at a given distance.
  8599. * @param distance The distance from the camera we want the position to be
  8600. * @returns the position
  8601. */
  8602. getFrontPosition(distance: number): Vector3;
  8603. /** @hidden */
  8604. _getLockedTargetPosition(): Nullable<Vector3>;
  8605. private _storedPosition;
  8606. private _storedRotation;
  8607. private _storedRotationQuaternion;
  8608. /**
  8609. * Store current camera state of the camera (fov, position, rotation, etc..)
  8610. * @returns the camera
  8611. */
  8612. storeState(): Camera;
  8613. /**
  8614. * Restored camera state. You must call storeState() first
  8615. * @returns whether it was successful or not
  8616. * @hidden
  8617. */
  8618. _restoreStateValues(): boolean;
  8619. /** @hidden */
  8620. _initCache(): void;
  8621. /** @hidden */
  8622. _updateCache(ignoreParentClass?: boolean): void;
  8623. /** @hidden */
  8624. _isSynchronizedViewMatrix(): boolean;
  8625. /** @hidden */
  8626. _computeLocalCameraSpeed(): number;
  8627. /**
  8628. * Defines the target the camera should look at.
  8629. * @param target Defines the new target as a Vector or a mesh
  8630. */
  8631. setTarget(target: Vector3): void;
  8632. /**
  8633. * Return the current target position of the camera. This value is expressed in local space.
  8634. * @returns the target position
  8635. */
  8636. getTarget(): Vector3;
  8637. /** @hidden */
  8638. _decideIfNeedsToMove(): boolean;
  8639. /** @hidden */
  8640. _updatePosition(): void;
  8641. /** @hidden */
  8642. _checkInputs(): void;
  8643. protected _updateCameraRotationMatrix(): void;
  8644. /**
  8645. * 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)
  8646. * @returns the current camera
  8647. */
  8648. private _rotateUpVectorWithCameraRotationMatrix;
  8649. private _cachedRotationZ;
  8650. private _cachedQuaternionRotationZ;
  8651. /** @hidden */
  8652. _getViewMatrix(): Matrix;
  8653. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8654. /**
  8655. * @hidden
  8656. */
  8657. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8658. /**
  8659. * @hidden
  8660. */
  8661. _updateRigCameras(): void;
  8662. private _getRigCamPositionAndTarget;
  8663. /**
  8664. * Gets the current object class name.
  8665. * @return the class name
  8666. */
  8667. getClassName(): string;
  8668. }
  8669. }
  8670. declare module "babylonjs/Events/keyboardEvents" {
  8671. /**
  8672. * Gather the list of keyboard event types as constants.
  8673. */
  8674. export class KeyboardEventTypes {
  8675. /**
  8676. * The keydown event is fired when a key becomes active (pressed).
  8677. */
  8678. static readonly KEYDOWN: number;
  8679. /**
  8680. * The keyup event is fired when a key has been released.
  8681. */
  8682. static readonly KEYUP: number;
  8683. }
  8684. /**
  8685. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8686. */
  8687. export class KeyboardInfo {
  8688. /**
  8689. * Defines the type of event (KeyboardEventTypes)
  8690. */
  8691. type: number;
  8692. /**
  8693. * Defines the related dom event
  8694. */
  8695. event: KeyboardEvent;
  8696. /**
  8697. * Instantiates a new keyboard info.
  8698. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8699. * @param type Defines the type of event (KeyboardEventTypes)
  8700. * @param event Defines the related dom event
  8701. */
  8702. constructor(
  8703. /**
  8704. * Defines the type of event (KeyboardEventTypes)
  8705. */
  8706. type: number,
  8707. /**
  8708. * Defines the related dom event
  8709. */
  8710. event: KeyboardEvent);
  8711. }
  8712. /**
  8713. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8714. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8715. */
  8716. export class KeyboardInfoPre extends KeyboardInfo {
  8717. /**
  8718. * Defines the type of event (KeyboardEventTypes)
  8719. */
  8720. type: number;
  8721. /**
  8722. * Defines the related dom event
  8723. */
  8724. event: KeyboardEvent;
  8725. /**
  8726. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8727. */
  8728. skipOnPointerObservable: boolean;
  8729. /**
  8730. * Instantiates a new keyboard pre info.
  8731. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8732. * @param type Defines the type of event (KeyboardEventTypes)
  8733. * @param event Defines the related dom event
  8734. */
  8735. constructor(
  8736. /**
  8737. * Defines the type of event (KeyboardEventTypes)
  8738. */
  8739. type: number,
  8740. /**
  8741. * Defines the related dom event
  8742. */
  8743. event: KeyboardEvent);
  8744. }
  8745. }
  8746. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8747. import { Nullable } from "babylonjs/types";
  8748. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8749. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8750. /**
  8751. * Manage the keyboard inputs to control the movement of a free camera.
  8752. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8753. */
  8754. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8755. /**
  8756. * Defines the camera the input is attached to.
  8757. */
  8758. camera: FreeCamera;
  8759. /**
  8760. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8761. */
  8762. keysUp: number[];
  8763. /**
  8764. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8765. */
  8766. keysDown: number[];
  8767. /**
  8768. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8769. */
  8770. keysLeft: number[];
  8771. /**
  8772. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8773. */
  8774. keysRight: number[];
  8775. private _keys;
  8776. private _onCanvasBlurObserver;
  8777. private _onKeyboardObserver;
  8778. private _engine;
  8779. private _scene;
  8780. /**
  8781. * Attach the input controls to a specific dom element to get the input from.
  8782. * @param element Defines the element the controls should be listened from
  8783. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8784. */
  8785. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8786. /**
  8787. * Detach the current controls from the specified dom element.
  8788. * @param element Defines the element to stop listening the inputs from
  8789. */
  8790. detachControl(element: Nullable<HTMLElement>): void;
  8791. /**
  8792. * Update the current camera state depending on the inputs that have been used this frame.
  8793. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8794. */
  8795. checkInputs(): void;
  8796. /**
  8797. * Gets the class name of the current intput.
  8798. * @returns the class name
  8799. */
  8800. getClassName(): string;
  8801. /** @hidden */
  8802. _onLostFocus(): void;
  8803. /**
  8804. * Get the friendly name associated with the input class.
  8805. * @returns the input friendly name
  8806. */
  8807. getSimpleName(): string;
  8808. }
  8809. }
  8810. declare module "babylonjs/Lights/shadowLight" {
  8811. import { Camera } from "babylonjs/Cameras/camera";
  8812. import { Scene } from "babylonjs/scene";
  8813. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8814. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8815. import { Light } from "babylonjs/Lights/light";
  8816. /**
  8817. * Interface describing all the common properties and methods a shadow light needs to implement.
  8818. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8819. * as well as binding the different shadow properties to the effects.
  8820. */
  8821. export interface IShadowLight extends Light {
  8822. /**
  8823. * The light id in the scene (used in scene.findLighById for instance)
  8824. */
  8825. id: string;
  8826. /**
  8827. * The position the shdow will be casted from.
  8828. */
  8829. position: Vector3;
  8830. /**
  8831. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8832. */
  8833. direction: Vector3;
  8834. /**
  8835. * The transformed position. Position of the light in world space taking parenting in account.
  8836. */
  8837. transformedPosition: Vector3;
  8838. /**
  8839. * The transformed direction. Direction of the light in world space taking parenting in account.
  8840. */
  8841. transformedDirection: Vector3;
  8842. /**
  8843. * The friendly name of the light in the scene.
  8844. */
  8845. name: string;
  8846. /**
  8847. * Defines the shadow projection clipping minimum z value.
  8848. */
  8849. shadowMinZ: number;
  8850. /**
  8851. * Defines the shadow projection clipping maximum z value.
  8852. */
  8853. shadowMaxZ: number;
  8854. /**
  8855. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8856. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8857. */
  8858. computeTransformedInformation(): boolean;
  8859. /**
  8860. * Gets the scene the light belongs to.
  8861. * @returns The scene
  8862. */
  8863. getScene(): Scene;
  8864. /**
  8865. * Callback defining a custom Projection Matrix Builder.
  8866. * This can be used to override the default projection matrix computation.
  8867. */
  8868. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8869. /**
  8870. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8871. * @param matrix The materix to updated with the projection information
  8872. * @param viewMatrix The transform matrix of the light
  8873. * @param renderList The list of mesh to render in the map
  8874. * @returns The current light
  8875. */
  8876. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8877. /**
  8878. * Gets the current depth scale used in ESM.
  8879. * @returns The scale
  8880. */
  8881. getDepthScale(): number;
  8882. /**
  8883. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8884. * @returns true if a cube texture needs to be use
  8885. */
  8886. needCube(): boolean;
  8887. /**
  8888. * Detects if the projection matrix requires to be recomputed this frame.
  8889. * @returns true if it requires to be recomputed otherwise, false.
  8890. */
  8891. needProjectionMatrixCompute(): boolean;
  8892. /**
  8893. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8894. */
  8895. forceProjectionMatrixCompute(): void;
  8896. /**
  8897. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8898. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8899. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8900. */
  8901. getShadowDirection(faceIndex?: number): Vector3;
  8902. /**
  8903. * Gets the minZ used for shadow according to both the scene and the light.
  8904. * @param activeCamera The camera we are returning the min for
  8905. * @returns the depth min z
  8906. */
  8907. getDepthMinZ(activeCamera: Camera): number;
  8908. /**
  8909. * Gets the maxZ used for shadow according to both the scene and the light.
  8910. * @param activeCamera The camera we are returning the max for
  8911. * @returns the depth max z
  8912. */
  8913. getDepthMaxZ(activeCamera: Camera): number;
  8914. }
  8915. /**
  8916. * Base implementation IShadowLight
  8917. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8918. */
  8919. export abstract class ShadowLight extends Light implements IShadowLight {
  8920. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8921. protected _position: Vector3;
  8922. protected _setPosition(value: Vector3): void;
  8923. /**
  8924. * Sets the position the shadow will be casted from. Also use as the light position for both
  8925. * point and spot lights.
  8926. */
  8927. /**
  8928. * Sets the position the shadow will be casted from. Also use as the light position for both
  8929. * point and spot lights.
  8930. */
  8931. position: Vector3;
  8932. protected _direction: Vector3;
  8933. protected _setDirection(value: Vector3): void;
  8934. /**
  8935. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8936. * Also use as the light direction on spot and directional lights.
  8937. */
  8938. /**
  8939. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8940. * Also use as the light direction on spot and directional lights.
  8941. */
  8942. direction: Vector3;
  8943. private _shadowMinZ;
  8944. /**
  8945. * Gets the shadow projection clipping minimum z value.
  8946. */
  8947. /**
  8948. * Sets the shadow projection clipping minimum z value.
  8949. */
  8950. shadowMinZ: number;
  8951. private _shadowMaxZ;
  8952. /**
  8953. * Sets the shadow projection clipping maximum z value.
  8954. */
  8955. /**
  8956. * Gets the shadow projection clipping maximum z value.
  8957. */
  8958. shadowMaxZ: number;
  8959. /**
  8960. * Callback defining a custom Projection Matrix Builder.
  8961. * This can be used to override the default projection matrix computation.
  8962. */
  8963. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8964. /**
  8965. * The transformed position. Position of the light in world space taking parenting in account.
  8966. */
  8967. transformedPosition: Vector3;
  8968. /**
  8969. * The transformed direction. Direction of the light in world space taking parenting in account.
  8970. */
  8971. transformedDirection: Vector3;
  8972. private _needProjectionMatrixCompute;
  8973. /**
  8974. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8975. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8976. */
  8977. computeTransformedInformation(): boolean;
  8978. /**
  8979. * Return the depth scale used for the shadow map.
  8980. * @returns the depth scale.
  8981. */
  8982. getDepthScale(): number;
  8983. /**
  8984. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8985. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8986. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8987. */
  8988. getShadowDirection(faceIndex?: number): Vector3;
  8989. /**
  8990. * Returns the ShadowLight absolute position in the World.
  8991. * @returns the position vector in world space
  8992. */
  8993. getAbsolutePosition(): Vector3;
  8994. /**
  8995. * Sets the ShadowLight direction toward the passed target.
  8996. * @param target The point to target in local space
  8997. * @returns the updated ShadowLight direction
  8998. */
  8999. setDirectionToTarget(target: Vector3): Vector3;
  9000. /**
  9001. * Returns the light rotation in euler definition.
  9002. * @returns the x y z rotation in local space.
  9003. */
  9004. getRotation(): Vector3;
  9005. /**
  9006. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9007. * @returns true if a cube texture needs to be use
  9008. */
  9009. needCube(): boolean;
  9010. /**
  9011. * Detects if the projection matrix requires to be recomputed this frame.
  9012. * @returns true if it requires to be recomputed otherwise, false.
  9013. */
  9014. needProjectionMatrixCompute(): boolean;
  9015. /**
  9016. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9017. */
  9018. forceProjectionMatrixCompute(): void;
  9019. /** @hidden */
  9020. _initCache(): void;
  9021. /** @hidden */
  9022. _isSynchronized(): boolean;
  9023. /**
  9024. * Computes the world matrix of the node
  9025. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9026. * @returns the world matrix
  9027. */
  9028. computeWorldMatrix(force?: boolean): Matrix;
  9029. /**
  9030. * Gets the minZ used for shadow according to both the scene and the light.
  9031. * @param activeCamera The camera we are returning the min for
  9032. * @returns the depth min z
  9033. */
  9034. getDepthMinZ(activeCamera: Camera): number;
  9035. /**
  9036. * Gets the maxZ used for shadow according to both the scene and the light.
  9037. * @param activeCamera The camera we are returning the max for
  9038. * @returns the depth max z
  9039. */
  9040. getDepthMaxZ(activeCamera: Camera): number;
  9041. /**
  9042. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9043. * @param matrix The materix to updated with the projection information
  9044. * @param viewMatrix The transform matrix of the light
  9045. * @param renderList The list of mesh to render in the map
  9046. * @returns The current light
  9047. */
  9048. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9049. }
  9050. }
  9051. declare module "babylonjs/Materials/effectFallbacks" {
  9052. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9053. import { Effect } from "babylonjs/Materials/effect";
  9054. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9055. /**
  9056. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9057. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9058. */
  9059. export class EffectFallbacks implements IEffectFallbacks {
  9060. private _defines;
  9061. private _currentRank;
  9062. private _maxRank;
  9063. private _mesh;
  9064. /**
  9065. * Removes the fallback from the bound mesh.
  9066. */
  9067. unBindMesh(): void;
  9068. /**
  9069. * Adds a fallback on the specified property.
  9070. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9071. * @param define The name of the define in the shader
  9072. */
  9073. addFallback(rank: number, define: string): void;
  9074. /**
  9075. * Sets the mesh to use CPU skinning when needing to fallback.
  9076. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9077. * @param mesh The mesh to use the fallbacks.
  9078. */
  9079. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9080. /**
  9081. * Checks to see if more fallbacks are still availible.
  9082. */
  9083. readonly hasMoreFallbacks: boolean;
  9084. /**
  9085. * Removes the defines that should be removed when falling back.
  9086. * @param currentDefines defines the current define statements for the shader.
  9087. * @param effect defines the current effect we try to compile
  9088. * @returns The resulting defines with defines of the current rank removed.
  9089. */
  9090. reduce(currentDefines: string, effect: Effect): string;
  9091. }
  9092. }
  9093. declare module "babylonjs/Materials/materialHelper" {
  9094. import { Nullable } from "babylonjs/types";
  9095. import { Scene } from "babylonjs/scene";
  9096. import { Engine } from "babylonjs/Engines/engine";
  9097. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9098. import { Light } from "babylonjs/Lights/light";
  9099. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9100. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  9101. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  9102. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9103. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  9104. /**
  9105. * "Static Class" containing the most commonly used helper while dealing with material for
  9106. * rendering purpose.
  9107. *
  9108. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  9109. *
  9110. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  9111. */
  9112. export class MaterialHelper {
  9113. /**
  9114. * Bind the current view position to an effect.
  9115. * @param effect The effect to be bound
  9116. * @param scene The scene the eyes position is used from
  9117. */
  9118. static BindEyePosition(effect: Effect, scene: Scene): void;
  9119. /**
  9120. * Helps preparing the defines values about the UVs in used in the effect.
  9121. * UVs are shared as much as we can accross channels in the shaders.
  9122. * @param texture The texture we are preparing the UVs for
  9123. * @param defines The defines to update
  9124. * @param key The channel key "diffuse", "specular"... used in the shader
  9125. */
  9126. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  9127. /**
  9128. * Binds a texture matrix value to its corrsponding uniform
  9129. * @param texture The texture to bind the matrix for
  9130. * @param uniformBuffer The uniform buffer receivin the data
  9131. * @param key The channel key "diffuse", "specular"... used in the shader
  9132. */
  9133. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  9134. /**
  9135. * Gets the current status of the fog (should it be enabled?)
  9136. * @param mesh defines the mesh to evaluate for fog support
  9137. * @param scene defines the hosting scene
  9138. * @returns true if fog must be enabled
  9139. */
  9140. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  9141. /**
  9142. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  9143. * @param mesh defines the current mesh
  9144. * @param scene defines the current scene
  9145. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  9146. * @param pointsCloud defines if point cloud rendering has to be turned on
  9147. * @param fogEnabled defines if fog has to be turned on
  9148. * @param alphaTest defines if alpha testing has to be turned on
  9149. * @param defines defines the current list of defines
  9150. */
  9151. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  9152. /**
  9153. * Helper used to prepare the list of defines associated with frame values for shader compilation
  9154. * @param scene defines the current scene
  9155. * @param engine defines the current engine
  9156. * @param defines specifies the list of active defines
  9157. * @param useInstances defines if instances have to be turned on
  9158. * @param useClipPlane defines if clip plane have to be turned on
  9159. */
  9160. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  9161. /**
  9162. * Prepares the defines for bones
  9163. * @param mesh The mesh containing the geometry data we will draw
  9164. * @param defines The defines to update
  9165. */
  9166. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  9167. /**
  9168. * Prepares the defines for morph targets
  9169. * @param mesh The mesh containing the geometry data we will draw
  9170. * @param defines The defines to update
  9171. */
  9172. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  9173. /**
  9174. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  9175. * @param mesh The mesh containing the geometry data we will draw
  9176. * @param defines The defines to update
  9177. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  9178. * @param useBones Precise whether bones should be used or not (override mesh info)
  9179. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  9180. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  9181. * @returns false if defines are considered not dirty and have not been checked
  9182. */
  9183. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  9184. /**
  9185. * Prepares the defines related to multiview
  9186. * @param scene The scene we are intending to draw
  9187. * @param defines The defines to update
  9188. */
  9189. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  9190. /**
  9191. * Prepares the defines related to the light information passed in parameter
  9192. * @param scene The scene we are intending to draw
  9193. * @param mesh The mesh the effect is compiling for
  9194. * @param light The light the effect is compiling for
  9195. * @param lightIndex The index of the light
  9196. * @param defines The defines to update
  9197. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9198. * @param state Defines the current state regarding what is needed (normals, etc...)
  9199. */
  9200. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  9201. needNormals: boolean;
  9202. needRebuild: boolean;
  9203. shadowEnabled: boolean;
  9204. specularEnabled: boolean;
  9205. lightmapMode: boolean;
  9206. }): void;
  9207. /**
  9208. * Prepares the defines related to the light information passed in parameter
  9209. * @param scene The scene we are intending to draw
  9210. * @param mesh The mesh the effect is compiling for
  9211. * @param defines The defines to update
  9212. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9213. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  9214. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  9215. * @returns true if normals will be required for the rest of the effect
  9216. */
  9217. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  9218. /**
  9219. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  9220. * @param lightIndex defines the light index
  9221. * @param uniformsList The uniform list
  9222. * @param samplersList The sampler list
  9223. * @param projectedLightTexture defines if projected texture must be used
  9224. * @param uniformBuffersList defines an optional list of uniform buffers
  9225. */
  9226. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  9227. /**
  9228. * Prepares the uniforms and samplers list to be used in the effect
  9229. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  9230. * @param samplersList The sampler list
  9231. * @param defines The defines helping in the list generation
  9232. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  9233. */
  9234. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  9235. /**
  9236. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9237. * @param defines The defines to update while falling back
  9238. * @param fallbacks The authorized effect fallbacks
  9239. * @param maxSimultaneousLights The maximum number of lights allowed
  9240. * @param rank the current rank of the Effect
  9241. * @returns The newly affected rank
  9242. */
  9243. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9244. private static _TmpMorphInfluencers;
  9245. /**
  9246. * Prepares the list of attributes required for morph targets according to the effect defines.
  9247. * @param attribs The current list of supported attribs
  9248. * @param mesh The mesh to prepare the morph targets attributes for
  9249. * @param influencers The number of influencers
  9250. */
  9251. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9252. /**
  9253. * Prepares the list of attributes required for morph targets according to the effect defines.
  9254. * @param attribs The current list of supported attribs
  9255. * @param mesh The mesh to prepare the morph targets attributes for
  9256. * @param defines The current Defines of the effect
  9257. */
  9258. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9259. /**
  9260. * Prepares the list of attributes required for bones according to the effect defines.
  9261. * @param attribs The current list of supported attribs
  9262. * @param mesh The mesh to prepare the bones attributes for
  9263. * @param defines The current Defines of the effect
  9264. * @param fallbacks The current efffect fallback strategy
  9265. */
  9266. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9267. /**
  9268. * Check and prepare the list of attributes required for instances according to the effect defines.
  9269. * @param attribs The current list of supported attribs
  9270. * @param defines The current MaterialDefines of the effect
  9271. */
  9272. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9273. /**
  9274. * Add the list of attributes required for instances to the attribs array.
  9275. * @param attribs The current list of supported attribs
  9276. */
  9277. static PushAttributesForInstances(attribs: string[]): void;
  9278. /**
  9279. * Binds the light information to the effect.
  9280. * @param light The light containing the generator
  9281. * @param effect The effect we are binding the data to
  9282. * @param lightIndex The light index in the effect used to render
  9283. */
  9284. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9285. /**
  9286. * Binds the lights information from the scene to the effect for the given mesh.
  9287. * @param light Light to bind
  9288. * @param lightIndex Light index
  9289. * @param scene The scene where the light belongs to
  9290. * @param effect The effect we are binding the data to
  9291. * @param useSpecular Defines if specular is supported
  9292. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9293. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9294. */
  9295. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9296. /**
  9297. * Binds the lights information from the scene to the effect for the given mesh.
  9298. * @param scene The scene the lights belongs to
  9299. * @param mesh The mesh we are binding the information to render
  9300. * @param effect The effect we are binding the data to
  9301. * @param defines The generated defines for the effect
  9302. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9303. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9304. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9305. */
  9306. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9307. private static _tempFogColor;
  9308. /**
  9309. * Binds the fog information from the scene to the effect for the given mesh.
  9310. * @param scene The scene the lights belongs to
  9311. * @param mesh The mesh we are binding the information to render
  9312. * @param effect The effect we are binding the data to
  9313. * @param linearSpace Defines if the fog effect is applied in linear space
  9314. */
  9315. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9316. /**
  9317. * Binds the bones information from the mesh to the effect.
  9318. * @param mesh The mesh we are binding the information to render
  9319. * @param effect The effect we are binding the data to
  9320. */
  9321. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9322. /**
  9323. * Binds the morph targets information from the mesh to the effect.
  9324. * @param abstractMesh The mesh we are binding the information to render
  9325. * @param effect The effect we are binding the data to
  9326. */
  9327. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9328. /**
  9329. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9330. * @param defines The generated defines used in the effect
  9331. * @param effect The effect we are binding the data to
  9332. * @param scene The scene we are willing to render with logarithmic scale for
  9333. */
  9334. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9335. /**
  9336. * Binds the clip plane information from the scene to the effect.
  9337. * @param scene The scene the clip plane information are extracted from
  9338. * @param effect The effect we are binding the data to
  9339. */
  9340. static BindClipPlane(effect: Effect, scene: Scene): void;
  9341. }
  9342. }
  9343. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9344. /** @hidden */
  9345. export var packingFunctions: {
  9346. name: string;
  9347. shader: string;
  9348. };
  9349. }
  9350. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9351. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9352. /** @hidden */
  9353. export var shadowMapPixelShader: {
  9354. name: string;
  9355. shader: string;
  9356. };
  9357. }
  9358. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9359. /** @hidden */
  9360. export var bonesDeclaration: {
  9361. name: string;
  9362. shader: string;
  9363. };
  9364. }
  9365. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9366. /** @hidden */
  9367. export var morphTargetsVertexGlobalDeclaration: {
  9368. name: string;
  9369. shader: string;
  9370. };
  9371. }
  9372. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9373. /** @hidden */
  9374. export var morphTargetsVertexDeclaration: {
  9375. name: string;
  9376. shader: string;
  9377. };
  9378. }
  9379. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9380. /** @hidden */
  9381. export var instancesDeclaration: {
  9382. name: string;
  9383. shader: string;
  9384. };
  9385. }
  9386. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9387. /** @hidden */
  9388. export var helperFunctions: {
  9389. name: string;
  9390. shader: string;
  9391. };
  9392. }
  9393. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9394. /** @hidden */
  9395. export var morphTargetsVertex: {
  9396. name: string;
  9397. shader: string;
  9398. };
  9399. }
  9400. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9401. /** @hidden */
  9402. export var instancesVertex: {
  9403. name: string;
  9404. shader: string;
  9405. };
  9406. }
  9407. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9408. /** @hidden */
  9409. export var bonesVertex: {
  9410. name: string;
  9411. shader: string;
  9412. };
  9413. }
  9414. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9415. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9416. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9417. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9418. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9419. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9420. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9421. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9422. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9423. /** @hidden */
  9424. export var shadowMapVertexShader: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9430. /** @hidden */
  9431. export var depthBoxBlurPixelShader: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9437. import { Nullable } from "babylonjs/types";
  9438. import { Scene } from "babylonjs/scene";
  9439. import { Matrix } from "babylonjs/Maths/math.vector";
  9440. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9441. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9442. import { Mesh } from "babylonjs/Meshes/mesh";
  9443. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9444. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9445. import { Effect } from "babylonjs/Materials/effect";
  9446. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9447. import "babylonjs/Shaders/shadowMap.fragment";
  9448. import "babylonjs/Shaders/shadowMap.vertex";
  9449. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9450. import { Observable } from "babylonjs/Misc/observable";
  9451. /**
  9452. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9453. */
  9454. export interface ICustomShaderOptions {
  9455. /**
  9456. * Gets or sets the custom shader name to use
  9457. */
  9458. shaderName: string;
  9459. /**
  9460. * The list of attribute names used in the shader
  9461. */
  9462. attributes?: string[];
  9463. /**
  9464. * The list of unifrom names used in the shader
  9465. */
  9466. uniforms?: string[];
  9467. /**
  9468. * The list of sampler names used in the shader
  9469. */
  9470. samplers?: string[];
  9471. /**
  9472. * The list of defines used in the shader
  9473. */
  9474. defines?: string[];
  9475. }
  9476. /**
  9477. * Interface to implement to create a shadow generator compatible with BJS.
  9478. */
  9479. export interface IShadowGenerator {
  9480. /**
  9481. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9482. * @returns The render target texture if present otherwise, null
  9483. */
  9484. getShadowMap(): Nullable<RenderTargetTexture>;
  9485. /**
  9486. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9487. * @returns The render target texture if the shadow map is present otherwise, null
  9488. */
  9489. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9490. /**
  9491. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9492. * @param subMesh The submesh we want to render in the shadow map
  9493. * @param useInstances Defines wether will draw in the map using instances
  9494. * @returns true if ready otherwise, false
  9495. */
  9496. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9497. /**
  9498. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9499. * @param defines Defines of the material we want to update
  9500. * @param lightIndex Index of the light in the enabled light list of the material
  9501. */
  9502. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9503. /**
  9504. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9505. * defined in the generator but impacting the effect).
  9506. * It implies the unifroms available on the materials are the standard BJS ones.
  9507. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9508. * @param effect The effect we are binfing the information for
  9509. */
  9510. bindShadowLight(lightIndex: string, effect: Effect): void;
  9511. /**
  9512. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9513. * (eq to shadow prjection matrix * light transform matrix)
  9514. * @returns The transform matrix used to create the shadow map
  9515. */
  9516. getTransformMatrix(): Matrix;
  9517. /**
  9518. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9519. * Cube and 2D textures for instance.
  9520. */
  9521. recreateShadowMap(): void;
  9522. /**
  9523. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9524. * @param onCompiled Callback triggered at the and of the effects compilation
  9525. * @param options Sets of optional options forcing the compilation with different modes
  9526. */
  9527. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9528. useInstances: boolean;
  9529. }>): void;
  9530. /**
  9531. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9532. * @param options Sets of optional options forcing the compilation with different modes
  9533. * @returns A promise that resolves when the compilation completes
  9534. */
  9535. forceCompilationAsync(options?: Partial<{
  9536. useInstances: boolean;
  9537. }>): Promise<void>;
  9538. /**
  9539. * Serializes the shadow generator setup to a json object.
  9540. * @returns The serialized JSON object
  9541. */
  9542. serialize(): any;
  9543. /**
  9544. * Disposes the Shadow map and related Textures and effects.
  9545. */
  9546. dispose(): void;
  9547. }
  9548. /**
  9549. * Default implementation IShadowGenerator.
  9550. * This is the main object responsible of generating shadows in the framework.
  9551. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9552. */
  9553. export class ShadowGenerator implements IShadowGenerator {
  9554. /**
  9555. * Shadow generator mode None: no filtering applied.
  9556. */
  9557. static readonly FILTER_NONE: number;
  9558. /**
  9559. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9560. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9561. */
  9562. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9563. /**
  9564. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9565. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9566. */
  9567. static readonly FILTER_POISSONSAMPLING: number;
  9568. /**
  9569. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9570. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9571. */
  9572. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9573. /**
  9574. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9575. * edge artifacts on steep falloff.
  9576. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9577. */
  9578. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9579. /**
  9580. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9581. * edge artifacts on steep falloff.
  9582. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9583. */
  9584. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9585. /**
  9586. * Shadow generator mode PCF: Percentage Closer Filtering
  9587. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9588. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9589. */
  9590. static readonly FILTER_PCF: number;
  9591. /**
  9592. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9593. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9594. * Contact Hardening
  9595. */
  9596. static readonly FILTER_PCSS: number;
  9597. /**
  9598. * Reserved for PCF and PCSS
  9599. * Highest Quality.
  9600. *
  9601. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9602. *
  9603. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9604. */
  9605. static readonly QUALITY_HIGH: number;
  9606. /**
  9607. * Reserved for PCF and PCSS
  9608. * Good tradeoff for quality/perf cross devices
  9609. *
  9610. * Execute PCF on a 3*3 kernel.
  9611. *
  9612. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9613. */
  9614. static readonly QUALITY_MEDIUM: number;
  9615. /**
  9616. * Reserved for PCF and PCSS
  9617. * The lowest quality but the fastest.
  9618. *
  9619. * Execute PCF on a 1*1 kernel.
  9620. *
  9621. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9622. */
  9623. static readonly QUALITY_LOW: number;
  9624. /** Gets or sets the custom shader name to use */
  9625. customShaderOptions: ICustomShaderOptions;
  9626. /**
  9627. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9628. */
  9629. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9630. /**
  9631. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9632. */
  9633. onAfterShadowMapRenderObservable: Observable<Effect>;
  9634. /**
  9635. * Observable triggered before a mesh is rendered in the shadow map.
  9636. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9637. */
  9638. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9639. /**
  9640. * Observable triggered after a mesh is rendered in the shadow map.
  9641. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9642. */
  9643. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9644. private _bias;
  9645. /**
  9646. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9647. */
  9648. /**
  9649. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9650. */
  9651. bias: number;
  9652. private _normalBias;
  9653. /**
  9654. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9655. */
  9656. /**
  9657. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9658. */
  9659. normalBias: number;
  9660. private _blurBoxOffset;
  9661. /**
  9662. * Gets the blur box offset: offset applied during the blur pass.
  9663. * Only useful if useKernelBlur = false
  9664. */
  9665. /**
  9666. * Sets the blur box offset: offset applied during the blur pass.
  9667. * Only useful if useKernelBlur = false
  9668. */
  9669. blurBoxOffset: number;
  9670. private _blurScale;
  9671. /**
  9672. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9673. * 2 means half of the size.
  9674. */
  9675. /**
  9676. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9677. * 2 means half of the size.
  9678. */
  9679. blurScale: number;
  9680. private _blurKernel;
  9681. /**
  9682. * Gets the blur kernel: kernel size of the blur pass.
  9683. * Only useful if useKernelBlur = true
  9684. */
  9685. /**
  9686. * Sets the blur kernel: kernel size of the blur pass.
  9687. * Only useful if useKernelBlur = true
  9688. */
  9689. blurKernel: number;
  9690. private _useKernelBlur;
  9691. /**
  9692. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9693. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9694. */
  9695. /**
  9696. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9697. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9698. */
  9699. useKernelBlur: boolean;
  9700. private _depthScale;
  9701. /**
  9702. * Gets the depth scale used in ESM mode.
  9703. */
  9704. /**
  9705. * Sets the depth scale used in ESM mode.
  9706. * This can override the scale stored on the light.
  9707. */
  9708. depthScale: number;
  9709. private _filter;
  9710. /**
  9711. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9712. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9713. */
  9714. /**
  9715. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9716. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9717. */
  9718. filter: number;
  9719. /**
  9720. * Gets if the current filter is set to Poisson Sampling.
  9721. */
  9722. /**
  9723. * Sets the current filter to Poisson Sampling.
  9724. */
  9725. usePoissonSampling: boolean;
  9726. /**
  9727. * Gets if the current filter is set to ESM.
  9728. */
  9729. /**
  9730. * Sets the current filter is to ESM.
  9731. */
  9732. useExponentialShadowMap: boolean;
  9733. /**
  9734. * Gets if the current filter is set to filtered ESM.
  9735. */
  9736. /**
  9737. * Gets if the current filter is set to filtered ESM.
  9738. */
  9739. useBlurExponentialShadowMap: boolean;
  9740. /**
  9741. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9742. * exponential to prevent steep falloff artifacts).
  9743. */
  9744. /**
  9745. * Sets the current filter to "close ESM" (using the inverse of the
  9746. * exponential to prevent steep falloff artifacts).
  9747. */
  9748. useCloseExponentialShadowMap: boolean;
  9749. /**
  9750. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9751. * exponential to prevent steep falloff artifacts).
  9752. */
  9753. /**
  9754. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9755. * exponential to prevent steep falloff artifacts).
  9756. */
  9757. useBlurCloseExponentialShadowMap: boolean;
  9758. /**
  9759. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9760. */
  9761. /**
  9762. * Sets the current filter to "PCF" (percentage closer filtering).
  9763. */
  9764. usePercentageCloserFiltering: boolean;
  9765. private _filteringQuality;
  9766. /**
  9767. * Gets the PCF or PCSS Quality.
  9768. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9769. */
  9770. /**
  9771. * Sets the PCF or PCSS Quality.
  9772. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9773. */
  9774. filteringQuality: number;
  9775. /**
  9776. * Gets if the current filter is set to "PCSS" (contact hardening).
  9777. */
  9778. /**
  9779. * Sets the current filter to "PCSS" (contact hardening).
  9780. */
  9781. useContactHardeningShadow: boolean;
  9782. private _contactHardeningLightSizeUVRatio;
  9783. /**
  9784. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9785. * Using a ratio helps keeping shape stability independently of the map size.
  9786. *
  9787. * It does not account for the light projection as it was having too much
  9788. * instability during the light setup or during light position changes.
  9789. *
  9790. * Only valid if useContactHardeningShadow is true.
  9791. */
  9792. /**
  9793. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9794. * Using a ratio helps keeping shape stability independently of the map size.
  9795. *
  9796. * It does not account for the light projection as it was having too much
  9797. * instability during the light setup or during light position changes.
  9798. *
  9799. * Only valid if useContactHardeningShadow is true.
  9800. */
  9801. contactHardeningLightSizeUVRatio: number;
  9802. private _darkness;
  9803. /** Gets or sets the actual darkness of a shadow */
  9804. darkness: number;
  9805. /**
  9806. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9807. * 0 means strongest and 1 would means no shadow.
  9808. * @returns the darkness.
  9809. */
  9810. getDarkness(): number;
  9811. /**
  9812. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9813. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9814. * @returns the shadow generator allowing fluent coding.
  9815. */
  9816. setDarkness(darkness: number): ShadowGenerator;
  9817. private _transparencyShadow;
  9818. /** Gets or sets the ability to have transparent shadow */
  9819. transparencyShadow: boolean;
  9820. /**
  9821. * Sets the ability to have transparent shadow (boolean).
  9822. * @param transparent True if transparent else False
  9823. * @returns the shadow generator allowing fluent coding
  9824. */
  9825. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9826. private _shadowMap;
  9827. private _shadowMap2;
  9828. /**
  9829. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9830. * @returns The render target texture if present otherwise, null
  9831. */
  9832. getShadowMap(): Nullable<RenderTargetTexture>;
  9833. /**
  9834. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9835. * @returns The render target texture if the shadow map is present otherwise, null
  9836. */
  9837. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9838. /**
  9839. * Gets the class name of that object
  9840. * @returns "ShadowGenerator"
  9841. */
  9842. getClassName(): string;
  9843. /**
  9844. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9845. * @param mesh Mesh to add
  9846. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9847. * @returns the Shadow Generator itself
  9848. */
  9849. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9850. /**
  9851. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9852. * @param mesh Mesh to remove
  9853. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9854. * @returns the Shadow Generator itself
  9855. */
  9856. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9857. /**
  9858. * Controls the extent to which the shadows fade out at the edge of the frustum
  9859. * Used only by directionals and spots
  9860. */
  9861. frustumEdgeFalloff: number;
  9862. private _light;
  9863. /**
  9864. * Returns the associated light object.
  9865. * @returns the light generating the shadow
  9866. */
  9867. getLight(): IShadowLight;
  9868. /**
  9869. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9870. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9871. * It might on the other hand introduce peter panning.
  9872. */
  9873. forceBackFacesOnly: boolean;
  9874. private _scene;
  9875. private _lightDirection;
  9876. private _effect;
  9877. private _viewMatrix;
  9878. private _projectionMatrix;
  9879. private _transformMatrix;
  9880. private _cachedPosition;
  9881. private _cachedDirection;
  9882. private _cachedDefines;
  9883. private _currentRenderID;
  9884. private _boxBlurPostprocess;
  9885. private _kernelBlurXPostprocess;
  9886. private _kernelBlurYPostprocess;
  9887. private _blurPostProcesses;
  9888. private _mapSize;
  9889. private _currentFaceIndex;
  9890. private _currentFaceIndexCache;
  9891. private _textureType;
  9892. private _defaultTextureMatrix;
  9893. private _storedUniqueId;
  9894. /** @hidden */
  9895. static _SceneComponentInitialization: (scene: Scene) => void;
  9896. /**
  9897. * Creates a ShadowGenerator object.
  9898. * A ShadowGenerator is the required tool to use the shadows.
  9899. * Each light casting shadows needs to use its own ShadowGenerator.
  9900. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9901. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9902. * @param light The light object generating the shadows.
  9903. * @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.
  9904. */
  9905. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9906. private _initializeGenerator;
  9907. private _initializeShadowMap;
  9908. private _initializeBlurRTTAndPostProcesses;
  9909. private _renderForShadowMap;
  9910. private _renderSubMeshForShadowMap;
  9911. private _applyFilterValues;
  9912. /**
  9913. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9914. * @param onCompiled Callback triggered at the and of the effects compilation
  9915. * @param options Sets of optional options forcing the compilation with different modes
  9916. */
  9917. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9918. useInstances: boolean;
  9919. }>): void;
  9920. /**
  9921. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9922. * @param options Sets of optional options forcing the compilation with different modes
  9923. * @returns A promise that resolves when the compilation completes
  9924. */
  9925. forceCompilationAsync(options?: Partial<{
  9926. useInstances: boolean;
  9927. }>): Promise<void>;
  9928. /**
  9929. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9930. * @param subMesh The submesh we want to render in the shadow map
  9931. * @param useInstances Defines wether will draw in the map using instances
  9932. * @returns true if ready otherwise, false
  9933. */
  9934. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9935. /**
  9936. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9937. * @param defines Defines of the material we want to update
  9938. * @param lightIndex Index of the light in the enabled light list of the material
  9939. */
  9940. prepareDefines(defines: any, lightIndex: number): void;
  9941. /**
  9942. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9943. * defined in the generator but impacting the effect).
  9944. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9945. * @param effect The effect we are binfing the information for
  9946. */
  9947. bindShadowLight(lightIndex: string, effect: Effect): void;
  9948. /**
  9949. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9950. * (eq to shadow prjection matrix * light transform matrix)
  9951. * @returns The transform matrix used to create the shadow map
  9952. */
  9953. getTransformMatrix(): Matrix;
  9954. /**
  9955. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9956. * Cube and 2D textures for instance.
  9957. */
  9958. recreateShadowMap(): void;
  9959. private _disposeBlurPostProcesses;
  9960. private _disposeRTTandPostProcesses;
  9961. /**
  9962. * Disposes the ShadowGenerator.
  9963. * Returns nothing.
  9964. */
  9965. dispose(): void;
  9966. /**
  9967. * Serializes the shadow generator setup to a json object.
  9968. * @returns The serialized JSON object
  9969. */
  9970. serialize(): any;
  9971. /**
  9972. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9973. * @param parsedShadowGenerator The JSON object to parse
  9974. * @param scene The scene to create the shadow map for
  9975. * @returns The parsed shadow generator
  9976. */
  9977. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9978. }
  9979. }
  9980. declare module "babylonjs/Lights/light" {
  9981. import { Nullable } from "babylonjs/types";
  9982. import { Scene } from "babylonjs/scene";
  9983. import { Vector3 } from "babylonjs/Maths/math.vector";
  9984. import { Color3 } from "babylonjs/Maths/math.color";
  9985. import { Node } from "babylonjs/node";
  9986. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9987. import { Effect } from "babylonjs/Materials/effect";
  9988. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9989. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9990. /**
  9991. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9992. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9993. * 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.
  9994. */
  9995. export abstract class Light extends Node {
  9996. /**
  9997. * Falloff Default: light is falling off following the material specification:
  9998. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9999. */
  10000. static readonly FALLOFF_DEFAULT: number;
  10001. /**
  10002. * Falloff Physical: light is falling off following the inverse squared distance law.
  10003. */
  10004. static readonly FALLOFF_PHYSICAL: number;
  10005. /**
  10006. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  10007. * to enhance interoperability with other engines.
  10008. */
  10009. static readonly FALLOFF_GLTF: number;
  10010. /**
  10011. * Falloff Standard: light is falling off like in the standard material
  10012. * to enhance interoperability with other materials.
  10013. */
  10014. static readonly FALLOFF_STANDARD: number;
  10015. /**
  10016. * If every light affecting the material is in this lightmapMode,
  10017. * material.lightmapTexture adds or multiplies
  10018. * (depends on material.useLightmapAsShadowmap)
  10019. * after every other light calculations.
  10020. */
  10021. static readonly LIGHTMAP_DEFAULT: number;
  10022. /**
  10023. * material.lightmapTexture as only diffuse lighting from this light
  10024. * adds only specular lighting from this light
  10025. * adds dynamic shadows
  10026. */
  10027. static readonly LIGHTMAP_SPECULAR: number;
  10028. /**
  10029. * material.lightmapTexture as only lighting
  10030. * no light calculation from this light
  10031. * only adds dynamic shadows from this light
  10032. */
  10033. static readonly LIGHTMAP_SHADOWSONLY: number;
  10034. /**
  10035. * Each light type uses the default quantity according to its type:
  10036. * point/spot lights use luminous intensity
  10037. * directional lights use illuminance
  10038. */
  10039. static readonly INTENSITYMODE_AUTOMATIC: number;
  10040. /**
  10041. * lumen (lm)
  10042. */
  10043. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  10044. /**
  10045. * candela (lm/sr)
  10046. */
  10047. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  10048. /**
  10049. * lux (lm/m^2)
  10050. */
  10051. static readonly INTENSITYMODE_ILLUMINANCE: number;
  10052. /**
  10053. * nit (cd/m^2)
  10054. */
  10055. static readonly INTENSITYMODE_LUMINANCE: number;
  10056. /**
  10057. * Light type const id of the point light.
  10058. */
  10059. static readonly LIGHTTYPEID_POINTLIGHT: number;
  10060. /**
  10061. * Light type const id of the directional light.
  10062. */
  10063. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  10064. /**
  10065. * Light type const id of the spot light.
  10066. */
  10067. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  10068. /**
  10069. * Light type const id of the hemispheric light.
  10070. */
  10071. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  10072. /**
  10073. * Diffuse gives the basic color to an object.
  10074. */
  10075. diffuse: Color3;
  10076. /**
  10077. * Specular produces a highlight color on an object.
  10078. * Note: This is note affecting PBR materials.
  10079. */
  10080. specular: Color3;
  10081. /**
  10082. * Defines the falloff type for this light. This lets overrriding how punctual light are
  10083. * falling off base on range or angle.
  10084. * This can be set to any values in Light.FALLOFF_x.
  10085. *
  10086. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  10087. * other types of materials.
  10088. */
  10089. falloffType: number;
  10090. /**
  10091. * Strength of the light.
  10092. * Note: By default it is define in the framework own unit.
  10093. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  10094. */
  10095. intensity: number;
  10096. private _range;
  10097. protected _inverseSquaredRange: number;
  10098. /**
  10099. * Defines how far from the source the light is impacting in scene units.
  10100. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  10101. */
  10102. /**
  10103. * Defines how far from the source the light is impacting in scene units.
  10104. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  10105. */
  10106. range: number;
  10107. /**
  10108. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  10109. * of light.
  10110. */
  10111. private _photometricScale;
  10112. private _intensityMode;
  10113. /**
  10114. * Gets the photometric scale used to interpret the intensity.
  10115. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10116. */
  10117. /**
  10118. * Sets the photometric scale used to interpret the intensity.
  10119. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10120. */
  10121. intensityMode: number;
  10122. private _radius;
  10123. /**
  10124. * Gets the light radius used by PBR Materials to simulate soft area lights.
  10125. */
  10126. /**
  10127. * sets the light radius used by PBR Materials to simulate soft area lights.
  10128. */
  10129. radius: number;
  10130. private _renderPriority;
  10131. /**
  10132. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  10133. * exceeding the number allowed of the materials.
  10134. */
  10135. renderPriority: number;
  10136. private _shadowEnabled;
  10137. /**
  10138. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10139. * the current shadow generator.
  10140. */
  10141. /**
  10142. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10143. * the current shadow generator.
  10144. */
  10145. shadowEnabled: boolean;
  10146. private _includedOnlyMeshes;
  10147. /**
  10148. * Gets the only meshes impacted by this light.
  10149. */
  10150. /**
  10151. * Sets the only meshes impacted by this light.
  10152. */
  10153. includedOnlyMeshes: AbstractMesh[];
  10154. private _excludedMeshes;
  10155. /**
  10156. * Gets the meshes not impacted by this light.
  10157. */
  10158. /**
  10159. * Sets the meshes not impacted by this light.
  10160. */
  10161. excludedMeshes: AbstractMesh[];
  10162. private _excludeWithLayerMask;
  10163. /**
  10164. * Gets the layer id use to find what meshes are not impacted by the light.
  10165. * Inactive if 0
  10166. */
  10167. /**
  10168. * Sets the layer id use to find what meshes are not impacted by the light.
  10169. * Inactive if 0
  10170. */
  10171. excludeWithLayerMask: number;
  10172. private _includeOnlyWithLayerMask;
  10173. /**
  10174. * Gets the layer id use to find what meshes are impacted by the light.
  10175. * Inactive if 0
  10176. */
  10177. /**
  10178. * Sets the layer id use to find what meshes are impacted by the light.
  10179. * Inactive if 0
  10180. */
  10181. includeOnlyWithLayerMask: number;
  10182. private _lightmapMode;
  10183. /**
  10184. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10185. */
  10186. /**
  10187. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10188. */
  10189. lightmapMode: number;
  10190. /**
  10191. * Shadow generator associted to the light.
  10192. * @hidden Internal use only.
  10193. */
  10194. _shadowGenerator: Nullable<IShadowGenerator>;
  10195. /**
  10196. * @hidden Internal use only.
  10197. */
  10198. _excludedMeshesIds: string[];
  10199. /**
  10200. * @hidden Internal use only.
  10201. */
  10202. _includedOnlyMeshesIds: string[];
  10203. /**
  10204. * The current light unifom buffer.
  10205. * @hidden Internal use only.
  10206. */
  10207. _uniformBuffer: UniformBuffer;
  10208. /** @hidden */
  10209. _renderId: number;
  10210. /**
  10211. * Creates a Light object in the scene.
  10212. * Documentation : https://doc.babylonjs.com/babylon101/lights
  10213. * @param name The firendly name of the light
  10214. * @param scene The scene the light belongs too
  10215. */
  10216. constructor(name: string, scene: Scene);
  10217. protected abstract _buildUniformLayout(): void;
  10218. /**
  10219. * Sets the passed Effect "effect" with the Light information.
  10220. * @param effect The effect to update
  10221. * @param lightIndex The index of the light in the effect to update
  10222. * @returns The light
  10223. */
  10224. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  10225. /**
  10226. * Sets the passed Effect "effect" with the Light information.
  10227. * @param effect The effect to update
  10228. * @param lightDataUniformName The uniform used to store light data (position or direction)
  10229. * @returns The light
  10230. */
  10231. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  10232. /**
  10233. * Returns the string "Light".
  10234. * @returns the class name
  10235. */
  10236. getClassName(): string;
  10237. /** @hidden */
  10238. readonly _isLight: boolean;
  10239. /**
  10240. * Converts the light information to a readable string for debug purpose.
  10241. * @param fullDetails Supports for multiple levels of logging within scene loading
  10242. * @returns the human readable light info
  10243. */
  10244. toString(fullDetails?: boolean): string;
  10245. /** @hidden */
  10246. protected _syncParentEnabledState(): void;
  10247. /**
  10248. * Set the enabled state of this node.
  10249. * @param value - the new enabled state
  10250. */
  10251. setEnabled(value: boolean): void;
  10252. /**
  10253. * Returns the Light associated shadow generator if any.
  10254. * @return the associated shadow generator.
  10255. */
  10256. getShadowGenerator(): Nullable<IShadowGenerator>;
  10257. /**
  10258. * Returns a Vector3, the absolute light position in the World.
  10259. * @returns the world space position of the light
  10260. */
  10261. getAbsolutePosition(): Vector3;
  10262. /**
  10263. * Specifies if the light will affect the passed mesh.
  10264. * @param mesh The mesh to test against the light
  10265. * @return true the mesh is affected otherwise, false.
  10266. */
  10267. canAffectMesh(mesh: AbstractMesh): boolean;
  10268. /**
  10269. * Sort function to order lights for rendering.
  10270. * @param a First Light object to compare to second.
  10271. * @param b Second Light object to compare first.
  10272. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10273. */
  10274. static CompareLightsPriority(a: Light, b: Light): number;
  10275. /**
  10276. * Releases resources associated with this node.
  10277. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10278. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10279. */
  10280. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10281. /**
  10282. * Returns the light type ID (integer).
  10283. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10284. */
  10285. getTypeID(): number;
  10286. /**
  10287. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10288. * @returns the scaled intensity in intensity mode unit
  10289. */
  10290. getScaledIntensity(): number;
  10291. /**
  10292. * Returns a new Light object, named "name", from the current one.
  10293. * @param name The name of the cloned light
  10294. * @returns the new created light
  10295. */
  10296. clone(name: string): Nullable<Light>;
  10297. /**
  10298. * Serializes the current light into a Serialization object.
  10299. * @returns the serialized object.
  10300. */
  10301. serialize(): any;
  10302. /**
  10303. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10304. * This new light is named "name" and added to the passed scene.
  10305. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10306. * @param name The friendly name of the light
  10307. * @param scene The scene the new light will belong to
  10308. * @returns the constructor function
  10309. */
  10310. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10311. /**
  10312. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10313. * @param parsedLight The JSON representation of the light
  10314. * @param scene The scene to create the parsed light in
  10315. * @returns the created light after parsing
  10316. */
  10317. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10318. private _hookArrayForExcluded;
  10319. private _hookArrayForIncludedOnly;
  10320. private _resyncMeshes;
  10321. /**
  10322. * Forces the meshes to update their light related information in their rendering used effects
  10323. * @hidden Internal Use Only
  10324. */
  10325. _markMeshesAsLightDirty(): void;
  10326. /**
  10327. * Recomputes the cached photometric scale if needed.
  10328. */
  10329. private _computePhotometricScale;
  10330. /**
  10331. * Returns the Photometric Scale according to the light type and intensity mode.
  10332. */
  10333. private _getPhotometricScale;
  10334. /**
  10335. * Reorder the light in the scene according to their defined priority.
  10336. * @hidden Internal Use Only
  10337. */
  10338. _reorderLightsInScene(): void;
  10339. /**
  10340. * Prepares the list of defines specific to the light type.
  10341. * @param defines the list of defines
  10342. * @param lightIndex defines the index of the light for the effect
  10343. */
  10344. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10345. }
  10346. }
  10347. declare module "babylonjs/Actions/action" {
  10348. import { Observable } from "babylonjs/Misc/observable";
  10349. import { Condition } from "babylonjs/Actions/condition";
  10350. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10351. import { ActionManager } from "babylonjs/Actions/actionManager";
  10352. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10353. /**
  10354. * Interface used to define Action
  10355. */
  10356. export interface IAction {
  10357. /**
  10358. * Trigger for the action
  10359. */
  10360. trigger: number;
  10361. /** Options of the trigger */
  10362. triggerOptions: any;
  10363. /**
  10364. * Gets the trigger parameters
  10365. * @returns the trigger parameters
  10366. */
  10367. getTriggerParameter(): any;
  10368. /**
  10369. * Internal only - executes current action event
  10370. * @hidden
  10371. */
  10372. _executeCurrent(evt?: ActionEvent): void;
  10373. /**
  10374. * Serialize placeholder for child classes
  10375. * @param parent of child
  10376. * @returns the serialized object
  10377. */
  10378. serialize(parent: any): any;
  10379. /**
  10380. * Internal only
  10381. * @hidden
  10382. */
  10383. _prepare(): void;
  10384. /**
  10385. * Internal only - manager for action
  10386. * @hidden
  10387. */
  10388. _actionManager: AbstractActionManager;
  10389. /**
  10390. * Adds action to chain of actions, may be a DoNothingAction
  10391. * @param action defines the next action to execute
  10392. * @returns The action passed in
  10393. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10394. */
  10395. then(action: IAction): IAction;
  10396. }
  10397. /**
  10398. * The action to be carried out following a trigger
  10399. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10400. */
  10401. export class Action implements IAction {
  10402. /** the trigger, with or without parameters, for the action */
  10403. triggerOptions: any;
  10404. /**
  10405. * Trigger for the action
  10406. */
  10407. trigger: number;
  10408. /**
  10409. * Internal only - manager for action
  10410. * @hidden
  10411. */
  10412. _actionManager: ActionManager;
  10413. private _nextActiveAction;
  10414. private _child;
  10415. private _condition?;
  10416. private _triggerParameter;
  10417. /**
  10418. * An event triggered prior to action being executed.
  10419. */
  10420. onBeforeExecuteObservable: Observable<Action>;
  10421. /**
  10422. * Creates a new Action
  10423. * @param triggerOptions the trigger, with or without parameters, for the action
  10424. * @param condition an optional determinant of action
  10425. */
  10426. constructor(
  10427. /** the trigger, with or without parameters, for the action */
  10428. triggerOptions: any, condition?: Condition);
  10429. /**
  10430. * Internal only
  10431. * @hidden
  10432. */
  10433. _prepare(): void;
  10434. /**
  10435. * Gets the trigger parameters
  10436. * @returns the trigger parameters
  10437. */
  10438. getTriggerParameter(): any;
  10439. /**
  10440. * Internal only - executes current action event
  10441. * @hidden
  10442. */
  10443. _executeCurrent(evt?: ActionEvent): void;
  10444. /**
  10445. * Execute placeholder for child classes
  10446. * @param evt optional action event
  10447. */
  10448. execute(evt?: ActionEvent): void;
  10449. /**
  10450. * Skips to next active action
  10451. */
  10452. skipToNextActiveAction(): void;
  10453. /**
  10454. * Adds action to chain of actions, may be a DoNothingAction
  10455. * @param action defines the next action to execute
  10456. * @returns The action passed in
  10457. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10458. */
  10459. then(action: Action): Action;
  10460. /**
  10461. * Internal only
  10462. * @hidden
  10463. */
  10464. _getProperty(propertyPath: string): string;
  10465. /**
  10466. * Internal only
  10467. * @hidden
  10468. */
  10469. _getEffectiveTarget(target: any, propertyPath: string): any;
  10470. /**
  10471. * Serialize placeholder for child classes
  10472. * @param parent of child
  10473. * @returns the serialized object
  10474. */
  10475. serialize(parent: any): any;
  10476. /**
  10477. * Internal only called by serialize
  10478. * @hidden
  10479. */
  10480. protected _serialize(serializedAction: any, parent?: any): any;
  10481. /**
  10482. * Internal only
  10483. * @hidden
  10484. */
  10485. static _SerializeValueAsString: (value: any) => string;
  10486. /**
  10487. * Internal only
  10488. * @hidden
  10489. */
  10490. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10491. name: string;
  10492. targetType: string;
  10493. value: string;
  10494. };
  10495. }
  10496. }
  10497. declare module "babylonjs/Actions/condition" {
  10498. import { ActionManager } from "babylonjs/Actions/actionManager";
  10499. /**
  10500. * A Condition applied to an Action
  10501. */
  10502. export class Condition {
  10503. /**
  10504. * Internal only - manager for action
  10505. * @hidden
  10506. */
  10507. _actionManager: ActionManager;
  10508. /**
  10509. * Internal only
  10510. * @hidden
  10511. */
  10512. _evaluationId: number;
  10513. /**
  10514. * Internal only
  10515. * @hidden
  10516. */
  10517. _currentResult: boolean;
  10518. /**
  10519. * Creates a new Condition
  10520. * @param actionManager the manager of the action the condition is applied to
  10521. */
  10522. constructor(actionManager: ActionManager);
  10523. /**
  10524. * Check if the current condition is valid
  10525. * @returns a boolean
  10526. */
  10527. isValid(): boolean;
  10528. /**
  10529. * Internal only
  10530. * @hidden
  10531. */
  10532. _getProperty(propertyPath: string): string;
  10533. /**
  10534. * Internal only
  10535. * @hidden
  10536. */
  10537. _getEffectiveTarget(target: any, propertyPath: string): any;
  10538. /**
  10539. * Serialize placeholder for child classes
  10540. * @returns the serialized object
  10541. */
  10542. serialize(): any;
  10543. /**
  10544. * Internal only
  10545. * @hidden
  10546. */
  10547. protected _serialize(serializedCondition: any): any;
  10548. }
  10549. /**
  10550. * Defines specific conditional operators as extensions of Condition
  10551. */
  10552. export class ValueCondition extends Condition {
  10553. /** path to specify the property of the target the conditional operator uses */
  10554. propertyPath: string;
  10555. /** the value compared by the conditional operator against the current value of the property */
  10556. value: any;
  10557. /** the conditional operator, default ValueCondition.IsEqual */
  10558. operator: number;
  10559. /**
  10560. * Internal only
  10561. * @hidden
  10562. */
  10563. private static _IsEqual;
  10564. /**
  10565. * Internal only
  10566. * @hidden
  10567. */
  10568. private static _IsDifferent;
  10569. /**
  10570. * Internal only
  10571. * @hidden
  10572. */
  10573. private static _IsGreater;
  10574. /**
  10575. * Internal only
  10576. * @hidden
  10577. */
  10578. private static _IsLesser;
  10579. /**
  10580. * returns the number for IsEqual
  10581. */
  10582. static readonly IsEqual: number;
  10583. /**
  10584. * Returns the number for IsDifferent
  10585. */
  10586. static readonly IsDifferent: number;
  10587. /**
  10588. * Returns the number for IsGreater
  10589. */
  10590. static readonly IsGreater: number;
  10591. /**
  10592. * Returns the number for IsLesser
  10593. */
  10594. static readonly IsLesser: number;
  10595. /**
  10596. * Internal only The action manager for the condition
  10597. * @hidden
  10598. */
  10599. _actionManager: ActionManager;
  10600. /**
  10601. * Internal only
  10602. * @hidden
  10603. */
  10604. private _target;
  10605. /**
  10606. * Internal only
  10607. * @hidden
  10608. */
  10609. private _effectiveTarget;
  10610. /**
  10611. * Internal only
  10612. * @hidden
  10613. */
  10614. private _property;
  10615. /**
  10616. * Creates a new ValueCondition
  10617. * @param actionManager manager for the action the condition applies to
  10618. * @param target for the action
  10619. * @param propertyPath path to specify the property of the target the conditional operator uses
  10620. * @param value the value compared by the conditional operator against the current value of the property
  10621. * @param operator the conditional operator, default ValueCondition.IsEqual
  10622. */
  10623. constructor(actionManager: ActionManager, target: any,
  10624. /** path to specify the property of the target the conditional operator uses */
  10625. propertyPath: string,
  10626. /** the value compared by the conditional operator against the current value of the property */
  10627. value: any,
  10628. /** the conditional operator, default ValueCondition.IsEqual */
  10629. operator?: number);
  10630. /**
  10631. * Compares the given value with the property value for the specified conditional operator
  10632. * @returns the result of the comparison
  10633. */
  10634. isValid(): boolean;
  10635. /**
  10636. * Serialize the ValueCondition into a JSON compatible object
  10637. * @returns serialization object
  10638. */
  10639. serialize(): any;
  10640. /**
  10641. * Gets the name of the conditional operator for the ValueCondition
  10642. * @param operator the conditional operator
  10643. * @returns the name
  10644. */
  10645. static GetOperatorName(operator: number): string;
  10646. }
  10647. /**
  10648. * Defines a predicate condition as an extension of Condition
  10649. */
  10650. export class PredicateCondition extends Condition {
  10651. /** defines the predicate function used to validate the condition */
  10652. predicate: () => boolean;
  10653. /**
  10654. * Internal only - manager for action
  10655. * @hidden
  10656. */
  10657. _actionManager: ActionManager;
  10658. /**
  10659. * Creates a new PredicateCondition
  10660. * @param actionManager manager for the action the condition applies to
  10661. * @param predicate defines the predicate function used to validate the condition
  10662. */
  10663. constructor(actionManager: ActionManager,
  10664. /** defines the predicate function used to validate the condition */
  10665. predicate: () => boolean);
  10666. /**
  10667. * @returns the validity of the predicate condition
  10668. */
  10669. isValid(): boolean;
  10670. }
  10671. /**
  10672. * Defines a state condition as an extension of Condition
  10673. */
  10674. export class StateCondition extends Condition {
  10675. /** Value to compare with target state */
  10676. value: string;
  10677. /**
  10678. * Internal only - manager for action
  10679. * @hidden
  10680. */
  10681. _actionManager: ActionManager;
  10682. /**
  10683. * Internal only
  10684. * @hidden
  10685. */
  10686. private _target;
  10687. /**
  10688. * Creates a new StateCondition
  10689. * @param actionManager manager for the action the condition applies to
  10690. * @param target of the condition
  10691. * @param value to compare with target state
  10692. */
  10693. constructor(actionManager: ActionManager, target: any,
  10694. /** Value to compare with target state */
  10695. value: string);
  10696. /**
  10697. * Gets a boolean indicating if the current condition is met
  10698. * @returns the validity of the state
  10699. */
  10700. isValid(): boolean;
  10701. /**
  10702. * Serialize the StateCondition into a JSON compatible object
  10703. * @returns serialization object
  10704. */
  10705. serialize(): any;
  10706. }
  10707. }
  10708. declare module "babylonjs/Actions/directActions" {
  10709. import { Action } from "babylonjs/Actions/action";
  10710. import { Condition } from "babylonjs/Actions/condition";
  10711. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10712. /**
  10713. * This defines an action responsible to toggle a boolean once triggered.
  10714. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10715. */
  10716. export class SwitchBooleanAction extends Action {
  10717. /**
  10718. * The path to the boolean property in the target object
  10719. */
  10720. propertyPath: string;
  10721. private _target;
  10722. private _effectiveTarget;
  10723. private _property;
  10724. /**
  10725. * Instantiate the action
  10726. * @param triggerOptions defines the trigger options
  10727. * @param target defines the object containing the boolean
  10728. * @param propertyPath defines the path to the boolean property in the target object
  10729. * @param condition defines the trigger related conditions
  10730. */
  10731. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10732. /** @hidden */
  10733. _prepare(): void;
  10734. /**
  10735. * Execute the action toggle the boolean value.
  10736. */
  10737. execute(): void;
  10738. /**
  10739. * Serializes the actions and its related information.
  10740. * @param parent defines the object to serialize in
  10741. * @returns the serialized object
  10742. */
  10743. serialize(parent: any): any;
  10744. }
  10745. /**
  10746. * This defines an action responsible to set a the state field of the target
  10747. * to a desired value once triggered.
  10748. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10749. */
  10750. export class SetStateAction extends Action {
  10751. /**
  10752. * The value to store in the state field.
  10753. */
  10754. value: string;
  10755. private _target;
  10756. /**
  10757. * Instantiate the action
  10758. * @param triggerOptions defines the trigger options
  10759. * @param target defines the object containing the state property
  10760. * @param value defines the value to store in the state field
  10761. * @param condition defines the trigger related conditions
  10762. */
  10763. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10764. /**
  10765. * Execute the action and store the value on the target state property.
  10766. */
  10767. execute(): void;
  10768. /**
  10769. * Serializes the actions and its related information.
  10770. * @param parent defines the object to serialize in
  10771. * @returns the serialized object
  10772. */
  10773. serialize(parent: any): any;
  10774. }
  10775. /**
  10776. * This defines an action responsible to set a property of the target
  10777. * to a desired value once triggered.
  10778. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10779. */
  10780. export class SetValueAction extends Action {
  10781. /**
  10782. * The path of the property to set in the target.
  10783. */
  10784. propertyPath: string;
  10785. /**
  10786. * The value to set in the property
  10787. */
  10788. value: any;
  10789. private _target;
  10790. private _effectiveTarget;
  10791. private _property;
  10792. /**
  10793. * Instantiate the action
  10794. * @param triggerOptions defines the trigger options
  10795. * @param target defines the object containing the property
  10796. * @param propertyPath defines the path of the property to set in the target
  10797. * @param value defines the value to set in the property
  10798. * @param condition defines the trigger related conditions
  10799. */
  10800. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10801. /** @hidden */
  10802. _prepare(): void;
  10803. /**
  10804. * Execute the action and set the targetted property to the desired value.
  10805. */
  10806. execute(): void;
  10807. /**
  10808. * Serializes the actions and its related information.
  10809. * @param parent defines the object to serialize in
  10810. * @returns the serialized object
  10811. */
  10812. serialize(parent: any): any;
  10813. }
  10814. /**
  10815. * This defines an action responsible to increment the target value
  10816. * to a desired value once triggered.
  10817. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10818. */
  10819. export class IncrementValueAction extends Action {
  10820. /**
  10821. * The path of the property to increment in the target.
  10822. */
  10823. propertyPath: string;
  10824. /**
  10825. * The value we should increment the property by.
  10826. */
  10827. value: any;
  10828. private _target;
  10829. private _effectiveTarget;
  10830. private _property;
  10831. /**
  10832. * Instantiate the action
  10833. * @param triggerOptions defines the trigger options
  10834. * @param target defines the object containing the property
  10835. * @param propertyPath defines the path of the property to increment in the target
  10836. * @param value defines the value value we should increment the property by
  10837. * @param condition defines the trigger related conditions
  10838. */
  10839. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10840. /** @hidden */
  10841. _prepare(): void;
  10842. /**
  10843. * Execute the action and increment the target of the value amount.
  10844. */
  10845. execute(): void;
  10846. /**
  10847. * Serializes the actions and its related information.
  10848. * @param parent defines the object to serialize in
  10849. * @returns the serialized object
  10850. */
  10851. serialize(parent: any): any;
  10852. }
  10853. /**
  10854. * This defines an action responsible to start an animation once triggered.
  10855. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10856. */
  10857. export class PlayAnimationAction extends Action {
  10858. /**
  10859. * Where the animation should start (animation frame)
  10860. */
  10861. from: number;
  10862. /**
  10863. * Where the animation should stop (animation frame)
  10864. */
  10865. to: number;
  10866. /**
  10867. * Define if the animation should loop or stop after the first play.
  10868. */
  10869. loop?: boolean;
  10870. private _target;
  10871. /**
  10872. * Instantiate the action
  10873. * @param triggerOptions defines the trigger options
  10874. * @param target defines the target animation or animation name
  10875. * @param from defines from where the animation should start (animation frame)
  10876. * @param end defines where the animation should stop (animation frame)
  10877. * @param loop defines if the animation should loop or stop after the first play
  10878. * @param condition defines the trigger related conditions
  10879. */
  10880. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10881. /** @hidden */
  10882. _prepare(): void;
  10883. /**
  10884. * Execute the action and play the animation.
  10885. */
  10886. execute(): void;
  10887. /**
  10888. * Serializes the actions and its related information.
  10889. * @param parent defines the object to serialize in
  10890. * @returns the serialized object
  10891. */
  10892. serialize(parent: any): any;
  10893. }
  10894. /**
  10895. * This defines an action responsible to stop an animation once triggered.
  10896. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10897. */
  10898. export class StopAnimationAction extends Action {
  10899. private _target;
  10900. /**
  10901. * Instantiate the action
  10902. * @param triggerOptions defines the trigger options
  10903. * @param target defines the target animation or animation name
  10904. * @param condition defines the trigger related conditions
  10905. */
  10906. constructor(triggerOptions: any, target: any, condition?: Condition);
  10907. /** @hidden */
  10908. _prepare(): void;
  10909. /**
  10910. * Execute the action and stop the animation.
  10911. */
  10912. execute(): void;
  10913. /**
  10914. * Serializes the actions and its related information.
  10915. * @param parent defines the object to serialize in
  10916. * @returns the serialized object
  10917. */
  10918. serialize(parent: any): any;
  10919. }
  10920. /**
  10921. * This defines an action responsible that does nothing once triggered.
  10922. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10923. */
  10924. export class DoNothingAction extends Action {
  10925. /**
  10926. * Instantiate the action
  10927. * @param triggerOptions defines the trigger options
  10928. * @param condition defines the trigger related conditions
  10929. */
  10930. constructor(triggerOptions?: any, condition?: Condition);
  10931. /**
  10932. * Execute the action and do nothing.
  10933. */
  10934. execute(): void;
  10935. /**
  10936. * Serializes the actions and its related information.
  10937. * @param parent defines the object to serialize in
  10938. * @returns the serialized object
  10939. */
  10940. serialize(parent: any): any;
  10941. }
  10942. /**
  10943. * This defines an action responsible to trigger several actions once triggered.
  10944. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10945. */
  10946. export class CombineAction extends Action {
  10947. /**
  10948. * The list of aggregated animations to run.
  10949. */
  10950. children: Action[];
  10951. /**
  10952. * Instantiate the action
  10953. * @param triggerOptions defines the trigger options
  10954. * @param children defines the list of aggregated animations to run
  10955. * @param condition defines the trigger related conditions
  10956. */
  10957. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10958. /** @hidden */
  10959. _prepare(): void;
  10960. /**
  10961. * Execute the action and executes all the aggregated actions.
  10962. */
  10963. execute(evt: ActionEvent): void;
  10964. /**
  10965. * Serializes the actions and its related information.
  10966. * @param parent defines the object to serialize in
  10967. * @returns the serialized object
  10968. */
  10969. serialize(parent: any): any;
  10970. }
  10971. /**
  10972. * This defines an action responsible to run code (external event) once triggered.
  10973. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10974. */
  10975. export class ExecuteCodeAction extends Action {
  10976. /**
  10977. * The callback function to run.
  10978. */
  10979. func: (evt: ActionEvent) => void;
  10980. /**
  10981. * Instantiate the action
  10982. * @param triggerOptions defines the trigger options
  10983. * @param func defines the callback function to run
  10984. * @param condition defines the trigger related conditions
  10985. */
  10986. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10987. /**
  10988. * Execute the action and run the attached code.
  10989. */
  10990. execute(evt: ActionEvent): void;
  10991. }
  10992. /**
  10993. * This defines an action responsible to set the parent property of the target once triggered.
  10994. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10995. */
  10996. export class SetParentAction extends Action {
  10997. private _parent;
  10998. private _target;
  10999. /**
  11000. * Instantiate the action
  11001. * @param triggerOptions defines the trigger options
  11002. * @param target defines the target containing the parent property
  11003. * @param parent defines from where the animation should start (animation frame)
  11004. * @param condition defines the trigger related conditions
  11005. */
  11006. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  11007. /** @hidden */
  11008. _prepare(): void;
  11009. /**
  11010. * Execute the action and set the parent property.
  11011. */
  11012. execute(): void;
  11013. /**
  11014. * Serializes the actions and its related information.
  11015. * @param parent defines the object to serialize in
  11016. * @returns the serialized object
  11017. */
  11018. serialize(parent: any): any;
  11019. }
  11020. }
  11021. declare module "babylonjs/Actions/actionManager" {
  11022. import { Nullable } from "babylonjs/types";
  11023. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11024. import { Scene } from "babylonjs/scene";
  11025. import { IAction } from "babylonjs/Actions/action";
  11026. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  11027. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  11028. /**
  11029. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  11030. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  11031. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  11032. */
  11033. export class ActionManager extends AbstractActionManager {
  11034. /**
  11035. * Nothing
  11036. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11037. */
  11038. static readonly NothingTrigger: number;
  11039. /**
  11040. * On pick
  11041. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11042. */
  11043. static readonly OnPickTrigger: number;
  11044. /**
  11045. * On left pick
  11046. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11047. */
  11048. static readonly OnLeftPickTrigger: number;
  11049. /**
  11050. * On right pick
  11051. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11052. */
  11053. static readonly OnRightPickTrigger: number;
  11054. /**
  11055. * On center pick
  11056. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11057. */
  11058. static readonly OnCenterPickTrigger: number;
  11059. /**
  11060. * On pick down
  11061. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11062. */
  11063. static readonly OnPickDownTrigger: number;
  11064. /**
  11065. * On double pick
  11066. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11067. */
  11068. static readonly OnDoublePickTrigger: number;
  11069. /**
  11070. * On pick up
  11071. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11072. */
  11073. static readonly OnPickUpTrigger: number;
  11074. /**
  11075. * On pick out.
  11076. * This trigger will only be raised if you also declared a OnPickDown
  11077. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11078. */
  11079. static readonly OnPickOutTrigger: number;
  11080. /**
  11081. * On long press
  11082. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11083. */
  11084. static readonly OnLongPressTrigger: number;
  11085. /**
  11086. * On pointer over
  11087. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11088. */
  11089. static readonly OnPointerOverTrigger: number;
  11090. /**
  11091. * On pointer out
  11092. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11093. */
  11094. static readonly OnPointerOutTrigger: number;
  11095. /**
  11096. * On every frame
  11097. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11098. */
  11099. static readonly OnEveryFrameTrigger: number;
  11100. /**
  11101. * On intersection enter
  11102. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11103. */
  11104. static readonly OnIntersectionEnterTrigger: number;
  11105. /**
  11106. * On intersection exit
  11107. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11108. */
  11109. static readonly OnIntersectionExitTrigger: number;
  11110. /**
  11111. * On key down
  11112. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11113. */
  11114. static readonly OnKeyDownTrigger: number;
  11115. /**
  11116. * On key up
  11117. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11118. */
  11119. static readonly OnKeyUpTrigger: number;
  11120. private _scene;
  11121. /**
  11122. * Creates a new action manager
  11123. * @param scene defines the hosting scene
  11124. */
  11125. constructor(scene: Scene);
  11126. /**
  11127. * Releases all associated resources
  11128. */
  11129. dispose(): void;
  11130. /**
  11131. * Gets hosting scene
  11132. * @returns the hosting scene
  11133. */
  11134. getScene(): Scene;
  11135. /**
  11136. * Does this action manager handles actions of any of the given triggers
  11137. * @param triggers defines the triggers to be tested
  11138. * @return a boolean indicating whether one (or more) of the triggers is handled
  11139. */
  11140. hasSpecificTriggers(triggers: number[]): boolean;
  11141. /**
  11142. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  11143. * speed.
  11144. * @param triggerA defines the trigger to be tested
  11145. * @param triggerB defines the trigger to be tested
  11146. * @return a boolean indicating whether one (or more) of the triggers is handled
  11147. */
  11148. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  11149. /**
  11150. * Does this action manager handles actions of a given trigger
  11151. * @param trigger defines the trigger to be tested
  11152. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  11153. * @return whether the trigger is handled
  11154. */
  11155. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  11156. /**
  11157. * Does this action manager has pointer triggers
  11158. */
  11159. readonly hasPointerTriggers: boolean;
  11160. /**
  11161. * Does this action manager has pick triggers
  11162. */
  11163. readonly hasPickTriggers: boolean;
  11164. /**
  11165. * Registers an action to this action manager
  11166. * @param action defines the action to be registered
  11167. * @return the action amended (prepared) after registration
  11168. */
  11169. registerAction(action: IAction): Nullable<IAction>;
  11170. /**
  11171. * Unregisters an action to this action manager
  11172. * @param action defines the action to be unregistered
  11173. * @return a boolean indicating whether the action has been unregistered
  11174. */
  11175. unregisterAction(action: IAction): Boolean;
  11176. /**
  11177. * Process a specific trigger
  11178. * @param trigger defines the trigger to process
  11179. * @param evt defines the event details to be processed
  11180. */
  11181. processTrigger(trigger: number, evt?: IActionEvent): void;
  11182. /** @hidden */
  11183. _getEffectiveTarget(target: any, propertyPath: string): any;
  11184. /** @hidden */
  11185. _getProperty(propertyPath: string): string;
  11186. /**
  11187. * Serialize this manager to a JSON object
  11188. * @param name defines the property name to store this manager
  11189. * @returns a JSON representation of this manager
  11190. */
  11191. serialize(name: string): any;
  11192. /**
  11193. * Creates a new ActionManager from a JSON data
  11194. * @param parsedActions defines the JSON data to read from
  11195. * @param object defines the hosting mesh
  11196. * @param scene defines the hosting scene
  11197. */
  11198. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  11199. /**
  11200. * Get a trigger name by index
  11201. * @param trigger defines the trigger index
  11202. * @returns a trigger name
  11203. */
  11204. static GetTriggerName(trigger: number): string;
  11205. }
  11206. }
  11207. declare module "babylonjs/Culling/ray" {
  11208. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  11209. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  11210. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11211. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11212. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  11213. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  11214. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  11215. import { Plane } from "babylonjs/Maths/math.plane";
  11216. /**
  11217. * Class representing a ray with position and direction
  11218. */
  11219. export class Ray {
  11220. /** origin point */
  11221. origin: Vector3;
  11222. /** direction */
  11223. direction: Vector3;
  11224. /** length of the ray */
  11225. length: number;
  11226. private static readonly TmpVector3;
  11227. private _tmpRay;
  11228. /**
  11229. * Creates a new ray
  11230. * @param origin origin point
  11231. * @param direction direction
  11232. * @param length length of the ray
  11233. */
  11234. constructor(
  11235. /** origin point */
  11236. origin: Vector3,
  11237. /** direction */
  11238. direction: Vector3,
  11239. /** length of the ray */
  11240. length?: number);
  11241. /**
  11242. * Checks if the ray intersects a box
  11243. * @param minimum bound of the box
  11244. * @param maximum bound of the box
  11245. * @param intersectionTreshold extra extend to be added to the box in all direction
  11246. * @returns if the box was hit
  11247. */
  11248. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11249. /**
  11250. * Checks if the ray intersects a box
  11251. * @param box the bounding box to check
  11252. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11253. * @returns if the box was hit
  11254. */
  11255. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11256. /**
  11257. * If the ray hits a sphere
  11258. * @param sphere the bounding sphere to check
  11259. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11260. * @returns true if it hits the sphere
  11261. */
  11262. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11263. /**
  11264. * If the ray hits a triange
  11265. * @param vertex0 triangle vertex
  11266. * @param vertex1 triangle vertex
  11267. * @param vertex2 triangle vertex
  11268. * @returns intersection information if hit
  11269. */
  11270. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11271. /**
  11272. * Checks if ray intersects a plane
  11273. * @param plane the plane to check
  11274. * @returns the distance away it was hit
  11275. */
  11276. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11277. /**
  11278. * Calculate the intercept of a ray on a given axis
  11279. * @param axis to check 'x' | 'y' | 'z'
  11280. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11281. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11282. */
  11283. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11284. /**
  11285. * Checks if ray intersects a mesh
  11286. * @param mesh the mesh to check
  11287. * @param fastCheck if only the bounding box should checked
  11288. * @returns picking info of the intersecton
  11289. */
  11290. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11291. /**
  11292. * Checks if ray intersects a mesh
  11293. * @param meshes the meshes to check
  11294. * @param fastCheck if only the bounding box should checked
  11295. * @param results array to store result in
  11296. * @returns Array of picking infos
  11297. */
  11298. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11299. private _comparePickingInfo;
  11300. private static smallnum;
  11301. private static rayl;
  11302. /**
  11303. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11304. * @param sega the first point of the segment to test the intersection against
  11305. * @param segb the second point of the segment to test the intersection against
  11306. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11307. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11308. */
  11309. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11310. /**
  11311. * Update the ray from viewport position
  11312. * @param x position
  11313. * @param y y position
  11314. * @param viewportWidth viewport width
  11315. * @param viewportHeight viewport height
  11316. * @param world world matrix
  11317. * @param view view matrix
  11318. * @param projection projection matrix
  11319. * @returns this ray updated
  11320. */
  11321. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11322. /**
  11323. * Creates a ray with origin and direction of 0,0,0
  11324. * @returns the new ray
  11325. */
  11326. static Zero(): Ray;
  11327. /**
  11328. * Creates a new ray from screen space and viewport
  11329. * @param x position
  11330. * @param y y position
  11331. * @param viewportWidth viewport width
  11332. * @param viewportHeight viewport height
  11333. * @param world world matrix
  11334. * @param view view matrix
  11335. * @param projection projection matrix
  11336. * @returns new ray
  11337. */
  11338. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11339. /**
  11340. * 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
  11341. * transformed to the given world matrix.
  11342. * @param origin The origin point
  11343. * @param end The end point
  11344. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11345. * @returns the new ray
  11346. */
  11347. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11348. /**
  11349. * Transforms a ray by a matrix
  11350. * @param ray ray to transform
  11351. * @param matrix matrix to apply
  11352. * @returns the resulting new ray
  11353. */
  11354. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11355. /**
  11356. * Transforms a ray by a matrix
  11357. * @param ray ray to transform
  11358. * @param matrix matrix to apply
  11359. * @param result ray to store result in
  11360. */
  11361. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11362. /**
  11363. * Unproject a ray from screen space to object space
  11364. * @param sourceX defines the screen space x coordinate to use
  11365. * @param sourceY defines the screen space y coordinate to use
  11366. * @param viewportWidth defines the current width of the viewport
  11367. * @param viewportHeight defines the current height of the viewport
  11368. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11369. * @param view defines the view matrix to use
  11370. * @param projection defines the projection matrix to use
  11371. */
  11372. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11373. }
  11374. /**
  11375. * Type used to define predicate used to select faces when a mesh intersection is detected
  11376. */
  11377. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11378. module "babylonjs/scene" {
  11379. interface Scene {
  11380. /** @hidden */
  11381. _tempPickingRay: Nullable<Ray>;
  11382. /** @hidden */
  11383. _cachedRayForTransform: Ray;
  11384. /** @hidden */
  11385. _pickWithRayInverseMatrix: Matrix;
  11386. /** @hidden */
  11387. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11388. /** @hidden */
  11389. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11390. }
  11391. }
  11392. }
  11393. declare module "babylonjs/sceneComponent" {
  11394. import { Scene } from "babylonjs/scene";
  11395. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11396. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11397. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11398. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11399. import { Nullable } from "babylonjs/types";
  11400. import { Camera } from "babylonjs/Cameras/camera";
  11401. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11402. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11403. import { AbstractScene } from "babylonjs/abstractScene";
  11404. import { Mesh } from "babylonjs/Meshes/mesh";
  11405. /**
  11406. * Groups all the scene component constants in one place to ease maintenance.
  11407. * @hidden
  11408. */
  11409. export class SceneComponentConstants {
  11410. static readonly NAME_EFFECTLAYER: string;
  11411. static readonly NAME_LAYER: string;
  11412. static readonly NAME_LENSFLARESYSTEM: string;
  11413. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11414. static readonly NAME_PARTICLESYSTEM: string;
  11415. static readonly NAME_GAMEPAD: string;
  11416. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11417. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11418. static readonly NAME_DEPTHRENDERER: string;
  11419. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11420. static readonly NAME_SPRITE: string;
  11421. static readonly NAME_OUTLINERENDERER: string;
  11422. static readonly NAME_PROCEDURALTEXTURE: string;
  11423. static readonly NAME_SHADOWGENERATOR: string;
  11424. static readonly NAME_OCTREE: string;
  11425. static readonly NAME_PHYSICSENGINE: string;
  11426. static readonly NAME_AUDIO: string;
  11427. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11428. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11429. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11430. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11431. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11432. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11433. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11434. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11435. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11436. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11437. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11438. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11439. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11440. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11441. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11442. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11443. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11444. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11445. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11446. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11447. static readonly STEP_AFTERRENDER_AUDIO: number;
  11448. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11449. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11450. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11451. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11452. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11453. static readonly STEP_POINTERMOVE_SPRITE: number;
  11454. static readonly STEP_POINTERDOWN_SPRITE: number;
  11455. static readonly STEP_POINTERUP_SPRITE: number;
  11456. }
  11457. /**
  11458. * This represents a scene component.
  11459. *
  11460. * This is used to decouple the dependency the scene is having on the different workloads like
  11461. * layers, post processes...
  11462. */
  11463. export interface ISceneComponent {
  11464. /**
  11465. * The name of the component. Each component must have a unique name.
  11466. */
  11467. name: string;
  11468. /**
  11469. * The scene the component belongs to.
  11470. */
  11471. scene: Scene;
  11472. /**
  11473. * Register the component to one instance of a scene.
  11474. */
  11475. register(): void;
  11476. /**
  11477. * Rebuilds the elements related to this component in case of
  11478. * context lost for instance.
  11479. */
  11480. rebuild(): void;
  11481. /**
  11482. * Disposes the component and the associated ressources.
  11483. */
  11484. dispose(): void;
  11485. }
  11486. /**
  11487. * This represents a SERIALIZABLE scene component.
  11488. *
  11489. * This extends Scene Component to add Serialization methods on top.
  11490. */
  11491. export interface ISceneSerializableComponent extends ISceneComponent {
  11492. /**
  11493. * Adds all the elements from the container to the scene
  11494. * @param container the container holding the elements
  11495. */
  11496. addFromContainer(container: AbstractScene): void;
  11497. /**
  11498. * Removes all the elements in the container from the scene
  11499. * @param container contains the elements to remove
  11500. * @param dispose if the removed element should be disposed (default: false)
  11501. */
  11502. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11503. /**
  11504. * Serializes the component data to the specified json object
  11505. * @param serializationObject The object to serialize to
  11506. */
  11507. serialize(serializationObject: any): void;
  11508. }
  11509. /**
  11510. * Strong typing of a Mesh related stage step action
  11511. */
  11512. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11513. /**
  11514. * Strong typing of a Evaluate Sub Mesh related stage step action
  11515. */
  11516. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11517. /**
  11518. * Strong typing of a Active Mesh related stage step action
  11519. */
  11520. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11521. /**
  11522. * Strong typing of a Camera related stage step action
  11523. */
  11524. export type CameraStageAction = (camera: Camera) => void;
  11525. /**
  11526. * Strong typing of a Camera Frame buffer related stage step action
  11527. */
  11528. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11529. /**
  11530. * Strong typing of a Render Target related stage step action
  11531. */
  11532. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11533. /**
  11534. * Strong typing of a RenderingGroup related stage step action
  11535. */
  11536. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11537. /**
  11538. * Strong typing of a Mesh Render related stage step action
  11539. */
  11540. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11541. /**
  11542. * Strong typing of a simple stage step action
  11543. */
  11544. export type SimpleStageAction = () => void;
  11545. /**
  11546. * Strong typing of a render target action.
  11547. */
  11548. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11549. /**
  11550. * Strong typing of a pointer move action.
  11551. */
  11552. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  11553. /**
  11554. * Strong typing of a pointer up/down action.
  11555. */
  11556. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11557. /**
  11558. * Representation of a stage in the scene (Basically a list of ordered steps)
  11559. * @hidden
  11560. */
  11561. export class Stage<T extends Function> extends Array<{
  11562. index: number;
  11563. component: ISceneComponent;
  11564. action: T;
  11565. }> {
  11566. /**
  11567. * Hide ctor from the rest of the world.
  11568. * @param items The items to add.
  11569. */
  11570. private constructor();
  11571. /**
  11572. * Creates a new Stage.
  11573. * @returns A new instance of a Stage
  11574. */
  11575. static Create<T extends Function>(): Stage<T>;
  11576. /**
  11577. * Registers a step in an ordered way in the targeted stage.
  11578. * @param index Defines the position to register the step in
  11579. * @param component Defines the component attached to the step
  11580. * @param action Defines the action to launch during the step
  11581. */
  11582. registerStep(index: number, component: ISceneComponent, action: T): void;
  11583. /**
  11584. * Clears all the steps from the stage.
  11585. */
  11586. clear(): void;
  11587. }
  11588. }
  11589. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11590. import { Nullable } from "babylonjs/types";
  11591. import { Observable } from "babylonjs/Misc/observable";
  11592. import { Scene } from "babylonjs/scene";
  11593. import { Sprite } from "babylonjs/Sprites/sprite";
  11594. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11595. import { Ray } from "babylonjs/Culling/ray";
  11596. import { Camera } from "babylonjs/Cameras/camera";
  11597. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11598. import { ISceneComponent } from "babylonjs/sceneComponent";
  11599. module "babylonjs/scene" {
  11600. interface Scene {
  11601. /** @hidden */
  11602. _pointerOverSprite: Nullable<Sprite>;
  11603. /** @hidden */
  11604. _pickedDownSprite: Nullable<Sprite>;
  11605. /** @hidden */
  11606. _tempSpritePickingRay: Nullable<Ray>;
  11607. /**
  11608. * All of the sprite managers added to this scene
  11609. * @see http://doc.babylonjs.com/babylon101/sprites
  11610. */
  11611. spriteManagers: Array<ISpriteManager>;
  11612. /**
  11613. * An event triggered when sprites rendering is about to start
  11614. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11615. */
  11616. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11617. /**
  11618. * An event triggered when sprites rendering is done
  11619. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11620. */
  11621. onAfterSpritesRenderingObservable: Observable<Scene>;
  11622. /** @hidden */
  11623. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11624. /** Launch a ray to try to pick a sprite in the scene
  11625. * @param x position on screen
  11626. * @param y position on screen
  11627. * @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
  11628. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11629. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11630. * @returns a PickingInfo
  11631. */
  11632. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11633. /** Use the given ray to pick a sprite in the scene
  11634. * @param ray The ray (in world space) to use to pick meshes
  11635. * @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
  11636. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11637. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11638. * @returns a PickingInfo
  11639. */
  11640. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11641. /** @hidden */
  11642. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11643. /** Launch a ray to try to pick sprites in the scene
  11644. * @param x position on screen
  11645. * @param y position on screen
  11646. * @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
  11647. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11648. * @returns a PickingInfo array
  11649. */
  11650. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11651. /** Use the given ray to pick sprites in the scene
  11652. * @param ray The ray (in world space) to use to pick meshes
  11653. * @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
  11654. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11655. * @returns a PickingInfo array
  11656. */
  11657. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11658. /**
  11659. * Force the sprite under the pointer
  11660. * @param sprite defines the sprite to use
  11661. */
  11662. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11663. /**
  11664. * Gets the sprite under the pointer
  11665. * @returns a Sprite or null if no sprite is under the pointer
  11666. */
  11667. getPointerOverSprite(): Nullable<Sprite>;
  11668. }
  11669. }
  11670. /**
  11671. * Defines the sprite scene component responsible to manage sprites
  11672. * in a given scene.
  11673. */
  11674. export class SpriteSceneComponent implements ISceneComponent {
  11675. /**
  11676. * The component name helpfull to identify the component in the list of scene components.
  11677. */
  11678. readonly name: string;
  11679. /**
  11680. * The scene the component belongs to.
  11681. */
  11682. scene: Scene;
  11683. /** @hidden */
  11684. private _spritePredicate;
  11685. /**
  11686. * Creates a new instance of the component for the given scene
  11687. * @param scene Defines the scene to register the component in
  11688. */
  11689. constructor(scene: Scene);
  11690. /**
  11691. * Registers the component in a given scene
  11692. */
  11693. register(): void;
  11694. /**
  11695. * Rebuilds the elements related to this component in case of
  11696. * context lost for instance.
  11697. */
  11698. rebuild(): void;
  11699. /**
  11700. * Disposes the component and the associated ressources.
  11701. */
  11702. dispose(): void;
  11703. private _pickSpriteButKeepRay;
  11704. private _pointerMove;
  11705. private _pointerDown;
  11706. private _pointerUp;
  11707. }
  11708. }
  11709. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11710. /** @hidden */
  11711. export var fogFragmentDeclaration: {
  11712. name: string;
  11713. shader: string;
  11714. };
  11715. }
  11716. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11717. /** @hidden */
  11718. export var fogFragment: {
  11719. name: string;
  11720. shader: string;
  11721. };
  11722. }
  11723. declare module "babylonjs/Shaders/sprites.fragment" {
  11724. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11725. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11726. /** @hidden */
  11727. export var spritesPixelShader: {
  11728. name: string;
  11729. shader: string;
  11730. };
  11731. }
  11732. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11733. /** @hidden */
  11734. export var fogVertexDeclaration: {
  11735. name: string;
  11736. shader: string;
  11737. };
  11738. }
  11739. declare module "babylonjs/Shaders/sprites.vertex" {
  11740. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11741. /** @hidden */
  11742. export var spritesVertexShader: {
  11743. name: string;
  11744. shader: string;
  11745. };
  11746. }
  11747. declare module "babylonjs/Sprites/spriteManager" {
  11748. import { IDisposable, Scene } from "babylonjs/scene";
  11749. import { Nullable } from "babylonjs/types";
  11750. import { Observable } from "babylonjs/Misc/observable";
  11751. import { Sprite } from "babylonjs/Sprites/sprite";
  11752. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11753. import { Camera } from "babylonjs/Cameras/camera";
  11754. import { Texture } from "babylonjs/Materials/Textures/texture";
  11755. import "babylonjs/Shaders/sprites.fragment";
  11756. import "babylonjs/Shaders/sprites.vertex";
  11757. import { Ray } from "babylonjs/Culling/ray";
  11758. /**
  11759. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11760. */
  11761. export interface ISpriteManager extends IDisposable {
  11762. /**
  11763. * Restricts the camera to viewing objects with the same layerMask.
  11764. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11765. */
  11766. layerMask: number;
  11767. /**
  11768. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11769. */
  11770. isPickable: boolean;
  11771. /**
  11772. * Specifies the rendering group id for this mesh (0 by default)
  11773. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11774. */
  11775. renderingGroupId: number;
  11776. /**
  11777. * Defines the list of sprites managed by the manager.
  11778. */
  11779. sprites: Array<Sprite>;
  11780. /**
  11781. * Tests the intersection of a sprite with a specific ray.
  11782. * @param ray The ray we are sending to test the collision
  11783. * @param camera The camera space we are sending rays in
  11784. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11785. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11786. * @returns picking info or null.
  11787. */
  11788. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11789. /**
  11790. * Intersects the sprites with a ray
  11791. * @param ray defines the ray to intersect with
  11792. * @param camera defines the current active camera
  11793. * @param predicate defines a predicate used to select candidate sprites
  11794. * @returns null if no hit or a PickingInfo array
  11795. */
  11796. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11797. /**
  11798. * Renders the list of sprites on screen.
  11799. */
  11800. render(): void;
  11801. }
  11802. /**
  11803. * Class used to manage multiple sprites on the same spritesheet
  11804. * @see http://doc.babylonjs.com/babylon101/sprites
  11805. */
  11806. export class SpriteManager implements ISpriteManager {
  11807. /** defines the manager's name */
  11808. name: string;
  11809. /** Gets the list of sprites */
  11810. sprites: Sprite[];
  11811. /** Gets or sets the rendering group id (0 by default) */
  11812. renderingGroupId: number;
  11813. /** Gets or sets camera layer mask */
  11814. layerMask: number;
  11815. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11816. fogEnabled: boolean;
  11817. /** Gets or sets a boolean indicating if the sprites are pickable */
  11818. isPickable: boolean;
  11819. /** Defines the default width of a cell in the spritesheet */
  11820. cellWidth: number;
  11821. /** Defines the default height of a cell in the spritesheet */
  11822. cellHeight: number;
  11823. /** Associative array from JSON sprite data file */
  11824. private _cellData;
  11825. /** Array of sprite names from JSON sprite data file */
  11826. private _spriteMap;
  11827. /** True when packed cell data from JSON file is ready*/
  11828. private _packedAndReady;
  11829. /**
  11830. * An event triggered when the manager is disposed.
  11831. */
  11832. onDisposeObservable: Observable<SpriteManager>;
  11833. private _onDisposeObserver;
  11834. /**
  11835. * Callback called when the manager is disposed
  11836. */
  11837. onDispose: () => void;
  11838. private _capacity;
  11839. private _fromPacked;
  11840. private _spriteTexture;
  11841. private _epsilon;
  11842. private _scene;
  11843. private _vertexData;
  11844. private _buffer;
  11845. private _vertexBuffers;
  11846. private _indexBuffer;
  11847. private _effectBase;
  11848. private _effectFog;
  11849. /**
  11850. * Gets or sets the spritesheet texture
  11851. */
  11852. texture: Texture;
  11853. /**
  11854. * Creates a new sprite manager
  11855. * @param name defines the manager's name
  11856. * @param imgUrl defines the sprite sheet url
  11857. * @param capacity defines the maximum allowed number of sprites
  11858. * @param cellSize defines the size of a sprite cell
  11859. * @param scene defines the hosting scene
  11860. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11861. * @param samplingMode defines the smapling mode to use with spritesheet
  11862. * @param fromPacked set to false; do not alter
  11863. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11864. */
  11865. constructor(
  11866. /** defines the manager's name */
  11867. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  11868. private _makePacked;
  11869. private _appendSpriteVertex;
  11870. /**
  11871. * Intersects the sprites with a ray
  11872. * @param ray defines the ray to intersect with
  11873. * @param camera defines the current active camera
  11874. * @param predicate defines a predicate used to select candidate sprites
  11875. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11876. * @returns null if no hit or a PickingInfo
  11877. */
  11878. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11879. /**
  11880. * Intersects the sprites with a ray
  11881. * @param ray defines the ray to intersect with
  11882. * @param camera defines the current active camera
  11883. * @param predicate defines a predicate used to select candidate sprites
  11884. * @returns null if no hit or a PickingInfo array
  11885. */
  11886. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11887. /**
  11888. * Render all child sprites
  11889. */
  11890. render(): void;
  11891. /**
  11892. * Release associated resources
  11893. */
  11894. dispose(): void;
  11895. }
  11896. }
  11897. declare module "babylonjs/Sprites/sprite" {
  11898. import { Vector3 } from "babylonjs/Maths/math.vector";
  11899. import { Nullable } from "babylonjs/types";
  11900. import { ActionManager } from "babylonjs/Actions/actionManager";
  11901. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11902. import { Color4 } from "babylonjs/Maths/math.color";
  11903. /**
  11904. * Class used to represent a sprite
  11905. * @see http://doc.babylonjs.com/babylon101/sprites
  11906. */
  11907. export class Sprite {
  11908. /** defines the name */
  11909. name: string;
  11910. /** Gets or sets the current world position */
  11911. position: Vector3;
  11912. /** Gets or sets the main color */
  11913. color: Color4;
  11914. /** Gets or sets the width */
  11915. width: number;
  11916. /** Gets or sets the height */
  11917. height: number;
  11918. /** Gets or sets rotation angle */
  11919. angle: number;
  11920. /** Gets or sets the cell index in the sprite sheet */
  11921. cellIndex: number;
  11922. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  11923. cellRef: string;
  11924. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11925. invertU: number;
  11926. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11927. invertV: number;
  11928. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11929. disposeWhenFinishedAnimating: boolean;
  11930. /** Gets the list of attached animations */
  11931. animations: Animation[];
  11932. /** Gets or sets a boolean indicating if the sprite can be picked */
  11933. isPickable: boolean;
  11934. /**
  11935. * Gets or sets the associated action manager
  11936. */
  11937. actionManager: Nullable<ActionManager>;
  11938. private _animationStarted;
  11939. private _loopAnimation;
  11940. private _fromIndex;
  11941. private _toIndex;
  11942. private _delay;
  11943. private _direction;
  11944. private _manager;
  11945. private _time;
  11946. private _onAnimationEnd;
  11947. /**
  11948. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11949. */
  11950. isVisible: boolean;
  11951. /**
  11952. * Gets or sets the sprite size
  11953. */
  11954. size: number;
  11955. /**
  11956. * Creates a new Sprite
  11957. * @param name defines the name
  11958. * @param manager defines the manager
  11959. */
  11960. constructor(
  11961. /** defines the name */
  11962. name: string, manager: ISpriteManager);
  11963. /**
  11964. * Starts an animation
  11965. * @param from defines the initial key
  11966. * @param to defines the end key
  11967. * @param loop defines if the animation must loop
  11968. * @param delay defines the start delay (in ms)
  11969. * @param onAnimationEnd defines a callback to call when animation ends
  11970. */
  11971. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11972. /** Stops current animation (if any) */
  11973. stopAnimation(): void;
  11974. /** @hidden */
  11975. _animate(deltaTime: number): void;
  11976. /** Release associated resources */
  11977. dispose(): void;
  11978. }
  11979. }
  11980. declare module "babylonjs/Collisions/pickingInfo" {
  11981. import { Nullable } from "babylonjs/types";
  11982. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11983. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11984. import { Sprite } from "babylonjs/Sprites/sprite";
  11985. import { Ray } from "babylonjs/Culling/ray";
  11986. /**
  11987. * Information about the result of picking within a scene
  11988. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11989. */
  11990. export class PickingInfo {
  11991. /** @hidden */
  11992. _pickingUnavailable: boolean;
  11993. /**
  11994. * If the pick collided with an object
  11995. */
  11996. hit: boolean;
  11997. /**
  11998. * Distance away where the pick collided
  11999. */
  12000. distance: number;
  12001. /**
  12002. * The location of pick collision
  12003. */
  12004. pickedPoint: Nullable<Vector3>;
  12005. /**
  12006. * The mesh corresponding the the pick collision
  12007. */
  12008. pickedMesh: Nullable<AbstractMesh>;
  12009. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  12010. bu: number;
  12011. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  12012. bv: number;
  12013. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  12014. faceId: number;
  12015. /** Id of the the submesh that was picked */
  12016. subMeshId: number;
  12017. /** If a sprite was picked, this will be the sprite the pick collided with */
  12018. pickedSprite: Nullable<Sprite>;
  12019. /**
  12020. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  12021. */
  12022. originMesh: Nullable<AbstractMesh>;
  12023. /**
  12024. * The ray that was used to perform the picking.
  12025. */
  12026. ray: Nullable<Ray>;
  12027. /**
  12028. * Gets the normal correspodning to the face the pick collided with
  12029. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  12030. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  12031. * @returns The normal correspodning to the face the pick collided with
  12032. */
  12033. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  12034. /**
  12035. * Gets the texture coordinates of where the pick occured
  12036. * @returns the vector containing the coordnates of the texture
  12037. */
  12038. getTextureCoordinates(): Nullable<Vector2>;
  12039. }
  12040. }
  12041. declare module "babylonjs/Events/pointerEvents" {
  12042. import { Nullable } from "babylonjs/types";
  12043. import { Vector2 } from "babylonjs/Maths/math.vector";
  12044. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  12045. import { Ray } from "babylonjs/Culling/ray";
  12046. /**
  12047. * Gather the list of pointer event types as constants.
  12048. */
  12049. export class PointerEventTypes {
  12050. /**
  12051. * 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.
  12052. */
  12053. static readonly POINTERDOWN: number;
  12054. /**
  12055. * The pointerup event is fired when a pointer is no longer active.
  12056. */
  12057. static readonly POINTERUP: number;
  12058. /**
  12059. * The pointermove event is fired when a pointer changes coordinates.
  12060. */
  12061. static readonly POINTERMOVE: number;
  12062. /**
  12063. * The pointerwheel event is fired when a mouse wheel has been rotated.
  12064. */
  12065. static readonly POINTERWHEEL: number;
  12066. /**
  12067. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  12068. */
  12069. static readonly POINTERPICK: number;
  12070. /**
  12071. * The pointertap event is fired when a the object has been touched and released without drag.
  12072. */
  12073. static readonly POINTERTAP: number;
  12074. /**
  12075. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  12076. */
  12077. static readonly POINTERDOUBLETAP: number;
  12078. }
  12079. /**
  12080. * Base class of pointer info types.
  12081. */
  12082. export class PointerInfoBase {
  12083. /**
  12084. * Defines the type of event (PointerEventTypes)
  12085. */
  12086. type: number;
  12087. /**
  12088. * Defines the related dom event
  12089. */
  12090. event: PointerEvent | MouseWheelEvent;
  12091. /**
  12092. * Instantiates the base class of pointers info.
  12093. * @param type Defines the type of event (PointerEventTypes)
  12094. * @param event Defines the related dom event
  12095. */
  12096. constructor(
  12097. /**
  12098. * Defines the type of event (PointerEventTypes)
  12099. */
  12100. type: number,
  12101. /**
  12102. * Defines the related dom event
  12103. */
  12104. event: PointerEvent | MouseWheelEvent);
  12105. }
  12106. /**
  12107. * This class is used to store pointer related info for the onPrePointerObservable event.
  12108. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  12109. */
  12110. export class PointerInfoPre extends PointerInfoBase {
  12111. /**
  12112. * Ray from a pointer if availible (eg. 6dof controller)
  12113. */
  12114. ray: Nullable<Ray>;
  12115. /**
  12116. * Defines the local position of the pointer on the canvas.
  12117. */
  12118. localPosition: Vector2;
  12119. /**
  12120. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  12121. */
  12122. skipOnPointerObservable: boolean;
  12123. /**
  12124. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  12125. * @param type Defines the type of event (PointerEventTypes)
  12126. * @param event Defines the related dom event
  12127. * @param localX Defines the local x coordinates of the pointer when the event occured
  12128. * @param localY Defines the local y coordinates of the pointer when the event occured
  12129. */
  12130. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  12131. }
  12132. /**
  12133. * This type contains all the data related to a pointer event in Babylon.js.
  12134. * 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.
  12135. */
  12136. export class PointerInfo extends PointerInfoBase {
  12137. /**
  12138. * Defines the picking info associated to the info (if any)\
  12139. */
  12140. pickInfo: Nullable<PickingInfo>;
  12141. /**
  12142. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  12143. * @param type Defines the type of event (PointerEventTypes)
  12144. * @param event Defines the related dom event
  12145. * @param pickInfo Defines the picking info associated to the info (if any)\
  12146. */
  12147. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  12148. /**
  12149. * Defines the picking info associated to the info (if any)\
  12150. */
  12151. pickInfo: Nullable<PickingInfo>);
  12152. }
  12153. /**
  12154. * Data relating to a touch event on the screen.
  12155. */
  12156. export interface PointerTouch {
  12157. /**
  12158. * X coordinate of touch.
  12159. */
  12160. x: number;
  12161. /**
  12162. * Y coordinate of touch.
  12163. */
  12164. y: number;
  12165. /**
  12166. * Id of touch. Unique for each finger.
  12167. */
  12168. pointerId: number;
  12169. /**
  12170. * Event type passed from DOM.
  12171. */
  12172. type: any;
  12173. }
  12174. }
  12175. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  12176. import { Observable } from "babylonjs/Misc/observable";
  12177. import { Nullable } from "babylonjs/types";
  12178. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12179. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12180. /**
  12181. * Manage the mouse inputs to control the movement of a free camera.
  12182. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12183. */
  12184. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  12185. /**
  12186. * Define if touch is enabled in the mouse input
  12187. */
  12188. touchEnabled: boolean;
  12189. /**
  12190. * Defines the camera the input is attached to.
  12191. */
  12192. camera: FreeCamera;
  12193. /**
  12194. * Defines the buttons associated with the input to handle camera move.
  12195. */
  12196. buttons: number[];
  12197. /**
  12198. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  12199. */
  12200. angularSensibility: number;
  12201. private _pointerInput;
  12202. private _onMouseMove;
  12203. private _observer;
  12204. private previousPosition;
  12205. /**
  12206. * Observable for when a pointer move event occurs containing the move offset
  12207. */
  12208. onPointerMovedObservable: Observable<{
  12209. offsetX: number;
  12210. offsetY: number;
  12211. }>;
  12212. /**
  12213. * @hidden
  12214. * If the camera should be rotated automatically based on pointer movement
  12215. */
  12216. _allowCameraRotation: boolean;
  12217. /**
  12218. * Manage the mouse inputs to control the movement of a free camera.
  12219. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12220. * @param touchEnabled Defines if touch is enabled or not
  12221. */
  12222. constructor(
  12223. /**
  12224. * Define if touch is enabled in the mouse input
  12225. */
  12226. touchEnabled?: boolean);
  12227. /**
  12228. * Attach the input controls to a specific dom element to get the input from.
  12229. * @param element Defines the element the controls should be listened from
  12230. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12231. */
  12232. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12233. /**
  12234. * Called on JS contextmenu event.
  12235. * Override this method to provide functionality.
  12236. */
  12237. protected onContextMenu(evt: PointerEvent): void;
  12238. /**
  12239. * Detach the current controls from the specified dom element.
  12240. * @param element Defines the element to stop listening the inputs from
  12241. */
  12242. detachControl(element: Nullable<HTMLElement>): void;
  12243. /**
  12244. * Gets the class name of the current intput.
  12245. * @returns the class name
  12246. */
  12247. getClassName(): string;
  12248. /**
  12249. * Get the friendly name associated with the input class.
  12250. * @returns the input friendly name
  12251. */
  12252. getSimpleName(): string;
  12253. }
  12254. }
  12255. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  12256. import { Nullable } from "babylonjs/types";
  12257. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12258. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12259. /**
  12260. * Manage the touch inputs to control the movement of a free camera.
  12261. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12262. */
  12263. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  12264. /**
  12265. * Defines the camera the input is attached to.
  12266. */
  12267. camera: FreeCamera;
  12268. /**
  12269. * Defines the touch sensibility for rotation.
  12270. * The higher the faster.
  12271. */
  12272. touchAngularSensibility: number;
  12273. /**
  12274. * Defines the touch sensibility for move.
  12275. * The higher the faster.
  12276. */
  12277. touchMoveSensibility: number;
  12278. private _offsetX;
  12279. private _offsetY;
  12280. private _pointerPressed;
  12281. private _pointerInput;
  12282. private _observer;
  12283. private _onLostFocus;
  12284. /**
  12285. * Attach the input controls to a specific dom element to get the input from.
  12286. * @param element Defines the element the controls should be listened from
  12287. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12288. */
  12289. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12290. /**
  12291. * Detach the current controls from the specified dom element.
  12292. * @param element Defines the element to stop listening the inputs from
  12293. */
  12294. detachControl(element: Nullable<HTMLElement>): void;
  12295. /**
  12296. * Update the current camera state depending on the inputs that have been used this frame.
  12297. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12298. */
  12299. checkInputs(): void;
  12300. /**
  12301. * Gets the class name of the current intput.
  12302. * @returns the class name
  12303. */
  12304. getClassName(): string;
  12305. /**
  12306. * Get the friendly name associated with the input class.
  12307. * @returns the input friendly name
  12308. */
  12309. getSimpleName(): string;
  12310. }
  12311. }
  12312. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12313. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12314. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12315. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12316. import { Nullable } from "babylonjs/types";
  12317. /**
  12318. * Default Inputs manager for the FreeCamera.
  12319. * It groups all the default supported inputs for ease of use.
  12320. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12321. */
  12322. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12323. /**
  12324. * @hidden
  12325. */
  12326. _mouseInput: Nullable<FreeCameraMouseInput>;
  12327. /**
  12328. * Instantiates a new FreeCameraInputsManager.
  12329. * @param camera Defines the camera the inputs belong to
  12330. */
  12331. constructor(camera: FreeCamera);
  12332. /**
  12333. * Add keyboard input support to the input manager.
  12334. * @returns the current input manager
  12335. */
  12336. addKeyboard(): FreeCameraInputsManager;
  12337. /**
  12338. * Add mouse input support to the input manager.
  12339. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12340. * @returns the current input manager
  12341. */
  12342. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12343. /**
  12344. * Removes the mouse input support from the manager
  12345. * @returns the current input manager
  12346. */
  12347. removeMouse(): FreeCameraInputsManager;
  12348. /**
  12349. * Add touch input support to the input manager.
  12350. * @returns the current input manager
  12351. */
  12352. addTouch(): FreeCameraInputsManager;
  12353. /**
  12354. * Remove all attached input methods from a camera
  12355. */
  12356. clear(): void;
  12357. }
  12358. }
  12359. declare module "babylonjs/Cameras/freeCamera" {
  12360. import { Vector3 } from "babylonjs/Maths/math.vector";
  12361. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12362. import { Scene } from "babylonjs/scene";
  12363. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12364. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12365. /**
  12366. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12367. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12368. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12369. */
  12370. export class FreeCamera extends TargetCamera {
  12371. /**
  12372. * Define the collision ellipsoid of the camera.
  12373. * This is helpful to simulate a camera body like the player body around the camera
  12374. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12375. */
  12376. ellipsoid: Vector3;
  12377. /**
  12378. * Define an offset for the position of the ellipsoid around the camera.
  12379. * This can be helpful to determine the center of the body near the gravity center of the body
  12380. * instead of its head.
  12381. */
  12382. ellipsoidOffset: Vector3;
  12383. /**
  12384. * Enable or disable collisions of the camera with the rest of the scene objects.
  12385. */
  12386. checkCollisions: boolean;
  12387. /**
  12388. * Enable or disable gravity on the camera.
  12389. */
  12390. applyGravity: boolean;
  12391. /**
  12392. * Define the input manager associated to the camera.
  12393. */
  12394. inputs: FreeCameraInputsManager;
  12395. /**
  12396. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12397. * Higher values reduce sensitivity.
  12398. */
  12399. /**
  12400. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12401. * Higher values reduce sensitivity.
  12402. */
  12403. angularSensibility: number;
  12404. /**
  12405. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12406. */
  12407. keysUp: number[];
  12408. /**
  12409. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12410. */
  12411. keysDown: number[];
  12412. /**
  12413. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12414. */
  12415. keysLeft: number[];
  12416. /**
  12417. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12418. */
  12419. keysRight: number[];
  12420. /**
  12421. * Event raised when the camera collide with a mesh in the scene.
  12422. */
  12423. onCollide: (collidedMesh: AbstractMesh) => void;
  12424. private _collider;
  12425. private _needMoveForGravity;
  12426. private _oldPosition;
  12427. private _diffPosition;
  12428. private _newPosition;
  12429. /** @hidden */
  12430. _localDirection: Vector3;
  12431. /** @hidden */
  12432. _transformedDirection: Vector3;
  12433. /**
  12434. * Instantiates a Free Camera.
  12435. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12436. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12437. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12438. * @param name Define the name of the camera in the scene
  12439. * @param position Define the start position of the camera in the scene
  12440. * @param scene Define the scene the camera belongs to
  12441. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12442. */
  12443. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12444. /**
  12445. * Attached controls to the current camera.
  12446. * @param element Defines the element the controls should be listened from
  12447. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12448. */
  12449. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12450. /**
  12451. * Detach the current controls from the camera.
  12452. * The camera will stop reacting to inputs.
  12453. * @param element Defines the element to stop listening the inputs from
  12454. */
  12455. detachControl(element: HTMLElement): void;
  12456. private _collisionMask;
  12457. /**
  12458. * Define a collision mask to limit the list of object the camera can collide with
  12459. */
  12460. collisionMask: number;
  12461. /** @hidden */
  12462. _collideWithWorld(displacement: Vector3): void;
  12463. private _onCollisionPositionChange;
  12464. /** @hidden */
  12465. _checkInputs(): void;
  12466. /** @hidden */
  12467. _decideIfNeedsToMove(): boolean;
  12468. /** @hidden */
  12469. _updatePosition(): void;
  12470. /**
  12471. * Destroy the camera and release the current resources hold by it.
  12472. */
  12473. dispose(): void;
  12474. /**
  12475. * Gets the current object class name.
  12476. * @return the class name
  12477. */
  12478. getClassName(): string;
  12479. }
  12480. }
  12481. declare module "babylonjs/Gamepads/gamepad" {
  12482. import { Observable } from "babylonjs/Misc/observable";
  12483. /**
  12484. * Represents a gamepad control stick position
  12485. */
  12486. export class StickValues {
  12487. /**
  12488. * The x component of the control stick
  12489. */
  12490. x: number;
  12491. /**
  12492. * The y component of the control stick
  12493. */
  12494. y: number;
  12495. /**
  12496. * Initializes the gamepad x and y control stick values
  12497. * @param x The x component of the gamepad control stick value
  12498. * @param y The y component of the gamepad control stick value
  12499. */
  12500. constructor(
  12501. /**
  12502. * The x component of the control stick
  12503. */
  12504. x: number,
  12505. /**
  12506. * The y component of the control stick
  12507. */
  12508. y: number);
  12509. }
  12510. /**
  12511. * An interface which manages callbacks for gamepad button changes
  12512. */
  12513. export interface GamepadButtonChanges {
  12514. /**
  12515. * Called when a gamepad has been changed
  12516. */
  12517. changed: boolean;
  12518. /**
  12519. * Called when a gamepad press event has been triggered
  12520. */
  12521. pressChanged: boolean;
  12522. /**
  12523. * Called when a touch event has been triggered
  12524. */
  12525. touchChanged: boolean;
  12526. /**
  12527. * Called when a value has changed
  12528. */
  12529. valueChanged: boolean;
  12530. }
  12531. /**
  12532. * Represents a gamepad
  12533. */
  12534. export class Gamepad {
  12535. /**
  12536. * The id of the gamepad
  12537. */
  12538. id: string;
  12539. /**
  12540. * The index of the gamepad
  12541. */
  12542. index: number;
  12543. /**
  12544. * The browser gamepad
  12545. */
  12546. browserGamepad: any;
  12547. /**
  12548. * Specifies what type of gamepad this represents
  12549. */
  12550. type: number;
  12551. private _leftStick;
  12552. private _rightStick;
  12553. /** @hidden */
  12554. _isConnected: boolean;
  12555. private _leftStickAxisX;
  12556. private _leftStickAxisY;
  12557. private _rightStickAxisX;
  12558. private _rightStickAxisY;
  12559. /**
  12560. * Triggered when the left control stick has been changed
  12561. */
  12562. private _onleftstickchanged;
  12563. /**
  12564. * Triggered when the right control stick has been changed
  12565. */
  12566. private _onrightstickchanged;
  12567. /**
  12568. * Represents a gamepad controller
  12569. */
  12570. static GAMEPAD: number;
  12571. /**
  12572. * Represents a generic controller
  12573. */
  12574. static GENERIC: number;
  12575. /**
  12576. * Represents an XBox controller
  12577. */
  12578. static XBOX: number;
  12579. /**
  12580. * Represents a pose-enabled controller
  12581. */
  12582. static POSE_ENABLED: number;
  12583. /**
  12584. * Represents an Dual Shock controller
  12585. */
  12586. static DUALSHOCK: number;
  12587. /**
  12588. * Specifies whether the left control stick should be Y-inverted
  12589. */
  12590. protected _invertLeftStickY: boolean;
  12591. /**
  12592. * Specifies if the gamepad has been connected
  12593. */
  12594. readonly isConnected: boolean;
  12595. /**
  12596. * Initializes the gamepad
  12597. * @param id The id of the gamepad
  12598. * @param index The index of the gamepad
  12599. * @param browserGamepad The browser gamepad
  12600. * @param leftStickX The x component of the left joystick
  12601. * @param leftStickY The y component of the left joystick
  12602. * @param rightStickX The x component of the right joystick
  12603. * @param rightStickY The y component of the right joystick
  12604. */
  12605. constructor(
  12606. /**
  12607. * The id of the gamepad
  12608. */
  12609. id: string,
  12610. /**
  12611. * The index of the gamepad
  12612. */
  12613. index: number,
  12614. /**
  12615. * The browser gamepad
  12616. */
  12617. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12618. /**
  12619. * Callback triggered when the left joystick has changed
  12620. * @param callback
  12621. */
  12622. onleftstickchanged(callback: (values: StickValues) => void): void;
  12623. /**
  12624. * Callback triggered when the right joystick has changed
  12625. * @param callback
  12626. */
  12627. onrightstickchanged(callback: (values: StickValues) => void): void;
  12628. /**
  12629. * Gets the left joystick
  12630. */
  12631. /**
  12632. * Sets the left joystick values
  12633. */
  12634. leftStick: StickValues;
  12635. /**
  12636. * Gets the right joystick
  12637. */
  12638. /**
  12639. * Sets the right joystick value
  12640. */
  12641. rightStick: StickValues;
  12642. /**
  12643. * Updates the gamepad joystick positions
  12644. */
  12645. update(): void;
  12646. /**
  12647. * Disposes the gamepad
  12648. */
  12649. dispose(): void;
  12650. }
  12651. /**
  12652. * Represents a generic gamepad
  12653. */
  12654. export class GenericPad extends Gamepad {
  12655. private _buttons;
  12656. private _onbuttondown;
  12657. private _onbuttonup;
  12658. /**
  12659. * Observable triggered when a button has been pressed
  12660. */
  12661. onButtonDownObservable: Observable<number>;
  12662. /**
  12663. * Observable triggered when a button has been released
  12664. */
  12665. onButtonUpObservable: Observable<number>;
  12666. /**
  12667. * Callback triggered when a button has been pressed
  12668. * @param callback Called when a button has been pressed
  12669. */
  12670. onbuttondown(callback: (buttonPressed: number) => void): void;
  12671. /**
  12672. * Callback triggered when a button has been released
  12673. * @param callback Called when a button has been released
  12674. */
  12675. onbuttonup(callback: (buttonReleased: number) => void): void;
  12676. /**
  12677. * Initializes the generic gamepad
  12678. * @param id The id of the generic gamepad
  12679. * @param index The index of the generic gamepad
  12680. * @param browserGamepad The browser gamepad
  12681. */
  12682. constructor(id: string, index: number, browserGamepad: any);
  12683. private _setButtonValue;
  12684. /**
  12685. * Updates the generic gamepad
  12686. */
  12687. update(): void;
  12688. /**
  12689. * Disposes the generic gamepad
  12690. */
  12691. dispose(): void;
  12692. }
  12693. }
  12694. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12695. import { Nullable } from "babylonjs/types";
  12696. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12697. import { Scene } from "babylonjs/scene";
  12698. module "babylonjs/Engines/engine" {
  12699. interface Engine {
  12700. /**
  12701. * Creates a raw texture
  12702. * @param data defines the data to store in the texture
  12703. * @param width defines the width of the texture
  12704. * @param height defines the height of the texture
  12705. * @param format defines the format of the data
  12706. * @param generateMipMaps defines if the engine should generate the mip levels
  12707. * @param invertY defines if data must be stored with Y axis inverted
  12708. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12709. * @param compression defines the compression used (null by default)
  12710. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12711. * @returns the raw texture inside an InternalTexture
  12712. */
  12713. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12714. /**
  12715. * Update a raw texture
  12716. * @param texture defines the texture to update
  12717. * @param data defines the data to store in the texture
  12718. * @param format defines the format of the data
  12719. * @param invertY defines if data must be stored with Y axis inverted
  12720. */
  12721. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12722. /**
  12723. * Update a raw texture
  12724. * @param texture defines the texture to update
  12725. * @param data defines the data to store in the texture
  12726. * @param format defines the format of the data
  12727. * @param invertY defines if data must be stored with Y axis inverted
  12728. * @param compression defines the compression used (null by default)
  12729. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12730. */
  12731. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12732. /**
  12733. * Creates a new raw cube texture
  12734. * @param data defines the array of data to use to create each face
  12735. * @param size defines the size of the textures
  12736. * @param format defines the format of the data
  12737. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12738. * @param generateMipMaps defines if the engine should generate the mip levels
  12739. * @param invertY defines if data must be stored with Y axis inverted
  12740. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12741. * @param compression defines the compression used (null by default)
  12742. * @returns the cube texture as an InternalTexture
  12743. */
  12744. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12745. /**
  12746. * Update a raw cube texture
  12747. * @param texture defines the texture to udpdate
  12748. * @param data defines the data to store
  12749. * @param format defines the data format
  12750. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12751. * @param invertY defines if data must be stored with Y axis inverted
  12752. */
  12753. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12754. /**
  12755. * Update a raw cube texture
  12756. * @param texture defines the texture to udpdate
  12757. * @param data defines the data to store
  12758. * @param format defines the data format
  12759. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12760. * @param invertY defines if data must be stored with Y axis inverted
  12761. * @param compression defines the compression used (null by default)
  12762. */
  12763. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12764. /**
  12765. * Update a raw cube texture
  12766. * @param texture defines the texture to udpdate
  12767. * @param data defines the data to store
  12768. * @param format defines the data format
  12769. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12770. * @param invertY defines if data must be stored with Y axis inverted
  12771. * @param compression defines the compression used (null by default)
  12772. * @param level defines which level of the texture to update
  12773. */
  12774. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12775. /**
  12776. * Creates a new raw cube texture from a specified url
  12777. * @param url defines the url where the data is located
  12778. * @param scene defines the current scene
  12779. * @param size defines the size of the textures
  12780. * @param format defines the format of the data
  12781. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12782. * @param noMipmap defines if the engine should avoid generating the mip levels
  12783. * @param callback defines a callback used to extract texture data from loaded data
  12784. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12785. * @param onLoad defines a callback called when texture is loaded
  12786. * @param onError defines a callback called if there is an error
  12787. * @returns the cube texture as an InternalTexture
  12788. */
  12789. 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;
  12790. /**
  12791. * Creates a new raw cube texture from a specified url
  12792. * @param url defines the url where the data is located
  12793. * @param scene defines the current scene
  12794. * @param size defines the size of the textures
  12795. * @param format defines the format of the data
  12796. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12797. * @param noMipmap defines if the engine should avoid generating the mip levels
  12798. * @param callback defines a callback used to extract texture data from loaded data
  12799. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12800. * @param onLoad defines a callback called when texture is loaded
  12801. * @param onError defines a callback called if there is an error
  12802. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12803. * @param invertY defines if data must be stored with Y axis inverted
  12804. * @returns the cube texture as an InternalTexture
  12805. */
  12806. 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;
  12807. /**
  12808. * Creates a new raw 3D texture
  12809. * @param data defines the data used to create the texture
  12810. * @param width defines the width of the texture
  12811. * @param height defines the height of the texture
  12812. * @param depth defines the depth of the texture
  12813. * @param format defines the format of the texture
  12814. * @param generateMipMaps defines if the engine must generate mip levels
  12815. * @param invertY defines if data must be stored with Y axis inverted
  12816. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12817. * @param compression defines the compressed used (can be null)
  12818. * @param textureType defines the compressed used (can be null)
  12819. * @returns a new raw 3D texture (stored in an InternalTexture)
  12820. */
  12821. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12822. /**
  12823. * Update a raw 3D texture
  12824. * @param texture defines the texture to update
  12825. * @param data defines the data to store
  12826. * @param format defines the data format
  12827. * @param invertY defines if data must be stored with Y axis inverted
  12828. */
  12829. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12830. /**
  12831. * Update a raw 3D texture
  12832. * @param texture defines the texture to update
  12833. * @param data defines the data to store
  12834. * @param format defines the data format
  12835. * @param invertY defines if data must be stored with Y axis inverted
  12836. * @param compression defines the used compression (can be null)
  12837. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12838. */
  12839. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12840. /**
  12841. * Creates a new raw 2D array texture
  12842. * @param data defines the data used to create the texture
  12843. * @param width defines the width of the texture
  12844. * @param height defines the height of the texture
  12845. * @param depth defines the number of layers of the texture
  12846. * @param format defines the format of the texture
  12847. * @param generateMipMaps defines if the engine must generate mip levels
  12848. * @param invertY defines if data must be stored with Y axis inverted
  12849. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12850. * @param compression defines the compressed used (can be null)
  12851. * @param textureType defines the compressed used (can be null)
  12852. * @returns a new raw 2D array texture (stored in an InternalTexture)
  12853. */
  12854. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12855. /**
  12856. * Update a raw 2D array texture
  12857. * @param texture defines the texture to update
  12858. * @param data defines the data to store
  12859. * @param format defines the data format
  12860. * @param invertY defines if data must be stored with Y axis inverted
  12861. */
  12862. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12863. /**
  12864. * Update a raw 2D array texture
  12865. * @param texture defines the texture to update
  12866. * @param data defines the data to store
  12867. * @param format defines the data format
  12868. * @param invertY defines if data must be stored with Y axis inverted
  12869. * @param compression defines the used compression (can be null)
  12870. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12871. */
  12872. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12873. }
  12874. }
  12875. }
  12876. declare module "babylonjs/Materials/Textures/rawTexture" {
  12877. import { Scene } from "babylonjs/scene";
  12878. import { Texture } from "babylonjs/Materials/Textures/texture";
  12879. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12880. /**
  12881. * Raw texture can help creating a texture directly from an array of data.
  12882. * This can be super useful if you either get the data from an uncompressed source or
  12883. * if you wish to create your texture pixel by pixel.
  12884. */
  12885. export class RawTexture extends Texture {
  12886. /**
  12887. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12888. */
  12889. format: number;
  12890. private _engine;
  12891. /**
  12892. * Instantiates a new RawTexture.
  12893. * Raw texture can help creating a texture directly from an array of data.
  12894. * This can be super useful if you either get the data from an uncompressed source or
  12895. * if you wish to create your texture pixel by pixel.
  12896. * @param data define the array of data to use to create the texture
  12897. * @param width define the width of the texture
  12898. * @param height define the height of the texture
  12899. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12900. * @param scene define the scene the texture belongs to
  12901. * @param generateMipMaps define whether mip maps should be generated or not
  12902. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12903. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12904. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12905. */
  12906. constructor(data: ArrayBufferView, width: number, height: number,
  12907. /**
  12908. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12909. */
  12910. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12911. /**
  12912. * Updates the texture underlying data.
  12913. * @param data Define the new data of the texture
  12914. */
  12915. update(data: ArrayBufferView): void;
  12916. /**
  12917. * Creates a luminance texture from some data.
  12918. * @param data Define the texture data
  12919. * @param width Define the width of the texture
  12920. * @param height Define the height of the texture
  12921. * @param scene Define the scene the texture belongs to
  12922. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12923. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12924. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12925. * @returns the luminance texture
  12926. */
  12927. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12928. /**
  12929. * Creates a luminance alpha texture from some data.
  12930. * @param data Define the texture data
  12931. * @param width Define the width of the texture
  12932. * @param height Define the height of the texture
  12933. * @param scene Define the scene the texture belongs to
  12934. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12935. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12936. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12937. * @returns the luminance alpha texture
  12938. */
  12939. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12940. /**
  12941. * Creates an alpha texture from some data.
  12942. * @param data Define the texture data
  12943. * @param width Define the width of the texture
  12944. * @param height Define the height of the texture
  12945. * @param scene Define the scene the texture belongs to
  12946. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12947. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12948. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12949. * @returns the alpha texture
  12950. */
  12951. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12952. /**
  12953. * Creates a RGB texture from some data.
  12954. * @param data Define the texture data
  12955. * @param width Define the width of the texture
  12956. * @param height Define the height of the texture
  12957. * @param scene Define the scene the texture belongs to
  12958. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12959. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12960. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12961. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12962. * @returns the RGB alpha texture
  12963. */
  12964. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12965. /**
  12966. * Creates a RGBA texture from some data.
  12967. * @param data Define the texture data
  12968. * @param width Define the width of the texture
  12969. * @param height Define the height of the texture
  12970. * @param scene Define the scene the texture belongs to
  12971. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12972. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12973. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12974. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12975. * @returns the RGBA texture
  12976. */
  12977. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12978. /**
  12979. * Creates a R texture from some data.
  12980. * @param data Define the texture data
  12981. * @param width Define the width of the texture
  12982. * @param height Define the height of the texture
  12983. * @param scene Define the scene the texture belongs to
  12984. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12985. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12986. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12987. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12988. * @returns the R texture
  12989. */
  12990. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12991. }
  12992. }
  12993. declare module "babylonjs/Maths/math.size" {
  12994. /**
  12995. * Interface for the size containing width and height
  12996. */
  12997. export interface ISize {
  12998. /**
  12999. * Width
  13000. */
  13001. width: number;
  13002. /**
  13003. * Heighht
  13004. */
  13005. height: number;
  13006. }
  13007. /**
  13008. * Size containing widht and height
  13009. */
  13010. export class Size implements ISize {
  13011. /**
  13012. * Width
  13013. */
  13014. width: number;
  13015. /**
  13016. * Height
  13017. */
  13018. height: number;
  13019. /**
  13020. * Creates a Size object from the given width and height (floats).
  13021. * @param width width of the new size
  13022. * @param height height of the new size
  13023. */
  13024. constructor(width: number, height: number);
  13025. /**
  13026. * Returns a string with the Size width and height
  13027. * @returns a string with the Size width and height
  13028. */
  13029. toString(): string;
  13030. /**
  13031. * "Size"
  13032. * @returns the string "Size"
  13033. */
  13034. getClassName(): string;
  13035. /**
  13036. * Returns the Size hash code.
  13037. * @returns a hash code for a unique width and height
  13038. */
  13039. getHashCode(): number;
  13040. /**
  13041. * Updates the current size from the given one.
  13042. * @param src the given size
  13043. */
  13044. copyFrom(src: Size): void;
  13045. /**
  13046. * Updates in place the current Size from the given floats.
  13047. * @param width width of the new size
  13048. * @param height height of the new size
  13049. * @returns the updated Size.
  13050. */
  13051. copyFromFloats(width: number, height: number): Size;
  13052. /**
  13053. * Updates in place the current Size from the given floats.
  13054. * @param width width to set
  13055. * @param height height to set
  13056. * @returns the updated Size.
  13057. */
  13058. set(width: number, height: number): Size;
  13059. /**
  13060. * Multiplies the width and height by numbers
  13061. * @param w factor to multiple the width by
  13062. * @param h factor to multiple the height by
  13063. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  13064. */
  13065. multiplyByFloats(w: number, h: number): Size;
  13066. /**
  13067. * Clones the size
  13068. * @returns a new Size copied from the given one.
  13069. */
  13070. clone(): Size;
  13071. /**
  13072. * True if the current Size and the given one width and height are strictly equal.
  13073. * @param other the other size to compare against
  13074. * @returns True if the current Size and the given one width and height are strictly equal.
  13075. */
  13076. equals(other: Size): boolean;
  13077. /**
  13078. * The surface of the Size : width * height (float).
  13079. */
  13080. readonly surface: number;
  13081. /**
  13082. * Create a new size of zero
  13083. * @returns a new Size set to (0.0, 0.0)
  13084. */
  13085. static Zero(): Size;
  13086. /**
  13087. * Sums the width and height of two sizes
  13088. * @param otherSize size to add to this size
  13089. * @returns a new Size set as the addition result of the current Size and the given one.
  13090. */
  13091. add(otherSize: Size): Size;
  13092. /**
  13093. * Subtracts the width and height of two
  13094. * @param otherSize size to subtract to this size
  13095. * @returns a new Size set as the subtraction result of the given one from the current Size.
  13096. */
  13097. subtract(otherSize: Size): Size;
  13098. /**
  13099. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  13100. * @param start starting size to lerp between
  13101. * @param end end size to lerp between
  13102. * @param amount amount to lerp between the start and end values
  13103. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  13104. */
  13105. static Lerp(start: Size, end: Size, amount: number): Size;
  13106. }
  13107. }
  13108. declare module "babylonjs/Animations/runtimeAnimation" {
  13109. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  13110. import { Animatable } from "babylonjs/Animations/animatable";
  13111. import { Scene } from "babylonjs/scene";
  13112. /**
  13113. * Defines a runtime animation
  13114. */
  13115. export class RuntimeAnimation {
  13116. private _events;
  13117. /**
  13118. * The current frame of the runtime animation
  13119. */
  13120. private _currentFrame;
  13121. /**
  13122. * The animation used by the runtime animation
  13123. */
  13124. private _animation;
  13125. /**
  13126. * The target of the runtime animation
  13127. */
  13128. private _target;
  13129. /**
  13130. * The initiating animatable
  13131. */
  13132. private _host;
  13133. /**
  13134. * The original value of the runtime animation
  13135. */
  13136. private _originalValue;
  13137. /**
  13138. * The original blend value of the runtime animation
  13139. */
  13140. private _originalBlendValue;
  13141. /**
  13142. * The offsets cache of the runtime animation
  13143. */
  13144. private _offsetsCache;
  13145. /**
  13146. * The high limits cache of the runtime animation
  13147. */
  13148. private _highLimitsCache;
  13149. /**
  13150. * Specifies if the runtime animation has been stopped
  13151. */
  13152. private _stopped;
  13153. /**
  13154. * The blending factor of the runtime animation
  13155. */
  13156. private _blendingFactor;
  13157. /**
  13158. * The BabylonJS scene
  13159. */
  13160. private _scene;
  13161. /**
  13162. * The current value of the runtime animation
  13163. */
  13164. private _currentValue;
  13165. /** @hidden */
  13166. _animationState: _IAnimationState;
  13167. /**
  13168. * The active target of the runtime animation
  13169. */
  13170. private _activeTargets;
  13171. private _currentActiveTarget;
  13172. private _directTarget;
  13173. /**
  13174. * The target path of the runtime animation
  13175. */
  13176. private _targetPath;
  13177. /**
  13178. * The weight of the runtime animation
  13179. */
  13180. private _weight;
  13181. /**
  13182. * The ratio offset of the runtime animation
  13183. */
  13184. private _ratioOffset;
  13185. /**
  13186. * The previous delay of the runtime animation
  13187. */
  13188. private _previousDelay;
  13189. /**
  13190. * The previous ratio of the runtime animation
  13191. */
  13192. private _previousRatio;
  13193. private _enableBlending;
  13194. private _keys;
  13195. private _minFrame;
  13196. private _maxFrame;
  13197. private _minValue;
  13198. private _maxValue;
  13199. private _targetIsArray;
  13200. /**
  13201. * Gets the current frame of the runtime animation
  13202. */
  13203. readonly currentFrame: number;
  13204. /**
  13205. * Gets the weight of the runtime animation
  13206. */
  13207. readonly weight: number;
  13208. /**
  13209. * Gets the current value of the runtime animation
  13210. */
  13211. readonly currentValue: any;
  13212. /**
  13213. * Gets the target path of the runtime animation
  13214. */
  13215. readonly targetPath: string;
  13216. /**
  13217. * Gets the actual target of the runtime animation
  13218. */
  13219. readonly target: any;
  13220. /** @hidden */
  13221. _onLoop: () => void;
  13222. /**
  13223. * Create a new RuntimeAnimation object
  13224. * @param target defines the target of the animation
  13225. * @param animation defines the source animation object
  13226. * @param scene defines the hosting scene
  13227. * @param host defines the initiating Animatable
  13228. */
  13229. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  13230. private _preparePath;
  13231. /**
  13232. * Gets the animation from the runtime animation
  13233. */
  13234. readonly animation: Animation;
  13235. /**
  13236. * Resets the runtime animation to the beginning
  13237. * @param restoreOriginal defines whether to restore the target property to the original value
  13238. */
  13239. reset(restoreOriginal?: boolean): void;
  13240. /**
  13241. * Specifies if the runtime animation is stopped
  13242. * @returns Boolean specifying if the runtime animation is stopped
  13243. */
  13244. isStopped(): boolean;
  13245. /**
  13246. * Disposes of the runtime animation
  13247. */
  13248. dispose(): void;
  13249. /**
  13250. * Apply the interpolated value to the target
  13251. * @param currentValue defines the value computed by the animation
  13252. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  13253. */
  13254. setValue(currentValue: any, weight: number): void;
  13255. private _getOriginalValues;
  13256. private _setValue;
  13257. /**
  13258. * Gets the loop pmode of the runtime animation
  13259. * @returns Loop Mode
  13260. */
  13261. private _getCorrectLoopMode;
  13262. /**
  13263. * Move the current animation to a given frame
  13264. * @param frame defines the frame to move to
  13265. */
  13266. goToFrame(frame: number): void;
  13267. /**
  13268. * @hidden Internal use only
  13269. */
  13270. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  13271. /**
  13272. * Execute the current animation
  13273. * @param delay defines the delay to add to the current frame
  13274. * @param from defines the lower bound of the animation range
  13275. * @param to defines the upper bound of the animation range
  13276. * @param loop defines if the current animation must loop
  13277. * @param speedRatio defines the current speed ratio
  13278. * @param weight defines the weight of the animation (default is -1 so no weight)
  13279. * @param onLoop optional callback called when animation loops
  13280. * @returns a boolean indicating if the animation is running
  13281. */
  13282. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  13283. }
  13284. }
  13285. declare module "babylonjs/Animations/animatable" {
  13286. import { Animation } from "babylonjs/Animations/animation";
  13287. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  13288. import { Nullable } from "babylonjs/types";
  13289. import { Observable } from "babylonjs/Misc/observable";
  13290. import { Scene } from "babylonjs/scene";
  13291. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  13292. import { Node } from "babylonjs/node";
  13293. /**
  13294. * Class used to store an actual running animation
  13295. */
  13296. export class Animatable {
  13297. /** defines the target object */
  13298. target: any;
  13299. /** defines the starting frame number (default is 0) */
  13300. fromFrame: number;
  13301. /** defines the ending frame number (default is 100) */
  13302. toFrame: number;
  13303. /** defines if the animation must loop (default is false) */
  13304. loopAnimation: boolean;
  13305. /** defines a callback to call when animation ends if it is not looping */
  13306. onAnimationEnd?: (() => void) | null | undefined;
  13307. /** defines a callback to call when animation loops */
  13308. onAnimationLoop?: (() => void) | null | undefined;
  13309. private _localDelayOffset;
  13310. private _pausedDelay;
  13311. private _runtimeAnimations;
  13312. private _paused;
  13313. private _scene;
  13314. private _speedRatio;
  13315. private _weight;
  13316. private _syncRoot;
  13317. /**
  13318. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13319. * This will only apply for non looping animation (default is true)
  13320. */
  13321. disposeOnEnd: boolean;
  13322. /**
  13323. * Gets a boolean indicating if the animation has started
  13324. */
  13325. animationStarted: boolean;
  13326. /**
  13327. * Observer raised when the animation ends
  13328. */
  13329. onAnimationEndObservable: Observable<Animatable>;
  13330. /**
  13331. * Observer raised when the animation loops
  13332. */
  13333. onAnimationLoopObservable: Observable<Animatable>;
  13334. /**
  13335. * Gets the root Animatable used to synchronize and normalize animations
  13336. */
  13337. readonly syncRoot: Nullable<Animatable>;
  13338. /**
  13339. * Gets the current frame of the first RuntimeAnimation
  13340. * Used to synchronize Animatables
  13341. */
  13342. readonly masterFrame: number;
  13343. /**
  13344. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13345. */
  13346. weight: number;
  13347. /**
  13348. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13349. */
  13350. speedRatio: number;
  13351. /**
  13352. * Creates a new Animatable
  13353. * @param scene defines the hosting scene
  13354. * @param target defines the target object
  13355. * @param fromFrame defines the starting frame number (default is 0)
  13356. * @param toFrame defines the ending frame number (default is 100)
  13357. * @param loopAnimation defines if the animation must loop (default is false)
  13358. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13359. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13360. * @param animations defines a group of animation to add to the new Animatable
  13361. * @param onAnimationLoop defines a callback to call when animation loops
  13362. */
  13363. constructor(scene: Scene,
  13364. /** defines the target object */
  13365. target: any,
  13366. /** defines the starting frame number (default is 0) */
  13367. fromFrame?: number,
  13368. /** defines the ending frame number (default is 100) */
  13369. toFrame?: number,
  13370. /** defines if the animation must loop (default is false) */
  13371. loopAnimation?: boolean, speedRatio?: number,
  13372. /** defines a callback to call when animation ends if it is not looping */
  13373. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13374. /** defines a callback to call when animation loops */
  13375. onAnimationLoop?: (() => void) | null | undefined);
  13376. /**
  13377. * Synchronize and normalize current Animatable with a source Animatable
  13378. * This is useful when using animation weights and when animations are not of the same length
  13379. * @param root defines the root Animatable to synchronize with
  13380. * @returns the current Animatable
  13381. */
  13382. syncWith(root: Animatable): Animatable;
  13383. /**
  13384. * Gets the list of runtime animations
  13385. * @returns an array of RuntimeAnimation
  13386. */
  13387. getAnimations(): RuntimeAnimation[];
  13388. /**
  13389. * Adds more animations to the current animatable
  13390. * @param target defines the target of the animations
  13391. * @param animations defines the new animations to add
  13392. */
  13393. appendAnimations(target: any, animations: Animation[]): void;
  13394. /**
  13395. * Gets the source animation for a specific property
  13396. * @param property defines the propertyu to look for
  13397. * @returns null or the source animation for the given property
  13398. */
  13399. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13400. /**
  13401. * Gets the runtime animation for a specific property
  13402. * @param property defines the propertyu to look for
  13403. * @returns null or the runtime animation for the given property
  13404. */
  13405. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13406. /**
  13407. * Resets the animatable to its original state
  13408. */
  13409. reset(): void;
  13410. /**
  13411. * Allows the animatable to blend with current running animations
  13412. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13413. * @param blendingSpeed defines the blending speed to use
  13414. */
  13415. enableBlending(blendingSpeed: number): void;
  13416. /**
  13417. * Disable animation blending
  13418. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13419. */
  13420. disableBlending(): void;
  13421. /**
  13422. * Jump directly to a given frame
  13423. * @param frame defines the frame to jump to
  13424. */
  13425. goToFrame(frame: number): void;
  13426. /**
  13427. * Pause the animation
  13428. */
  13429. pause(): void;
  13430. /**
  13431. * Restart the animation
  13432. */
  13433. restart(): void;
  13434. private _raiseOnAnimationEnd;
  13435. /**
  13436. * Stop and delete the current animation
  13437. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13438. * @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)
  13439. */
  13440. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13441. /**
  13442. * Wait asynchronously for the animation to end
  13443. * @returns a promise which will be fullfilled when the animation ends
  13444. */
  13445. waitAsync(): Promise<Animatable>;
  13446. /** @hidden */
  13447. _animate(delay: number): boolean;
  13448. }
  13449. module "babylonjs/scene" {
  13450. interface Scene {
  13451. /** @hidden */
  13452. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13453. /** @hidden */
  13454. _processLateAnimationBindingsForMatrices(holder: {
  13455. totalWeight: number;
  13456. animations: RuntimeAnimation[];
  13457. originalValue: Matrix;
  13458. }): any;
  13459. /** @hidden */
  13460. _processLateAnimationBindingsForQuaternions(holder: {
  13461. totalWeight: number;
  13462. animations: RuntimeAnimation[];
  13463. originalValue: Quaternion;
  13464. }, refQuaternion: Quaternion): Quaternion;
  13465. /** @hidden */
  13466. _processLateAnimationBindings(): void;
  13467. /**
  13468. * Will start the animation sequence of a given target
  13469. * @param target defines the target
  13470. * @param from defines from which frame should animation start
  13471. * @param to defines until which frame should animation run.
  13472. * @param weight defines the weight to apply to the animation (1.0 by default)
  13473. * @param loop defines if the animation loops
  13474. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13475. * @param onAnimationEnd defines the function to be executed when the animation ends
  13476. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13477. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13478. * @param onAnimationLoop defines the callback to call when an animation loops
  13479. * @returns the animatable object created for this animation
  13480. */
  13481. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13482. /**
  13483. * Will start the animation sequence of a given target
  13484. * @param target defines the target
  13485. * @param from defines from which frame should animation start
  13486. * @param to defines until which frame should animation run.
  13487. * @param loop defines if the animation loops
  13488. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13489. * @param onAnimationEnd defines the function to be executed when the animation ends
  13490. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13491. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13492. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13493. * @param onAnimationLoop defines the callback to call when an animation loops
  13494. * @returns the animatable object created for this animation
  13495. */
  13496. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13497. /**
  13498. * Will start the animation sequence of a given target and its hierarchy
  13499. * @param target defines the target
  13500. * @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.
  13501. * @param from defines from which frame should animation start
  13502. * @param to defines until which frame should animation run.
  13503. * @param loop defines if the animation loops
  13504. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13505. * @param onAnimationEnd defines the function to be executed when the animation ends
  13506. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13507. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13508. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13509. * @param onAnimationLoop defines the callback to call when an animation loops
  13510. * @returns the list of created animatables
  13511. */
  13512. 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[];
  13513. /**
  13514. * Begin a new animation on a given node
  13515. * @param target defines the target where the animation will take place
  13516. * @param animations defines the list of animations to start
  13517. * @param from defines the initial value
  13518. * @param to defines the final value
  13519. * @param loop defines if you want animation to loop (off by default)
  13520. * @param speedRatio defines the speed ratio to apply to all animations
  13521. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13522. * @param onAnimationLoop defines the callback to call when an animation loops
  13523. * @returns the list of created animatables
  13524. */
  13525. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13526. /**
  13527. * Begin a new animation on a given node and its hierarchy
  13528. * @param target defines the root node where the animation will take place
  13529. * @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.
  13530. * @param animations defines the list of animations to start
  13531. * @param from defines the initial value
  13532. * @param to defines the final value
  13533. * @param loop defines if you want animation to loop (off by default)
  13534. * @param speedRatio defines the speed ratio to apply to all animations
  13535. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13536. * @param onAnimationLoop defines the callback to call when an animation loops
  13537. * @returns the list of animatables created for all nodes
  13538. */
  13539. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13540. /**
  13541. * Gets the animatable associated with a specific target
  13542. * @param target defines the target of the animatable
  13543. * @returns the required animatable if found
  13544. */
  13545. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13546. /**
  13547. * Gets all animatables associated with a given target
  13548. * @param target defines the target to look animatables for
  13549. * @returns an array of Animatables
  13550. */
  13551. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13552. /**
  13553. * Stops and removes all animations that have been applied to the scene
  13554. */
  13555. stopAllAnimations(): void;
  13556. /**
  13557. * Gets the current delta time used by animation engine
  13558. */
  13559. deltaTime: number;
  13560. }
  13561. }
  13562. module "babylonjs/Bones/bone" {
  13563. interface Bone {
  13564. /**
  13565. * Copy an animation range from another bone
  13566. * @param source defines the source bone
  13567. * @param rangeName defines the range name to copy
  13568. * @param frameOffset defines the frame offset
  13569. * @param rescaleAsRequired defines if rescaling must be applied if required
  13570. * @param skelDimensionsRatio defines the scaling ratio
  13571. * @returns true if operation was successful
  13572. */
  13573. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13574. }
  13575. }
  13576. }
  13577. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13578. /**
  13579. * Class used to override all child animations of a given target
  13580. */
  13581. export class AnimationPropertiesOverride {
  13582. /**
  13583. * Gets or sets a value indicating if animation blending must be used
  13584. */
  13585. enableBlending: boolean;
  13586. /**
  13587. * Gets or sets the blending speed to use when enableBlending is true
  13588. */
  13589. blendingSpeed: number;
  13590. /**
  13591. * Gets or sets the default loop mode to use
  13592. */
  13593. loopMode: number;
  13594. }
  13595. }
  13596. declare module "babylonjs/Bones/skeleton" {
  13597. import { Bone } from "babylonjs/Bones/bone";
  13598. import { Observable } from "babylonjs/Misc/observable";
  13599. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13600. import { Scene } from "babylonjs/scene";
  13601. import { Nullable } from "babylonjs/types";
  13602. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13603. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13604. import { Animatable } from "babylonjs/Animations/animatable";
  13605. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13606. import { Animation } from "babylonjs/Animations/animation";
  13607. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13608. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13609. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13610. /**
  13611. * Class used to handle skinning animations
  13612. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13613. */
  13614. export class Skeleton implements IAnimatable {
  13615. /** defines the skeleton name */
  13616. name: string;
  13617. /** defines the skeleton Id */
  13618. id: string;
  13619. /**
  13620. * Defines the list of child bones
  13621. */
  13622. bones: Bone[];
  13623. /**
  13624. * Defines an estimate of the dimension of the skeleton at rest
  13625. */
  13626. dimensionsAtRest: Vector3;
  13627. /**
  13628. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13629. */
  13630. needInitialSkinMatrix: boolean;
  13631. /**
  13632. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13633. */
  13634. overrideMesh: Nullable<AbstractMesh>;
  13635. /**
  13636. * Gets the list of animations attached to this skeleton
  13637. */
  13638. animations: Array<Animation>;
  13639. private _scene;
  13640. private _isDirty;
  13641. private _transformMatrices;
  13642. private _transformMatrixTexture;
  13643. private _meshesWithPoseMatrix;
  13644. private _animatables;
  13645. private _identity;
  13646. private _synchronizedWithMesh;
  13647. private _ranges;
  13648. private _lastAbsoluteTransformsUpdateId;
  13649. private _canUseTextureForBones;
  13650. private _uniqueId;
  13651. /** @hidden */
  13652. _numBonesWithLinkedTransformNode: number;
  13653. /** @hidden */
  13654. _hasWaitingData: Nullable<boolean>;
  13655. /**
  13656. * Specifies if the skeleton should be serialized
  13657. */
  13658. doNotSerialize: boolean;
  13659. private _useTextureToStoreBoneMatrices;
  13660. /**
  13661. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13662. * Please note that this option is not available if the hardware does not support it
  13663. */
  13664. useTextureToStoreBoneMatrices: boolean;
  13665. private _animationPropertiesOverride;
  13666. /**
  13667. * Gets or sets the animation properties override
  13668. */
  13669. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13670. /**
  13671. * List of inspectable custom properties (used by the Inspector)
  13672. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13673. */
  13674. inspectableCustomProperties: IInspectable[];
  13675. /**
  13676. * An observable triggered before computing the skeleton's matrices
  13677. */
  13678. onBeforeComputeObservable: Observable<Skeleton>;
  13679. /**
  13680. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13681. */
  13682. readonly isUsingTextureForMatrices: boolean;
  13683. /**
  13684. * Gets the unique ID of this skeleton
  13685. */
  13686. readonly uniqueId: number;
  13687. /**
  13688. * Creates a new skeleton
  13689. * @param name defines the skeleton name
  13690. * @param id defines the skeleton Id
  13691. * @param scene defines the hosting scene
  13692. */
  13693. constructor(
  13694. /** defines the skeleton name */
  13695. name: string,
  13696. /** defines the skeleton Id */
  13697. id: string, scene: Scene);
  13698. /**
  13699. * Gets the current object class name.
  13700. * @return the class name
  13701. */
  13702. getClassName(): string;
  13703. /**
  13704. * Returns an array containing the root bones
  13705. * @returns an array containing the root bones
  13706. */
  13707. getChildren(): Array<Bone>;
  13708. /**
  13709. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13710. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13711. * @returns a Float32Array containing matrices data
  13712. */
  13713. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13714. /**
  13715. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13716. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13717. * @returns a raw texture containing the data
  13718. */
  13719. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13720. /**
  13721. * Gets the current hosting scene
  13722. * @returns a scene object
  13723. */
  13724. getScene(): Scene;
  13725. /**
  13726. * Gets a string representing the current skeleton data
  13727. * @param fullDetails defines a boolean indicating if we want a verbose version
  13728. * @returns a string representing the current skeleton data
  13729. */
  13730. toString(fullDetails?: boolean): string;
  13731. /**
  13732. * Get bone's index searching by name
  13733. * @param name defines bone's name to search for
  13734. * @return the indice of the bone. Returns -1 if not found
  13735. */
  13736. getBoneIndexByName(name: string): number;
  13737. /**
  13738. * Creater a new animation range
  13739. * @param name defines the name of the range
  13740. * @param from defines the start key
  13741. * @param to defines the end key
  13742. */
  13743. createAnimationRange(name: string, from: number, to: number): void;
  13744. /**
  13745. * Delete a specific animation range
  13746. * @param name defines the name of the range
  13747. * @param deleteFrames defines if frames must be removed as well
  13748. */
  13749. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13750. /**
  13751. * Gets a specific animation range
  13752. * @param name defines the name of the range to look for
  13753. * @returns the requested animation range or null if not found
  13754. */
  13755. getAnimationRange(name: string): Nullable<AnimationRange>;
  13756. /**
  13757. * Gets the list of all animation ranges defined on this skeleton
  13758. * @returns an array
  13759. */
  13760. getAnimationRanges(): Nullable<AnimationRange>[];
  13761. /**
  13762. * Copy animation range from a source skeleton.
  13763. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13764. * @param source defines the source skeleton
  13765. * @param name defines the name of the range to copy
  13766. * @param rescaleAsRequired defines if rescaling must be applied if required
  13767. * @returns true if operation was successful
  13768. */
  13769. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13770. /**
  13771. * Forces the skeleton to go to rest pose
  13772. */
  13773. returnToRest(): void;
  13774. private _getHighestAnimationFrame;
  13775. /**
  13776. * Begin a specific animation range
  13777. * @param name defines the name of the range to start
  13778. * @param loop defines if looping must be turned on (false by default)
  13779. * @param speedRatio defines the speed ratio to apply (1 by default)
  13780. * @param onAnimationEnd defines a callback which will be called when animation will end
  13781. * @returns a new animatable
  13782. */
  13783. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13784. /** @hidden */
  13785. _markAsDirty(): void;
  13786. /** @hidden */
  13787. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13788. /** @hidden */
  13789. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13790. private _computeTransformMatrices;
  13791. /**
  13792. * Build all resources required to render a skeleton
  13793. */
  13794. prepare(): void;
  13795. /**
  13796. * Gets the list of animatables currently running for this skeleton
  13797. * @returns an array of animatables
  13798. */
  13799. getAnimatables(): IAnimatable[];
  13800. /**
  13801. * Clone the current skeleton
  13802. * @param name defines the name of the new skeleton
  13803. * @param id defines the id of the new skeleton
  13804. * @returns the new skeleton
  13805. */
  13806. clone(name: string, id?: string): Skeleton;
  13807. /**
  13808. * Enable animation blending for this skeleton
  13809. * @param blendingSpeed defines the blending speed to apply
  13810. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13811. */
  13812. enableBlending(blendingSpeed?: number): void;
  13813. /**
  13814. * Releases all resources associated with the current skeleton
  13815. */
  13816. dispose(): void;
  13817. /**
  13818. * Serialize the skeleton in a JSON object
  13819. * @returns a JSON object
  13820. */
  13821. serialize(): any;
  13822. /**
  13823. * Creates a new skeleton from serialized data
  13824. * @param parsedSkeleton defines the serialized data
  13825. * @param scene defines the hosting scene
  13826. * @returns a new skeleton
  13827. */
  13828. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13829. /**
  13830. * Compute all node absolute transforms
  13831. * @param forceUpdate defines if computation must be done even if cache is up to date
  13832. */
  13833. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13834. /**
  13835. * Gets the root pose matrix
  13836. * @returns a matrix
  13837. */
  13838. getPoseMatrix(): Nullable<Matrix>;
  13839. /**
  13840. * Sorts bones per internal index
  13841. */
  13842. sortBones(): void;
  13843. private _sortBones;
  13844. }
  13845. }
  13846. declare module "babylonjs/Bones/bone" {
  13847. import { Skeleton } from "babylonjs/Bones/skeleton";
  13848. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13849. import { Nullable } from "babylonjs/types";
  13850. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13851. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13852. import { Node } from "babylonjs/node";
  13853. import { Space } from "babylonjs/Maths/math.axis";
  13854. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13855. /**
  13856. * Class used to store bone information
  13857. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13858. */
  13859. export class Bone extends Node {
  13860. /**
  13861. * defines the bone name
  13862. */
  13863. name: string;
  13864. private static _tmpVecs;
  13865. private static _tmpQuat;
  13866. private static _tmpMats;
  13867. /**
  13868. * Gets the list of child bones
  13869. */
  13870. children: Bone[];
  13871. /** Gets the animations associated with this bone */
  13872. animations: import("babylonjs/Animations/animation").Animation[];
  13873. /**
  13874. * Gets or sets bone length
  13875. */
  13876. length: number;
  13877. /**
  13878. * @hidden Internal only
  13879. * Set this value to map this bone to a different index in the transform matrices
  13880. * Set this value to -1 to exclude the bone from the transform matrices
  13881. */
  13882. _index: Nullable<number>;
  13883. private _skeleton;
  13884. private _localMatrix;
  13885. private _restPose;
  13886. private _baseMatrix;
  13887. private _absoluteTransform;
  13888. private _invertedAbsoluteTransform;
  13889. private _parent;
  13890. private _scalingDeterminant;
  13891. private _worldTransform;
  13892. private _localScaling;
  13893. private _localRotation;
  13894. private _localPosition;
  13895. private _needToDecompose;
  13896. private _needToCompose;
  13897. /** @hidden */
  13898. _linkedTransformNode: Nullable<TransformNode>;
  13899. /** @hidden */
  13900. _waitingTransformNodeId: Nullable<string>;
  13901. /** @hidden */
  13902. /** @hidden */
  13903. _matrix: Matrix;
  13904. /**
  13905. * Create a new bone
  13906. * @param name defines the bone name
  13907. * @param skeleton defines the parent skeleton
  13908. * @param parentBone defines the parent (can be null if the bone is the root)
  13909. * @param localMatrix defines the local matrix
  13910. * @param restPose defines the rest pose matrix
  13911. * @param baseMatrix defines the base matrix
  13912. * @param index defines index of the bone in the hiearchy
  13913. */
  13914. constructor(
  13915. /**
  13916. * defines the bone name
  13917. */
  13918. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13919. /**
  13920. * Gets the current object class name.
  13921. * @return the class name
  13922. */
  13923. getClassName(): string;
  13924. /**
  13925. * Gets the parent skeleton
  13926. * @returns a skeleton
  13927. */
  13928. getSkeleton(): Skeleton;
  13929. /**
  13930. * Gets parent bone
  13931. * @returns a bone or null if the bone is the root of the bone hierarchy
  13932. */
  13933. getParent(): Nullable<Bone>;
  13934. /**
  13935. * Returns an array containing the root bones
  13936. * @returns an array containing the root bones
  13937. */
  13938. getChildren(): Array<Bone>;
  13939. /**
  13940. * Gets the node index in matrix array generated for rendering
  13941. * @returns the node index
  13942. */
  13943. getIndex(): number;
  13944. /**
  13945. * Sets the parent bone
  13946. * @param parent defines the parent (can be null if the bone is the root)
  13947. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13948. */
  13949. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13950. /**
  13951. * Gets the local matrix
  13952. * @returns a matrix
  13953. */
  13954. getLocalMatrix(): Matrix;
  13955. /**
  13956. * Gets the base matrix (initial matrix which remains unchanged)
  13957. * @returns a matrix
  13958. */
  13959. getBaseMatrix(): Matrix;
  13960. /**
  13961. * Gets the rest pose matrix
  13962. * @returns a matrix
  13963. */
  13964. getRestPose(): Matrix;
  13965. /**
  13966. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13967. */
  13968. getWorldMatrix(): Matrix;
  13969. /**
  13970. * Sets the local matrix to rest pose matrix
  13971. */
  13972. returnToRest(): void;
  13973. /**
  13974. * Gets the inverse of the absolute transform matrix.
  13975. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13976. * @returns a matrix
  13977. */
  13978. getInvertedAbsoluteTransform(): Matrix;
  13979. /**
  13980. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13981. * @returns a matrix
  13982. */
  13983. getAbsoluteTransform(): Matrix;
  13984. /**
  13985. * Links with the given transform node.
  13986. * The local matrix of this bone is copied from the transform node every frame.
  13987. * @param transformNode defines the transform node to link to
  13988. */
  13989. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13990. /**
  13991. * Gets the node used to drive the bone's transformation
  13992. * @returns a transform node or null
  13993. */
  13994. getTransformNode(): Nullable<TransformNode>;
  13995. /** Gets or sets current position (in local space) */
  13996. position: Vector3;
  13997. /** Gets or sets current rotation (in local space) */
  13998. rotation: Vector3;
  13999. /** Gets or sets current rotation quaternion (in local space) */
  14000. rotationQuaternion: Quaternion;
  14001. /** Gets or sets current scaling (in local space) */
  14002. scaling: Vector3;
  14003. /**
  14004. * Gets the animation properties override
  14005. */
  14006. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  14007. private _decompose;
  14008. private _compose;
  14009. /**
  14010. * Update the base and local matrices
  14011. * @param matrix defines the new base or local matrix
  14012. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  14013. * @param updateLocalMatrix defines if the local matrix should be updated
  14014. */
  14015. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  14016. /** @hidden */
  14017. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  14018. /**
  14019. * Flag the bone as dirty (Forcing it to update everything)
  14020. */
  14021. markAsDirty(): void;
  14022. /** @hidden */
  14023. _markAsDirtyAndCompose(): void;
  14024. private _markAsDirtyAndDecompose;
  14025. /**
  14026. * Translate the bone in local or world space
  14027. * @param vec The amount to translate the bone
  14028. * @param space The space that the translation is in
  14029. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14030. */
  14031. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  14032. /**
  14033. * Set the postion of the bone in local or world space
  14034. * @param position The position to set the bone
  14035. * @param space The space that the position is in
  14036. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14037. */
  14038. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  14039. /**
  14040. * Set the absolute position of the bone (world space)
  14041. * @param position The position to set the bone
  14042. * @param mesh The mesh that this bone is attached to
  14043. */
  14044. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  14045. /**
  14046. * Scale the bone on the x, y and z axes (in local space)
  14047. * @param x The amount to scale the bone on the x axis
  14048. * @param y The amount to scale the bone on the y axis
  14049. * @param z The amount to scale the bone on the z axis
  14050. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  14051. */
  14052. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  14053. /**
  14054. * Set the bone scaling in local space
  14055. * @param scale defines the scaling vector
  14056. */
  14057. setScale(scale: Vector3): void;
  14058. /**
  14059. * Gets the current scaling in local space
  14060. * @returns the current scaling vector
  14061. */
  14062. getScale(): Vector3;
  14063. /**
  14064. * Gets the current scaling in local space and stores it in a target vector
  14065. * @param result defines the target vector
  14066. */
  14067. getScaleToRef(result: Vector3): void;
  14068. /**
  14069. * Set the yaw, pitch, and roll of the bone in local or world space
  14070. * @param yaw The rotation of the bone on the y axis
  14071. * @param pitch The rotation of the bone on the x axis
  14072. * @param roll The rotation of the bone on the z axis
  14073. * @param space The space that the axes of rotation are in
  14074. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14075. */
  14076. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  14077. /**
  14078. * Add a rotation to the bone on an axis in local or world space
  14079. * @param axis The axis to rotate the bone on
  14080. * @param amount The amount to rotate the bone
  14081. * @param space The space that the axis is in
  14082. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14083. */
  14084. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  14085. /**
  14086. * Set the rotation of the bone to a particular axis angle in local or world space
  14087. * @param axis The axis to rotate the bone on
  14088. * @param angle The angle that the bone should be rotated to
  14089. * @param space The space that the axis is in
  14090. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14091. */
  14092. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  14093. /**
  14094. * Set the euler rotation of the bone in local of world space
  14095. * @param rotation The euler rotation that the bone should be set to
  14096. * @param space The space that the rotation is in
  14097. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14098. */
  14099. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  14100. /**
  14101. * Set the quaternion rotation of the bone in local of world space
  14102. * @param quat The quaternion rotation that the bone should be set to
  14103. * @param space The space that the rotation is in
  14104. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14105. */
  14106. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  14107. /**
  14108. * Set the rotation matrix of the bone in local of world space
  14109. * @param rotMat The rotation matrix that the bone should be set to
  14110. * @param space The space that the rotation is in
  14111. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14112. */
  14113. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  14114. private _rotateWithMatrix;
  14115. private _getNegativeRotationToRef;
  14116. /**
  14117. * Get the position of the bone in local or world space
  14118. * @param space The space that the returned position is in
  14119. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14120. * @returns The position of the bone
  14121. */
  14122. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14123. /**
  14124. * Copy the position of the bone to a vector3 in local or world space
  14125. * @param space The space that the returned position is in
  14126. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14127. * @param result The vector3 to copy the position to
  14128. */
  14129. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  14130. /**
  14131. * Get the absolute position of the bone (world space)
  14132. * @param mesh The mesh that this bone is attached to
  14133. * @returns The absolute position of the bone
  14134. */
  14135. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  14136. /**
  14137. * Copy the absolute position of the bone (world space) to the result param
  14138. * @param mesh The mesh that this bone is attached to
  14139. * @param result The vector3 to copy the absolute position to
  14140. */
  14141. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  14142. /**
  14143. * Compute the absolute transforms of this bone and its children
  14144. */
  14145. computeAbsoluteTransforms(): void;
  14146. /**
  14147. * Get the world direction from an axis that is in the local space of the bone
  14148. * @param localAxis The local direction that is used to compute the world direction
  14149. * @param mesh The mesh that this bone is attached to
  14150. * @returns The world direction
  14151. */
  14152. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14153. /**
  14154. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  14155. * @param localAxis The local direction that is used to compute the world direction
  14156. * @param mesh The mesh that this bone is attached to
  14157. * @param result The vector3 that the world direction will be copied to
  14158. */
  14159. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14160. /**
  14161. * Get the euler rotation of the bone in local or world space
  14162. * @param space The space that the rotation should be in
  14163. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14164. * @returns The euler rotation
  14165. */
  14166. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14167. /**
  14168. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  14169. * @param space The space that the rotation should be in
  14170. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14171. * @param result The vector3 that the rotation should be copied to
  14172. */
  14173. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14174. /**
  14175. * Get the quaternion rotation of the bone in either local or world space
  14176. * @param space The space that the rotation should be in
  14177. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14178. * @returns The quaternion rotation
  14179. */
  14180. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  14181. /**
  14182. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  14183. * @param space The space that the rotation should be in
  14184. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14185. * @param result The quaternion that the rotation should be copied to
  14186. */
  14187. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  14188. /**
  14189. * Get the rotation matrix of the bone in local or world space
  14190. * @param space The space that the rotation should be in
  14191. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14192. * @returns The rotation matrix
  14193. */
  14194. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  14195. /**
  14196. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  14197. * @param space The space that the rotation should be in
  14198. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14199. * @param result The quaternion that the rotation should be copied to
  14200. */
  14201. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  14202. /**
  14203. * Get the world position of a point that is in the local space of the bone
  14204. * @param position The local position
  14205. * @param mesh The mesh that this bone is attached to
  14206. * @returns The world position
  14207. */
  14208. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14209. /**
  14210. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  14211. * @param position The local position
  14212. * @param mesh The mesh that this bone is attached to
  14213. * @param result The vector3 that the world position should be copied to
  14214. */
  14215. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14216. /**
  14217. * Get the local position of a point that is in world space
  14218. * @param position The world position
  14219. * @param mesh The mesh that this bone is attached to
  14220. * @returns The local position
  14221. */
  14222. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14223. /**
  14224. * Get the local position of a point that is in world space and copy it to the result param
  14225. * @param position The world position
  14226. * @param mesh The mesh that this bone is attached to
  14227. * @param result The vector3 that the local position should be copied to
  14228. */
  14229. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14230. }
  14231. }
  14232. declare module "babylonjs/Meshes/transformNode" {
  14233. import { DeepImmutable } from "babylonjs/types";
  14234. import { Observable } from "babylonjs/Misc/observable";
  14235. import { Nullable } from "babylonjs/types";
  14236. import { Camera } from "babylonjs/Cameras/camera";
  14237. import { Scene } from "babylonjs/scene";
  14238. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14239. import { Node } from "babylonjs/node";
  14240. import { Bone } from "babylonjs/Bones/bone";
  14241. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14242. import { Space } from "babylonjs/Maths/math.axis";
  14243. /**
  14244. * 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.
  14245. * @see https://doc.babylonjs.com/how_to/transformnode
  14246. */
  14247. export class TransformNode extends Node {
  14248. /**
  14249. * Object will not rotate to face the camera
  14250. */
  14251. static BILLBOARDMODE_NONE: number;
  14252. /**
  14253. * Object will rotate to face the camera but only on the x axis
  14254. */
  14255. static BILLBOARDMODE_X: number;
  14256. /**
  14257. * Object will rotate to face the camera but only on the y axis
  14258. */
  14259. static BILLBOARDMODE_Y: number;
  14260. /**
  14261. * Object will rotate to face the camera but only on the z axis
  14262. */
  14263. static BILLBOARDMODE_Z: number;
  14264. /**
  14265. * Object will rotate to face the camera
  14266. */
  14267. static BILLBOARDMODE_ALL: number;
  14268. /**
  14269. * Object will rotate to face the camera's position instead of orientation
  14270. */
  14271. static BILLBOARDMODE_USE_POSITION: number;
  14272. private _forward;
  14273. private _forwardInverted;
  14274. private _up;
  14275. private _right;
  14276. private _rightInverted;
  14277. private _position;
  14278. private _rotation;
  14279. private _rotationQuaternion;
  14280. protected _scaling: Vector3;
  14281. protected _isDirty: boolean;
  14282. private _transformToBoneReferal;
  14283. private _isAbsoluteSynced;
  14284. private _billboardMode;
  14285. /**
  14286. * Gets or sets the billboard mode. Default is 0.
  14287. *
  14288. * | Value | Type | Description |
  14289. * | --- | --- | --- |
  14290. * | 0 | BILLBOARDMODE_NONE | |
  14291. * | 1 | BILLBOARDMODE_X | |
  14292. * | 2 | BILLBOARDMODE_Y | |
  14293. * | 4 | BILLBOARDMODE_Z | |
  14294. * | 7 | BILLBOARDMODE_ALL | |
  14295. *
  14296. */
  14297. billboardMode: number;
  14298. private _preserveParentRotationForBillboard;
  14299. /**
  14300. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14301. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14302. */
  14303. preserveParentRotationForBillboard: boolean;
  14304. /**
  14305. * 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
  14306. */
  14307. scalingDeterminant: number;
  14308. private _infiniteDistance;
  14309. /**
  14310. * Gets or sets the distance of the object to max, often used by skybox
  14311. */
  14312. infiniteDistance: boolean;
  14313. /**
  14314. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14315. * By default the system will update normals to compensate
  14316. */
  14317. ignoreNonUniformScaling: boolean;
  14318. /**
  14319. * 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
  14320. */
  14321. reIntegrateRotationIntoRotationQuaternion: boolean;
  14322. /** @hidden */
  14323. _poseMatrix: Nullable<Matrix>;
  14324. /** @hidden */
  14325. _localMatrix: Matrix;
  14326. private _usePivotMatrix;
  14327. private _absolutePosition;
  14328. private _absoluteScaling;
  14329. private _absoluteRotationQuaternion;
  14330. private _pivotMatrix;
  14331. private _pivotMatrixInverse;
  14332. protected _postMultiplyPivotMatrix: boolean;
  14333. protected _isWorldMatrixFrozen: boolean;
  14334. /** @hidden */
  14335. _indexInSceneTransformNodesArray: number;
  14336. /**
  14337. * An event triggered after the world matrix is updated
  14338. */
  14339. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14340. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14341. /**
  14342. * Gets a string identifying the name of the class
  14343. * @returns "TransformNode" string
  14344. */
  14345. getClassName(): string;
  14346. /**
  14347. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14348. */
  14349. position: Vector3;
  14350. /**
  14351. * 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)).
  14352. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14353. */
  14354. rotation: Vector3;
  14355. /**
  14356. * 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)).
  14357. */
  14358. scaling: Vector3;
  14359. /**
  14360. * 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).
  14361. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14362. */
  14363. rotationQuaternion: Nullable<Quaternion>;
  14364. /**
  14365. * The forward direction of that transform in world space.
  14366. */
  14367. readonly forward: Vector3;
  14368. /**
  14369. * The up direction of that transform in world space.
  14370. */
  14371. readonly up: Vector3;
  14372. /**
  14373. * The right direction of that transform in world space.
  14374. */
  14375. readonly right: Vector3;
  14376. /**
  14377. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14378. * @param matrix the matrix to copy the pose from
  14379. * @returns this TransformNode.
  14380. */
  14381. updatePoseMatrix(matrix: Matrix): TransformNode;
  14382. /**
  14383. * Returns the mesh Pose matrix.
  14384. * @returns the pose matrix
  14385. */
  14386. getPoseMatrix(): Matrix;
  14387. /** @hidden */
  14388. _isSynchronized(): boolean;
  14389. /** @hidden */
  14390. _initCache(): void;
  14391. /**
  14392. * Flag the transform node as dirty (Forcing it to update everything)
  14393. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14394. * @returns this transform node
  14395. */
  14396. markAsDirty(property: string): TransformNode;
  14397. /**
  14398. * Returns the current mesh absolute position.
  14399. * Returns a Vector3.
  14400. */
  14401. readonly absolutePosition: Vector3;
  14402. /**
  14403. * Returns the current mesh absolute scaling.
  14404. * Returns a Vector3.
  14405. */
  14406. readonly absoluteScaling: Vector3;
  14407. /**
  14408. * Returns the current mesh absolute rotation.
  14409. * Returns a Quaternion.
  14410. */
  14411. readonly absoluteRotationQuaternion: Quaternion;
  14412. /**
  14413. * Sets a new matrix to apply before all other transformation
  14414. * @param matrix defines the transform matrix
  14415. * @returns the current TransformNode
  14416. */
  14417. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14418. /**
  14419. * Sets a new pivot matrix to the current node
  14420. * @param matrix defines the new pivot matrix to use
  14421. * @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
  14422. * @returns the current TransformNode
  14423. */
  14424. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14425. /**
  14426. * Returns the mesh pivot matrix.
  14427. * Default : Identity.
  14428. * @returns the matrix
  14429. */
  14430. getPivotMatrix(): Matrix;
  14431. /**
  14432. * Instantiate (when possible) or clone that node with its hierarchy
  14433. * @param newParent defines the new parent to use for the instance (or clone)
  14434. * @param options defines options to configure how copy is done
  14435. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  14436. * @returns an instance (or a clone) of the current node with its hiearchy
  14437. */
  14438. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  14439. doNotInstantiate: boolean;
  14440. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  14441. /**
  14442. * Prevents the World matrix to be computed any longer
  14443. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14444. * @returns the TransformNode.
  14445. */
  14446. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14447. /**
  14448. * Allows back the World matrix computation.
  14449. * @returns the TransformNode.
  14450. */
  14451. unfreezeWorldMatrix(): this;
  14452. /**
  14453. * True if the World matrix has been frozen.
  14454. */
  14455. readonly isWorldMatrixFrozen: boolean;
  14456. /**
  14457. * Retuns the mesh absolute position in the World.
  14458. * @returns a Vector3.
  14459. */
  14460. getAbsolutePosition(): Vector3;
  14461. /**
  14462. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14463. * @param absolutePosition the absolute position to set
  14464. * @returns the TransformNode.
  14465. */
  14466. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14467. /**
  14468. * Sets the mesh position in its local space.
  14469. * @param vector3 the position to set in localspace
  14470. * @returns the TransformNode.
  14471. */
  14472. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14473. /**
  14474. * Returns the mesh position in the local space from the current World matrix values.
  14475. * @returns a new Vector3.
  14476. */
  14477. getPositionExpressedInLocalSpace(): Vector3;
  14478. /**
  14479. * Translates the mesh along the passed Vector3 in its local space.
  14480. * @param vector3 the distance to translate in localspace
  14481. * @returns the TransformNode.
  14482. */
  14483. locallyTranslate(vector3: Vector3): TransformNode;
  14484. private static _lookAtVectorCache;
  14485. /**
  14486. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14487. * @param targetPoint the position (must be in same space as current mesh) to look at
  14488. * @param yawCor optional yaw (y-axis) correction in radians
  14489. * @param pitchCor optional pitch (x-axis) correction in radians
  14490. * @param rollCor optional roll (z-axis) correction in radians
  14491. * @param space the choosen space of the target
  14492. * @returns the TransformNode.
  14493. */
  14494. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14495. /**
  14496. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14497. * This Vector3 is expressed in the World space.
  14498. * @param localAxis axis to rotate
  14499. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14500. */
  14501. getDirection(localAxis: Vector3): Vector3;
  14502. /**
  14503. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14504. * localAxis is expressed in the mesh local space.
  14505. * result is computed in the Wordl space from the mesh World matrix.
  14506. * @param localAxis axis to rotate
  14507. * @param result the resulting transformnode
  14508. * @returns this TransformNode.
  14509. */
  14510. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14511. /**
  14512. * Sets this transform node rotation to the given local axis.
  14513. * @param localAxis the axis in local space
  14514. * @param yawCor optional yaw (y-axis) correction in radians
  14515. * @param pitchCor optional pitch (x-axis) correction in radians
  14516. * @param rollCor optional roll (z-axis) correction in radians
  14517. * @returns this TransformNode
  14518. */
  14519. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14520. /**
  14521. * Sets a new pivot point to the current node
  14522. * @param point defines the new pivot point to use
  14523. * @param space defines if the point is in world or local space (local by default)
  14524. * @returns the current TransformNode
  14525. */
  14526. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14527. /**
  14528. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14529. * @returns the pivot point
  14530. */
  14531. getPivotPoint(): Vector3;
  14532. /**
  14533. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14534. * @param result the vector3 to store the result
  14535. * @returns this TransformNode.
  14536. */
  14537. getPivotPointToRef(result: Vector3): TransformNode;
  14538. /**
  14539. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14540. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14541. */
  14542. getAbsolutePivotPoint(): Vector3;
  14543. /**
  14544. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14545. * @param result vector3 to store the result
  14546. * @returns this TransformNode.
  14547. */
  14548. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14549. /**
  14550. * Defines the passed node as the parent of the current node.
  14551. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14552. * @see https://doc.babylonjs.com/how_to/parenting
  14553. * @param node the node ot set as the parent
  14554. * @returns this TransformNode.
  14555. */
  14556. setParent(node: Nullable<Node>): TransformNode;
  14557. private _nonUniformScaling;
  14558. /**
  14559. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14560. */
  14561. readonly nonUniformScaling: boolean;
  14562. /** @hidden */
  14563. _updateNonUniformScalingState(value: boolean): boolean;
  14564. /**
  14565. * Attach the current TransformNode to another TransformNode associated with a bone
  14566. * @param bone Bone affecting the TransformNode
  14567. * @param affectedTransformNode TransformNode associated with the bone
  14568. * @returns this object
  14569. */
  14570. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14571. /**
  14572. * Detach the transform node if its associated with a bone
  14573. * @returns this object
  14574. */
  14575. detachFromBone(): TransformNode;
  14576. private static _rotationAxisCache;
  14577. /**
  14578. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14579. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14580. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14581. * The passed axis is also normalized.
  14582. * @param axis the axis to rotate around
  14583. * @param amount the amount to rotate in radians
  14584. * @param space Space to rotate in (Default: local)
  14585. * @returns the TransformNode.
  14586. */
  14587. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14588. /**
  14589. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14590. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14591. * The passed axis is also normalized. .
  14592. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14593. * @param point the point to rotate around
  14594. * @param axis the axis to rotate around
  14595. * @param amount the amount to rotate in radians
  14596. * @returns the TransformNode
  14597. */
  14598. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14599. /**
  14600. * Translates the mesh along the axis vector for the passed distance in the given space.
  14601. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14602. * @param axis the axis to translate in
  14603. * @param distance the distance to translate
  14604. * @param space Space to rotate in (Default: local)
  14605. * @returns the TransformNode.
  14606. */
  14607. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14608. /**
  14609. * Adds a rotation step to the mesh current rotation.
  14610. * x, y, z are Euler angles expressed in radians.
  14611. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14612. * This means this rotation is made in the mesh local space only.
  14613. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14614. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14615. * ```javascript
  14616. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14617. * ```
  14618. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14619. * 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.
  14620. * @param x Rotation to add
  14621. * @param y Rotation to add
  14622. * @param z Rotation to add
  14623. * @returns the TransformNode.
  14624. */
  14625. addRotation(x: number, y: number, z: number): TransformNode;
  14626. /**
  14627. * @hidden
  14628. */
  14629. protected _getEffectiveParent(): Nullable<Node>;
  14630. /**
  14631. * Computes the world matrix of the node
  14632. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14633. * @returns the world matrix
  14634. */
  14635. computeWorldMatrix(force?: boolean): Matrix;
  14636. protected _afterComputeWorldMatrix(): void;
  14637. /**
  14638. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14639. * @param func callback function to add
  14640. *
  14641. * @returns the TransformNode.
  14642. */
  14643. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14644. /**
  14645. * Removes a registered callback function.
  14646. * @param func callback function to remove
  14647. * @returns the TransformNode.
  14648. */
  14649. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14650. /**
  14651. * Gets the position of the current mesh in camera space
  14652. * @param camera defines the camera to use
  14653. * @returns a position
  14654. */
  14655. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14656. /**
  14657. * Returns the distance from the mesh to the active camera
  14658. * @param camera defines the camera to use
  14659. * @returns the distance
  14660. */
  14661. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14662. /**
  14663. * Clone the current transform node
  14664. * @param name Name of the new clone
  14665. * @param newParent New parent for the clone
  14666. * @param doNotCloneChildren Do not clone children hierarchy
  14667. * @returns the new transform node
  14668. */
  14669. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14670. /**
  14671. * Serializes the objects information.
  14672. * @param currentSerializationObject defines the object to serialize in
  14673. * @returns the serialized object
  14674. */
  14675. serialize(currentSerializationObject?: any): any;
  14676. /**
  14677. * Returns a new TransformNode object parsed from the source provided.
  14678. * @param parsedTransformNode is the source.
  14679. * @param scene the scne the object belongs to
  14680. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14681. * @returns a new TransformNode object parsed from the source provided.
  14682. */
  14683. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14684. /**
  14685. * Get all child-transformNodes of this node
  14686. * @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
  14687. * @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
  14688. * @returns an array of TransformNode
  14689. */
  14690. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14691. /**
  14692. * Releases resources associated with this transform node.
  14693. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14694. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14695. */
  14696. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14697. /**
  14698. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14699. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14700. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14701. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14702. * @returns the current mesh
  14703. */
  14704. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14705. private _syncAbsoluteScalingAndRotation;
  14706. }
  14707. }
  14708. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14709. import { Observable } from "babylonjs/Misc/observable";
  14710. import { Nullable } from "babylonjs/types";
  14711. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14712. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14713. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14714. import { Ray } from "babylonjs/Culling/ray";
  14715. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14716. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14717. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14718. /**
  14719. * Defines the types of pose enabled controllers that are supported
  14720. */
  14721. export enum PoseEnabledControllerType {
  14722. /**
  14723. * HTC Vive
  14724. */
  14725. VIVE = 0,
  14726. /**
  14727. * Oculus Rift
  14728. */
  14729. OCULUS = 1,
  14730. /**
  14731. * Windows mixed reality
  14732. */
  14733. WINDOWS = 2,
  14734. /**
  14735. * Samsung gear VR
  14736. */
  14737. GEAR_VR = 3,
  14738. /**
  14739. * Google Daydream
  14740. */
  14741. DAYDREAM = 4,
  14742. /**
  14743. * Generic
  14744. */
  14745. GENERIC = 5
  14746. }
  14747. /**
  14748. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14749. */
  14750. export interface MutableGamepadButton {
  14751. /**
  14752. * Value of the button/trigger
  14753. */
  14754. value: number;
  14755. /**
  14756. * If the button/trigger is currently touched
  14757. */
  14758. touched: boolean;
  14759. /**
  14760. * If the button/trigger is currently pressed
  14761. */
  14762. pressed: boolean;
  14763. }
  14764. /**
  14765. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14766. * @hidden
  14767. */
  14768. export interface ExtendedGamepadButton extends GamepadButton {
  14769. /**
  14770. * If the button/trigger is currently pressed
  14771. */
  14772. readonly pressed: boolean;
  14773. /**
  14774. * If the button/trigger is currently touched
  14775. */
  14776. readonly touched: boolean;
  14777. /**
  14778. * Value of the button/trigger
  14779. */
  14780. readonly value: number;
  14781. }
  14782. /** @hidden */
  14783. export interface _GamePadFactory {
  14784. /**
  14785. * Returns wether or not the current gamepad can be created for this type of controller.
  14786. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14787. * @returns true if it can be created, otherwise false
  14788. */
  14789. canCreate(gamepadInfo: any): boolean;
  14790. /**
  14791. * Creates a new instance of the Gamepad.
  14792. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14793. * @returns the new gamepad instance
  14794. */
  14795. create(gamepadInfo: any): Gamepad;
  14796. }
  14797. /**
  14798. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14799. */
  14800. export class PoseEnabledControllerHelper {
  14801. /** @hidden */
  14802. static _ControllerFactories: _GamePadFactory[];
  14803. /** @hidden */
  14804. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14805. /**
  14806. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14807. * @param vrGamepad the gamepad to initialized
  14808. * @returns a vr controller of the type the gamepad identified as
  14809. */
  14810. static InitiateController(vrGamepad: any): Gamepad;
  14811. }
  14812. /**
  14813. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14814. */
  14815. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14816. /**
  14817. * If the controller is used in a webXR session
  14818. */
  14819. isXR: boolean;
  14820. private _deviceRoomPosition;
  14821. private _deviceRoomRotationQuaternion;
  14822. /**
  14823. * The device position in babylon space
  14824. */
  14825. devicePosition: Vector3;
  14826. /**
  14827. * The device rotation in babylon space
  14828. */
  14829. deviceRotationQuaternion: Quaternion;
  14830. /**
  14831. * The scale factor of the device in babylon space
  14832. */
  14833. deviceScaleFactor: number;
  14834. /**
  14835. * (Likely devicePosition should be used instead) The device position in its room space
  14836. */
  14837. position: Vector3;
  14838. /**
  14839. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14840. */
  14841. rotationQuaternion: Quaternion;
  14842. /**
  14843. * The type of controller (Eg. Windows mixed reality)
  14844. */
  14845. controllerType: PoseEnabledControllerType;
  14846. protected _calculatedPosition: Vector3;
  14847. private _calculatedRotation;
  14848. /**
  14849. * The raw pose from the device
  14850. */
  14851. rawPose: DevicePose;
  14852. private _trackPosition;
  14853. private _maxRotationDistFromHeadset;
  14854. private _draggedRoomRotation;
  14855. /**
  14856. * @hidden
  14857. */
  14858. _disableTrackPosition(fixedPosition: Vector3): void;
  14859. /**
  14860. * Internal, the mesh attached to the controller
  14861. * @hidden
  14862. */
  14863. _mesh: Nullable<AbstractMesh>;
  14864. private _poseControlledCamera;
  14865. private _leftHandSystemQuaternion;
  14866. /**
  14867. * Internal, matrix used to convert room space to babylon space
  14868. * @hidden
  14869. */
  14870. _deviceToWorld: Matrix;
  14871. /**
  14872. * Node to be used when casting a ray from the controller
  14873. * @hidden
  14874. */
  14875. _pointingPoseNode: Nullable<TransformNode>;
  14876. /**
  14877. * Name of the child mesh that can be used to cast a ray from the controller
  14878. */
  14879. static readonly POINTING_POSE: string;
  14880. /**
  14881. * Creates a new PoseEnabledController from a gamepad
  14882. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14883. */
  14884. constructor(browserGamepad: any);
  14885. private _workingMatrix;
  14886. /**
  14887. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14888. */
  14889. update(): void;
  14890. /**
  14891. * Updates only the pose device and mesh without doing any button event checking
  14892. */
  14893. protected _updatePoseAndMesh(): void;
  14894. /**
  14895. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14896. * @param poseData raw pose fromthe device
  14897. */
  14898. updateFromDevice(poseData: DevicePose): void;
  14899. /**
  14900. * @hidden
  14901. */
  14902. _meshAttachedObservable: Observable<AbstractMesh>;
  14903. /**
  14904. * Attaches a mesh to the controller
  14905. * @param mesh the mesh to be attached
  14906. */
  14907. attachToMesh(mesh: AbstractMesh): void;
  14908. /**
  14909. * Attaches the controllers mesh to a camera
  14910. * @param camera the camera the mesh should be attached to
  14911. */
  14912. attachToPoseControlledCamera(camera: TargetCamera): void;
  14913. /**
  14914. * Disposes of the controller
  14915. */
  14916. dispose(): void;
  14917. /**
  14918. * The mesh that is attached to the controller
  14919. */
  14920. readonly mesh: Nullable<AbstractMesh>;
  14921. /**
  14922. * Gets the ray of the controller in the direction the controller is pointing
  14923. * @param length the length the resulting ray should be
  14924. * @returns a ray in the direction the controller is pointing
  14925. */
  14926. getForwardRay(length?: number): Ray;
  14927. }
  14928. }
  14929. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14930. import { Observable } from "babylonjs/Misc/observable";
  14931. import { Scene } from "babylonjs/scene";
  14932. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14933. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14934. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14935. import { Nullable } from "babylonjs/types";
  14936. /**
  14937. * Defines the WebVRController object that represents controllers tracked in 3D space
  14938. */
  14939. export abstract class WebVRController extends PoseEnabledController {
  14940. /**
  14941. * Internal, the default controller model for the controller
  14942. */
  14943. protected _defaultModel: Nullable<AbstractMesh>;
  14944. /**
  14945. * Fired when the trigger state has changed
  14946. */
  14947. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14948. /**
  14949. * Fired when the main button state has changed
  14950. */
  14951. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14952. /**
  14953. * Fired when the secondary button state has changed
  14954. */
  14955. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14956. /**
  14957. * Fired when the pad state has changed
  14958. */
  14959. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14960. /**
  14961. * Fired when controllers stick values have changed
  14962. */
  14963. onPadValuesChangedObservable: Observable<StickValues>;
  14964. /**
  14965. * Array of button availible on the controller
  14966. */
  14967. protected _buttons: Array<MutableGamepadButton>;
  14968. private _onButtonStateChange;
  14969. /**
  14970. * Fired when a controller button's state has changed
  14971. * @param callback the callback containing the button that was modified
  14972. */
  14973. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14974. /**
  14975. * X and Y axis corresponding to the controllers joystick
  14976. */
  14977. pad: StickValues;
  14978. /**
  14979. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14980. */
  14981. hand: string;
  14982. /**
  14983. * The default controller model for the controller
  14984. */
  14985. readonly defaultModel: Nullable<AbstractMesh>;
  14986. /**
  14987. * Creates a new WebVRController from a gamepad
  14988. * @param vrGamepad the gamepad that the WebVRController should be created from
  14989. */
  14990. constructor(vrGamepad: any);
  14991. /**
  14992. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14993. */
  14994. update(): void;
  14995. /**
  14996. * Function to be called when a button is modified
  14997. */
  14998. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14999. /**
  15000. * Loads a mesh and attaches it to the controller
  15001. * @param scene the scene the mesh should be added to
  15002. * @param meshLoaded callback for when the mesh has been loaded
  15003. */
  15004. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  15005. private _setButtonValue;
  15006. private _changes;
  15007. private _checkChanges;
  15008. /**
  15009. * Disposes of th webVRCOntroller
  15010. */
  15011. dispose(): void;
  15012. }
  15013. }
  15014. declare module "babylonjs/Lights/hemisphericLight" {
  15015. import { Nullable } from "babylonjs/types";
  15016. import { Scene } from "babylonjs/scene";
  15017. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15018. import { Color3 } from "babylonjs/Maths/math.color";
  15019. import { Effect } from "babylonjs/Materials/effect";
  15020. import { Light } from "babylonjs/Lights/light";
  15021. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  15022. /**
  15023. * The HemisphericLight simulates the ambient environment light,
  15024. * so the passed direction is the light reflection direction, not the incoming direction.
  15025. */
  15026. export class HemisphericLight extends Light {
  15027. /**
  15028. * The groundColor is the light in the opposite direction to the one specified during creation.
  15029. * 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.
  15030. */
  15031. groundColor: Color3;
  15032. /**
  15033. * The light reflection direction, not the incoming direction.
  15034. */
  15035. direction: Vector3;
  15036. /**
  15037. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  15038. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  15039. * The HemisphericLight can't cast shadows.
  15040. * Documentation : https://doc.babylonjs.com/babylon101/lights
  15041. * @param name The friendly name of the light
  15042. * @param direction The direction of the light reflection
  15043. * @param scene The scene the light belongs to
  15044. */
  15045. constructor(name: string, direction: Vector3, scene: Scene);
  15046. protected _buildUniformLayout(): void;
  15047. /**
  15048. * Returns the string "HemisphericLight".
  15049. * @return The class name
  15050. */
  15051. getClassName(): string;
  15052. /**
  15053. * Sets the HemisphericLight direction towards the passed target (Vector3).
  15054. * Returns the updated direction.
  15055. * @param target The target the direction should point to
  15056. * @return The computed direction
  15057. */
  15058. setDirectionToTarget(target: Vector3): Vector3;
  15059. /**
  15060. * Returns the shadow generator associated to the light.
  15061. * @returns Always null for hemispheric lights because it does not support shadows.
  15062. */
  15063. getShadowGenerator(): Nullable<IShadowGenerator>;
  15064. /**
  15065. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  15066. * @param effect The effect to update
  15067. * @param lightIndex The index of the light in the effect to update
  15068. * @returns The hemispheric light
  15069. */
  15070. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  15071. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  15072. /**
  15073. * Computes the world matrix of the node
  15074. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15075. * @param useWasUpdatedFlag defines a reserved property
  15076. * @returns the world matrix
  15077. */
  15078. computeWorldMatrix(): Matrix;
  15079. /**
  15080. * Returns the integer 3.
  15081. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  15082. */
  15083. getTypeID(): number;
  15084. /**
  15085. * Prepares the list of defines specific to the light type.
  15086. * @param defines the list of defines
  15087. * @param lightIndex defines the index of the light for the effect
  15088. */
  15089. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  15090. }
  15091. }
  15092. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  15093. /** @hidden */
  15094. export var vrMultiviewToSingleviewPixelShader: {
  15095. name: string;
  15096. shader: string;
  15097. };
  15098. }
  15099. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  15100. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15101. import { Scene } from "babylonjs/scene";
  15102. /**
  15103. * Renders to multiple views with a single draw call
  15104. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  15105. */
  15106. export class MultiviewRenderTarget extends RenderTargetTexture {
  15107. /**
  15108. * Creates a multiview render target
  15109. * @param scene scene used with the render target
  15110. * @param size the size of the render target (used for each view)
  15111. */
  15112. constructor(scene: Scene, size?: number | {
  15113. width: number;
  15114. height: number;
  15115. } | {
  15116. ratio: number;
  15117. });
  15118. /**
  15119. * @hidden
  15120. * @param faceIndex the face index, if its a cube texture
  15121. */
  15122. _bindFrameBuffer(faceIndex?: number): void;
  15123. /**
  15124. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  15125. * @returns the view count
  15126. */
  15127. getViewCount(): number;
  15128. }
  15129. }
  15130. declare module "babylonjs/Maths/math.frustum" {
  15131. import { Matrix } from "babylonjs/Maths/math.vector";
  15132. import { DeepImmutable } from "babylonjs/types";
  15133. import { Plane } from "babylonjs/Maths/math.plane";
  15134. /**
  15135. * Represents a camera frustum
  15136. */
  15137. export class Frustum {
  15138. /**
  15139. * Gets the planes representing the frustum
  15140. * @param transform matrix to be applied to the returned planes
  15141. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  15142. */
  15143. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  15144. /**
  15145. * Gets the near frustum plane transformed by the transform matrix
  15146. * @param transform transformation matrix to be applied to the resulting frustum plane
  15147. * @param frustumPlane the resuling frustum plane
  15148. */
  15149. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15150. /**
  15151. * Gets the far frustum plane transformed by the transform matrix
  15152. * @param transform transformation matrix to be applied to the resulting frustum plane
  15153. * @param frustumPlane the resuling frustum plane
  15154. */
  15155. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15156. /**
  15157. * Gets the left frustum plane transformed by the transform matrix
  15158. * @param transform transformation matrix to be applied to the resulting frustum plane
  15159. * @param frustumPlane the resuling frustum plane
  15160. */
  15161. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15162. /**
  15163. * Gets the right frustum plane transformed by the transform matrix
  15164. * @param transform transformation matrix to be applied to the resulting frustum plane
  15165. * @param frustumPlane the resuling frustum plane
  15166. */
  15167. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15168. /**
  15169. * Gets the top frustum plane transformed by the transform matrix
  15170. * @param transform transformation matrix to be applied to the resulting frustum plane
  15171. * @param frustumPlane the resuling frustum plane
  15172. */
  15173. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15174. /**
  15175. * Gets the bottom frustum plane transformed by the transform matrix
  15176. * @param transform transformation matrix to be applied to the resulting frustum plane
  15177. * @param frustumPlane the resuling frustum plane
  15178. */
  15179. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15180. /**
  15181. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  15182. * @param transform transformation matrix to be applied to the resulting frustum planes
  15183. * @param frustumPlanes the resuling frustum planes
  15184. */
  15185. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  15186. }
  15187. }
  15188. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  15189. import { Camera } from "babylonjs/Cameras/camera";
  15190. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15191. import { Nullable } from "babylonjs/types";
  15192. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15193. import { Matrix } from "babylonjs/Maths/math.vector";
  15194. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  15195. module "babylonjs/Engines/engine" {
  15196. interface Engine {
  15197. /**
  15198. * Creates a new multiview render target
  15199. * @param width defines the width of the texture
  15200. * @param height defines the height of the texture
  15201. * @returns the created multiview texture
  15202. */
  15203. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  15204. /**
  15205. * Binds a multiview framebuffer to be drawn to
  15206. * @param multiviewTexture texture to bind
  15207. */
  15208. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  15209. }
  15210. }
  15211. module "babylonjs/Cameras/camera" {
  15212. interface Camera {
  15213. /**
  15214. * @hidden
  15215. * 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)
  15216. */
  15217. _useMultiviewToSingleView: boolean;
  15218. /**
  15219. * @hidden
  15220. * 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)
  15221. */
  15222. _multiviewTexture: Nullable<RenderTargetTexture>;
  15223. /**
  15224. * @hidden
  15225. * ensures the multiview texture of the camera exists and has the specified width/height
  15226. * @param width height to set on the multiview texture
  15227. * @param height width to set on the multiview texture
  15228. */
  15229. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  15230. }
  15231. }
  15232. module "babylonjs/scene" {
  15233. interface Scene {
  15234. /** @hidden */
  15235. _transformMatrixR: Matrix;
  15236. /** @hidden */
  15237. _multiviewSceneUbo: Nullable<UniformBuffer>;
  15238. /** @hidden */
  15239. _createMultiviewUbo(): void;
  15240. /** @hidden */
  15241. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  15242. /** @hidden */
  15243. _renderMultiviewToSingleView(camera: Camera): void;
  15244. }
  15245. }
  15246. }
  15247. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  15248. import { Camera } from "babylonjs/Cameras/camera";
  15249. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  15250. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  15251. import "babylonjs/Engines/Extensions/engine.multiview";
  15252. /**
  15253. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  15254. * This will not be used for webXR as it supports displaying texture arrays directly
  15255. */
  15256. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  15257. /**
  15258. * Initializes a VRMultiviewToSingleview
  15259. * @param name name of the post process
  15260. * @param camera camera to be applied to
  15261. * @param scaleFactor scaling factor to the size of the output texture
  15262. */
  15263. constructor(name: string, camera: Camera, scaleFactor: number);
  15264. }
  15265. }
  15266. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  15267. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  15268. import { Nullable } from "babylonjs/types";
  15269. import { Size } from "babylonjs/Maths/math.size";
  15270. import { Observable } from "babylonjs/Misc/observable";
  15271. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  15272. /**
  15273. * Interface used to define additional presentation attributes
  15274. */
  15275. export interface IVRPresentationAttributes {
  15276. /**
  15277. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  15278. */
  15279. highRefreshRate: boolean;
  15280. /**
  15281. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  15282. */
  15283. foveationLevel: number;
  15284. }
  15285. module "babylonjs/Engines/engine" {
  15286. interface Engine {
  15287. /** @hidden */
  15288. _vrDisplay: any;
  15289. /** @hidden */
  15290. _vrSupported: boolean;
  15291. /** @hidden */
  15292. _oldSize: Size;
  15293. /** @hidden */
  15294. _oldHardwareScaleFactor: number;
  15295. /** @hidden */
  15296. _vrExclusivePointerMode: boolean;
  15297. /** @hidden */
  15298. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  15299. /** @hidden */
  15300. _onVRDisplayPointerRestricted: () => void;
  15301. /** @hidden */
  15302. _onVRDisplayPointerUnrestricted: () => void;
  15303. /** @hidden */
  15304. _onVrDisplayConnect: Nullable<(display: any) => void>;
  15305. /** @hidden */
  15306. _onVrDisplayDisconnect: Nullable<() => void>;
  15307. /** @hidden */
  15308. _onVrDisplayPresentChange: Nullable<() => void>;
  15309. /**
  15310. * Observable signaled when VR display mode changes
  15311. */
  15312. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  15313. /**
  15314. * Observable signaled when VR request present is complete
  15315. */
  15316. onVRRequestPresentComplete: Observable<boolean>;
  15317. /**
  15318. * Observable signaled when VR request present starts
  15319. */
  15320. onVRRequestPresentStart: Observable<Engine>;
  15321. /**
  15322. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  15323. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  15324. */
  15325. isInVRExclusivePointerMode: boolean;
  15326. /**
  15327. * Gets a boolean indicating if a webVR device was detected
  15328. * @returns true if a webVR device was detected
  15329. */
  15330. isVRDevicePresent(): boolean;
  15331. /**
  15332. * Gets the current webVR device
  15333. * @returns the current webVR device (or null)
  15334. */
  15335. getVRDevice(): any;
  15336. /**
  15337. * Initializes a webVR display and starts listening to display change events
  15338. * The onVRDisplayChangedObservable will be notified upon these changes
  15339. * @returns A promise containing a VRDisplay and if vr is supported
  15340. */
  15341. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  15342. /** @hidden */
  15343. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  15344. /**
  15345. * Gets or sets the presentation attributes used to configure VR rendering
  15346. */
  15347. vrPresentationAttributes?: IVRPresentationAttributes;
  15348. /**
  15349. * Call this function to switch to webVR mode
  15350. * Will do nothing if webVR is not supported or if there is no webVR device
  15351. * @param options the webvr options provided to the camera. mainly used for multiview
  15352. * @see http://doc.babylonjs.com/how_to/webvr_camera
  15353. */
  15354. enableVR(options: WebVROptions): void;
  15355. /** @hidden */
  15356. _onVRFullScreenTriggered(): void;
  15357. }
  15358. }
  15359. }
  15360. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15361. import { Nullable } from "babylonjs/types";
  15362. import { Observable } from "babylonjs/Misc/observable";
  15363. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15364. import { Scene } from "babylonjs/scene";
  15365. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15366. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15367. import { Node } from "babylonjs/node";
  15368. import { Ray } from "babylonjs/Culling/ray";
  15369. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15370. import "babylonjs/Engines/Extensions/engine.webVR";
  15371. /**
  15372. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15373. * IMPORTANT!! The data is right-hand data.
  15374. * @export
  15375. * @interface DevicePose
  15376. */
  15377. export interface DevicePose {
  15378. /**
  15379. * The position of the device, values in array are [x,y,z].
  15380. */
  15381. readonly position: Nullable<Float32Array>;
  15382. /**
  15383. * The linearVelocity of the device, values in array are [x,y,z].
  15384. */
  15385. readonly linearVelocity: Nullable<Float32Array>;
  15386. /**
  15387. * The linearAcceleration of the device, values in array are [x,y,z].
  15388. */
  15389. readonly linearAcceleration: Nullable<Float32Array>;
  15390. /**
  15391. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15392. */
  15393. readonly orientation: Nullable<Float32Array>;
  15394. /**
  15395. * The angularVelocity of the device, values in array are [x,y,z].
  15396. */
  15397. readonly angularVelocity: Nullable<Float32Array>;
  15398. /**
  15399. * The angularAcceleration of the device, values in array are [x,y,z].
  15400. */
  15401. readonly angularAcceleration: Nullable<Float32Array>;
  15402. }
  15403. /**
  15404. * Interface representing a pose controlled object in Babylon.
  15405. * A pose controlled object has both regular pose values as well as pose values
  15406. * from an external device such as a VR head mounted display
  15407. */
  15408. export interface PoseControlled {
  15409. /**
  15410. * The position of the object in babylon space.
  15411. */
  15412. position: Vector3;
  15413. /**
  15414. * The rotation quaternion of the object in babylon space.
  15415. */
  15416. rotationQuaternion: Quaternion;
  15417. /**
  15418. * The position of the device in babylon space.
  15419. */
  15420. devicePosition?: Vector3;
  15421. /**
  15422. * The rotation quaternion of the device in babylon space.
  15423. */
  15424. deviceRotationQuaternion: Quaternion;
  15425. /**
  15426. * The raw pose coming from the device.
  15427. */
  15428. rawPose: Nullable<DevicePose>;
  15429. /**
  15430. * The scale of the device to be used when translating from device space to babylon space.
  15431. */
  15432. deviceScaleFactor: number;
  15433. /**
  15434. * Updates the poseControlled values based on the input device pose.
  15435. * @param poseData the pose data to update the object with
  15436. */
  15437. updateFromDevice(poseData: DevicePose): void;
  15438. }
  15439. /**
  15440. * Set of options to customize the webVRCamera
  15441. */
  15442. export interface WebVROptions {
  15443. /**
  15444. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15445. */
  15446. trackPosition?: boolean;
  15447. /**
  15448. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15449. */
  15450. positionScale?: number;
  15451. /**
  15452. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15453. */
  15454. displayName?: string;
  15455. /**
  15456. * Should the native controller meshes be initialized. (default: true)
  15457. */
  15458. controllerMeshes?: boolean;
  15459. /**
  15460. * Creating a default HemiLight only on controllers. (default: true)
  15461. */
  15462. defaultLightingOnControllers?: boolean;
  15463. /**
  15464. * If you don't want to use the default VR button of the helper. (default: false)
  15465. */
  15466. useCustomVRButton?: boolean;
  15467. /**
  15468. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15469. */
  15470. customVRButton?: HTMLButtonElement;
  15471. /**
  15472. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15473. */
  15474. rayLength?: number;
  15475. /**
  15476. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15477. */
  15478. defaultHeight?: number;
  15479. /**
  15480. * If multiview should be used if availible (default: false)
  15481. */
  15482. useMultiview?: boolean;
  15483. }
  15484. /**
  15485. * This represents a WebVR camera.
  15486. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15487. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15488. */
  15489. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15490. private webVROptions;
  15491. /**
  15492. * @hidden
  15493. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15494. */
  15495. _vrDevice: any;
  15496. /**
  15497. * The rawPose of the vrDevice.
  15498. */
  15499. rawPose: Nullable<DevicePose>;
  15500. private _onVREnabled;
  15501. private _specsVersion;
  15502. private _attached;
  15503. private _frameData;
  15504. protected _descendants: Array<Node>;
  15505. private _deviceRoomPosition;
  15506. /** @hidden */
  15507. _deviceRoomRotationQuaternion: Quaternion;
  15508. private _standingMatrix;
  15509. /**
  15510. * Represents device position in babylon space.
  15511. */
  15512. devicePosition: Vector3;
  15513. /**
  15514. * Represents device rotation in babylon space.
  15515. */
  15516. deviceRotationQuaternion: Quaternion;
  15517. /**
  15518. * The scale of the device to be used when translating from device space to babylon space.
  15519. */
  15520. deviceScaleFactor: number;
  15521. private _deviceToWorld;
  15522. private _worldToDevice;
  15523. /**
  15524. * References to the webVR controllers for the vrDevice.
  15525. */
  15526. controllers: Array<WebVRController>;
  15527. /**
  15528. * Emits an event when a controller is attached.
  15529. */
  15530. onControllersAttachedObservable: Observable<WebVRController[]>;
  15531. /**
  15532. * Emits an event when a controller's mesh has been loaded;
  15533. */
  15534. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15535. /**
  15536. * Emits an event when the HMD's pose has been updated.
  15537. */
  15538. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15539. private _poseSet;
  15540. /**
  15541. * If the rig cameras be used as parent instead of this camera.
  15542. */
  15543. rigParenting: boolean;
  15544. private _lightOnControllers;
  15545. private _defaultHeight?;
  15546. /**
  15547. * Instantiates a WebVRFreeCamera.
  15548. * @param name The name of the WebVRFreeCamera
  15549. * @param position The starting anchor position for the camera
  15550. * @param scene The scene the camera belongs to
  15551. * @param webVROptions a set of customizable options for the webVRCamera
  15552. */
  15553. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15554. /**
  15555. * Gets the device distance from the ground in meters.
  15556. * @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.
  15557. */
  15558. deviceDistanceToRoomGround(): number;
  15559. /**
  15560. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15561. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15562. */
  15563. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15564. /**
  15565. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15566. * @returns A promise with a boolean set to if the standing matrix is supported.
  15567. */
  15568. useStandingMatrixAsync(): Promise<boolean>;
  15569. /**
  15570. * Disposes the camera
  15571. */
  15572. dispose(): void;
  15573. /**
  15574. * Gets a vrController by name.
  15575. * @param name The name of the controller to retreive
  15576. * @returns the controller matching the name specified or null if not found
  15577. */
  15578. getControllerByName(name: string): Nullable<WebVRController>;
  15579. private _leftController;
  15580. /**
  15581. * The controller corresponding to the users left hand.
  15582. */
  15583. readonly leftController: Nullable<WebVRController>;
  15584. private _rightController;
  15585. /**
  15586. * The controller corresponding to the users right hand.
  15587. */
  15588. readonly rightController: Nullable<WebVRController>;
  15589. /**
  15590. * Casts a ray forward from the vrCamera's gaze.
  15591. * @param length Length of the ray (default: 100)
  15592. * @returns the ray corresponding to the gaze
  15593. */
  15594. getForwardRay(length?: number): Ray;
  15595. /**
  15596. * @hidden
  15597. * Updates the camera based on device's frame data
  15598. */
  15599. _checkInputs(): void;
  15600. /**
  15601. * Updates the poseControlled values based on the input device pose.
  15602. * @param poseData Pose coming from the device
  15603. */
  15604. updateFromDevice(poseData: DevicePose): void;
  15605. private _htmlElementAttached;
  15606. private _detachIfAttached;
  15607. /**
  15608. * WebVR's attach control will start broadcasting frames to the device.
  15609. * Note that in certain browsers (chrome for example) this function must be called
  15610. * within a user-interaction callback. Example:
  15611. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15612. *
  15613. * @param element html element to attach the vrDevice to
  15614. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15615. */
  15616. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15617. /**
  15618. * Detaches the camera from the html element and disables VR
  15619. *
  15620. * @param element html element to detach from
  15621. */
  15622. detachControl(element: HTMLElement): void;
  15623. /**
  15624. * @returns the name of this class
  15625. */
  15626. getClassName(): string;
  15627. /**
  15628. * Calls resetPose on the vrDisplay
  15629. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15630. */
  15631. resetToCurrentRotation(): void;
  15632. /**
  15633. * @hidden
  15634. * Updates the rig cameras (left and right eye)
  15635. */
  15636. _updateRigCameras(): void;
  15637. private _workingVector;
  15638. private _oneVector;
  15639. private _workingMatrix;
  15640. private updateCacheCalled;
  15641. private _correctPositionIfNotTrackPosition;
  15642. /**
  15643. * @hidden
  15644. * Updates the cached values of the camera
  15645. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15646. */
  15647. _updateCache(ignoreParentClass?: boolean): void;
  15648. /**
  15649. * @hidden
  15650. * Get current device position in babylon world
  15651. */
  15652. _computeDevicePosition(): void;
  15653. /**
  15654. * Updates the current device position and rotation in the babylon world
  15655. */
  15656. update(): void;
  15657. /**
  15658. * @hidden
  15659. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15660. * @returns an identity matrix
  15661. */
  15662. _getViewMatrix(): Matrix;
  15663. private _tmpMatrix;
  15664. /**
  15665. * This function is called by the two RIG cameras.
  15666. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15667. * @hidden
  15668. */
  15669. _getWebVRViewMatrix(): Matrix;
  15670. /** @hidden */
  15671. _getWebVRProjectionMatrix(): Matrix;
  15672. private _onGamepadConnectedObserver;
  15673. private _onGamepadDisconnectedObserver;
  15674. private _updateCacheWhenTrackingDisabledObserver;
  15675. /**
  15676. * Initializes the controllers and their meshes
  15677. */
  15678. initControllers(): void;
  15679. }
  15680. }
  15681. declare module "babylonjs/PostProcesses/postProcess" {
  15682. import { Nullable } from "babylonjs/types";
  15683. import { SmartArray } from "babylonjs/Misc/smartArray";
  15684. import { Observable } from "babylonjs/Misc/observable";
  15685. import { Vector2 } from "babylonjs/Maths/math.vector";
  15686. import { Camera } from "babylonjs/Cameras/camera";
  15687. import { Effect } from "babylonjs/Materials/effect";
  15688. import "babylonjs/Shaders/postprocess.vertex";
  15689. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15690. import { Engine } from "babylonjs/Engines/engine";
  15691. import { Color4 } from "babylonjs/Maths/math.color";
  15692. import "babylonjs/Engines/Extensions/engine.renderTarget";
  15693. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15694. /**
  15695. * Size options for a post process
  15696. */
  15697. export type PostProcessOptions = {
  15698. width: number;
  15699. height: number;
  15700. };
  15701. /**
  15702. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15703. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15704. */
  15705. export class PostProcess {
  15706. /** Name of the PostProcess. */
  15707. name: string;
  15708. /**
  15709. * Gets or sets the unique id of the post process
  15710. */
  15711. uniqueId: number;
  15712. /**
  15713. * Width of the texture to apply the post process on
  15714. */
  15715. width: number;
  15716. /**
  15717. * Height of the texture to apply the post process on
  15718. */
  15719. height: number;
  15720. /**
  15721. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15722. * @hidden
  15723. */
  15724. _outputTexture: Nullable<InternalTexture>;
  15725. /**
  15726. * Sampling mode used by the shader
  15727. * See https://doc.babylonjs.com/classes/3.1/texture
  15728. */
  15729. renderTargetSamplingMode: number;
  15730. /**
  15731. * Clear color to use when screen clearing
  15732. */
  15733. clearColor: Color4;
  15734. /**
  15735. * If the buffer needs to be cleared before applying the post process. (default: true)
  15736. * Should be set to false if shader will overwrite all previous pixels.
  15737. */
  15738. autoClear: boolean;
  15739. /**
  15740. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15741. */
  15742. alphaMode: number;
  15743. /**
  15744. * Sets the setAlphaBlendConstants of the babylon engine
  15745. */
  15746. alphaConstants: Color4;
  15747. /**
  15748. * Animations to be used for the post processing
  15749. */
  15750. animations: import("babylonjs/Animations/animation").Animation[];
  15751. /**
  15752. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15753. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15754. */
  15755. enablePixelPerfectMode: boolean;
  15756. /**
  15757. * Force the postprocess to be applied without taking in account viewport
  15758. */
  15759. forceFullscreenViewport: boolean;
  15760. /**
  15761. * List of inspectable custom properties (used by the Inspector)
  15762. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15763. */
  15764. inspectableCustomProperties: IInspectable[];
  15765. /**
  15766. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15767. *
  15768. * | Value | Type | Description |
  15769. * | ----- | ----------------------------------- | ----------- |
  15770. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15771. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15772. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15773. *
  15774. */
  15775. scaleMode: number;
  15776. /**
  15777. * Force textures to be a power of two (default: false)
  15778. */
  15779. alwaysForcePOT: boolean;
  15780. private _samples;
  15781. /**
  15782. * Number of sample textures (default: 1)
  15783. */
  15784. samples: number;
  15785. /**
  15786. * Modify the scale of the post process to be the same as the viewport (default: false)
  15787. */
  15788. adaptScaleToCurrentViewport: boolean;
  15789. private _camera;
  15790. private _scene;
  15791. private _engine;
  15792. private _options;
  15793. private _reusable;
  15794. private _textureType;
  15795. /**
  15796. * Smart array of input and output textures for the post process.
  15797. * @hidden
  15798. */
  15799. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15800. /**
  15801. * The index in _textures that corresponds to the output texture.
  15802. * @hidden
  15803. */
  15804. _currentRenderTextureInd: number;
  15805. private _effect;
  15806. private _samplers;
  15807. private _fragmentUrl;
  15808. private _vertexUrl;
  15809. private _parameters;
  15810. private _scaleRatio;
  15811. protected _indexParameters: any;
  15812. private _shareOutputWithPostProcess;
  15813. private _texelSize;
  15814. private _forcedOutputTexture;
  15815. /**
  15816. * Returns the fragment url or shader name used in the post process.
  15817. * @returns the fragment url or name in the shader store.
  15818. */
  15819. getEffectName(): string;
  15820. /**
  15821. * An event triggered when the postprocess is activated.
  15822. */
  15823. onActivateObservable: Observable<Camera>;
  15824. private _onActivateObserver;
  15825. /**
  15826. * A function that is added to the onActivateObservable
  15827. */
  15828. onActivate: Nullable<(camera: Camera) => void>;
  15829. /**
  15830. * An event triggered when the postprocess changes its size.
  15831. */
  15832. onSizeChangedObservable: Observable<PostProcess>;
  15833. private _onSizeChangedObserver;
  15834. /**
  15835. * A function that is added to the onSizeChangedObservable
  15836. */
  15837. onSizeChanged: (postProcess: PostProcess) => void;
  15838. /**
  15839. * An event triggered when the postprocess applies its effect.
  15840. */
  15841. onApplyObservable: Observable<Effect>;
  15842. private _onApplyObserver;
  15843. /**
  15844. * A function that is added to the onApplyObservable
  15845. */
  15846. onApply: (effect: Effect) => void;
  15847. /**
  15848. * An event triggered before rendering the postprocess
  15849. */
  15850. onBeforeRenderObservable: Observable<Effect>;
  15851. private _onBeforeRenderObserver;
  15852. /**
  15853. * A function that is added to the onBeforeRenderObservable
  15854. */
  15855. onBeforeRender: (effect: Effect) => void;
  15856. /**
  15857. * An event triggered after rendering the postprocess
  15858. */
  15859. onAfterRenderObservable: Observable<Effect>;
  15860. private _onAfterRenderObserver;
  15861. /**
  15862. * A function that is added to the onAfterRenderObservable
  15863. */
  15864. onAfterRender: (efect: Effect) => void;
  15865. /**
  15866. * 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
  15867. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15868. */
  15869. inputTexture: InternalTexture;
  15870. /**
  15871. * Gets the camera which post process is applied to.
  15872. * @returns The camera the post process is applied to.
  15873. */
  15874. getCamera(): Camera;
  15875. /**
  15876. * Gets the texel size of the postprocess.
  15877. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15878. */
  15879. readonly texelSize: Vector2;
  15880. /**
  15881. * Creates a new instance PostProcess
  15882. * @param name The name of the PostProcess.
  15883. * @param fragmentUrl The url of the fragment shader to be used.
  15884. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15885. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15886. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15887. * @param camera The camera to apply the render pass to.
  15888. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15889. * @param engine The engine which the post process will be applied. (default: current engine)
  15890. * @param reusable If the post process can be reused on the same frame. (default: false)
  15891. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15892. * @param textureType Type of textures used when performing the post process. (default: 0)
  15893. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15894. * @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
  15895. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15896. */
  15897. constructor(
  15898. /** Name of the PostProcess. */
  15899. 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);
  15900. /**
  15901. * Gets a string idenfifying the name of the class
  15902. * @returns "PostProcess" string
  15903. */
  15904. getClassName(): string;
  15905. /**
  15906. * Gets the engine which this post process belongs to.
  15907. * @returns The engine the post process was enabled with.
  15908. */
  15909. getEngine(): Engine;
  15910. /**
  15911. * The effect that is created when initializing the post process.
  15912. * @returns The created effect corresponding the the postprocess.
  15913. */
  15914. getEffect(): Effect;
  15915. /**
  15916. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15917. * @param postProcess The post process to share the output with.
  15918. * @returns This post process.
  15919. */
  15920. shareOutputWith(postProcess: PostProcess): PostProcess;
  15921. /**
  15922. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15923. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15924. */
  15925. useOwnOutput(): void;
  15926. /**
  15927. * Updates the effect with the current post process compile time values and recompiles the shader.
  15928. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15929. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15930. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15931. * @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
  15932. * @param onCompiled Called when the shader has been compiled.
  15933. * @param onError Called if there is an error when compiling a shader.
  15934. */
  15935. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15936. /**
  15937. * The post process is reusable if it can be used multiple times within one frame.
  15938. * @returns If the post process is reusable
  15939. */
  15940. isReusable(): boolean;
  15941. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15942. markTextureDirty(): void;
  15943. /**
  15944. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15945. * 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.
  15946. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15947. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15948. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15949. * @returns The target texture that was bound to be written to.
  15950. */
  15951. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15952. /**
  15953. * If the post process is supported.
  15954. */
  15955. readonly isSupported: boolean;
  15956. /**
  15957. * The aspect ratio of the output texture.
  15958. */
  15959. readonly aspectRatio: number;
  15960. /**
  15961. * Get a value indicating if the post-process is ready to be used
  15962. * @returns true if the post-process is ready (shader is compiled)
  15963. */
  15964. isReady(): boolean;
  15965. /**
  15966. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15967. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15968. */
  15969. apply(): Nullable<Effect>;
  15970. private _disposeTextures;
  15971. /**
  15972. * Disposes the post process.
  15973. * @param camera The camera to dispose the post process on.
  15974. */
  15975. dispose(camera?: Camera): void;
  15976. }
  15977. }
  15978. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15979. /** @hidden */
  15980. export var kernelBlurVaryingDeclaration: {
  15981. name: string;
  15982. shader: string;
  15983. };
  15984. }
  15985. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15986. /** @hidden */
  15987. export var kernelBlurFragment: {
  15988. name: string;
  15989. shader: string;
  15990. };
  15991. }
  15992. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15993. /** @hidden */
  15994. export var kernelBlurFragment2: {
  15995. name: string;
  15996. shader: string;
  15997. };
  15998. }
  15999. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  16000. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  16001. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  16002. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  16003. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  16004. /** @hidden */
  16005. export var kernelBlurPixelShader: {
  16006. name: string;
  16007. shader: string;
  16008. };
  16009. }
  16010. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  16011. /** @hidden */
  16012. export var kernelBlurVertex: {
  16013. name: string;
  16014. shader: string;
  16015. };
  16016. }
  16017. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  16018. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  16019. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  16020. /** @hidden */
  16021. export var kernelBlurVertexShader: {
  16022. name: string;
  16023. shader: string;
  16024. };
  16025. }
  16026. declare module "babylonjs/PostProcesses/blurPostProcess" {
  16027. import { Vector2 } from "babylonjs/Maths/math.vector";
  16028. import { Nullable } from "babylonjs/types";
  16029. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  16030. import { Camera } from "babylonjs/Cameras/camera";
  16031. import { Effect } from "babylonjs/Materials/effect";
  16032. import { Engine } from "babylonjs/Engines/engine";
  16033. import "babylonjs/Shaders/kernelBlur.fragment";
  16034. import "babylonjs/Shaders/kernelBlur.vertex";
  16035. /**
  16036. * The Blur Post Process which blurs an image based on a kernel and direction.
  16037. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  16038. */
  16039. export class BlurPostProcess extends PostProcess {
  16040. /** The direction in which to blur the image. */
  16041. direction: Vector2;
  16042. private blockCompilation;
  16043. protected _kernel: number;
  16044. protected _idealKernel: number;
  16045. protected _packedFloat: boolean;
  16046. private _staticDefines;
  16047. /**
  16048. * Sets the length in pixels of the blur sample region
  16049. */
  16050. /**
  16051. * Gets the length in pixels of the blur sample region
  16052. */
  16053. kernel: number;
  16054. /**
  16055. * Sets wether or not the blur needs to unpack/repack floats
  16056. */
  16057. /**
  16058. * Gets wether or not the blur is unpacking/repacking floats
  16059. */
  16060. packedFloat: boolean;
  16061. /**
  16062. * Creates a new instance BlurPostProcess
  16063. * @param name The name of the effect.
  16064. * @param direction The direction in which to blur the image.
  16065. * @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.
  16066. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  16067. * @param camera The camera to apply the render pass to.
  16068. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  16069. * @param engine The engine which the post process will be applied. (default: current engine)
  16070. * @param reusable If the post process can be reused on the same frame. (default: false)
  16071. * @param textureType Type of textures used when performing the post process. (default: 0)
  16072. * @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)
  16073. */
  16074. constructor(name: string,
  16075. /** The direction in which to blur the image. */
  16076. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  16077. /**
  16078. * Updates the effect with the current post process compile time values and recompiles the shader.
  16079. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  16080. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  16081. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  16082. * @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
  16083. * @param onCompiled Called when the shader has been compiled.
  16084. * @param onError Called if there is an error when compiling a shader.
  16085. */
  16086. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  16087. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  16088. /**
  16089. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  16090. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  16091. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  16092. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  16093. * The gaps between physical kernels are compensated for in the weighting of the samples
  16094. * @param idealKernel Ideal blur kernel.
  16095. * @return Nearest best kernel.
  16096. */
  16097. protected _nearestBestKernel(idealKernel: number): number;
  16098. /**
  16099. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  16100. * @param x The point on the Gaussian distribution to sample.
  16101. * @return the value of the Gaussian function at x.
  16102. */
  16103. protected _gaussianWeight(x: number): number;
  16104. /**
  16105. * Generates a string that can be used as a floating point number in GLSL.
  16106. * @param x Value to print.
  16107. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  16108. * @return GLSL float string.
  16109. */
  16110. protected _glslFloat(x: number, decimalFigures?: number): string;
  16111. }
  16112. }
  16113. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  16114. import { Scene } from "babylonjs/scene";
  16115. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  16116. import { Plane } from "babylonjs/Maths/math.plane";
  16117. /**
  16118. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16119. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16120. * You can then easily use it as a reflectionTexture on a flat surface.
  16121. * In case the surface is not a plane, please consider relying on reflection probes.
  16122. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16123. */
  16124. export class MirrorTexture extends RenderTargetTexture {
  16125. private scene;
  16126. /**
  16127. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  16128. * 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.
  16129. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16130. */
  16131. mirrorPlane: Plane;
  16132. /**
  16133. * Define the blur ratio used to blur the reflection if needed.
  16134. */
  16135. blurRatio: number;
  16136. /**
  16137. * Define the adaptive blur kernel used to blur the reflection if needed.
  16138. * This will autocompute the closest best match for the `blurKernel`
  16139. */
  16140. adaptiveBlurKernel: number;
  16141. /**
  16142. * Define the blur kernel used to blur the reflection if needed.
  16143. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16144. */
  16145. blurKernel: number;
  16146. /**
  16147. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  16148. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16149. */
  16150. blurKernelX: number;
  16151. /**
  16152. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  16153. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16154. */
  16155. blurKernelY: number;
  16156. private _autoComputeBlurKernel;
  16157. protected _onRatioRescale(): void;
  16158. private _updateGammaSpace;
  16159. private _imageProcessingConfigChangeObserver;
  16160. private _transformMatrix;
  16161. private _mirrorMatrix;
  16162. private _savedViewMatrix;
  16163. private _blurX;
  16164. private _blurY;
  16165. private _adaptiveBlurKernel;
  16166. private _blurKernelX;
  16167. private _blurKernelY;
  16168. private _blurRatio;
  16169. /**
  16170. * Instantiates a Mirror Texture.
  16171. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16172. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16173. * You can then easily use it as a reflectionTexture on a flat surface.
  16174. * In case the surface is not a plane, please consider relying on reflection probes.
  16175. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16176. * @param name
  16177. * @param size
  16178. * @param scene
  16179. * @param generateMipMaps
  16180. * @param type
  16181. * @param samplingMode
  16182. * @param generateDepthBuffer
  16183. */
  16184. constructor(name: string, size: number | {
  16185. width: number;
  16186. height: number;
  16187. } | {
  16188. ratio: number;
  16189. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  16190. private _preparePostProcesses;
  16191. /**
  16192. * Clone the mirror texture.
  16193. * @returns the cloned texture
  16194. */
  16195. clone(): MirrorTexture;
  16196. /**
  16197. * Serialize the texture to a JSON representation you could use in Parse later on
  16198. * @returns the serialized JSON representation
  16199. */
  16200. serialize(): any;
  16201. /**
  16202. * Dispose the texture and release its associated resources.
  16203. */
  16204. dispose(): void;
  16205. }
  16206. }
  16207. declare module "babylonjs/Materials/Textures/texture" {
  16208. import { Observable } from "babylonjs/Misc/observable";
  16209. import { Nullable } from "babylonjs/types";
  16210. import { Matrix } from "babylonjs/Maths/math.vector";
  16211. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16212. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16213. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  16214. import { Scene } from "babylonjs/scene";
  16215. /**
  16216. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16217. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16218. */
  16219. export class Texture extends BaseTexture {
  16220. /**
  16221. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  16222. */
  16223. static SerializeBuffers: boolean;
  16224. /** @hidden */
  16225. static _CubeTextureParser: (jsonTexture: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  16226. /** @hidden */
  16227. static _CreateMirror: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  16228. /** @hidden */
  16229. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  16230. /** nearest is mag = nearest and min = nearest and mip = linear */
  16231. static readonly NEAREST_SAMPLINGMODE: number;
  16232. /** nearest is mag = nearest and min = nearest and mip = linear */
  16233. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  16234. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16235. static readonly BILINEAR_SAMPLINGMODE: number;
  16236. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16237. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  16238. /** Trilinear is mag = linear and min = linear and mip = linear */
  16239. static readonly TRILINEAR_SAMPLINGMODE: number;
  16240. /** Trilinear is mag = linear and min = linear and mip = linear */
  16241. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  16242. /** mag = nearest and min = nearest and mip = nearest */
  16243. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  16244. /** mag = nearest and min = linear and mip = nearest */
  16245. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  16246. /** mag = nearest and min = linear and mip = linear */
  16247. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  16248. /** mag = nearest and min = linear and mip = none */
  16249. static readonly NEAREST_LINEAR: number;
  16250. /** mag = nearest and min = nearest and mip = none */
  16251. static readonly NEAREST_NEAREST: number;
  16252. /** mag = linear and min = nearest and mip = nearest */
  16253. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  16254. /** mag = linear and min = nearest and mip = linear */
  16255. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  16256. /** mag = linear and min = linear and mip = none */
  16257. static readonly LINEAR_LINEAR: number;
  16258. /** mag = linear and min = nearest and mip = none */
  16259. static readonly LINEAR_NEAREST: number;
  16260. /** Explicit coordinates mode */
  16261. static readonly EXPLICIT_MODE: number;
  16262. /** Spherical coordinates mode */
  16263. static readonly SPHERICAL_MODE: number;
  16264. /** Planar coordinates mode */
  16265. static readonly PLANAR_MODE: number;
  16266. /** Cubic coordinates mode */
  16267. static readonly CUBIC_MODE: number;
  16268. /** Projection coordinates mode */
  16269. static readonly PROJECTION_MODE: number;
  16270. /** Inverse Cubic coordinates mode */
  16271. static readonly SKYBOX_MODE: number;
  16272. /** Inverse Cubic coordinates mode */
  16273. static readonly INVCUBIC_MODE: number;
  16274. /** Equirectangular coordinates mode */
  16275. static readonly EQUIRECTANGULAR_MODE: number;
  16276. /** Equirectangular Fixed coordinates mode */
  16277. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  16278. /** Equirectangular Fixed Mirrored coordinates mode */
  16279. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  16280. /** Texture is not repeating outside of 0..1 UVs */
  16281. static readonly CLAMP_ADDRESSMODE: number;
  16282. /** Texture is repeating outside of 0..1 UVs */
  16283. static readonly WRAP_ADDRESSMODE: number;
  16284. /** Texture is repeating and mirrored */
  16285. static readonly MIRROR_ADDRESSMODE: number;
  16286. /**
  16287. * 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
  16288. */
  16289. static UseSerializedUrlIfAny: boolean;
  16290. /**
  16291. * Define the url of the texture.
  16292. */
  16293. url: Nullable<string>;
  16294. /**
  16295. * Define an offset on the texture to offset the u coordinates of the UVs
  16296. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16297. */
  16298. uOffset: number;
  16299. /**
  16300. * Define an offset on the texture to offset the v coordinates of the UVs
  16301. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16302. */
  16303. vOffset: number;
  16304. /**
  16305. * Define an offset on the texture to scale the u coordinates of the UVs
  16306. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16307. */
  16308. uScale: number;
  16309. /**
  16310. * Define an offset on the texture to scale the v coordinates of the UVs
  16311. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16312. */
  16313. vScale: number;
  16314. /**
  16315. * Define an offset on the texture to rotate around the u coordinates of the UVs
  16316. * @see http://doc.babylonjs.com/how_to/more_materials
  16317. */
  16318. uAng: number;
  16319. /**
  16320. * Define an offset on the texture to rotate around the v coordinates of the UVs
  16321. * @see http://doc.babylonjs.com/how_to/more_materials
  16322. */
  16323. vAng: number;
  16324. /**
  16325. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  16326. * @see http://doc.babylonjs.com/how_to/more_materials
  16327. */
  16328. wAng: number;
  16329. /**
  16330. * Defines the center of rotation (U)
  16331. */
  16332. uRotationCenter: number;
  16333. /**
  16334. * Defines the center of rotation (V)
  16335. */
  16336. vRotationCenter: number;
  16337. /**
  16338. * Defines the center of rotation (W)
  16339. */
  16340. wRotationCenter: number;
  16341. /**
  16342. * Are mip maps generated for this texture or not.
  16343. */
  16344. readonly noMipmap: boolean;
  16345. /**
  16346. * List of inspectable custom properties (used by the Inspector)
  16347. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16348. */
  16349. inspectableCustomProperties: Nullable<IInspectable[]>;
  16350. private _noMipmap;
  16351. /** @hidden */
  16352. _invertY: boolean;
  16353. private _rowGenerationMatrix;
  16354. private _cachedTextureMatrix;
  16355. private _projectionModeMatrix;
  16356. private _t0;
  16357. private _t1;
  16358. private _t2;
  16359. private _cachedUOffset;
  16360. private _cachedVOffset;
  16361. private _cachedUScale;
  16362. private _cachedVScale;
  16363. private _cachedUAng;
  16364. private _cachedVAng;
  16365. private _cachedWAng;
  16366. private _cachedProjectionMatrixId;
  16367. private _cachedCoordinatesMode;
  16368. /** @hidden */
  16369. protected _initialSamplingMode: number;
  16370. /** @hidden */
  16371. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  16372. private _deleteBuffer;
  16373. protected _format: Nullable<number>;
  16374. private _delayedOnLoad;
  16375. private _delayedOnError;
  16376. private _mimeType?;
  16377. /**
  16378. * Observable triggered once the texture has been loaded.
  16379. */
  16380. onLoadObservable: Observable<Texture>;
  16381. protected _isBlocking: boolean;
  16382. /**
  16383. * Is the texture preventing material to render while loading.
  16384. * If false, a default texture will be used instead of the loading one during the preparation step.
  16385. */
  16386. isBlocking: boolean;
  16387. /**
  16388. * Get the current sampling mode associated with the texture.
  16389. */
  16390. readonly samplingMode: number;
  16391. /**
  16392. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16393. */
  16394. readonly invertY: boolean;
  16395. /**
  16396. * Instantiates a new texture.
  16397. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16398. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16399. * @param url defines the url of the picture to load as a texture
  16400. * @param scene defines the scene or engine the texture will belong to
  16401. * @param noMipmap defines if the texture will require mip maps or not
  16402. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  16403. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16404. * @param onLoad defines a callback triggered when the texture has been loaded
  16405. * @param onError defines a callback triggered when an error occurred during the loading session
  16406. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  16407. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  16408. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16409. * @param mimeType defines an optional mime type information
  16410. */
  16411. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  16412. /**
  16413. * Update the url (and optional buffer) of this texture if url was null during construction.
  16414. * @param url the url of the texture
  16415. * @param buffer the buffer of the texture (defaults to null)
  16416. * @param onLoad callback called when the texture is loaded (defaults to null)
  16417. */
  16418. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16419. /**
  16420. * Finish the loading sequence of a texture flagged as delayed load.
  16421. * @hidden
  16422. */
  16423. delayLoad(): void;
  16424. private _prepareRowForTextureGeneration;
  16425. /**
  16426. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16427. * @returns the transform matrix of the texture.
  16428. */
  16429. getTextureMatrix(): Matrix;
  16430. /**
  16431. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16432. * @returns The reflection texture transform
  16433. */
  16434. getReflectionTextureMatrix(): Matrix;
  16435. /**
  16436. * Clones the texture.
  16437. * @returns the cloned texture
  16438. */
  16439. clone(): Texture;
  16440. /**
  16441. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16442. * @returns The JSON representation of the texture
  16443. */
  16444. serialize(): any;
  16445. /**
  16446. * Get the current class name of the texture useful for serialization or dynamic coding.
  16447. * @returns "Texture"
  16448. */
  16449. getClassName(): string;
  16450. /**
  16451. * Dispose the texture and release its associated resources.
  16452. */
  16453. dispose(): void;
  16454. /**
  16455. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16456. * @param parsedTexture Define the JSON representation of the texture
  16457. * @param scene Define the scene the parsed texture should be instantiated in
  16458. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16459. * @returns The parsed texture if successful
  16460. */
  16461. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16462. /**
  16463. * Creates a texture from its base 64 representation.
  16464. * @param data Define the base64 payload without the data: prefix
  16465. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16466. * @param scene Define the scene the texture should belong to
  16467. * @param noMipmap Forces the texture to not create mip map information if true
  16468. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16469. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16470. * @param onLoad define a callback triggered when the texture has been loaded
  16471. * @param onError define a callback triggered when an error occurred during the loading session
  16472. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16473. * @returns the created texture
  16474. */
  16475. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16476. /**
  16477. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16478. * @param data Define the base64 payload without the data: prefix
  16479. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16480. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16481. * @param scene Define the scene the texture should belong to
  16482. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16483. * @param noMipmap Forces the texture to not create mip map information if true
  16484. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16485. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16486. * @param onLoad define a callback triggered when the texture has been loaded
  16487. * @param onError define a callback triggered when an error occurred during the loading session
  16488. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16489. * @returns the created texture
  16490. */
  16491. 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;
  16492. }
  16493. }
  16494. declare module "babylonjs/PostProcesses/postProcessManager" {
  16495. import { Nullable } from "babylonjs/types";
  16496. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16497. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16498. import { Scene } from "babylonjs/scene";
  16499. /**
  16500. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16501. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16502. */
  16503. export class PostProcessManager {
  16504. private _scene;
  16505. private _indexBuffer;
  16506. private _vertexBuffers;
  16507. /**
  16508. * Creates a new instance PostProcess
  16509. * @param scene The scene that the post process is associated with.
  16510. */
  16511. constructor(scene: Scene);
  16512. private _prepareBuffers;
  16513. private _buildIndexBuffer;
  16514. /**
  16515. * Rebuilds the vertex buffers of the manager.
  16516. * @hidden
  16517. */
  16518. _rebuild(): void;
  16519. /**
  16520. * Prepares a frame to be run through a post process.
  16521. * @param sourceTexture The input texture to the post procesess. (default: null)
  16522. * @param postProcesses An array of post processes to be run. (default: null)
  16523. * @returns True if the post processes were able to be run.
  16524. * @hidden
  16525. */
  16526. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16527. /**
  16528. * Manually render a set of post processes to a texture.
  16529. * @param postProcesses An array of post processes to be run.
  16530. * @param targetTexture The target texture to render to.
  16531. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16532. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16533. * @param lodLevel defines which lod of the texture to render to
  16534. */
  16535. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16536. /**
  16537. * Finalize the result of the output of the postprocesses.
  16538. * @param doNotPresent If true the result will not be displayed to the screen.
  16539. * @param targetTexture The target texture to render to.
  16540. * @param faceIndex The index of the face to bind the target texture to.
  16541. * @param postProcesses The array of post processes to render.
  16542. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16543. * @hidden
  16544. */
  16545. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16546. /**
  16547. * Disposes of the post process manager.
  16548. */
  16549. dispose(): void;
  16550. }
  16551. }
  16552. declare module "babylonjs/Misc/gradients" {
  16553. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16554. /** Interface used by value gradients (color, factor, ...) */
  16555. export interface IValueGradient {
  16556. /**
  16557. * Gets or sets the gradient value (between 0 and 1)
  16558. */
  16559. gradient: number;
  16560. }
  16561. /** Class used to store color4 gradient */
  16562. export class ColorGradient implements IValueGradient {
  16563. /**
  16564. * Gets or sets the gradient value (between 0 and 1)
  16565. */
  16566. gradient: number;
  16567. /**
  16568. * Gets or sets first associated color
  16569. */
  16570. color1: Color4;
  16571. /**
  16572. * Gets or sets second associated color
  16573. */
  16574. color2?: Color4;
  16575. /**
  16576. * Will get a color picked randomly between color1 and color2.
  16577. * If color2 is undefined then color1 will be used
  16578. * @param result defines the target Color4 to store the result in
  16579. */
  16580. getColorToRef(result: Color4): void;
  16581. }
  16582. /** Class used to store color 3 gradient */
  16583. export class Color3Gradient implements IValueGradient {
  16584. /**
  16585. * Gets or sets the gradient value (between 0 and 1)
  16586. */
  16587. gradient: number;
  16588. /**
  16589. * Gets or sets the associated color
  16590. */
  16591. color: Color3;
  16592. }
  16593. /** Class used to store factor gradient */
  16594. export class FactorGradient implements IValueGradient {
  16595. /**
  16596. * Gets or sets the gradient value (between 0 and 1)
  16597. */
  16598. gradient: number;
  16599. /**
  16600. * Gets or sets first associated factor
  16601. */
  16602. factor1: number;
  16603. /**
  16604. * Gets or sets second associated factor
  16605. */
  16606. factor2?: number;
  16607. /**
  16608. * Will get a number picked randomly between factor1 and factor2.
  16609. * If factor2 is undefined then factor1 will be used
  16610. * @returns the picked number
  16611. */
  16612. getFactor(): number;
  16613. }
  16614. /**
  16615. * Helper used to simplify some generic gradient tasks
  16616. */
  16617. export class GradientHelper {
  16618. /**
  16619. * Gets the current gradient from an array of IValueGradient
  16620. * @param ratio defines the current ratio to get
  16621. * @param gradients defines the array of IValueGradient
  16622. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16623. */
  16624. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16625. }
  16626. }
  16627. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  16628. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16629. import { Nullable } from "babylonjs/types";
  16630. module "babylonjs/Engines/thinEngine" {
  16631. interface ThinEngine {
  16632. /**
  16633. * Creates a dynamic texture
  16634. * @param width defines the width of the texture
  16635. * @param height defines the height of the texture
  16636. * @param generateMipMaps defines if the engine should generate the mip levels
  16637. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  16638. * @returns the dynamic texture inside an InternalTexture
  16639. */
  16640. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  16641. /**
  16642. * Update the content of a dynamic texture
  16643. * @param texture defines the texture to update
  16644. * @param canvas defines the canvas containing the source
  16645. * @param invertY defines if data must be stored with Y axis inverted
  16646. * @param premulAlpha defines if alpha is stored as premultiplied
  16647. * @param format defines the format of the data
  16648. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  16649. */
  16650. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  16651. }
  16652. }
  16653. }
  16654. declare module "babylonjs/Misc/canvasGenerator" {
  16655. /**
  16656. * Helper class used to generate a canvas to manipulate images
  16657. */
  16658. export class CanvasGenerator {
  16659. /**
  16660. * Create a new canvas (or offscreen canvas depending on the context)
  16661. * @param width defines the expected width
  16662. * @param height defines the expected height
  16663. * @return a new canvas or offscreen canvas
  16664. */
  16665. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  16666. }
  16667. }
  16668. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  16669. import { Scene } from "babylonjs/scene";
  16670. import { Texture } from "babylonjs/Materials/Textures/texture";
  16671. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  16672. /**
  16673. * A class extending Texture allowing drawing on a texture
  16674. * @see http://doc.babylonjs.com/how_to/dynamictexture
  16675. */
  16676. export class DynamicTexture extends Texture {
  16677. private _generateMipMaps;
  16678. private _canvas;
  16679. private _context;
  16680. private _engine;
  16681. /**
  16682. * Creates a DynamicTexture
  16683. * @param name defines the name of the texture
  16684. * @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
  16685. * @param scene defines the scene where you want the texture
  16686. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  16687. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  16688. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  16689. */
  16690. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  16691. /**
  16692. * Get the current class name of the texture useful for serialization or dynamic coding.
  16693. * @returns "DynamicTexture"
  16694. */
  16695. getClassName(): string;
  16696. /**
  16697. * Gets the current state of canRescale
  16698. */
  16699. readonly canRescale: boolean;
  16700. private _recreate;
  16701. /**
  16702. * Scales the texture
  16703. * @param ratio the scale factor to apply to both width and height
  16704. */
  16705. scale(ratio: number): void;
  16706. /**
  16707. * Resizes the texture
  16708. * @param width the new width
  16709. * @param height the new height
  16710. */
  16711. scaleTo(width: number, height: number): void;
  16712. /**
  16713. * Gets the context of the canvas used by the texture
  16714. * @returns the canvas context of the dynamic texture
  16715. */
  16716. getContext(): CanvasRenderingContext2D;
  16717. /**
  16718. * Clears the texture
  16719. */
  16720. clear(): void;
  16721. /**
  16722. * Updates the texture
  16723. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16724. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  16725. */
  16726. update(invertY?: boolean, premulAlpha?: boolean): void;
  16727. /**
  16728. * Draws text onto the texture
  16729. * @param text defines the text to be drawn
  16730. * @param x defines the placement of the text from the left
  16731. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  16732. * @param font defines the font to be used with font-style, font-size, font-name
  16733. * @param color defines the color used for the text
  16734. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  16735. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16736. * @param update defines whether texture is immediately update (default is true)
  16737. */
  16738. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  16739. /**
  16740. * Clones the texture
  16741. * @returns the clone of the texture.
  16742. */
  16743. clone(): DynamicTexture;
  16744. /**
  16745. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  16746. * @returns a serialized dynamic texture object
  16747. */
  16748. serialize(): any;
  16749. /** @hidden */
  16750. _rebuild(): void;
  16751. }
  16752. }
  16753. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16754. import { Scene } from "babylonjs/scene";
  16755. import { ISceneComponent } from "babylonjs/sceneComponent";
  16756. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16757. module "babylonjs/abstractScene" {
  16758. interface AbstractScene {
  16759. /**
  16760. * The list of procedural textures added to the scene
  16761. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16762. */
  16763. proceduralTextures: Array<ProceduralTexture>;
  16764. }
  16765. }
  16766. /**
  16767. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16768. * in a given scene.
  16769. */
  16770. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16771. /**
  16772. * The component name helpfull to identify the component in the list of scene components.
  16773. */
  16774. readonly name: string;
  16775. /**
  16776. * The scene the component belongs to.
  16777. */
  16778. scene: Scene;
  16779. /**
  16780. * Creates a new instance of the component for the given scene
  16781. * @param scene Defines the scene to register the component in
  16782. */
  16783. constructor(scene: Scene);
  16784. /**
  16785. * Registers the component in a given scene
  16786. */
  16787. register(): void;
  16788. /**
  16789. * Rebuilds the elements related to this component in case of
  16790. * context lost for instance.
  16791. */
  16792. rebuild(): void;
  16793. /**
  16794. * Disposes the component and the associated ressources.
  16795. */
  16796. dispose(): void;
  16797. private _beforeClear;
  16798. }
  16799. }
  16800. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  16801. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16802. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16803. module "babylonjs/Engines/thinEngine" {
  16804. interface ThinEngine {
  16805. /**
  16806. * Creates a new render target cube texture
  16807. * @param size defines the size of the texture
  16808. * @param options defines the options used to create the texture
  16809. * @returns a new render target cube texture stored in an InternalTexture
  16810. */
  16811. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16812. }
  16813. }
  16814. }
  16815. declare module "babylonjs/Shaders/procedural.vertex" {
  16816. /** @hidden */
  16817. export var proceduralVertexShader: {
  16818. name: string;
  16819. shader: string;
  16820. };
  16821. }
  16822. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16823. import { Observable } from "babylonjs/Misc/observable";
  16824. import { Nullable } from "babylonjs/types";
  16825. import { Scene } from "babylonjs/scene";
  16826. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16827. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16828. import { Effect } from "babylonjs/Materials/effect";
  16829. import { Texture } from "babylonjs/Materials/Textures/texture";
  16830. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16831. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  16832. import "babylonjs/Shaders/procedural.vertex";
  16833. /**
  16834. * 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.
  16835. * This is the base class of any Procedural texture and contains most of the shareable code.
  16836. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16837. */
  16838. export class ProceduralTexture extends Texture {
  16839. isCube: boolean;
  16840. /**
  16841. * Define if the texture is enabled or not (disabled texture will not render)
  16842. */
  16843. isEnabled: boolean;
  16844. /**
  16845. * Define if the texture must be cleared before rendering (default is true)
  16846. */
  16847. autoClear: boolean;
  16848. /**
  16849. * Callback called when the texture is generated
  16850. */
  16851. onGenerated: () => void;
  16852. /**
  16853. * Event raised when the texture is generated
  16854. */
  16855. onGeneratedObservable: Observable<ProceduralTexture>;
  16856. /** @hidden */
  16857. _generateMipMaps: boolean;
  16858. /** @hidden **/
  16859. _effect: Effect;
  16860. /** @hidden */
  16861. _textures: {
  16862. [key: string]: Texture;
  16863. };
  16864. private _size;
  16865. private _currentRefreshId;
  16866. private _refreshRate;
  16867. private _vertexBuffers;
  16868. private _indexBuffer;
  16869. private _uniforms;
  16870. private _samplers;
  16871. private _fragment;
  16872. private _floats;
  16873. private _ints;
  16874. private _floatsArrays;
  16875. private _colors3;
  16876. private _colors4;
  16877. private _vectors2;
  16878. private _vectors3;
  16879. private _matrices;
  16880. private _fallbackTexture;
  16881. private _fallbackTextureUsed;
  16882. private _engine;
  16883. private _cachedDefines;
  16884. private _contentUpdateId;
  16885. private _contentData;
  16886. /**
  16887. * Instantiates a new procedural texture.
  16888. * 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.
  16889. * This is the base class of any Procedural texture and contains most of the shareable code.
  16890. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16891. * @param name Define the name of the texture
  16892. * @param size Define the size of the texture to create
  16893. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16894. * @param scene Define the scene the texture belongs to
  16895. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16896. * @param generateMipMaps Define if the texture should creates mip maps or not
  16897. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16898. */
  16899. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16900. /**
  16901. * The effect that is created when initializing the post process.
  16902. * @returns The created effect corresponding the the postprocess.
  16903. */
  16904. getEffect(): Effect;
  16905. /**
  16906. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16907. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16908. */
  16909. getContent(): Nullable<ArrayBufferView>;
  16910. private _createIndexBuffer;
  16911. /** @hidden */
  16912. _rebuild(): void;
  16913. /**
  16914. * Resets the texture in order to recreate its associated resources.
  16915. * This can be called in case of context loss
  16916. */
  16917. reset(): void;
  16918. protected _getDefines(): string;
  16919. /**
  16920. * Is the texture ready to be used ? (rendered at least once)
  16921. * @returns true if ready, otherwise, false.
  16922. */
  16923. isReady(): boolean;
  16924. /**
  16925. * Resets the refresh counter of the texture and start bak from scratch.
  16926. * Could be useful to regenerate the texture if it is setup to render only once.
  16927. */
  16928. resetRefreshCounter(): void;
  16929. /**
  16930. * Set the fragment shader to use in order to render the texture.
  16931. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16932. */
  16933. setFragment(fragment: any): void;
  16934. /**
  16935. * Define the refresh rate of the texture or the rendering frequency.
  16936. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16937. */
  16938. refreshRate: number;
  16939. /** @hidden */
  16940. _shouldRender(): boolean;
  16941. /**
  16942. * Get the size the texture is rendering at.
  16943. * @returns the size (texture is always squared)
  16944. */
  16945. getRenderSize(): number;
  16946. /**
  16947. * Resize the texture to new value.
  16948. * @param size Define the new size the texture should have
  16949. * @param generateMipMaps Define whether the new texture should create mip maps
  16950. */
  16951. resize(size: number, generateMipMaps: boolean): void;
  16952. private _checkUniform;
  16953. /**
  16954. * Set a texture in the shader program used to render.
  16955. * @param name Define the name of the uniform samplers as defined in the shader
  16956. * @param texture Define the texture to bind to this sampler
  16957. * @return the texture itself allowing "fluent" like uniform updates
  16958. */
  16959. setTexture(name: string, texture: Texture): ProceduralTexture;
  16960. /**
  16961. * Set a float in the shader.
  16962. * @param name Define the name of the uniform as defined in the shader
  16963. * @param value Define the value to give to the uniform
  16964. * @return the texture itself allowing "fluent" like uniform updates
  16965. */
  16966. setFloat(name: string, value: number): ProceduralTexture;
  16967. /**
  16968. * Set a int in the shader.
  16969. * @param name Define the name of the uniform as defined in the shader
  16970. * @param value Define the value to give to the uniform
  16971. * @return the texture itself allowing "fluent" like uniform updates
  16972. */
  16973. setInt(name: string, value: number): ProceduralTexture;
  16974. /**
  16975. * Set an array of floats in the shader.
  16976. * @param name Define the name of the uniform as defined in the shader
  16977. * @param value Define the value to give to the uniform
  16978. * @return the texture itself allowing "fluent" like uniform updates
  16979. */
  16980. setFloats(name: string, value: number[]): ProceduralTexture;
  16981. /**
  16982. * Set a vec3 in the shader from a Color3.
  16983. * @param name Define the name of the uniform as defined in the shader
  16984. * @param value Define the value to give to the uniform
  16985. * @return the texture itself allowing "fluent" like uniform updates
  16986. */
  16987. setColor3(name: string, value: Color3): ProceduralTexture;
  16988. /**
  16989. * Set a vec4 in the shader from a Color4.
  16990. * @param name Define the name of the uniform as defined in the shader
  16991. * @param value Define the value to give to the uniform
  16992. * @return the texture itself allowing "fluent" like uniform updates
  16993. */
  16994. setColor4(name: string, value: Color4): ProceduralTexture;
  16995. /**
  16996. * Set a vec2 in the shader from a Vector2.
  16997. * @param name Define the name of the uniform as defined in the shader
  16998. * @param value Define the value to give to the uniform
  16999. * @return the texture itself allowing "fluent" like uniform updates
  17000. */
  17001. setVector2(name: string, value: Vector2): ProceduralTexture;
  17002. /**
  17003. * Set a vec3 in the shader from a Vector3.
  17004. * @param name Define the name of the uniform as defined in the shader
  17005. * @param value Define the value to give to the uniform
  17006. * @return the texture itself allowing "fluent" like uniform updates
  17007. */
  17008. setVector3(name: string, value: Vector3): ProceduralTexture;
  17009. /**
  17010. * Set a mat4 in the shader from a MAtrix.
  17011. * @param name Define the name of the uniform as defined in the shader
  17012. * @param value Define the value to give to the uniform
  17013. * @return the texture itself allowing "fluent" like uniform updates
  17014. */
  17015. setMatrix(name: string, value: Matrix): ProceduralTexture;
  17016. /**
  17017. * Render the texture to its associated render target.
  17018. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  17019. */
  17020. render(useCameraPostProcess?: boolean): void;
  17021. /**
  17022. * Clone the texture.
  17023. * @returns the cloned texture
  17024. */
  17025. clone(): ProceduralTexture;
  17026. /**
  17027. * Dispose the texture and release its asoociated resources.
  17028. */
  17029. dispose(): void;
  17030. }
  17031. }
  17032. declare module "babylonjs/Particles/baseParticleSystem" {
  17033. import { Nullable } from "babylonjs/types";
  17034. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  17035. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17036. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  17037. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  17038. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  17039. import { Scene } from "babylonjs/scene";
  17040. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  17041. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  17042. import { Texture } from "babylonjs/Materials/Textures/texture";
  17043. import { Color4 } from "babylonjs/Maths/math.color";
  17044. import { Animation } from "babylonjs/Animations/animation";
  17045. /**
  17046. * This represents the base class for particle system in Babylon.
  17047. * 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.
  17048. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17049. * @example https://doc.babylonjs.com/babylon101/particles
  17050. */
  17051. export class BaseParticleSystem {
  17052. /**
  17053. * Source color is added to the destination color without alpha affecting the result
  17054. */
  17055. static BLENDMODE_ONEONE: number;
  17056. /**
  17057. * Blend current color and particle color using particle’s alpha
  17058. */
  17059. static BLENDMODE_STANDARD: number;
  17060. /**
  17061. * Add current color and particle color multiplied by particle’s alpha
  17062. */
  17063. static BLENDMODE_ADD: number;
  17064. /**
  17065. * Multiply current color with particle color
  17066. */
  17067. static BLENDMODE_MULTIPLY: number;
  17068. /**
  17069. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  17070. */
  17071. static BLENDMODE_MULTIPLYADD: number;
  17072. /**
  17073. * List of animations used by the particle system.
  17074. */
  17075. animations: Animation[];
  17076. /**
  17077. * The id of the Particle system.
  17078. */
  17079. id: string;
  17080. /**
  17081. * The friendly name of the Particle system.
  17082. */
  17083. name: string;
  17084. /**
  17085. * The rendering group used by the Particle system to chose when to render.
  17086. */
  17087. renderingGroupId: number;
  17088. /**
  17089. * The emitter represents the Mesh or position we are attaching the particle system to.
  17090. */
  17091. emitter: Nullable<AbstractMesh | Vector3>;
  17092. /**
  17093. * The maximum number of particles to emit per frame
  17094. */
  17095. emitRate: number;
  17096. /**
  17097. * If you want to launch only a few particles at once, that can be done, as well.
  17098. */
  17099. manualEmitCount: number;
  17100. /**
  17101. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  17102. */
  17103. updateSpeed: number;
  17104. /**
  17105. * The amount of time the particle system is running (depends of the overall update speed).
  17106. */
  17107. targetStopDuration: number;
  17108. /**
  17109. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  17110. */
  17111. disposeOnStop: boolean;
  17112. /**
  17113. * Minimum power of emitting particles.
  17114. */
  17115. minEmitPower: number;
  17116. /**
  17117. * Maximum power of emitting particles.
  17118. */
  17119. maxEmitPower: number;
  17120. /**
  17121. * Minimum life time of emitting particles.
  17122. */
  17123. minLifeTime: number;
  17124. /**
  17125. * Maximum life time of emitting particles.
  17126. */
  17127. maxLifeTime: number;
  17128. /**
  17129. * Minimum Size of emitting particles.
  17130. */
  17131. minSize: number;
  17132. /**
  17133. * Maximum Size of emitting particles.
  17134. */
  17135. maxSize: number;
  17136. /**
  17137. * Minimum scale of emitting particles on X axis.
  17138. */
  17139. minScaleX: number;
  17140. /**
  17141. * Maximum scale of emitting particles on X axis.
  17142. */
  17143. maxScaleX: number;
  17144. /**
  17145. * Minimum scale of emitting particles on Y axis.
  17146. */
  17147. minScaleY: number;
  17148. /**
  17149. * Maximum scale of emitting particles on Y axis.
  17150. */
  17151. maxScaleY: number;
  17152. /**
  17153. * Gets or sets the minimal initial rotation in radians.
  17154. */
  17155. minInitialRotation: number;
  17156. /**
  17157. * Gets or sets the maximal initial rotation in radians.
  17158. */
  17159. maxInitialRotation: number;
  17160. /**
  17161. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  17162. */
  17163. minAngularSpeed: number;
  17164. /**
  17165. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  17166. */
  17167. maxAngularSpeed: number;
  17168. /**
  17169. * The texture used to render each particle. (this can be a spritesheet)
  17170. */
  17171. particleTexture: Nullable<Texture>;
  17172. /**
  17173. * The layer mask we are rendering the particles through.
  17174. */
  17175. layerMask: number;
  17176. /**
  17177. * This can help using your own shader to render the particle system.
  17178. * The according effect will be created
  17179. */
  17180. customShader: any;
  17181. /**
  17182. * By default particle system starts as soon as they are created. This prevents the
  17183. * automatic start to happen and let you decide when to start emitting particles.
  17184. */
  17185. preventAutoStart: boolean;
  17186. private _noiseTexture;
  17187. /**
  17188. * Gets or sets a texture used to add random noise to particle positions
  17189. */
  17190. noiseTexture: Nullable<ProceduralTexture>;
  17191. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  17192. noiseStrength: Vector3;
  17193. /**
  17194. * Callback triggered when the particle animation is ending.
  17195. */
  17196. onAnimationEnd: Nullable<() => void>;
  17197. /**
  17198. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  17199. */
  17200. blendMode: number;
  17201. /**
  17202. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  17203. * to override the particles.
  17204. */
  17205. forceDepthWrite: boolean;
  17206. /** 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 */
  17207. preWarmCycles: number;
  17208. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  17209. preWarmStepOffset: number;
  17210. /**
  17211. * 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)
  17212. */
  17213. spriteCellChangeSpeed: number;
  17214. /**
  17215. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  17216. */
  17217. startSpriteCellID: number;
  17218. /**
  17219. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  17220. */
  17221. endSpriteCellID: number;
  17222. /**
  17223. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  17224. */
  17225. spriteCellWidth: number;
  17226. /**
  17227. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  17228. */
  17229. spriteCellHeight: number;
  17230. /**
  17231. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  17232. */
  17233. spriteRandomStartCell: boolean;
  17234. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  17235. translationPivot: Vector2;
  17236. /** @hidden */
  17237. protected _isAnimationSheetEnabled: boolean;
  17238. /**
  17239. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  17240. */
  17241. beginAnimationOnStart: boolean;
  17242. /**
  17243. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  17244. */
  17245. beginAnimationFrom: number;
  17246. /**
  17247. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  17248. */
  17249. beginAnimationTo: number;
  17250. /**
  17251. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  17252. */
  17253. beginAnimationLoop: boolean;
  17254. /**
  17255. * Gets or sets a world offset applied to all particles
  17256. */
  17257. worldOffset: Vector3;
  17258. /**
  17259. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  17260. */
  17261. isAnimationSheetEnabled: boolean;
  17262. /**
  17263. * Get hosting scene
  17264. * @returns the scene
  17265. */
  17266. getScene(): Scene;
  17267. /**
  17268. * You can use gravity if you want to give an orientation to your particles.
  17269. */
  17270. gravity: Vector3;
  17271. protected _colorGradients: Nullable<Array<ColorGradient>>;
  17272. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  17273. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  17274. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  17275. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  17276. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  17277. protected _dragGradients: Nullable<Array<FactorGradient>>;
  17278. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  17279. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  17280. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  17281. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  17282. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  17283. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  17284. /**
  17285. * Defines the delay in milliseconds before starting the system (0 by default)
  17286. */
  17287. startDelay: number;
  17288. /**
  17289. * Gets the current list of drag gradients.
  17290. * You must use addDragGradient and removeDragGradient to udpate this list
  17291. * @returns the list of drag gradients
  17292. */
  17293. getDragGradients(): Nullable<Array<FactorGradient>>;
  17294. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  17295. limitVelocityDamping: number;
  17296. /**
  17297. * Gets the current list of limit velocity gradients.
  17298. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  17299. * @returns the list of limit velocity gradients
  17300. */
  17301. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  17302. /**
  17303. * Gets the current list of color gradients.
  17304. * You must use addColorGradient and removeColorGradient to udpate this list
  17305. * @returns the list of color gradients
  17306. */
  17307. getColorGradients(): Nullable<Array<ColorGradient>>;
  17308. /**
  17309. * Gets the current list of size gradients.
  17310. * You must use addSizeGradient and removeSizeGradient to udpate this list
  17311. * @returns the list of size gradients
  17312. */
  17313. getSizeGradients(): Nullable<Array<FactorGradient>>;
  17314. /**
  17315. * Gets the current list of color remap gradients.
  17316. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  17317. * @returns the list of color remap gradients
  17318. */
  17319. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  17320. /**
  17321. * Gets the current list of alpha remap gradients.
  17322. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  17323. * @returns the list of alpha remap gradients
  17324. */
  17325. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  17326. /**
  17327. * Gets the current list of life time gradients.
  17328. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  17329. * @returns the list of life time gradients
  17330. */
  17331. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  17332. /**
  17333. * Gets the current list of angular speed gradients.
  17334. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  17335. * @returns the list of angular speed gradients
  17336. */
  17337. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  17338. /**
  17339. * Gets the current list of velocity gradients.
  17340. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  17341. * @returns the list of velocity gradients
  17342. */
  17343. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  17344. /**
  17345. * Gets the current list of start size gradients.
  17346. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  17347. * @returns the list of start size gradients
  17348. */
  17349. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  17350. /**
  17351. * Gets the current list of emit rate gradients.
  17352. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  17353. * @returns the list of emit rate gradients
  17354. */
  17355. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  17356. /**
  17357. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17358. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17359. */
  17360. direction1: Vector3;
  17361. /**
  17362. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17363. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17364. */
  17365. direction2: Vector3;
  17366. /**
  17367. * 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.
  17368. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17369. */
  17370. minEmitBox: Vector3;
  17371. /**
  17372. * 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.
  17373. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17374. */
  17375. maxEmitBox: Vector3;
  17376. /**
  17377. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17378. */
  17379. color1: Color4;
  17380. /**
  17381. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17382. */
  17383. color2: Color4;
  17384. /**
  17385. * Color the particle will have at the end of its lifetime
  17386. */
  17387. colorDead: Color4;
  17388. /**
  17389. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  17390. */
  17391. textureMask: Color4;
  17392. /**
  17393. * The particle emitter type defines the emitter used by the particle system.
  17394. * It can be for example box, sphere, or cone...
  17395. */
  17396. particleEmitterType: IParticleEmitterType;
  17397. /** @hidden */
  17398. _isSubEmitter: boolean;
  17399. /**
  17400. * Gets or sets the billboard mode to use when isBillboardBased = true.
  17401. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  17402. */
  17403. billboardMode: number;
  17404. protected _isBillboardBased: boolean;
  17405. /**
  17406. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  17407. */
  17408. isBillboardBased: boolean;
  17409. /**
  17410. * The scene the particle system belongs to.
  17411. */
  17412. protected _scene: Scene;
  17413. /**
  17414. * Local cache of defines for image processing.
  17415. */
  17416. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  17417. /**
  17418. * Default configuration related to image processing available in the standard Material.
  17419. */
  17420. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17421. /**
  17422. * Gets the image processing configuration used either in this material.
  17423. */
  17424. /**
  17425. * Sets the Default image processing configuration used either in the this material.
  17426. *
  17427. * If sets to null, the scene one is in use.
  17428. */
  17429. imageProcessingConfiguration: ImageProcessingConfiguration;
  17430. /**
  17431. * Attaches a new image processing configuration to the Standard Material.
  17432. * @param configuration
  17433. */
  17434. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17435. /** @hidden */
  17436. protected _reset(): void;
  17437. /** @hidden */
  17438. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  17439. /**
  17440. * Instantiates a particle system.
  17441. * 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.
  17442. * @param name The name of the particle system
  17443. */
  17444. constructor(name: string);
  17445. /**
  17446. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  17447. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17448. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17449. * @returns the emitter
  17450. */
  17451. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  17452. /**
  17453. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  17454. * @param radius The radius of the hemisphere to emit from
  17455. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17456. * @returns the emitter
  17457. */
  17458. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  17459. /**
  17460. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  17461. * @param radius The radius of the sphere to emit from
  17462. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17463. * @returns the emitter
  17464. */
  17465. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  17466. /**
  17467. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17468. * @param radius The radius of the sphere to emit from
  17469. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17470. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17471. * @returns the emitter
  17472. */
  17473. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  17474. /**
  17475. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17476. * @param radius The radius of the emission cylinder
  17477. * @param height The height of the emission cylinder
  17478. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17479. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17480. * @returns the emitter
  17481. */
  17482. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  17483. /**
  17484. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17485. * @param radius The radius of the cylinder to emit from
  17486. * @param height The height of the emission cylinder
  17487. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17488. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17489. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17490. * @returns the emitter
  17491. */
  17492. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17493. /**
  17494. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17495. * @param radius The radius of the cone to emit from
  17496. * @param angle The base angle of the cone
  17497. * @returns the emitter
  17498. */
  17499. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17500. /**
  17501. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17502. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17503. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17504. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17505. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17506. * @returns the emitter
  17507. */
  17508. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17509. }
  17510. }
  17511. declare module "babylonjs/Particles/subEmitter" {
  17512. import { Scene } from "babylonjs/scene";
  17513. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17514. /**
  17515. * Type of sub emitter
  17516. */
  17517. export enum SubEmitterType {
  17518. /**
  17519. * Attached to the particle over it's lifetime
  17520. */
  17521. ATTACHED = 0,
  17522. /**
  17523. * Created when the particle dies
  17524. */
  17525. END = 1
  17526. }
  17527. /**
  17528. * Sub emitter class used to emit particles from an existing particle
  17529. */
  17530. export class SubEmitter {
  17531. /**
  17532. * the particle system to be used by the sub emitter
  17533. */
  17534. particleSystem: ParticleSystem;
  17535. /**
  17536. * Type of the submitter (Default: END)
  17537. */
  17538. type: SubEmitterType;
  17539. /**
  17540. * 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)
  17541. * Note: This only is supported when using an emitter of type Mesh
  17542. */
  17543. inheritDirection: boolean;
  17544. /**
  17545. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17546. */
  17547. inheritedVelocityAmount: number;
  17548. /**
  17549. * Creates a sub emitter
  17550. * @param particleSystem the particle system to be used by the sub emitter
  17551. */
  17552. constructor(
  17553. /**
  17554. * the particle system to be used by the sub emitter
  17555. */
  17556. particleSystem: ParticleSystem);
  17557. /**
  17558. * Clones the sub emitter
  17559. * @returns the cloned sub emitter
  17560. */
  17561. clone(): SubEmitter;
  17562. /**
  17563. * Serialize current object to a JSON object
  17564. * @returns the serialized object
  17565. */
  17566. serialize(): any;
  17567. /** @hidden */
  17568. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17569. /**
  17570. * Creates a new SubEmitter from a serialized JSON version
  17571. * @param serializationObject defines the JSON object to read from
  17572. * @param scene defines the hosting scene
  17573. * @param rootUrl defines the rootUrl for data loading
  17574. * @returns a new SubEmitter
  17575. */
  17576. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17577. /** Release associated resources */
  17578. dispose(): void;
  17579. }
  17580. }
  17581. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17582. /** @hidden */
  17583. export var clipPlaneFragmentDeclaration: {
  17584. name: string;
  17585. shader: string;
  17586. };
  17587. }
  17588. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17589. /** @hidden */
  17590. export var imageProcessingDeclaration: {
  17591. name: string;
  17592. shader: string;
  17593. };
  17594. }
  17595. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17596. /** @hidden */
  17597. export var imageProcessingFunctions: {
  17598. name: string;
  17599. shader: string;
  17600. };
  17601. }
  17602. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17603. /** @hidden */
  17604. export var clipPlaneFragment: {
  17605. name: string;
  17606. shader: string;
  17607. };
  17608. }
  17609. declare module "babylonjs/Shaders/particles.fragment" {
  17610. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17611. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17612. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17613. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17614. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17615. /** @hidden */
  17616. export var particlesPixelShader: {
  17617. name: string;
  17618. shader: string;
  17619. };
  17620. }
  17621. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17622. /** @hidden */
  17623. export var clipPlaneVertexDeclaration: {
  17624. name: string;
  17625. shader: string;
  17626. };
  17627. }
  17628. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17629. /** @hidden */
  17630. export var clipPlaneVertex: {
  17631. name: string;
  17632. shader: string;
  17633. };
  17634. }
  17635. declare module "babylonjs/Shaders/particles.vertex" {
  17636. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17637. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17638. /** @hidden */
  17639. export var particlesVertexShader: {
  17640. name: string;
  17641. shader: string;
  17642. };
  17643. }
  17644. declare module "babylonjs/Particles/particleSystem" {
  17645. import { Nullable } from "babylonjs/types";
  17646. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17647. import { Observable } from "babylonjs/Misc/observable";
  17648. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17649. import { Effect } from "babylonjs/Materials/effect";
  17650. import { Scene, IDisposable } from "babylonjs/scene";
  17651. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17652. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17653. import { Particle } from "babylonjs/Particles/particle";
  17654. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17655. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17656. import "babylonjs/Shaders/particles.fragment";
  17657. import "babylonjs/Shaders/particles.vertex";
  17658. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17659. /**
  17660. * This represents a particle system in Babylon.
  17661. * 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.
  17662. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17663. * @example https://doc.babylonjs.com/babylon101/particles
  17664. */
  17665. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17666. /**
  17667. * Billboard mode will only apply to Y axis
  17668. */
  17669. static readonly BILLBOARDMODE_Y: number;
  17670. /**
  17671. * Billboard mode will apply to all axes
  17672. */
  17673. static readonly BILLBOARDMODE_ALL: number;
  17674. /**
  17675. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17676. */
  17677. static readonly BILLBOARDMODE_STRETCHED: number;
  17678. /**
  17679. * This function can be defined to provide custom update for active particles.
  17680. * This function will be called instead of regular update (age, position, color, etc.).
  17681. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17682. */
  17683. updateFunction: (particles: Particle[]) => void;
  17684. private _emitterWorldMatrix;
  17685. /**
  17686. * This function can be defined to specify initial direction for every new particle.
  17687. * It by default use the emitterType defined function
  17688. */
  17689. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17690. /**
  17691. * This function can be defined to specify initial position for every new particle.
  17692. * It by default use the emitterType defined function
  17693. */
  17694. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17695. /**
  17696. * @hidden
  17697. */
  17698. _inheritedVelocityOffset: Vector3;
  17699. /**
  17700. * An event triggered when the system is disposed
  17701. */
  17702. onDisposeObservable: Observable<ParticleSystem>;
  17703. private _onDisposeObserver;
  17704. /**
  17705. * Sets a callback that will be triggered when the system is disposed
  17706. */
  17707. onDispose: () => void;
  17708. private _particles;
  17709. private _epsilon;
  17710. private _capacity;
  17711. private _stockParticles;
  17712. private _newPartsExcess;
  17713. private _vertexData;
  17714. private _vertexBuffer;
  17715. private _vertexBuffers;
  17716. private _spriteBuffer;
  17717. private _indexBuffer;
  17718. private _effect;
  17719. private _customEffect;
  17720. private _cachedDefines;
  17721. private _scaledColorStep;
  17722. private _colorDiff;
  17723. private _scaledDirection;
  17724. private _scaledGravity;
  17725. private _currentRenderId;
  17726. private _alive;
  17727. private _useInstancing;
  17728. private _started;
  17729. private _stopped;
  17730. private _actualFrame;
  17731. private _scaledUpdateSpeed;
  17732. private _vertexBufferSize;
  17733. /** @hidden */
  17734. _currentEmitRateGradient: Nullable<FactorGradient>;
  17735. /** @hidden */
  17736. _currentEmitRate1: number;
  17737. /** @hidden */
  17738. _currentEmitRate2: number;
  17739. /** @hidden */
  17740. _currentStartSizeGradient: Nullable<FactorGradient>;
  17741. /** @hidden */
  17742. _currentStartSize1: number;
  17743. /** @hidden */
  17744. _currentStartSize2: number;
  17745. private readonly _rawTextureWidth;
  17746. private _rampGradientsTexture;
  17747. private _useRampGradients;
  17748. /** Gets or sets a boolean indicating that ramp gradients must be used
  17749. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17750. */
  17751. useRampGradients: boolean;
  17752. /**
  17753. * 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.
  17754. * 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: [])
  17755. */
  17756. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17757. private _subEmitters;
  17758. /**
  17759. * @hidden
  17760. * If the particle systems emitter should be disposed when the particle system is disposed
  17761. */
  17762. _disposeEmitterOnDispose: boolean;
  17763. /**
  17764. * The current active Sub-systems, this property is used by the root particle system only.
  17765. */
  17766. activeSubSystems: Array<ParticleSystem>;
  17767. private _rootParticleSystem;
  17768. /**
  17769. * Gets the current list of active particles
  17770. */
  17771. readonly particles: Particle[];
  17772. /**
  17773. * Returns the string "ParticleSystem"
  17774. * @returns a string containing the class name
  17775. */
  17776. getClassName(): string;
  17777. /**
  17778. * Instantiates a particle system.
  17779. * 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.
  17780. * @param name The name of the particle system
  17781. * @param capacity The max number of particles alive at the same time
  17782. * @param scene The scene the particle system belongs to
  17783. * @param customEffect a custom effect used to change the way particles are rendered by default
  17784. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17785. * @param epsilon Offset used to render the particles
  17786. */
  17787. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17788. private _addFactorGradient;
  17789. private _removeFactorGradient;
  17790. /**
  17791. * Adds a new life time gradient
  17792. * @param gradient defines the gradient to use (between 0 and 1)
  17793. * @param factor defines the life time factor to affect to the specified gradient
  17794. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17795. * @returns the current particle system
  17796. */
  17797. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17798. /**
  17799. * Remove a specific life time gradient
  17800. * @param gradient defines the gradient to remove
  17801. * @returns the current particle system
  17802. */
  17803. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17804. /**
  17805. * Adds a new size gradient
  17806. * @param gradient defines the gradient to use (between 0 and 1)
  17807. * @param factor defines the size factor to affect to the specified gradient
  17808. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17809. * @returns the current particle system
  17810. */
  17811. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17812. /**
  17813. * Remove a specific size gradient
  17814. * @param gradient defines the gradient to remove
  17815. * @returns the current particle system
  17816. */
  17817. removeSizeGradient(gradient: number): IParticleSystem;
  17818. /**
  17819. * Adds a new color remap gradient
  17820. * @param gradient defines the gradient to use (between 0 and 1)
  17821. * @param min defines the color remap minimal range
  17822. * @param max defines the color remap maximal range
  17823. * @returns the current particle system
  17824. */
  17825. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17826. /**
  17827. * Remove a specific color remap gradient
  17828. * @param gradient defines the gradient to remove
  17829. * @returns the current particle system
  17830. */
  17831. removeColorRemapGradient(gradient: number): IParticleSystem;
  17832. /**
  17833. * Adds a new alpha remap gradient
  17834. * @param gradient defines the gradient to use (between 0 and 1)
  17835. * @param min defines the alpha remap minimal range
  17836. * @param max defines the alpha remap maximal range
  17837. * @returns the current particle system
  17838. */
  17839. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17840. /**
  17841. * Remove a specific alpha remap gradient
  17842. * @param gradient defines the gradient to remove
  17843. * @returns the current particle system
  17844. */
  17845. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17846. /**
  17847. * Adds a new angular speed gradient
  17848. * @param gradient defines the gradient to use (between 0 and 1)
  17849. * @param factor defines the angular speed to affect to the specified gradient
  17850. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17851. * @returns the current particle system
  17852. */
  17853. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17854. /**
  17855. * Remove a specific angular speed gradient
  17856. * @param gradient defines the gradient to remove
  17857. * @returns the current particle system
  17858. */
  17859. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17860. /**
  17861. * Adds a new velocity gradient
  17862. * @param gradient defines the gradient to use (between 0 and 1)
  17863. * @param factor defines the velocity to affect to the specified gradient
  17864. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17865. * @returns the current particle system
  17866. */
  17867. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17868. /**
  17869. * Remove a specific velocity gradient
  17870. * @param gradient defines the gradient to remove
  17871. * @returns the current particle system
  17872. */
  17873. removeVelocityGradient(gradient: number): IParticleSystem;
  17874. /**
  17875. * Adds a new limit velocity gradient
  17876. * @param gradient defines the gradient to use (between 0 and 1)
  17877. * @param factor defines the limit velocity value to affect to the specified gradient
  17878. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17879. * @returns the current particle system
  17880. */
  17881. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17882. /**
  17883. * Remove a specific limit velocity gradient
  17884. * @param gradient defines the gradient to remove
  17885. * @returns the current particle system
  17886. */
  17887. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17888. /**
  17889. * Adds a new drag gradient
  17890. * @param gradient defines the gradient to use (between 0 and 1)
  17891. * @param factor defines the drag value to affect to the specified gradient
  17892. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17893. * @returns the current particle system
  17894. */
  17895. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17896. /**
  17897. * Remove a specific drag gradient
  17898. * @param gradient defines the gradient to remove
  17899. * @returns the current particle system
  17900. */
  17901. removeDragGradient(gradient: number): IParticleSystem;
  17902. /**
  17903. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17904. * @param gradient defines the gradient to use (between 0 and 1)
  17905. * @param factor defines the emit rate value to affect to the specified gradient
  17906. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17907. * @returns the current particle system
  17908. */
  17909. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17910. /**
  17911. * Remove a specific emit rate gradient
  17912. * @param gradient defines the gradient to remove
  17913. * @returns the current particle system
  17914. */
  17915. removeEmitRateGradient(gradient: number): IParticleSystem;
  17916. /**
  17917. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17918. * @param gradient defines the gradient to use (between 0 and 1)
  17919. * @param factor defines the start size value to affect to the specified gradient
  17920. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17921. * @returns the current particle system
  17922. */
  17923. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17924. /**
  17925. * Remove a specific start size gradient
  17926. * @param gradient defines the gradient to remove
  17927. * @returns the current particle system
  17928. */
  17929. removeStartSizeGradient(gradient: number): IParticleSystem;
  17930. private _createRampGradientTexture;
  17931. /**
  17932. * Gets the current list of ramp gradients.
  17933. * You must use addRampGradient and removeRampGradient to udpate this list
  17934. * @returns the list of ramp gradients
  17935. */
  17936. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17937. /**
  17938. * Adds a new ramp gradient used to remap particle colors
  17939. * @param gradient defines the gradient to use (between 0 and 1)
  17940. * @param color defines the color to affect to the specified gradient
  17941. * @returns the current particle system
  17942. */
  17943. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17944. /**
  17945. * Remove a specific ramp gradient
  17946. * @param gradient defines the gradient to remove
  17947. * @returns the current particle system
  17948. */
  17949. removeRampGradient(gradient: number): ParticleSystem;
  17950. /**
  17951. * Adds a new color gradient
  17952. * @param gradient defines the gradient to use (between 0 and 1)
  17953. * @param color1 defines the color to affect to the specified gradient
  17954. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17955. * @returns this particle system
  17956. */
  17957. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17958. /**
  17959. * Remove a specific color gradient
  17960. * @param gradient defines the gradient to remove
  17961. * @returns this particle system
  17962. */
  17963. removeColorGradient(gradient: number): IParticleSystem;
  17964. private _fetchR;
  17965. protected _reset(): void;
  17966. private _resetEffect;
  17967. private _createVertexBuffers;
  17968. private _createIndexBuffer;
  17969. /**
  17970. * Gets the maximum number of particles active at the same time.
  17971. * @returns The max number of active particles.
  17972. */
  17973. getCapacity(): number;
  17974. /**
  17975. * Gets whether there are still active particles in the system.
  17976. * @returns True if it is alive, otherwise false.
  17977. */
  17978. isAlive(): boolean;
  17979. /**
  17980. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17981. * @returns True if it has been started, otherwise false.
  17982. */
  17983. isStarted(): boolean;
  17984. private _prepareSubEmitterInternalArray;
  17985. /**
  17986. * Starts the particle system and begins to emit
  17987. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17988. */
  17989. start(delay?: number): void;
  17990. /**
  17991. * Stops the particle system.
  17992. * @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.
  17993. */
  17994. stop(stopSubEmitters?: boolean): void;
  17995. /**
  17996. * Remove all active particles
  17997. */
  17998. reset(): void;
  17999. /**
  18000. * @hidden (for internal use only)
  18001. */
  18002. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  18003. /**
  18004. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  18005. * Its lifetime will start back at 0.
  18006. */
  18007. recycleParticle: (particle: Particle) => void;
  18008. private _stopSubEmitters;
  18009. private _createParticle;
  18010. private _removeFromRoot;
  18011. private _emitFromParticle;
  18012. private _update;
  18013. /** @hidden */
  18014. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  18015. /** @hidden */
  18016. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  18017. /** @hidden */
  18018. private _getEffect;
  18019. /**
  18020. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  18021. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  18022. */
  18023. animate(preWarmOnly?: boolean): void;
  18024. private _appendParticleVertices;
  18025. /**
  18026. * Rebuilds the particle system.
  18027. */
  18028. rebuild(): void;
  18029. /**
  18030. * Is this system ready to be used/rendered
  18031. * @return true if the system is ready
  18032. */
  18033. isReady(): boolean;
  18034. private _render;
  18035. /**
  18036. * Renders the particle system in its current state.
  18037. * @returns the current number of particles
  18038. */
  18039. render(): number;
  18040. /**
  18041. * Disposes the particle system and free the associated resources
  18042. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  18043. */
  18044. dispose(disposeTexture?: boolean): void;
  18045. /**
  18046. * Clones the particle system.
  18047. * @param name The name of the cloned object
  18048. * @param newEmitter The new emitter to use
  18049. * @returns the cloned particle system
  18050. */
  18051. clone(name: string, newEmitter: any): ParticleSystem;
  18052. /**
  18053. * Serializes the particle system to a JSON object.
  18054. * @returns the JSON object
  18055. */
  18056. serialize(): any;
  18057. /** @hidden */
  18058. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  18059. /** @hidden */
  18060. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  18061. /**
  18062. * Parses a JSON object to create a particle system.
  18063. * @param parsedParticleSystem The JSON object to parse
  18064. * @param scene The scene to create the particle system in
  18065. * @param rootUrl The root url to use to load external dependencies like texture
  18066. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  18067. * @returns the Parsed particle system
  18068. */
  18069. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  18070. }
  18071. }
  18072. declare module "babylonjs/Particles/particle" {
  18073. import { Nullable } from "babylonjs/types";
  18074. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  18075. import { Color4 } from "babylonjs/Maths/math.color";
  18076. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  18077. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  18078. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  18079. /**
  18080. * A particle represents one of the element emitted by a particle system.
  18081. * This is mainly define by its coordinates, direction, velocity and age.
  18082. */
  18083. export class Particle {
  18084. /**
  18085. * The particle system the particle belongs to.
  18086. */
  18087. particleSystem: ParticleSystem;
  18088. private static _Count;
  18089. /**
  18090. * Unique ID of the particle
  18091. */
  18092. id: number;
  18093. /**
  18094. * The world position of the particle in the scene.
  18095. */
  18096. position: Vector3;
  18097. /**
  18098. * The world direction of the particle in the scene.
  18099. */
  18100. direction: Vector3;
  18101. /**
  18102. * The color of the particle.
  18103. */
  18104. color: Color4;
  18105. /**
  18106. * The color change of the particle per step.
  18107. */
  18108. colorStep: Color4;
  18109. /**
  18110. * Defines how long will the life of the particle be.
  18111. */
  18112. lifeTime: number;
  18113. /**
  18114. * The current age of the particle.
  18115. */
  18116. age: number;
  18117. /**
  18118. * The current size of the particle.
  18119. */
  18120. size: number;
  18121. /**
  18122. * The current scale of the particle.
  18123. */
  18124. scale: Vector2;
  18125. /**
  18126. * The current angle of the particle.
  18127. */
  18128. angle: number;
  18129. /**
  18130. * Defines how fast is the angle changing.
  18131. */
  18132. angularSpeed: number;
  18133. /**
  18134. * Defines the cell index used by the particle to be rendered from a sprite.
  18135. */
  18136. cellIndex: number;
  18137. /**
  18138. * The information required to support color remapping
  18139. */
  18140. remapData: Vector4;
  18141. /** @hidden */
  18142. _randomCellOffset?: number;
  18143. /** @hidden */
  18144. _initialDirection: Nullable<Vector3>;
  18145. /** @hidden */
  18146. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  18147. /** @hidden */
  18148. _initialStartSpriteCellID: number;
  18149. /** @hidden */
  18150. _initialEndSpriteCellID: number;
  18151. /** @hidden */
  18152. _currentColorGradient: Nullable<ColorGradient>;
  18153. /** @hidden */
  18154. _currentColor1: Color4;
  18155. /** @hidden */
  18156. _currentColor2: Color4;
  18157. /** @hidden */
  18158. _currentSizeGradient: Nullable<FactorGradient>;
  18159. /** @hidden */
  18160. _currentSize1: number;
  18161. /** @hidden */
  18162. _currentSize2: number;
  18163. /** @hidden */
  18164. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  18165. /** @hidden */
  18166. _currentAngularSpeed1: number;
  18167. /** @hidden */
  18168. _currentAngularSpeed2: number;
  18169. /** @hidden */
  18170. _currentVelocityGradient: Nullable<FactorGradient>;
  18171. /** @hidden */
  18172. _currentVelocity1: number;
  18173. /** @hidden */
  18174. _currentVelocity2: number;
  18175. /** @hidden */
  18176. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  18177. /** @hidden */
  18178. _currentLimitVelocity1: number;
  18179. /** @hidden */
  18180. _currentLimitVelocity2: number;
  18181. /** @hidden */
  18182. _currentDragGradient: Nullable<FactorGradient>;
  18183. /** @hidden */
  18184. _currentDrag1: number;
  18185. /** @hidden */
  18186. _currentDrag2: number;
  18187. /** @hidden */
  18188. _randomNoiseCoordinates1: Vector3;
  18189. /** @hidden */
  18190. _randomNoiseCoordinates2: Vector3;
  18191. /**
  18192. * Creates a new instance Particle
  18193. * @param particleSystem the particle system the particle belongs to
  18194. */
  18195. constructor(
  18196. /**
  18197. * The particle system the particle belongs to.
  18198. */
  18199. particleSystem: ParticleSystem);
  18200. private updateCellInfoFromSystem;
  18201. /**
  18202. * Defines how the sprite cell index is updated for the particle
  18203. */
  18204. updateCellIndex(): void;
  18205. /** @hidden */
  18206. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  18207. /** @hidden */
  18208. _inheritParticleInfoToSubEmitters(): void;
  18209. /** @hidden */
  18210. _reset(): void;
  18211. /**
  18212. * Copy the properties of particle to another one.
  18213. * @param other the particle to copy the information to.
  18214. */
  18215. copyTo(other: Particle): void;
  18216. }
  18217. }
  18218. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  18219. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18220. import { Effect } from "babylonjs/Materials/effect";
  18221. import { Particle } from "babylonjs/Particles/particle";
  18222. /**
  18223. * Particle emitter represents a volume emitting particles.
  18224. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  18225. */
  18226. export interface IParticleEmitterType {
  18227. /**
  18228. * Called by the particle System when the direction is computed for the created particle.
  18229. * @param worldMatrix is the world matrix of the particle system
  18230. * @param directionToUpdate is the direction vector to update with the result
  18231. * @param particle is the particle we are computed the direction for
  18232. */
  18233. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18234. /**
  18235. * Called by the particle System when the position is computed for the created particle.
  18236. * @param worldMatrix is the world matrix of the particle system
  18237. * @param positionToUpdate is the position vector to update with the result
  18238. * @param particle is the particle we are computed the position for
  18239. */
  18240. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18241. /**
  18242. * Clones the current emitter and returns a copy of it
  18243. * @returns the new emitter
  18244. */
  18245. clone(): IParticleEmitterType;
  18246. /**
  18247. * Called by the GPUParticleSystem to setup the update shader
  18248. * @param effect defines the update shader
  18249. */
  18250. applyToShader(effect: Effect): void;
  18251. /**
  18252. * Returns a string to use to update the GPU particles update shader
  18253. * @returns the effect defines string
  18254. */
  18255. getEffectDefines(): string;
  18256. /**
  18257. * Returns a string representing the class name
  18258. * @returns a string containing the class name
  18259. */
  18260. getClassName(): string;
  18261. /**
  18262. * Serializes the particle system to a JSON object.
  18263. * @returns the JSON object
  18264. */
  18265. serialize(): any;
  18266. /**
  18267. * Parse properties from a JSON object
  18268. * @param serializationObject defines the JSON object
  18269. */
  18270. parse(serializationObject: any): void;
  18271. }
  18272. }
  18273. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  18274. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18275. import { Effect } from "babylonjs/Materials/effect";
  18276. import { Particle } from "babylonjs/Particles/particle";
  18277. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18278. /**
  18279. * Particle emitter emitting particles from the inside of a box.
  18280. * It emits the particles randomly between 2 given directions.
  18281. */
  18282. export class BoxParticleEmitter implements IParticleEmitterType {
  18283. /**
  18284. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18285. */
  18286. direction1: Vector3;
  18287. /**
  18288. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18289. */
  18290. direction2: Vector3;
  18291. /**
  18292. * 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.
  18293. */
  18294. minEmitBox: Vector3;
  18295. /**
  18296. * 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.
  18297. */
  18298. maxEmitBox: Vector3;
  18299. /**
  18300. * Creates a new instance BoxParticleEmitter
  18301. */
  18302. constructor();
  18303. /**
  18304. * Called by the particle System when the direction is computed for the created particle.
  18305. * @param worldMatrix is the world matrix of the particle system
  18306. * @param directionToUpdate is the direction vector to update with the result
  18307. * @param particle is the particle we are computed the direction for
  18308. */
  18309. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18310. /**
  18311. * Called by the particle System when the position is computed for the created particle.
  18312. * @param worldMatrix is the world matrix of the particle system
  18313. * @param positionToUpdate is the position vector to update with the result
  18314. * @param particle is the particle we are computed the position for
  18315. */
  18316. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18317. /**
  18318. * Clones the current emitter and returns a copy of it
  18319. * @returns the new emitter
  18320. */
  18321. clone(): BoxParticleEmitter;
  18322. /**
  18323. * Called by the GPUParticleSystem to setup the update shader
  18324. * @param effect defines the update shader
  18325. */
  18326. applyToShader(effect: Effect): void;
  18327. /**
  18328. * Returns a string to use to update the GPU particles update shader
  18329. * @returns a string containng the defines string
  18330. */
  18331. getEffectDefines(): string;
  18332. /**
  18333. * Returns the string "BoxParticleEmitter"
  18334. * @returns a string containing the class name
  18335. */
  18336. getClassName(): string;
  18337. /**
  18338. * Serializes the particle system to a JSON object.
  18339. * @returns the JSON object
  18340. */
  18341. serialize(): any;
  18342. /**
  18343. * Parse properties from a JSON object
  18344. * @param serializationObject defines the JSON object
  18345. */
  18346. parse(serializationObject: any): void;
  18347. }
  18348. }
  18349. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  18350. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18351. import { Effect } from "babylonjs/Materials/effect";
  18352. import { Particle } from "babylonjs/Particles/particle";
  18353. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18354. /**
  18355. * Particle emitter emitting particles from the inside of a cone.
  18356. * It emits the particles alongside the cone volume from the base to the particle.
  18357. * The emission direction might be randomized.
  18358. */
  18359. export class ConeParticleEmitter implements IParticleEmitterType {
  18360. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18361. directionRandomizer: number;
  18362. private _radius;
  18363. private _angle;
  18364. private _height;
  18365. /**
  18366. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  18367. */
  18368. radiusRange: number;
  18369. /**
  18370. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  18371. */
  18372. heightRange: number;
  18373. /**
  18374. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  18375. */
  18376. emitFromSpawnPointOnly: boolean;
  18377. /**
  18378. * Gets or sets the radius of the emission cone
  18379. */
  18380. radius: number;
  18381. /**
  18382. * Gets or sets the angle of the emission cone
  18383. */
  18384. angle: number;
  18385. private _buildHeight;
  18386. /**
  18387. * Creates a new instance ConeParticleEmitter
  18388. * @param radius the radius of the emission cone (1 by default)
  18389. * @param angle the cone base angle (PI by default)
  18390. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  18391. */
  18392. constructor(radius?: number, angle?: number,
  18393. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18394. directionRandomizer?: number);
  18395. /**
  18396. * Called by the particle System when the direction is computed for the created particle.
  18397. * @param worldMatrix is the world matrix of the particle system
  18398. * @param directionToUpdate is the direction vector to update with the result
  18399. * @param particle is the particle we are computed the direction for
  18400. */
  18401. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18402. /**
  18403. * Called by the particle System when the position is computed for the created particle.
  18404. * @param worldMatrix is the world matrix of the particle system
  18405. * @param positionToUpdate is the position vector to update with the result
  18406. * @param particle is the particle we are computed the position for
  18407. */
  18408. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18409. /**
  18410. * Clones the current emitter and returns a copy of it
  18411. * @returns the new emitter
  18412. */
  18413. clone(): ConeParticleEmitter;
  18414. /**
  18415. * Called by the GPUParticleSystem to setup the update shader
  18416. * @param effect defines the update shader
  18417. */
  18418. applyToShader(effect: Effect): void;
  18419. /**
  18420. * Returns a string to use to update the GPU particles update shader
  18421. * @returns a string containng the defines string
  18422. */
  18423. getEffectDefines(): string;
  18424. /**
  18425. * Returns the string "ConeParticleEmitter"
  18426. * @returns a string containing the class name
  18427. */
  18428. getClassName(): string;
  18429. /**
  18430. * Serializes the particle system to a JSON object.
  18431. * @returns the JSON object
  18432. */
  18433. serialize(): any;
  18434. /**
  18435. * Parse properties from a JSON object
  18436. * @param serializationObject defines the JSON object
  18437. */
  18438. parse(serializationObject: any): void;
  18439. }
  18440. }
  18441. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  18442. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18443. import { Effect } from "babylonjs/Materials/effect";
  18444. import { Particle } from "babylonjs/Particles/particle";
  18445. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18446. /**
  18447. * Particle emitter emitting particles from the inside of a cylinder.
  18448. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  18449. */
  18450. export class CylinderParticleEmitter implements IParticleEmitterType {
  18451. /**
  18452. * The radius of the emission cylinder.
  18453. */
  18454. radius: number;
  18455. /**
  18456. * The height of the emission cylinder.
  18457. */
  18458. height: number;
  18459. /**
  18460. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18461. */
  18462. radiusRange: number;
  18463. /**
  18464. * How much to randomize the particle direction [0-1].
  18465. */
  18466. directionRandomizer: number;
  18467. /**
  18468. * Creates a new instance CylinderParticleEmitter
  18469. * @param radius the radius of the emission cylinder (1 by default)
  18470. * @param height the height of the emission cylinder (1 by default)
  18471. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18472. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18473. */
  18474. constructor(
  18475. /**
  18476. * The radius of the emission cylinder.
  18477. */
  18478. radius?: number,
  18479. /**
  18480. * The height of the emission cylinder.
  18481. */
  18482. height?: number,
  18483. /**
  18484. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18485. */
  18486. radiusRange?: number,
  18487. /**
  18488. * How much to randomize the particle direction [0-1].
  18489. */
  18490. directionRandomizer?: number);
  18491. /**
  18492. * Called by the particle System when the direction is computed for the created particle.
  18493. * @param worldMatrix is the world matrix of the particle system
  18494. * @param directionToUpdate is the direction vector to update with the result
  18495. * @param particle is the particle we are computed the direction for
  18496. */
  18497. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18498. /**
  18499. * Called by the particle System when the position is computed for the created particle.
  18500. * @param worldMatrix is the world matrix of the particle system
  18501. * @param positionToUpdate is the position vector to update with the result
  18502. * @param particle is the particle we are computed the position for
  18503. */
  18504. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18505. /**
  18506. * Clones the current emitter and returns a copy of it
  18507. * @returns the new emitter
  18508. */
  18509. clone(): CylinderParticleEmitter;
  18510. /**
  18511. * Called by the GPUParticleSystem to setup the update shader
  18512. * @param effect defines the update shader
  18513. */
  18514. applyToShader(effect: Effect): void;
  18515. /**
  18516. * Returns a string to use to update the GPU particles update shader
  18517. * @returns a string containng the defines string
  18518. */
  18519. getEffectDefines(): string;
  18520. /**
  18521. * Returns the string "CylinderParticleEmitter"
  18522. * @returns a string containing the class name
  18523. */
  18524. getClassName(): string;
  18525. /**
  18526. * Serializes the particle system to a JSON object.
  18527. * @returns the JSON object
  18528. */
  18529. serialize(): any;
  18530. /**
  18531. * Parse properties from a JSON object
  18532. * @param serializationObject defines the JSON object
  18533. */
  18534. parse(serializationObject: any): void;
  18535. }
  18536. /**
  18537. * Particle emitter emitting particles from the inside of a cylinder.
  18538. * It emits the particles randomly between two vectors.
  18539. */
  18540. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18541. /**
  18542. * The min limit of the emission direction.
  18543. */
  18544. direction1: Vector3;
  18545. /**
  18546. * The max limit of the emission direction.
  18547. */
  18548. direction2: Vector3;
  18549. /**
  18550. * Creates a new instance CylinderDirectedParticleEmitter
  18551. * @param radius the radius of the emission cylinder (1 by default)
  18552. * @param height the height of the emission cylinder (1 by default)
  18553. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18554. * @param direction1 the min limit of the emission direction (up vector by default)
  18555. * @param direction2 the max limit of the emission direction (up vector by default)
  18556. */
  18557. constructor(radius?: number, height?: number, radiusRange?: number,
  18558. /**
  18559. * The min limit of the emission direction.
  18560. */
  18561. direction1?: Vector3,
  18562. /**
  18563. * The max limit of the emission direction.
  18564. */
  18565. direction2?: Vector3);
  18566. /**
  18567. * Called by the particle System when the direction is computed for the created particle.
  18568. * @param worldMatrix is the world matrix of the particle system
  18569. * @param directionToUpdate is the direction vector to update with the result
  18570. * @param particle is the particle we are computed the direction for
  18571. */
  18572. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18573. /**
  18574. * Clones the current emitter and returns a copy of it
  18575. * @returns the new emitter
  18576. */
  18577. clone(): CylinderDirectedParticleEmitter;
  18578. /**
  18579. * Called by the GPUParticleSystem to setup the update shader
  18580. * @param effect defines the update shader
  18581. */
  18582. applyToShader(effect: Effect): void;
  18583. /**
  18584. * Returns a string to use to update the GPU particles update shader
  18585. * @returns a string containng the defines string
  18586. */
  18587. getEffectDefines(): string;
  18588. /**
  18589. * Returns the string "CylinderDirectedParticleEmitter"
  18590. * @returns a string containing the class name
  18591. */
  18592. getClassName(): string;
  18593. /**
  18594. * Serializes the particle system to a JSON object.
  18595. * @returns the JSON object
  18596. */
  18597. serialize(): any;
  18598. /**
  18599. * Parse properties from a JSON object
  18600. * @param serializationObject defines the JSON object
  18601. */
  18602. parse(serializationObject: any): void;
  18603. }
  18604. }
  18605. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18606. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18607. import { Effect } from "babylonjs/Materials/effect";
  18608. import { Particle } from "babylonjs/Particles/particle";
  18609. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18610. /**
  18611. * Particle emitter emitting particles from the inside of a hemisphere.
  18612. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18613. */
  18614. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18615. /**
  18616. * The radius of the emission hemisphere.
  18617. */
  18618. radius: number;
  18619. /**
  18620. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18621. */
  18622. radiusRange: number;
  18623. /**
  18624. * How much to randomize the particle direction [0-1].
  18625. */
  18626. directionRandomizer: number;
  18627. /**
  18628. * Creates a new instance HemisphericParticleEmitter
  18629. * @param radius the radius of the emission hemisphere (1 by default)
  18630. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18631. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18632. */
  18633. constructor(
  18634. /**
  18635. * The radius of the emission hemisphere.
  18636. */
  18637. radius?: number,
  18638. /**
  18639. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18640. */
  18641. radiusRange?: number,
  18642. /**
  18643. * How much to randomize the particle direction [0-1].
  18644. */
  18645. directionRandomizer?: number);
  18646. /**
  18647. * Called by the particle System when the direction is computed for the created particle.
  18648. * @param worldMatrix is the world matrix of the particle system
  18649. * @param directionToUpdate is the direction vector to update with the result
  18650. * @param particle is the particle we are computed the direction for
  18651. */
  18652. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18653. /**
  18654. * Called by the particle System when the position is computed for the created particle.
  18655. * @param worldMatrix is the world matrix of the particle system
  18656. * @param positionToUpdate is the position vector to update with the result
  18657. * @param particle is the particle we are computed the position for
  18658. */
  18659. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18660. /**
  18661. * Clones the current emitter and returns a copy of it
  18662. * @returns the new emitter
  18663. */
  18664. clone(): HemisphericParticleEmitter;
  18665. /**
  18666. * Called by the GPUParticleSystem to setup the update shader
  18667. * @param effect defines the update shader
  18668. */
  18669. applyToShader(effect: Effect): void;
  18670. /**
  18671. * Returns a string to use to update the GPU particles update shader
  18672. * @returns a string containng the defines string
  18673. */
  18674. getEffectDefines(): string;
  18675. /**
  18676. * Returns the string "HemisphericParticleEmitter"
  18677. * @returns a string containing the class name
  18678. */
  18679. getClassName(): string;
  18680. /**
  18681. * Serializes the particle system to a JSON object.
  18682. * @returns the JSON object
  18683. */
  18684. serialize(): any;
  18685. /**
  18686. * Parse properties from a JSON object
  18687. * @param serializationObject defines the JSON object
  18688. */
  18689. parse(serializationObject: any): void;
  18690. }
  18691. }
  18692. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18693. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18694. import { Effect } from "babylonjs/Materials/effect";
  18695. import { Particle } from "babylonjs/Particles/particle";
  18696. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18697. /**
  18698. * Particle emitter emitting particles from a point.
  18699. * It emits the particles randomly between 2 given directions.
  18700. */
  18701. export class PointParticleEmitter implements IParticleEmitterType {
  18702. /**
  18703. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18704. */
  18705. direction1: Vector3;
  18706. /**
  18707. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18708. */
  18709. direction2: Vector3;
  18710. /**
  18711. * Creates a new instance PointParticleEmitter
  18712. */
  18713. constructor();
  18714. /**
  18715. * Called by the particle System when the direction is computed for the created particle.
  18716. * @param worldMatrix is the world matrix of the particle system
  18717. * @param directionToUpdate is the direction vector to update with the result
  18718. * @param particle is the particle we are computed the direction for
  18719. */
  18720. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18721. /**
  18722. * Called by the particle System when the position is computed for the created particle.
  18723. * @param worldMatrix is the world matrix of the particle system
  18724. * @param positionToUpdate is the position vector to update with the result
  18725. * @param particle is the particle we are computed the position for
  18726. */
  18727. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18728. /**
  18729. * Clones the current emitter and returns a copy of it
  18730. * @returns the new emitter
  18731. */
  18732. clone(): PointParticleEmitter;
  18733. /**
  18734. * Called by the GPUParticleSystem to setup the update shader
  18735. * @param effect defines the update shader
  18736. */
  18737. applyToShader(effect: Effect): void;
  18738. /**
  18739. * Returns a string to use to update the GPU particles update shader
  18740. * @returns a string containng the defines string
  18741. */
  18742. getEffectDefines(): string;
  18743. /**
  18744. * Returns the string "PointParticleEmitter"
  18745. * @returns a string containing the class name
  18746. */
  18747. getClassName(): string;
  18748. /**
  18749. * Serializes the particle system to a JSON object.
  18750. * @returns the JSON object
  18751. */
  18752. serialize(): any;
  18753. /**
  18754. * Parse properties from a JSON object
  18755. * @param serializationObject defines the JSON object
  18756. */
  18757. parse(serializationObject: any): void;
  18758. }
  18759. }
  18760. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18761. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18762. import { Effect } from "babylonjs/Materials/effect";
  18763. import { Particle } from "babylonjs/Particles/particle";
  18764. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18765. /**
  18766. * Particle emitter emitting particles from the inside of a sphere.
  18767. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18768. */
  18769. export class SphereParticleEmitter implements IParticleEmitterType {
  18770. /**
  18771. * The radius of the emission sphere.
  18772. */
  18773. radius: number;
  18774. /**
  18775. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18776. */
  18777. radiusRange: number;
  18778. /**
  18779. * How much to randomize the particle direction [0-1].
  18780. */
  18781. directionRandomizer: number;
  18782. /**
  18783. * Creates a new instance SphereParticleEmitter
  18784. * @param radius the radius of the emission sphere (1 by default)
  18785. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18786. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18787. */
  18788. constructor(
  18789. /**
  18790. * The radius of the emission sphere.
  18791. */
  18792. radius?: number,
  18793. /**
  18794. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18795. */
  18796. radiusRange?: number,
  18797. /**
  18798. * How much to randomize the particle direction [0-1].
  18799. */
  18800. directionRandomizer?: number);
  18801. /**
  18802. * Called by the particle System when the direction is computed for the created particle.
  18803. * @param worldMatrix is the world matrix of the particle system
  18804. * @param directionToUpdate is the direction vector to update with the result
  18805. * @param particle is the particle we are computed the direction for
  18806. */
  18807. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18808. /**
  18809. * Called by the particle System when the position is computed for the created particle.
  18810. * @param worldMatrix is the world matrix of the particle system
  18811. * @param positionToUpdate is the position vector to update with the result
  18812. * @param particle is the particle we are computed the position for
  18813. */
  18814. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18815. /**
  18816. * Clones the current emitter and returns a copy of it
  18817. * @returns the new emitter
  18818. */
  18819. clone(): SphereParticleEmitter;
  18820. /**
  18821. * Called by the GPUParticleSystem to setup the update shader
  18822. * @param effect defines the update shader
  18823. */
  18824. applyToShader(effect: Effect): void;
  18825. /**
  18826. * Returns a string to use to update the GPU particles update shader
  18827. * @returns a string containng the defines string
  18828. */
  18829. getEffectDefines(): string;
  18830. /**
  18831. * Returns the string "SphereParticleEmitter"
  18832. * @returns a string containing the class name
  18833. */
  18834. getClassName(): string;
  18835. /**
  18836. * Serializes the particle system to a JSON object.
  18837. * @returns the JSON object
  18838. */
  18839. serialize(): any;
  18840. /**
  18841. * Parse properties from a JSON object
  18842. * @param serializationObject defines the JSON object
  18843. */
  18844. parse(serializationObject: any): void;
  18845. }
  18846. /**
  18847. * Particle emitter emitting particles from the inside of a sphere.
  18848. * It emits the particles randomly between two vectors.
  18849. */
  18850. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18851. /**
  18852. * The min limit of the emission direction.
  18853. */
  18854. direction1: Vector3;
  18855. /**
  18856. * The max limit of the emission direction.
  18857. */
  18858. direction2: Vector3;
  18859. /**
  18860. * Creates a new instance SphereDirectedParticleEmitter
  18861. * @param radius the radius of the emission sphere (1 by default)
  18862. * @param direction1 the min limit of the emission direction (up vector by default)
  18863. * @param direction2 the max limit of the emission direction (up vector by default)
  18864. */
  18865. constructor(radius?: number,
  18866. /**
  18867. * The min limit of the emission direction.
  18868. */
  18869. direction1?: Vector3,
  18870. /**
  18871. * The max limit of the emission direction.
  18872. */
  18873. direction2?: Vector3);
  18874. /**
  18875. * Called by the particle System when the direction is computed for the created particle.
  18876. * @param worldMatrix is the world matrix of the particle system
  18877. * @param directionToUpdate is the direction vector to update with the result
  18878. * @param particle is the particle we are computed the direction for
  18879. */
  18880. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18881. /**
  18882. * Clones the current emitter and returns a copy of it
  18883. * @returns the new emitter
  18884. */
  18885. clone(): SphereDirectedParticleEmitter;
  18886. /**
  18887. * Called by the GPUParticleSystem to setup the update shader
  18888. * @param effect defines the update shader
  18889. */
  18890. applyToShader(effect: Effect): void;
  18891. /**
  18892. * Returns a string to use to update the GPU particles update shader
  18893. * @returns a string containng the defines string
  18894. */
  18895. getEffectDefines(): string;
  18896. /**
  18897. * Returns the string "SphereDirectedParticleEmitter"
  18898. * @returns a string containing the class name
  18899. */
  18900. getClassName(): string;
  18901. /**
  18902. * Serializes the particle system to a JSON object.
  18903. * @returns the JSON object
  18904. */
  18905. serialize(): any;
  18906. /**
  18907. * Parse properties from a JSON object
  18908. * @param serializationObject defines the JSON object
  18909. */
  18910. parse(serializationObject: any): void;
  18911. }
  18912. }
  18913. declare module "babylonjs/Particles/EmitterTypes/index" {
  18914. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18915. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18916. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18917. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18918. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18919. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18920. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18921. }
  18922. declare module "babylonjs/Particles/IParticleSystem" {
  18923. import { Nullable } from "babylonjs/types";
  18924. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18925. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18927. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18928. import { Texture } from "babylonjs/Materials/Textures/texture";
  18929. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18930. import { Scene } from "babylonjs/scene";
  18931. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18932. import { Animation } from "babylonjs/Animations/animation";
  18933. /**
  18934. * Interface representing a particle system in Babylon.js.
  18935. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18936. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18937. */
  18938. export interface IParticleSystem {
  18939. /**
  18940. * List of animations used by the particle system.
  18941. */
  18942. animations: Animation[];
  18943. /**
  18944. * The id of the Particle system.
  18945. */
  18946. id: string;
  18947. /**
  18948. * The name of the Particle system.
  18949. */
  18950. name: string;
  18951. /**
  18952. * The emitter represents the Mesh or position we are attaching the particle system to.
  18953. */
  18954. emitter: Nullable<AbstractMesh | Vector3>;
  18955. /**
  18956. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18957. */
  18958. isBillboardBased: boolean;
  18959. /**
  18960. * The rendering group used by the Particle system to chose when to render.
  18961. */
  18962. renderingGroupId: number;
  18963. /**
  18964. * The layer mask we are rendering the particles through.
  18965. */
  18966. layerMask: number;
  18967. /**
  18968. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18969. */
  18970. updateSpeed: number;
  18971. /**
  18972. * The amount of time the particle system is running (depends of the overall update speed).
  18973. */
  18974. targetStopDuration: number;
  18975. /**
  18976. * The texture used to render each particle. (this can be a spritesheet)
  18977. */
  18978. particleTexture: Nullable<Texture>;
  18979. /**
  18980. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18981. */
  18982. blendMode: number;
  18983. /**
  18984. * Minimum life time of emitting particles.
  18985. */
  18986. minLifeTime: number;
  18987. /**
  18988. * Maximum life time of emitting particles.
  18989. */
  18990. maxLifeTime: number;
  18991. /**
  18992. * Minimum Size of emitting particles.
  18993. */
  18994. minSize: number;
  18995. /**
  18996. * Maximum Size of emitting particles.
  18997. */
  18998. maxSize: number;
  18999. /**
  19000. * Minimum scale of emitting particles on X axis.
  19001. */
  19002. minScaleX: number;
  19003. /**
  19004. * Maximum scale of emitting particles on X axis.
  19005. */
  19006. maxScaleX: number;
  19007. /**
  19008. * Minimum scale of emitting particles on Y axis.
  19009. */
  19010. minScaleY: number;
  19011. /**
  19012. * Maximum scale of emitting particles on Y axis.
  19013. */
  19014. maxScaleY: number;
  19015. /**
  19016. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  19017. */
  19018. color1: Color4;
  19019. /**
  19020. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  19021. */
  19022. color2: Color4;
  19023. /**
  19024. * Color the particle will have at the end of its lifetime.
  19025. */
  19026. colorDead: Color4;
  19027. /**
  19028. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  19029. */
  19030. emitRate: number;
  19031. /**
  19032. * You can use gravity if you want to give an orientation to your particles.
  19033. */
  19034. gravity: Vector3;
  19035. /**
  19036. * Minimum power of emitting particles.
  19037. */
  19038. minEmitPower: number;
  19039. /**
  19040. * Maximum power of emitting particles.
  19041. */
  19042. maxEmitPower: number;
  19043. /**
  19044. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  19045. */
  19046. minAngularSpeed: number;
  19047. /**
  19048. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  19049. */
  19050. maxAngularSpeed: number;
  19051. /**
  19052. * Gets or sets the minimal initial rotation in radians.
  19053. */
  19054. minInitialRotation: number;
  19055. /**
  19056. * Gets or sets the maximal initial rotation in radians.
  19057. */
  19058. maxInitialRotation: number;
  19059. /**
  19060. * The particle emitter type defines the emitter used by the particle system.
  19061. * It can be for example box, sphere, or cone...
  19062. */
  19063. particleEmitterType: Nullable<IParticleEmitterType>;
  19064. /**
  19065. * Defines the delay in milliseconds before starting the system (0 by default)
  19066. */
  19067. startDelay: number;
  19068. /**
  19069. * 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
  19070. */
  19071. preWarmCycles: number;
  19072. /**
  19073. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  19074. */
  19075. preWarmStepOffset: number;
  19076. /**
  19077. * 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)
  19078. */
  19079. spriteCellChangeSpeed: number;
  19080. /**
  19081. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  19082. */
  19083. startSpriteCellID: number;
  19084. /**
  19085. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  19086. */
  19087. endSpriteCellID: number;
  19088. /**
  19089. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  19090. */
  19091. spriteCellWidth: number;
  19092. /**
  19093. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  19094. */
  19095. spriteCellHeight: number;
  19096. /**
  19097. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  19098. */
  19099. spriteRandomStartCell: boolean;
  19100. /**
  19101. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  19102. */
  19103. isAnimationSheetEnabled: boolean;
  19104. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  19105. translationPivot: Vector2;
  19106. /**
  19107. * Gets or sets a texture used to add random noise to particle positions
  19108. */
  19109. noiseTexture: Nullable<BaseTexture>;
  19110. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  19111. noiseStrength: Vector3;
  19112. /**
  19113. * Gets or sets the billboard mode to use when isBillboardBased = true.
  19114. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  19115. */
  19116. billboardMode: number;
  19117. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  19118. limitVelocityDamping: number;
  19119. /**
  19120. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  19121. */
  19122. beginAnimationOnStart: boolean;
  19123. /**
  19124. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  19125. */
  19126. beginAnimationFrom: number;
  19127. /**
  19128. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  19129. */
  19130. beginAnimationTo: number;
  19131. /**
  19132. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  19133. */
  19134. beginAnimationLoop: boolean;
  19135. /**
  19136. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  19137. */
  19138. disposeOnStop: boolean;
  19139. /**
  19140. * Gets the maximum number of particles active at the same time.
  19141. * @returns The max number of active particles.
  19142. */
  19143. getCapacity(): number;
  19144. /**
  19145. * Gets if the system has been started. (Note: this will still be true after stop is called)
  19146. * @returns True if it has been started, otherwise false.
  19147. */
  19148. isStarted(): boolean;
  19149. /**
  19150. * Animates the particle system for this frame.
  19151. */
  19152. animate(): void;
  19153. /**
  19154. * Renders the particle system in its current state.
  19155. * @returns the current number of particles
  19156. */
  19157. render(): number;
  19158. /**
  19159. * Dispose the particle system and frees its associated resources.
  19160. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  19161. */
  19162. dispose(disposeTexture?: boolean): void;
  19163. /**
  19164. * Clones the particle system.
  19165. * @param name The name of the cloned object
  19166. * @param newEmitter The new emitter to use
  19167. * @returns the cloned particle system
  19168. */
  19169. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  19170. /**
  19171. * Serializes the particle system to a JSON object.
  19172. * @returns the JSON object
  19173. */
  19174. serialize(): any;
  19175. /**
  19176. * Rebuild the particle system
  19177. */
  19178. rebuild(): void;
  19179. /**
  19180. * Starts the particle system and begins to emit
  19181. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  19182. */
  19183. start(delay?: number): void;
  19184. /**
  19185. * Stops the particle system.
  19186. */
  19187. stop(): void;
  19188. /**
  19189. * Remove all active particles
  19190. */
  19191. reset(): void;
  19192. /**
  19193. * Is this system ready to be used/rendered
  19194. * @return true if the system is ready
  19195. */
  19196. isReady(): boolean;
  19197. /**
  19198. * Adds a new color gradient
  19199. * @param gradient defines the gradient to use (between 0 and 1)
  19200. * @param color1 defines the color to affect to the specified gradient
  19201. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  19202. * @returns the current particle system
  19203. */
  19204. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  19205. /**
  19206. * Remove a specific color gradient
  19207. * @param gradient defines the gradient to remove
  19208. * @returns the current particle system
  19209. */
  19210. removeColorGradient(gradient: number): IParticleSystem;
  19211. /**
  19212. * Adds a new size gradient
  19213. * @param gradient defines the gradient to use (between 0 and 1)
  19214. * @param factor defines the size factor to affect to the specified gradient
  19215. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19216. * @returns the current particle system
  19217. */
  19218. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19219. /**
  19220. * Remove a specific size gradient
  19221. * @param gradient defines the gradient to remove
  19222. * @returns the current particle system
  19223. */
  19224. removeSizeGradient(gradient: number): IParticleSystem;
  19225. /**
  19226. * Gets the current list of color gradients.
  19227. * You must use addColorGradient and removeColorGradient to udpate this list
  19228. * @returns the list of color gradients
  19229. */
  19230. getColorGradients(): Nullable<Array<ColorGradient>>;
  19231. /**
  19232. * Gets the current list of size gradients.
  19233. * You must use addSizeGradient and removeSizeGradient to udpate this list
  19234. * @returns the list of size gradients
  19235. */
  19236. getSizeGradients(): Nullable<Array<FactorGradient>>;
  19237. /**
  19238. * Gets the current list of angular speed gradients.
  19239. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  19240. * @returns the list of angular speed gradients
  19241. */
  19242. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  19243. /**
  19244. * Adds a new angular speed gradient
  19245. * @param gradient defines the gradient to use (between 0 and 1)
  19246. * @param factor defines the angular speed to affect to the specified gradient
  19247. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19248. * @returns the current particle system
  19249. */
  19250. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19251. /**
  19252. * Remove a specific angular speed gradient
  19253. * @param gradient defines the gradient to remove
  19254. * @returns the current particle system
  19255. */
  19256. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  19257. /**
  19258. * Gets the current list of velocity gradients.
  19259. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  19260. * @returns the list of velocity gradients
  19261. */
  19262. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  19263. /**
  19264. * Adds a new velocity gradient
  19265. * @param gradient defines the gradient to use (between 0 and 1)
  19266. * @param factor defines the velocity to affect to the specified gradient
  19267. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19268. * @returns the current particle system
  19269. */
  19270. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19271. /**
  19272. * Remove a specific velocity gradient
  19273. * @param gradient defines the gradient to remove
  19274. * @returns the current particle system
  19275. */
  19276. removeVelocityGradient(gradient: number): IParticleSystem;
  19277. /**
  19278. * Gets the current list of limit velocity gradients.
  19279. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  19280. * @returns the list of limit velocity gradients
  19281. */
  19282. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  19283. /**
  19284. * Adds a new limit velocity gradient
  19285. * @param gradient defines the gradient to use (between 0 and 1)
  19286. * @param factor defines the limit velocity to affect to the specified gradient
  19287. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19288. * @returns the current particle system
  19289. */
  19290. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19291. /**
  19292. * Remove a specific limit velocity gradient
  19293. * @param gradient defines the gradient to remove
  19294. * @returns the current particle system
  19295. */
  19296. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  19297. /**
  19298. * Adds a new drag gradient
  19299. * @param gradient defines the gradient to use (between 0 and 1)
  19300. * @param factor defines the drag to affect to the specified gradient
  19301. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19302. * @returns the current particle system
  19303. */
  19304. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19305. /**
  19306. * Remove a specific drag gradient
  19307. * @param gradient defines the gradient to remove
  19308. * @returns the current particle system
  19309. */
  19310. removeDragGradient(gradient: number): IParticleSystem;
  19311. /**
  19312. * Gets the current list of drag gradients.
  19313. * You must use addDragGradient and removeDragGradient to udpate this list
  19314. * @returns the list of drag gradients
  19315. */
  19316. getDragGradients(): Nullable<Array<FactorGradient>>;
  19317. /**
  19318. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  19319. * @param gradient defines the gradient to use (between 0 and 1)
  19320. * @param factor defines the emit rate to affect to the specified gradient
  19321. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19322. * @returns the current particle system
  19323. */
  19324. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19325. /**
  19326. * Remove a specific emit rate gradient
  19327. * @param gradient defines the gradient to remove
  19328. * @returns the current particle system
  19329. */
  19330. removeEmitRateGradient(gradient: number): IParticleSystem;
  19331. /**
  19332. * Gets the current list of emit rate gradients.
  19333. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  19334. * @returns the list of emit rate gradients
  19335. */
  19336. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  19337. /**
  19338. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  19339. * @param gradient defines the gradient to use (between 0 and 1)
  19340. * @param factor defines the start size to affect to the specified gradient
  19341. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19342. * @returns the current particle system
  19343. */
  19344. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19345. /**
  19346. * Remove a specific start size gradient
  19347. * @param gradient defines the gradient to remove
  19348. * @returns the current particle system
  19349. */
  19350. removeStartSizeGradient(gradient: number): IParticleSystem;
  19351. /**
  19352. * Gets the current list of start size gradients.
  19353. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  19354. * @returns the list of start size gradients
  19355. */
  19356. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  19357. /**
  19358. * Adds a new life time gradient
  19359. * @param gradient defines the gradient to use (between 0 and 1)
  19360. * @param factor defines the life time factor to affect to the specified gradient
  19361. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19362. * @returns the current particle system
  19363. */
  19364. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19365. /**
  19366. * Remove a specific life time gradient
  19367. * @param gradient defines the gradient to remove
  19368. * @returns the current particle system
  19369. */
  19370. removeLifeTimeGradient(gradient: number): IParticleSystem;
  19371. /**
  19372. * Gets the current list of life time gradients.
  19373. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  19374. * @returns the list of life time gradients
  19375. */
  19376. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  19377. /**
  19378. * Gets the current list of color gradients.
  19379. * You must use addColorGradient and removeColorGradient to udpate this list
  19380. * @returns the list of color gradients
  19381. */
  19382. getColorGradients(): Nullable<Array<ColorGradient>>;
  19383. /**
  19384. * Adds a new ramp gradient used to remap particle colors
  19385. * @param gradient defines the gradient to use (between 0 and 1)
  19386. * @param color defines the color to affect to the specified gradient
  19387. * @returns the current particle system
  19388. */
  19389. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  19390. /**
  19391. * Gets the current list of ramp gradients.
  19392. * You must use addRampGradient and removeRampGradient to udpate this list
  19393. * @returns the list of ramp gradients
  19394. */
  19395. getRampGradients(): Nullable<Array<Color3Gradient>>;
  19396. /** Gets or sets a boolean indicating that ramp gradients must be used
  19397. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  19398. */
  19399. useRampGradients: boolean;
  19400. /**
  19401. * Adds a new color remap gradient
  19402. * @param gradient defines the gradient to use (between 0 and 1)
  19403. * @param min defines the color remap minimal range
  19404. * @param max defines the color remap maximal range
  19405. * @returns the current particle system
  19406. */
  19407. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19408. /**
  19409. * Gets the current list of color remap gradients.
  19410. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  19411. * @returns the list of color remap gradients
  19412. */
  19413. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  19414. /**
  19415. * Adds a new alpha remap gradient
  19416. * @param gradient defines the gradient to use (between 0 and 1)
  19417. * @param min defines the alpha remap minimal range
  19418. * @param max defines the alpha remap maximal range
  19419. * @returns the current particle system
  19420. */
  19421. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19422. /**
  19423. * Gets the current list of alpha remap gradients.
  19424. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  19425. * @returns the list of alpha remap gradients
  19426. */
  19427. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  19428. /**
  19429. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  19430. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19431. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19432. * @returns the emitter
  19433. */
  19434. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  19435. /**
  19436. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  19437. * @param radius The radius of the hemisphere to emit from
  19438. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19439. * @returns the emitter
  19440. */
  19441. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  19442. /**
  19443. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  19444. * @param radius The radius of the sphere to emit from
  19445. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19446. * @returns the emitter
  19447. */
  19448. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  19449. /**
  19450. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  19451. * @param radius The radius of the sphere to emit from
  19452. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  19453. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  19454. * @returns the emitter
  19455. */
  19456. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19457. /**
  19458. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  19459. * @param radius The radius of the emission cylinder
  19460. * @param height The height of the emission cylinder
  19461. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  19462. * @param directionRandomizer How much to randomize the particle direction [0-1]
  19463. * @returns the emitter
  19464. */
  19465. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  19466. /**
  19467. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  19468. * @param radius The radius of the cylinder to emit from
  19469. * @param height The height of the emission cylinder
  19470. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  19471. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  19472. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  19473. * @returns the emitter
  19474. */
  19475. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19476. /**
  19477. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  19478. * @param radius The radius of the cone to emit from
  19479. * @param angle The base angle of the cone
  19480. * @returns the emitter
  19481. */
  19482. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  19483. /**
  19484. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  19485. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19486. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19487. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19488. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19489. * @returns the emitter
  19490. */
  19491. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  19492. /**
  19493. * Get hosting scene
  19494. * @returns the scene
  19495. */
  19496. getScene(): Scene;
  19497. }
  19498. }
  19499. declare module "babylonjs/Meshes/instancedMesh" {
  19500. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19501. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19502. import { Camera } from "babylonjs/Cameras/camera";
  19503. import { Node } from "babylonjs/node";
  19504. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19505. import { Mesh } from "babylonjs/Meshes/mesh";
  19506. import { Material } from "babylonjs/Materials/material";
  19507. import { Skeleton } from "babylonjs/Bones/skeleton";
  19508. import { Light } from "babylonjs/Lights/light";
  19509. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19510. /**
  19511. * Creates an instance based on a source mesh.
  19512. */
  19513. export class InstancedMesh extends AbstractMesh {
  19514. private _sourceMesh;
  19515. private _currentLOD;
  19516. /** @hidden */
  19517. _indexInSourceMeshInstanceArray: number;
  19518. constructor(name: string, source: Mesh);
  19519. /**
  19520. * Returns the string "InstancedMesh".
  19521. */
  19522. getClassName(): string;
  19523. /** Gets the list of lights affecting that mesh */
  19524. readonly lightSources: Light[];
  19525. _resyncLightSources(): void;
  19526. _resyncLighSource(light: Light): void;
  19527. _removeLightSource(light: Light, dispose: boolean): void;
  19528. /**
  19529. * If the source mesh receives shadows
  19530. */
  19531. readonly receiveShadows: boolean;
  19532. /**
  19533. * The material of the source mesh
  19534. */
  19535. readonly material: Nullable<Material>;
  19536. /**
  19537. * Visibility of the source mesh
  19538. */
  19539. readonly visibility: number;
  19540. /**
  19541. * Skeleton of the source mesh
  19542. */
  19543. readonly skeleton: Nullable<Skeleton>;
  19544. /**
  19545. * Rendering ground id of the source mesh
  19546. */
  19547. renderingGroupId: number;
  19548. /**
  19549. * Returns the total number of vertices (integer).
  19550. */
  19551. getTotalVertices(): number;
  19552. /**
  19553. * Returns a positive integer : the total number of indices in this mesh geometry.
  19554. * @returns the numner of indices or zero if the mesh has no geometry.
  19555. */
  19556. getTotalIndices(): number;
  19557. /**
  19558. * The source mesh of the instance
  19559. */
  19560. readonly sourceMesh: Mesh;
  19561. /**
  19562. * Is this node ready to be used/rendered
  19563. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19564. * @return {boolean} is it ready
  19565. */
  19566. isReady(completeCheck?: boolean): boolean;
  19567. /**
  19568. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19569. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19570. * @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.
  19571. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19572. */
  19573. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19574. /**
  19575. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19576. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19577. * The `data` are either a numeric array either a Float32Array.
  19578. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19579. * 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).
  19580. * Note that a new underlying VertexBuffer object is created each call.
  19581. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19582. *
  19583. * Possible `kind` values :
  19584. * - VertexBuffer.PositionKind
  19585. * - VertexBuffer.UVKind
  19586. * - VertexBuffer.UV2Kind
  19587. * - VertexBuffer.UV3Kind
  19588. * - VertexBuffer.UV4Kind
  19589. * - VertexBuffer.UV5Kind
  19590. * - VertexBuffer.UV6Kind
  19591. * - VertexBuffer.ColorKind
  19592. * - VertexBuffer.MatricesIndicesKind
  19593. * - VertexBuffer.MatricesIndicesExtraKind
  19594. * - VertexBuffer.MatricesWeightsKind
  19595. * - VertexBuffer.MatricesWeightsExtraKind
  19596. *
  19597. * Returns the Mesh.
  19598. */
  19599. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  19600. /**
  19601. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19602. * If the mesh has no geometry, it is simply returned as it is.
  19603. * The `data` are either a numeric array either a Float32Array.
  19604. * No new underlying VertexBuffer object is created.
  19605. * 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.
  19606. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19607. *
  19608. * Possible `kind` values :
  19609. * - VertexBuffer.PositionKind
  19610. * - VertexBuffer.UVKind
  19611. * - VertexBuffer.UV2Kind
  19612. * - VertexBuffer.UV3Kind
  19613. * - VertexBuffer.UV4Kind
  19614. * - VertexBuffer.UV5Kind
  19615. * - VertexBuffer.UV6Kind
  19616. * - VertexBuffer.ColorKind
  19617. * - VertexBuffer.MatricesIndicesKind
  19618. * - VertexBuffer.MatricesIndicesExtraKind
  19619. * - VertexBuffer.MatricesWeightsKind
  19620. * - VertexBuffer.MatricesWeightsExtraKind
  19621. *
  19622. * Returns the Mesh.
  19623. */
  19624. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19625. /**
  19626. * Sets the mesh indices.
  19627. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19628. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19629. * This method creates a new index buffer each call.
  19630. * Returns the Mesh.
  19631. */
  19632. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19633. /**
  19634. * Boolean : True if the mesh owns the requested kind of data.
  19635. */
  19636. isVerticesDataPresent(kind: string): boolean;
  19637. /**
  19638. * Returns an array of indices (IndicesArray).
  19639. */
  19640. getIndices(): Nullable<IndicesArray>;
  19641. readonly _positions: Nullable<Vector3[]>;
  19642. /**
  19643. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19644. * This means the mesh underlying bounding box and sphere are recomputed.
  19645. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19646. * @returns the current mesh
  19647. */
  19648. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19649. /** @hidden */
  19650. _preActivate(): InstancedMesh;
  19651. /** @hidden */
  19652. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19653. /** @hidden */
  19654. _postActivate(): void;
  19655. getWorldMatrix(): Matrix;
  19656. readonly isAnInstance: boolean;
  19657. /**
  19658. * Returns the current associated LOD AbstractMesh.
  19659. */
  19660. getLOD(camera: Camera): AbstractMesh;
  19661. /** @hidden */
  19662. _syncSubMeshes(): InstancedMesh;
  19663. /** @hidden */
  19664. _generatePointsArray(): boolean;
  19665. /**
  19666. * Creates a new InstancedMesh from the current mesh.
  19667. * - name (string) : the cloned mesh name
  19668. * - newParent (optional Node) : the optional Node to parent the clone to.
  19669. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19670. *
  19671. * Returns the clone.
  19672. */
  19673. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19674. /**
  19675. * Disposes the InstancedMesh.
  19676. * Returns nothing.
  19677. */
  19678. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19679. }
  19680. module "babylonjs/Meshes/mesh" {
  19681. interface Mesh {
  19682. /**
  19683. * Register a custom buffer that will be instanced
  19684. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19685. * @param kind defines the buffer kind
  19686. * @param stride defines the stride in floats
  19687. */
  19688. registerInstancedBuffer(kind: string, stride: number): void;
  19689. /** @hidden */
  19690. _userInstancedBuffersStorage: {
  19691. data: {
  19692. [key: string]: Float32Array;
  19693. };
  19694. sizes: {
  19695. [key: string]: number;
  19696. };
  19697. vertexBuffers: {
  19698. [key: string]: Nullable<VertexBuffer>;
  19699. };
  19700. strides: {
  19701. [key: string]: number;
  19702. };
  19703. };
  19704. }
  19705. }
  19706. module "babylonjs/Meshes/abstractMesh" {
  19707. interface AbstractMesh {
  19708. /**
  19709. * Object used to store instanced buffers defined by user
  19710. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19711. */
  19712. instancedBuffers: {
  19713. [key: string]: any;
  19714. };
  19715. }
  19716. }
  19717. }
  19718. declare module "babylonjs/Materials/shaderMaterial" {
  19719. import { Scene } from "babylonjs/scene";
  19720. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19721. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19722. import { Mesh } from "babylonjs/Meshes/mesh";
  19723. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19724. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19725. import { Texture } from "babylonjs/Materials/Textures/texture";
  19726. import { Material } from "babylonjs/Materials/material";
  19727. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19728. /**
  19729. * Defines the options associated with the creation of a shader material.
  19730. */
  19731. export interface IShaderMaterialOptions {
  19732. /**
  19733. * Does the material work in alpha blend mode
  19734. */
  19735. needAlphaBlending: boolean;
  19736. /**
  19737. * Does the material work in alpha test mode
  19738. */
  19739. needAlphaTesting: boolean;
  19740. /**
  19741. * The list of attribute names used in the shader
  19742. */
  19743. attributes: string[];
  19744. /**
  19745. * The list of unifrom names used in the shader
  19746. */
  19747. uniforms: string[];
  19748. /**
  19749. * The list of UBO names used in the shader
  19750. */
  19751. uniformBuffers: string[];
  19752. /**
  19753. * The list of sampler names used in the shader
  19754. */
  19755. samplers: string[];
  19756. /**
  19757. * The list of defines used in the shader
  19758. */
  19759. defines: string[];
  19760. }
  19761. /**
  19762. * 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.
  19763. *
  19764. * This returned material effects how the mesh will look based on the code in the shaders.
  19765. *
  19766. * @see http://doc.babylonjs.com/how_to/shader_material
  19767. */
  19768. export class ShaderMaterial extends Material {
  19769. private _shaderPath;
  19770. private _options;
  19771. private _textures;
  19772. private _textureArrays;
  19773. private _floats;
  19774. private _ints;
  19775. private _floatsArrays;
  19776. private _colors3;
  19777. private _colors3Arrays;
  19778. private _colors4;
  19779. private _colors4Arrays;
  19780. private _vectors2;
  19781. private _vectors3;
  19782. private _vectors4;
  19783. private _matrices;
  19784. private _matrixArrays;
  19785. private _matrices3x3;
  19786. private _matrices2x2;
  19787. private _vectors2Arrays;
  19788. private _vectors3Arrays;
  19789. private _vectors4Arrays;
  19790. private _cachedWorldViewMatrix;
  19791. private _cachedWorldViewProjectionMatrix;
  19792. private _renderId;
  19793. private _multiview;
  19794. /**
  19795. * Instantiate a new shader material.
  19796. * 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.
  19797. * This returned material effects how the mesh will look based on the code in the shaders.
  19798. * @see http://doc.babylonjs.com/how_to/shader_material
  19799. * @param name Define the name of the material in the scene
  19800. * @param scene Define the scene the material belongs to
  19801. * @param shaderPath Defines the route to the shader code in one of three ways:
  19802. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19803. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  19804. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  19805. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19806. * @param options Define the options used to create the shader
  19807. */
  19808. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19809. /**
  19810. * Gets the shader path used to define the shader code
  19811. * It can be modified to trigger a new compilation
  19812. */
  19813. /**
  19814. * Sets the shader path used to define the shader code
  19815. * It can be modified to trigger a new compilation
  19816. */
  19817. shaderPath: any;
  19818. /**
  19819. * Gets the options used to compile the shader.
  19820. * They can be modified to trigger a new compilation
  19821. */
  19822. readonly options: IShaderMaterialOptions;
  19823. /**
  19824. * Gets the current class name of the material e.g. "ShaderMaterial"
  19825. * Mainly use in serialization.
  19826. * @returns the class name
  19827. */
  19828. getClassName(): string;
  19829. /**
  19830. * Specifies if the material will require alpha blending
  19831. * @returns a boolean specifying if alpha blending is needed
  19832. */
  19833. needAlphaBlending(): boolean;
  19834. /**
  19835. * Specifies if this material should be rendered in alpha test mode
  19836. * @returns a boolean specifying if an alpha test is needed.
  19837. */
  19838. needAlphaTesting(): boolean;
  19839. private _checkUniform;
  19840. /**
  19841. * Set a texture in the shader.
  19842. * @param name Define the name of the uniform samplers as defined in the shader
  19843. * @param texture Define the texture to bind to this sampler
  19844. * @return the material itself allowing "fluent" like uniform updates
  19845. */
  19846. setTexture(name: string, texture: Texture): ShaderMaterial;
  19847. /**
  19848. * Set a texture array in the shader.
  19849. * @param name Define the name of the uniform sampler array as defined in the shader
  19850. * @param textures Define the list of textures to bind to this sampler
  19851. * @return the material itself allowing "fluent" like uniform updates
  19852. */
  19853. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19854. /**
  19855. * Set a float in the shader.
  19856. * @param name Define the name of the uniform as defined in the shader
  19857. * @param value Define the value to give to the uniform
  19858. * @return the material itself allowing "fluent" like uniform updates
  19859. */
  19860. setFloat(name: string, value: number): ShaderMaterial;
  19861. /**
  19862. * Set a int in the shader.
  19863. * @param name Define the name of the uniform as defined in the shader
  19864. * @param value Define the value to give to the uniform
  19865. * @return the material itself allowing "fluent" like uniform updates
  19866. */
  19867. setInt(name: string, value: number): ShaderMaterial;
  19868. /**
  19869. * Set an array of floats in the shader.
  19870. * @param name Define the name of the uniform as defined in the shader
  19871. * @param value Define the value to give to the uniform
  19872. * @return the material itself allowing "fluent" like uniform updates
  19873. */
  19874. setFloats(name: string, value: number[]): ShaderMaterial;
  19875. /**
  19876. * Set a vec3 in the shader from a Color3.
  19877. * @param name Define the name of the uniform as defined in the shader
  19878. * @param value Define the value to give to the uniform
  19879. * @return the material itself allowing "fluent" like uniform updates
  19880. */
  19881. setColor3(name: string, value: Color3): ShaderMaterial;
  19882. /**
  19883. * Set a vec3 array in the shader from a Color3 array.
  19884. * @param name Define the name of the uniform as defined in the shader
  19885. * @param value Define the value to give to the uniform
  19886. * @return the material itself allowing "fluent" like uniform updates
  19887. */
  19888. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19889. /**
  19890. * Set a vec4 in the shader from a Color4.
  19891. * @param name Define the name of the uniform as defined in the shader
  19892. * @param value Define the value to give to the uniform
  19893. * @return the material itself allowing "fluent" like uniform updates
  19894. */
  19895. setColor4(name: string, value: Color4): ShaderMaterial;
  19896. /**
  19897. * Set a vec4 array in the shader from a Color4 array.
  19898. * @param name Define the name of the uniform as defined in the shader
  19899. * @param value Define the value to give to the uniform
  19900. * @return the material itself allowing "fluent" like uniform updates
  19901. */
  19902. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19903. /**
  19904. * Set a vec2 in the shader from a Vector2.
  19905. * @param name Define the name of the uniform as defined in the shader
  19906. * @param value Define the value to give to the uniform
  19907. * @return the material itself allowing "fluent" like uniform updates
  19908. */
  19909. setVector2(name: string, value: Vector2): ShaderMaterial;
  19910. /**
  19911. * Set a vec3 in the shader from a Vector3.
  19912. * @param name Define the name of the uniform as defined in the shader
  19913. * @param value Define the value to give to the uniform
  19914. * @return the material itself allowing "fluent" like uniform updates
  19915. */
  19916. setVector3(name: string, value: Vector3): ShaderMaterial;
  19917. /**
  19918. * Set a vec4 in the shader from a Vector4.
  19919. * @param name Define the name of the uniform as defined in the shader
  19920. * @param value Define the value to give to the uniform
  19921. * @return the material itself allowing "fluent" like uniform updates
  19922. */
  19923. setVector4(name: string, value: Vector4): ShaderMaterial;
  19924. /**
  19925. * Set a mat4 in the shader from a Matrix.
  19926. * @param name Define the name of the uniform as defined in the shader
  19927. * @param value Define the value to give to the uniform
  19928. * @return the material itself allowing "fluent" like uniform updates
  19929. */
  19930. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19931. /**
  19932. * Set a float32Array in the shader from a matrix array.
  19933. * @param name Define the name of the uniform as defined in the shader
  19934. * @param value Define the value to give to the uniform
  19935. * @return the material itself allowing "fluent" like uniform updates
  19936. */
  19937. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  19938. /**
  19939. * Set a mat3 in the shader from a Float32Array.
  19940. * @param name Define the name of the uniform as defined in the shader
  19941. * @param value Define the value to give to the uniform
  19942. * @return the material itself allowing "fluent" like uniform updates
  19943. */
  19944. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19945. /**
  19946. * Set a mat2 in the shader from a Float32Array.
  19947. * @param name Define the name of the uniform as defined in the shader
  19948. * @param value Define the value to give to the uniform
  19949. * @return the material itself allowing "fluent" like uniform updates
  19950. */
  19951. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19952. /**
  19953. * Set a vec2 array in the shader from a number array.
  19954. * @param name Define the name of the uniform as defined in the shader
  19955. * @param value Define the value to give to the uniform
  19956. * @return the material itself allowing "fluent" like uniform updates
  19957. */
  19958. setArray2(name: string, value: number[]): ShaderMaterial;
  19959. /**
  19960. * Set a vec3 array in the shader from a number array.
  19961. * @param name Define the name of the uniform as defined in the shader
  19962. * @param value Define the value to give to the uniform
  19963. * @return the material itself allowing "fluent" like uniform updates
  19964. */
  19965. setArray3(name: string, value: number[]): ShaderMaterial;
  19966. /**
  19967. * Set a vec4 array in the shader from a number array.
  19968. * @param name Define the name of the uniform as defined in the shader
  19969. * @param value Define the value to give to the uniform
  19970. * @return the material itself allowing "fluent" like uniform updates
  19971. */
  19972. setArray4(name: string, value: number[]): ShaderMaterial;
  19973. private _checkCache;
  19974. /**
  19975. * Specifies that the submesh is ready to be used
  19976. * @param mesh defines the mesh to check
  19977. * @param subMesh defines which submesh to check
  19978. * @param useInstances specifies that instances should be used
  19979. * @returns a boolean indicating that the submesh is ready or not
  19980. */
  19981. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19982. /**
  19983. * Checks if the material is ready to render the requested mesh
  19984. * @param mesh Define the mesh to render
  19985. * @param useInstances Define whether or not the material is used with instances
  19986. * @returns true if ready, otherwise false
  19987. */
  19988. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19989. /**
  19990. * Binds the world matrix to the material
  19991. * @param world defines the world transformation matrix
  19992. */
  19993. bindOnlyWorldMatrix(world: Matrix): void;
  19994. /**
  19995. * Binds the material to the mesh
  19996. * @param world defines the world transformation matrix
  19997. * @param mesh defines the mesh to bind the material to
  19998. */
  19999. bind(world: Matrix, mesh?: Mesh): void;
  20000. /**
  20001. * Gets the active textures from the material
  20002. * @returns an array of textures
  20003. */
  20004. getActiveTextures(): BaseTexture[];
  20005. /**
  20006. * Specifies if the material uses a texture
  20007. * @param texture defines the texture to check against the material
  20008. * @returns a boolean specifying if the material uses the texture
  20009. */
  20010. hasTexture(texture: BaseTexture): boolean;
  20011. /**
  20012. * Makes a duplicate of the material, and gives it a new name
  20013. * @param name defines the new name for the duplicated material
  20014. * @returns the cloned material
  20015. */
  20016. clone(name: string): ShaderMaterial;
  20017. /**
  20018. * Disposes the material
  20019. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  20020. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  20021. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  20022. */
  20023. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  20024. /**
  20025. * Serializes this material in a JSON representation
  20026. * @returns the serialized material object
  20027. */
  20028. serialize(): any;
  20029. /**
  20030. * Creates a shader material from parsed shader material data
  20031. * @param source defines the JSON represnetation of the material
  20032. * @param scene defines the hosting scene
  20033. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  20034. * @returns a new material
  20035. */
  20036. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  20037. }
  20038. }
  20039. declare module "babylonjs/Shaders/color.fragment" {
  20040. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  20041. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  20042. /** @hidden */
  20043. export var colorPixelShader: {
  20044. name: string;
  20045. shader: string;
  20046. };
  20047. }
  20048. declare module "babylonjs/Shaders/color.vertex" {
  20049. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  20050. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  20051. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  20052. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  20053. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  20054. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  20055. /** @hidden */
  20056. export var colorVertexShader: {
  20057. name: string;
  20058. shader: string;
  20059. };
  20060. }
  20061. declare module "babylonjs/Meshes/linesMesh" {
  20062. import { Nullable } from "babylonjs/types";
  20063. import { Scene } from "babylonjs/scene";
  20064. import { Color3 } from "babylonjs/Maths/math.color";
  20065. import { Node } from "babylonjs/node";
  20066. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20067. import { Mesh } from "babylonjs/Meshes/mesh";
  20068. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  20069. import { Effect } from "babylonjs/Materials/effect";
  20070. import { Material } from "babylonjs/Materials/material";
  20071. import "babylonjs/Shaders/color.fragment";
  20072. import "babylonjs/Shaders/color.vertex";
  20073. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20074. /**
  20075. * Line mesh
  20076. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  20077. */
  20078. export class LinesMesh extends Mesh {
  20079. /**
  20080. * If vertex color should be applied to the mesh
  20081. */
  20082. readonly useVertexColor?: boolean | undefined;
  20083. /**
  20084. * If vertex alpha should be applied to the mesh
  20085. */
  20086. readonly useVertexAlpha?: boolean | undefined;
  20087. /**
  20088. * Color of the line (Default: White)
  20089. */
  20090. color: Color3;
  20091. /**
  20092. * Alpha of the line (Default: 1)
  20093. */
  20094. alpha: number;
  20095. /**
  20096. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20097. * This margin is expressed in world space coordinates, so its value may vary.
  20098. * Default value is 0.1
  20099. */
  20100. intersectionThreshold: number;
  20101. private _colorShader;
  20102. private color4;
  20103. /**
  20104. * Creates a new LinesMesh
  20105. * @param name defines the name
  20106. * @param scene defines the hosting scene
  20107. * @param parent defines the parent mesh if any
  20108. * @param source defines the optional source LinesMesh used to clone data from
  20109. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  20110. * When false, achieved by calling a clone(), also passing False.
  20111. * This will make creation of children, recursive.
  20112. * @param useVertexColor defines if this LinesMesh supports vertex color
  20113. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  20114. */
  20115. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  20116. /**
  20117. * If vertex color should be applied to the mesh
  20118. */
  20119. useVertexColor?: boolean | undefined,
  20120. /**
  20121. * If vertex alpha should be applied to the mesh
  20122. */
  20123. useVertexAlpha?: boolean | undefined);
  20124. private _addClipPlaneDefine;
  20125. private _removeClipPlaneDefine;
  20126. isReady(): boolean;
  20127. /**
  20128. * Returns the string "LineMesh"
  20129. */
  20130. getClassName(): string;
  20131. /**
  20132. * @hidden
  20133. */
  20134. /**
  20135. * @hidden
  20136. */
  20137. material: Material;
  20138. /**
  20139. * @hidden
  20140. */
  20141. readonly checkCollisions: boolean;
  20142. /** @hidden */
  20143. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  20144. /** @hidden */
  20145. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  20146. /**
  20147. * Disposes of the line mesh
  20148. * @param doNotRecurse If children should be disposed
  20149. */
  20150. dispose(doNotRecurse?: boolean): void;
  20151. /**
  20152. * Returns a new LineMesh object cloned from the current one.
  20153. */
  20154. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  20155. /**
  20156. * Creates a new InstancedLinesMesh object from the mesh model.
  20157. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  20158. * @param name defines the name of the new instance
  20159. * @returns a new InstancedLinesMesh
  20160. */
  20161. createInstance(name: string): InstancedLinesMesh;
  20162. }
  20163. /**
  20164. * Creates an instance based on a source LinesMesh
  20165. */
  20166. export class InstancedLinesMesh extends InstancedMesh {
  20167. /**
  20168. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20169. * This margin is expressed in world space coordinates, so its value may vary.
  20170. * Initilized with the intersectionThreshold value of the source LinesMesh
  20171. */
  20172. intersectionThreshold: number;
  20173. constructor(name: string, source: LinesMesh);
  20174. /**
  20175. * Returns the string "InstancedLinesMesh".
  20176. */
  20177. getClassName(): string;
  20178. }
  20179. }
  20180. declare module "babylonjs/Shaders/line.fragment" {
  20181. /** @hidden */
  20182. export var linePixelShader: {
  20183. name: string;
  20184. shader: string;
  20185. };
  20186. }
  20187. declare module "babylonjs/Shaders/line.vertex" {
  20188. /** @hidden */
  20189. export var lineVertexShader: {
  20190. name: string;
  20191. shader: string;
  20192. };
  20193. }
  20194. declare module "babylonjs/Rendering/edgesRenderer" {
  20195. import { Nullable } from "babylonjs/types";
  20196. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  20197. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20198. import { Vector3 } from "babylonjs/Maths/math.vector";
  20199. import { IDisposable } from "babylonjs/scene";
  20200. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  20201. import "babylonjs/Shaders/line.fragment";
  20202. import "babylonjs/Shaders/line.vertex";
  20203. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  20204. module "babylonjs/Meshes/abstractMesh" {
  20205. interface AbstractMesh {
  20206. /**
  20207. * Gets the edgesRenderer associated with the mesh
  20208. */
  20209. edgesRenderer: Nullable<EdgesRenderer>;
  20210. }
  20211. }
  20212. module "babylonjs/Meshes/linesMesh" {
  20213. interface LinesMesh {
  20214. /**
  20215. * Enables the edge rendering mode on the mesh.
  20216. * This mode makes the mesh edges visible
  20217. * @param epsilon defines the maximal distance between two angles to detect a face
  20218. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20219. * @returns the currentAbstractMesh
  20220. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20221. */
  20222. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  20223. }
  20224. }
  20225. module "babylonjs/Meshes/linesMesh" {
  20226. interface InstancedLinesMesh {
  20227. /**
  20228. * Enables the edge rendering mode on the mesh.
  20229. * This mode makes the mesh edges visible
  20230. * @param epsilon defines the maximal distance between two angles to detect a face
  20231. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20232. * @returns the current InstancedLinesMesh
  20233. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20234. */
  20235. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  20236. }
  20237. }
  20238. /**
  20239. * Defines the minimum contract an Edges renderer should follow.
  20240. */
  20241. export interface IEdgesRenderer extends IDisposable {
  20242. /**
  20243. * Gets or sets a boolean indicating if the edgesRenderer is active
  20244. */
  20245. isEnabled: boolean;
  20246. /**
  20247. * Renders the edges of the attached mesh,
  20248. */
  20249. render(): void;
  20250. /**
  20251. * Checks wether or not the edges renderer is ready to render.
  20252. * @return true if ready, otherwise false.
  20253. */
  20254. isReady(): boolean;
  20255. }
  20256. /**
  20257. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  20258. */
  20259. export class EdgesRenderer implements IEdgesRenderer {
  20260. /**
  20261. * Define the size of the edges with an orthographic camera
  20262. */
  20263. edgesWidthScalerForOrthographic: number;
  20264. /**
  20265. * Define the size of the edges with a perspective camera
  20266. */
  20267. edgesWidthScalerForPerspective: number;
  20268. protected _source: AbstractMesh;
  20269. protected _linesPositions: number[];
  20270. protected _linesNormals: number[];
  20271. protected _linesIndices: number[];
  20272. protected _epsilon: number;
  20273. protected _indicesCount: number;
  20274. protected _lineShader: ShaderMaterial;
  20275. protected _ib: DataBuffer;
  20276. protected _buffers: {
  20277. [key: string]: Nullable<VertexBuffer>;
  20278. };
  20279. protected _checkVerticesInsteadOfIndices: boolean;
  20280. private _meshRebuildObserver;
  20281. private _meshDisposeObserver;
  20282. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  20283. isEnabled: boolean;
  20284. /**
  20285. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  20286. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  20287. * @param source Mesh used to create edges
  20288. * @param epsilon sum of angles in adjacency to check for edge
  20289. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  20290. * @param generateEdgesLines - should generate Lines or only prepare resources.
  20291. */
  20292. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  20293. protected _prepareRessources(): void;
  20294. /** @hidden */
  20295. _rebuild(): void;
  20296. /**
  20297. * Releases the required resources for the edges renderer
  20298. */
  20299. dispose(): void;
  20300. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  20301. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  20302. /**
  20303. * Checks if the pair of p0 and p1 is en edge
  20304. * @param faceIndex
  20305. * @param edge
  20306. * @param faceNormals
  20307. * @param p0
  20308. * @param p1
  20309. * @private
  20310. */
  20311. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  20312. /**
  20313. * push line into the position, normal and index buffer
  20314. * @protected
  20315. */
  20316. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  20317. /**
  20318. * Generates lines edges from adjacencjes
  20319. * @private
  20320. */
  20321. _generateEdgesLines(): void;
  20322. /**
  20323. * Checks wether or not the edges renderer is ready to render.
  20324. * @return true if ready, otherwise false.
  20325. */
  20326. isReady(): boolean;
  20327. /**
  20328. * Renders the edges of the attached mesh,
  20329. */
  20330. render(): void;
  20331. }
  20332. /**
  20333. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  20334. */
  20335. export class LineEdgesRenderer extends EdgesRenderer {
  20336. /**
  20337. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  20338. * @param source LineMesh used to generate edges
  20339. * @param epsilon not important (specified angle for edge detection)
  20340. * @param checkVerticesInsteadOfIndices not important for LineMesh
  20341. */
  20342. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  20343. /**
  20344. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  20345. */
  20346. _generateEdgesLines(): void;
  20347. }
  20348. }
  20349. declare module "babylonjs/Rendering/renderingGroup" {
  20350. import { SmartArray } from "babylonjs/Misc/smartArray";
  20351. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20352. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20353. import { Nullable } from "babylonjs/types";
  20354. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20355. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  20356. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20357. import { Material } from "babylonjs/Materials/material";
  20358. import { Scene } from "babylonjs/scene";
  20359. /**
  20360. * This represents the object necessary to create a rendering group.
  20361. * This is exclusively used and created by the rendering manager.
  20362. * To modify the behavior, you use the available helpers in your scene or meshes.
  20363. * @hidden
  20364. */
  20365. export class RenderingGroup {
  20366. index: number;
  20367. private static _zeroVector;
  20368. private _scene;
  20369. private _opaqueSubMeshes;
  20370. private _transparentSubMeshes;
  20371. private _alphaTestSubMeshes;
  20372. private _depthOnlySubMeshes;
  20373. private _particleSystems;
  20374. private _spriteManagers;
  20375. private _opaqueSortCompareFn;
  20376. private _alphaTestSortCompareFn;
  20377. private _transparentSortCompareFn;
  20378. private _renderOpaque;
  20379. private _renderAlphaTest;
  20380. private _renderTransparent;
  20381. /** @hidden */
  20382. _edgesRenderers: SmartArray<IEdgesRenderer>;
  20383. onBeforeTransparentRendering: () => void;
  20384. /**
  20385. * Set the opaque sort comparison function.
  20386. * If null the sub meshes will be render in the order they were created
  20387. */
  20388. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20389. /**
  20390. * Set the alpha test sort comparison function.
  20391. * If null the sub meshes will be render in the order they were created
  20392. */
  20393. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20394. /**
  20395. * Set the transparent sort comparison function.
  20396. * If null the sub meshes will be render in the order they were created
  20397. */
  20398. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20399. /**
  20400. * Creates a new rendering group.
  20401. * @param index The rendering group index
  20402. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  20403. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  20404. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  20405. */
  20406. 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>);
  20407. /**
  20408. * Render all the sub meshes contained in the group.
  20409. * @param customRenderFunction Used to override the default render behaviour of the group.
  20410. * @returns true if rendered some submeshes.
  20411. */
  20412. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  20413. /**
  20414. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  20415. * @param subMeshes The submeshes to render
  20416. */
  20417. private renderOpaqueSorted;
  20418. /**
  20419. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  20420. * @param subMeshes The submeshes to render
  20421. */
  20422. private renderAlphaTestSorted;
  20423. /**
  20424. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  20425. * @param subMeshes The submeshes to render
  20426. */
  20427. private renderTransparentSorted;
  20428. /**
  20429. * Renders the submeshes in a specified order.
  20430. * @param subMeshes The submeshes to sort before render
  20431. * @param sortCompareFn The comparison function use to sort
  20432. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  20433. * @param transparent Specifies to activate blending if true
  20434. */
  20435. private static renderSorted;
  20436. /**
  20437. * Renders the submeshes in the order they were dispatched (no sort applied).
  20438. * @param subMeshes The submeshes to render
  20439. */
  20440. private static renderUnsorted;
  20441. /**
  20442. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20443. * are rendered back to front if in the same alpha index.
  20444. *
  20445. * @param a The first submesh
  20446. * @param b The second submesh
  20447. * @returns The result of the comparison
  20448. */
  20449. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  20450. /**
  20451. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20452. * are rendered back to front.
  20453. *
  20454. * @param a The first submesh
  20455. * @param b The second submesh
  20456. * @returns The result of the comparison
  20457. */
  20458. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  20459. /**
  20460. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20461. * are rendered front to back (prevent overdraw).
  20462. *
  20463. * @param a The first submesh
  20464. * @param b The second submesh
  20465. * @returns The result of the comparison
  20466. */
  20467. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  20468. /**
  20469. * Resets the different lists of submeshes to prepare a new frame.
  20470. */
  20471. prepare(): void;
  20472. dispose(): void;
  20473. /**
  20474. * Inserts the submesh in its correct queue depending on its material.
  20475. * @param subMesh The submesh to dispatch
  20476. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20477. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20478. */
  20479. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20480. dispatchSprites(spriteManager: ISpriteManager): void;
  20481. dispatchParticles(particleSystem: IParticleSystem): void;
  20482. private _renderParticles;
  20483. private _renderSprites;
  20484. }
  20485. }
  20486. declare module "babylonjs/Rendering/renderingManager" {
  20487. import { Nullable } from "babylonjs/types";
  20488. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20489. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20490. import { SmartArray } from "babylonjs/Misc/smartArray";
  20491. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20492. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20493. import { Material } from "babylonjs/Materials/material";
  20494. import { Scene } from "babylonjs/scene";
  20495. import { Camera } from "babylonjs/Cameras/camera";
  20496. /**
  20497. * Interface describing the different options available in the rendering manager
  20498. * regarding Auto Clear between groups.
  20499. */
  20500. export interface IRenderingManagerAutoClearSetup {
  20501. /**
  20502. * Defines whether or not autoclear is enable.
  20503. */
  20504. autoClear: boolean;
  20505. /**
  20506. * Defines whether or not to autoclear the depth buffer.
  20507. */
  20508. depth: boolean;
  20509. /**
  20510. * Defines whether or not to autoclear the stencil buffer.
  20511. */
  20512. stencil: boolean;
  20513. }
  20514. /**
  20515. * This class is used by the onRenderingGroupObservable
  20516. */
  20517. export class RenderingGroupInfo {
  20518. /**
  20519. * The Scene that being rendered
  20520. */
  20521. scene: Scene;
  20522. /**
  20523. * The camera currently used for the rendering pass
  20524. */
  20525. camera: Nullable<Camera>;
  20526. /**
  20527. * The ID of the renderingGroup being processed
  20528. */
  20529. renderingGroupId: number;
  20530. }
  20531. /**
  20532. * This is the manager responsible of all the rendering for meshes sprites and particles.
  20533. * It is enable to manage the different groups as well as the different necessary sort functions.
  20534. * This should not be used directly aside of the few static configurations
  20535. */
  20536. export class RenderingManager {
  20537. /**
  20538. * The max id used for rendering groups (not included)
  20539. */
  20540. static MAX_RENDERINGGROUPS: number;
  20541. /**
  20542. * The min id used for rendering groups (included)
  20543. */
  20544. static MIN_RENDERINGGROUPS: number;
  20545. /**
  20546. * Used to globally prevent autoclearing scenes.
  20547. */
  20548. static AUTOCLEAR: boolean;
  20549. /**
  20550. * @hidden
  20551. */
  20552. _useSceneAutoClearSetup: boolean;
  20553. private _scene;
  20554. private _renderingGroups;
  20555. private _depthStencilBufferAlreadyCleaned;
  20556. private _autoClearDepthStencil;
  20557. private _customOpaqueSortCompareFn;
  20558. private _customAlphaTestSortCompareFn;
  20559. private _customTransparentSortCompareFn;
  20560. private _renderingGroupInfo;
  20561. /**
  20562. * Instantiates a new rendering group for a particular scene
  20563. * @param scene Defines the scene the groups belongs to
  20564. */
  20565. constructor(scene: Scene);
  20566. private _clearDepthStencilBuffer;
  20567. /**
  20568. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20569. * @hidden
  20570. */
  20571. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20572. /**
  20573. * Resets the different information of the group to prepare a new frame
  20574. * @hidden
  20575. */
  20576. reset(): void;
  20577. /**
  20578. * Dispose and release the group and its associated resources.
  20579. * @hidden
  20580. */
  20581. dispose(): void;
  20582. /**
  20583. * Clear the info related to rendering groups preventing retention points during dispose.
  20584. */
  20585. freeRenderingGroups(): void;
  20586. private _prepareRenderingGroup;
  20587. /**
  20588. * Add a sprite manager to the rendering manager in order to render it this frame.
  20589. * @param spriteManager Define the sprite manager to render
  20590. */
  20591. dispatchSprites(spriteManager: ISpriteManager): void;
  20592. /**
  20593. * Add a particle system to the rendering manager in order to render it this frame.
  20594. * @param particleSystem Define the particle system to render
  20595. */
  20596. dispatchParticles(particleSystem: IParticleSystem): void;
  20597. /**
  20598. * Add a submesh to the manager in order to render it this frame
  20599. * @param subMesh The submesh to dispatch
  20600. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20601. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20602. */
  20603. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20604. /**
  20605. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20606. * This allowed control for front to back rendering or reversly depending of the special needs.
  20607. *
  20608. * @param renderingGroupId The rendering group id corresponding to its index
  20609. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20610. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20611. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20612. */
  20613. 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;
  20614. /**
  20615. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20616. *
  20617. * @param renderingGroupId The rendering group id corresponding to its index
  20618. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20619. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20620. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20621. */
  20622. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20623. /**
  20624. * Gets the current auto clear configuration for one rendering group of the rendering
  20625. * manager.
  20626. * @param index the rendering group index to get the information for
  20627. * @returns The auto clear setup for the requested rendering group
  20628. */
  20629. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20630. }
  20631. }
  20632. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20633. import { Observable } from "babylonjs/Misc/observable";
  20634. import { SmartArray } from "babylonjs/Misc/smartArray";
  20635. import { Nullable } from "babylonjs/types";
  20636. import { Camera } from "babylonjs/Cameras/camera";
  20637. import { Scene } from "babylonjs/scene";
  20638. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20639. import { Color4 } from "babylonjs/Maths/math.color";
  20640. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20641. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20642. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20643. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20644. import { Texture } from "babylonjs/Materials/Textures/texture";
  20645. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20646. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20647. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20648. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  20649. import { Engine } from "babylonjs/Engines/engine";
  20650. /**
  20651. * This Helps creating a texture that will be created from a camera in your scene.
  20652. * It is basically a dynamic texture that could be used to create special effects for instance.
  20653. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20654. */
  20655. export class RenderTargetTexture extends Texture {
  20656. isCube: boolean;
  20657. /**
  20658. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20659. */
  20660. static readonly REFRESHRATE_RENDER_ONCE: number;
  20661. /**
  20662. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20663. */
  20664. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20665. /**
  20666. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20667. * the central point of your effect and can save a lot of performances.
  20668. */
  20669. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20670. /**
  20671. * Use this predicate to dynamically define the list of mesh you want to render.
  20672. * If set, the renderList property will be overwritten.
  20673. */
  20674. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20675. private _renderList;
  20676. /**
  20677. * Use this list to define the list of mesh you want to render.
  20678. */
  20679. renderList: Nullable<Array<AbstractMesh>>;
  20680. private _hookArray;
  20681. /**
  20682. * Define if particles should be rendered in your texture.
  20683. */
  20684. renderParticles: boolean;
  20685. /**
  20686. * Define if sprites should be rendered in your texture.
  20687. */
  20688. renderSprites: boolean;
  20689. /**
  20690. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20691. */
  20692. coordinatesMode: number;
  20693. /**
  20694. * Define the camera used to render the texture.
  20695. */
  20696. activeCamera: Nullable<Camera>;
  20697. /**
  20698. * Override the render function of the texture with your own one.
  20699. */
  20700. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20701. /**
  20702. * Define if camera post processes should be use while rendering the texture.
  20703. */
  20704. useCameraPostProcesses: boolean;
  20705. /**
  20706. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20707. */
  20708. ignoreCameraViewport: boolean;
  20709. private _postProcessManager;
  20710. private _postProcesses;
  20711. private _resizeObserver;
  20712. /**
  20713. * An event triggered when the texture is unbind.
  20714. */
  20715. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20716. /**
  20717. * An event triggered when the texture is unbind.
  20718. */
  20719. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20720. private _onAfterUnbindObserver;
  20721. /**
  20722. * Set a after unbind callback in the texture.
  20723. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20724. */
  20725. onAfterUnbind: () => void;
  20726. /**
  20727. * An event triggered before rendering the texture
  20728. */
  20729. onBeforeRenderObservable: Observable<number>;
  20730. private _onBeforeRenderObserver;
  20731. /**
  20732. * Set a before render callback in the texture.
  20733. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20734. */
  20735. onBeforeRender: (faceIndex: number) => void;
  20736. /**
  20737. * An event triggered after rendering the texture
  20738. */
  20739. onAfterRenderObservable: Observable<number>;
  20740. private _onAfterRenderObserver;
  20741. /**
  20742. * Set a after render callback in the texture.
  20743. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20744. */
  20745. onAfterRender: (faceIndex: number) => void;
  20746. /**
  20747. * An event triggered after the texture clear
  20748. */
  20749. onClearObservable: Observable<Engine>;
  20750. private _onClearObserver;
  20751. /**
  20752. * Set a clear callback in the texture.
  20753. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20754. */
  20755. onClear: (Engine: Engine) => void;
  20756. /**
  20757. * An event triggered when the texture is resized.
  20758. */
  20759. onResizeObservable: Observable<RenderTargetTexture>;
  20760. /**
  20761. * Define the clear color of the Render Target if it should be different from the scene.
  20762. */
  20763. clearColor: Color4;
  20764. protected _size: number | {
  20765. width: number;
  20766. height: number;
  20767. };
  20768. protected _initialSizeParameter: number | {
  20769. width: number;
  20770. height: number;
  20771. } | {
  20772. ratio: number;
  20773. };
  20774. protected _sizeRatio: Nullable<number>;
  20775. /** @hidden */
  20776. _generateMipMaps: boolean;
  20777. protected _renderingManager: RenderingManager;
  20778. /** @hidden */
  20779. _waitingRenderList: string[];
  20780. protected _doNotChangeAspectRatio: boolean;
  20781. protected _currentRefreshId: number;
  20782. protected _refreshRate: number;
  20783. protected _textureMatrix: Matrix;
  20784. protected _samples: number;
  20785. protected _renderTargetOptions: RenderTargetCreationOptions;
  20786. /**
  20787. * Gets render target creation options that were used.
  20788. */
  20789. readonly renderTargetOptions: RenderTargetCreationOptions;
  20790. protected _engine: Engine;
  20791. protected _onRatioRescale(): void;
  20792. /**
  20793. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20794. * It must define where the camera used to render the texture is set
  20795. */
  20796. boundingBoxPosition: Vector3;
  20797. private _boundingBoxSize;
  20798. /**
  20799. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20800. * When defined, the cubemap will switch to local mode
  20801. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20802. * @example https://www.babylonjs-playground.com/#RNASML
  20803. */
  20804. boundingBoxSize: Vector3;
  20805. /**
  20806. * In case the RTT has been created with a depth texture, get the associated
  20807. * depth texture.
  20808. * Otherwise, return null.
  20809. */
  20810. depthStencilTexture: Nullable<InternalTexture>;
  20811. /**
  20812. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20813. * or used a shadow, depth texture...
  20814. * @param name The friendly name of the texture
  20815. * @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)
  20816. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20817. * @param generateMipMaps True if mip maps need to be generated after render.
  20818. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20819. * @param type The type of the buffer in the RTT (int, half float, float...)
  20820. * @param isCube True if a cube texture needs to be created
  20821. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20822. * @param generateDepthBuffer True to generate a depth buffer
  20823. * @param generateStencilBuffer True to generate a stencil buffer
  20824. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20825. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20826. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20827. */
  20828. constructor(name: string, size: number | {
  20829. width: number;
  20830. height: number;
  20831. } | {
  20832. ratio: number;
  20833. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20834. /**
  20835. * Creates a depth stencil texture.
  20836. * This is only available in WebGL 2 or with the depth texture extension available.
  20837. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20838. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20839. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20840. */
  20841. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20842. private _processSizeParameter;
  20843. /**
  20844. * Define the number of samples to use in case of MSAA.
  20845. * It defaults to one meaning no MSAA has been enabled.
  20846. */
  20847. samples: number;
  20848. /**
  20849. * Resets the refresh counter of the texture and start bak from scratch.
  20850. * Could be useful to regenerate the texture if it is setup to render only once.
  20851. */
  20852. resetRefreshCounter(): void;
  20853. /**
  20854. * Define the refresh rate of the texture or the rendering frequency.
  20855. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20856. */
  20857. refreshRate: number;
  20858. /**
  20859. * Adds a post process to the render target rendering passes.
  20860. * @param postProcess define the post process to add
  20861. */
  20862. addPostProcess(postProcess: PostProcess): void;
  20863. /**
  20864. * Clear all the post processes attached to the render target
  20865. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20866. */
  20867. clearPostProcesses(dispose?: boolean): void;
  20868. /**
  20869. * Remove one of the post process from the list of attached post processes to the texture
  20870. * @param postProcess define the post process to remove from the list
  20871. */
  20872. removePostProcess(postProcess: PostProcess): void;
  20873. /** @hidden */
  20874. _shouldRender(): boolean;
  20875. /**
  20876. * Gets the actual render size of the texture.
  20877. * @returns the width of the render size
  20878. */
  20879. getRenderSize(): number;
  20880. /**
  20881. * Gets the actual render width of the texture.
  20882. * @returns the width of the render size
  20883. */
  20884. getRenderWidth(): number;
  20885. /**
  20886. * Gets the actual render height of the texture.
  20887. * @returns the height of the render size
  20888. */
  20889. getRenderHeight(): number;
  20890. /**
  20891. * Get if the texture can be rescaled or not.
  20892. */
  20893. readonly canRescale: boolean;
  20894. /**
  20895. * Resize the texture using a ratio.
  20896. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20897. */
  20898. scale(ratio: number): void;
  20899. /**
  20900. * Get the texture reflection matrix used to rotate/transform the reflection.
  20901. * @returns the reflection matrix
  20902. */
  20903. getReflectionTextureMatrix(): Matrix;
  20904. /**
  20905. * Resize the texture to a new desired size.
  20906. * Be carrefull as it will recreate all the data in the new texture.
  20907. * @param size Define the new size. It can be:
  20908. * - a number for squared texture,
  20909. * - an object containing { width: number, height: number }
  20910. * - or an object containing a ratio { ratio: number }
  20911. */
  20912. resize(size: number | {
  20913. width: number;
  20914. height: number;
  20915. } | {
  20916. ratio: number;
  20917. }): void;
  20918. /**
  20919. * Renders all the objects from the render list into the texture.
  20920. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20921. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20922. */
  20923. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20924. private _bestReflectionRenderTargetDimension;
  20925. /**
  20926. * @hidden
  20927. * @param faceIndex face index to bind to if this is a cubetexture
  20928. */
  20929. _bindFrameBuffer(faceIndex?: number): void;
  20930. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20931. private renderToTarget;
  20932. /**
  20933. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20934. * This allowed control for front to back rendering or reversly depending of the special needs.
  20935. *
  20936. * @param renderingGroupId The rendering group id corresponding to its index
  20937. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20938. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20939. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20940. */
  20941. 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;
  20942. /**
  20943. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20944. *
  20945. * @param renderingGroupId The rendering group id corresponding to its index
  20946. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20947. */
  20948. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20949. /**
  20950. * Clones the texture.
  20951. * @returns the cloned texture
  20952. */
  20953. clone(): RenderTargetTexture;
  20954. /**
  20955. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20956. * @returns The JSON representation of the texture
  20957. */
  20958. serialize(): any;
  20959. /**
  20960. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20961. */
  20962. disposeFramebufferObjects(): void;
  20963. /**
  20964. * Dispose the texture and release its associated resources.
  20965. */
  20966. dispose(): void;
  20967. /** @hidden */
  20968. _rebuild(): void;
  20969. /**
  20970. * Clear the info related to rendering groups preventing retention point in material dispose.
  20971. */
  20972. freeRenderingGroups(): void;
  20973. /**
  20974. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20975. * @returns the view count
  20976. */
  20977. getViewCount(): number;
  20978. }
  20979. }
  20980. declare module "babylonjs/Materials/material" {
  20981. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20982. import { SmartArray } from "babylonjs/Misc/smartArray";
  20983. import { Observable } from "babylonjs/Misc/observable";
  20984. import { Nullable } from "babylonjs/types";
  20985. import { Scene } from "babylonjs/scene";
  20986. import { Matrix } from "babylonjs/Maths/math.vector";
  20987. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20988. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20989. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20990. import { Effect } from "babylonjs/Materials/effect";
  20991. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20992. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20993. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20994. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20995. import { Mesh } from "babylonjs/Meshes/mesh";
  20996. import { Animation } from "babylonjs/Animations/animation";
  20997. /**
  20998. * Options for compiling materials.
  20999. */
  21000. export interface IMaterialCompilationOptions {
  21001. /**
  21002. * Defines whether clip planes are enabled.
  21003. */
  21004. clipPlane: boolean;
  21005. /**
  21006. * Defines whether instances are enabled.
  21007. */
  21008. useInstances: boolean;
  21009. }
  21010. /**
  21011. * Base class for the main features of a material in Babylon.js
  21012. */
  21013. export class Material implements IAnimatable {
  21014. /**
  21015. * Returns the triangle fill mode
  21016. */
  21017. static readonly TriangleFillMode: number;
  21018. /**
  21019. * Returns the wireframe mode
  21020. */
  21021. static readonly WireFrameFillMode: number;
  21022. /**
  21023. * Returns the point fill mode
  21024. */
  21025. static readonly PointFillMode: number;
  21026. /**
  21027. * Returns the point list draw mode
  21028. */
  21029. static readonly PointListDrawMode: number;
  21030. /**
  21031. * Returns the line list draw mode
  21032. */
  21033. static readonly LineListDrawMode: number;
  21034. /**
  21035. * Returns the line loop draw mode
  21036. */
  21037. static readonly LineLoopDrawMode: number;
  21038. /**
  21039. * Returns the line strip draw mode
  21040. */
  21041. static readonly LineStripDrawMode: number;
  21042. /**
  21043. * Returns the triangle strip draw mode
  21044. */
  21045. static readonly TriangleStripDrawMode: number;
  21046. /**
  21047. * Returns the triangle fan draw mode
  21048. */
  21049. static readonly TriangleFanDrawMode: number;
  21050. /**
  21051. * Stores the clock-wise side orientation
  21052. */
  21053. static readonly ClockWiseSideOrientation: number;
  21054. /**
  21055. * Stores the counter clock-wise side orientation
  21056. */
  21057. static readonly CounterClockWiseSideOrientation: number;
  21058. /**
  21059. * The dirty texture flag value
  21060. */
  21061. static readonly TextureDirtyFlag: number;
  21062. /**
  21063. * The dirty light flag value
  21064. */
  21065. static readonly LightDirtyFlag: number;
  21066. /**
  21067. * The dirty fresnel flag value
  21068. */
  21069. static readonly FresnelDirtyFlag: number;
  21070. /**
  21071. * The dirty attribute flag value
  21072. */
  21073. static readonly AttributesDirtyFlag: number;
  21074. /**
  21075. * The dirty misc flag value
  21076. */
  21077. static readonly MiscDirtyFlag: number;
  21078. /**
  21079. * The all dirty flag value
  21080. */
  21081. static readonly AllDirtyFlag: number;
  21082. /**
  21083. * The ID of the material
  21084. */
  21085. id: string;
  21086. /**
  21087. * Gets or sets the unique id of the material
  21088. */
  21089. uniqueId: number;
  21090. /**
  21091. * The name of the material
  21092. */
  21093. name: string;
  21094. /**
  21095. * Gets or sets user defined metadata
  21096. */
  21097. metadata: any;
  21098. /**
  21099. * For internal use only. Please do not use.
  21100. */
  21101. reservedDataStore: any;
  21102. /**
  21103. * Specifies if the ready state should be checked on each call
  21104. */
  21105. checkReadyOnEveryCall: boolean;
  21106. /**
  21107. * Specifies if the ready state should be checked once
  21108. */
  21109. checkReadyOnlyOnce: boolean;
  21110. /**
  21111. * The state of the material
  21112. */
  21113. state: string;
  21114. /**
  21115. * The alpha value of the material
  21116. */
  21117. protected _alpha: number;
  21118. /**
  21119. * List of inspectable custom properties (used by the Inspector)
  21120. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  21121. */
  21122. inspectableCustomProperties: IInspectable[];
  21123. /**
  21124. * Sets the alpha value of the material
  21125. */
  21126. /**
  21127. * Gets the alpha value of the material
  21128. */
  21129. alpha: number;
  21130. /**
  21131. * Specifies if back face culling is enabled
  21132. */
  21133. protected _backFaceCulling: boolean;
  21134. /**
  21135. * Sets the back-face culling state
  21136. */
  21137. /**
  21138. * Gets the back-face culling state
  21139. */
  21140. backFaceCulling: boolean;
  21141. /**
  21142. * Stores the value for side orientation
  21143. */
  21144. sideOrientation: number;
  21145. /**
  21146. * Callback triggered when the material is compiled
  21147. */
  21148. onCompiled: Nullable<(effect: Effect) => void>;
  21149. /**
  21150. * Callback triggered when an error occurs
  21151. */
  21152. onError: Nullable<(effect: Effect, errors: string) => void>;
  21153. /**
  21154. * Callback triggered to get the render target textures
  21155. */
  21156. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  21157. /**
  21158. * Gets a boolean indicating that current material needs to register RTT
  21159. */
  21160. readonly hasRenderTargetTextures: boolean;
  21161. /**
  21162. * Specifies if the material should be serialized
  21163. */
  21164. doNotSerialize: boolean;
  21165. /**
  21166. * @hidden
  21167. */
  21168. _storeEffectOnSubMeshes: boolean;
  21169. /**
  21170. * Stores the animations for the material
  21171. */
  21172. animations: Nullable<Array<Animation>>;
  21173. /**
  21174. * An event triggered when the material is disposed
  21175. */
  21176. onDisposeObservable: Observable<Material>;
  21177. /**
  21178. * An observer which watches for dispose events
  21179. */
  21180. private _onDisposeObserver;
  21181. private _onUnBindObservable;
  21182. /**
  21183. * Called during a dispose event
  21184. */
  21185. onDispose: () => void;
  21186. private _onBindObservable;
  21187. /**
  21188. * An event triggered when the material is bound
  21189. */
  21190. readonly onBindObservable: Observable<AbstractMesh>;
  21191. /**
  21192. * An observer which watches for bind events
  21193. */
  21194. private _onBindObserver;
  21195. /**
  21196. * Called during a bind event
  21197. */
  21198. onBind: (Mesh: AbstractMesh) => void;
  21199. /**
  21200. * An event triggered when the material is unbound
  21201. */
  21202. readonly onUnBindObservable: Observable<Material>;
  21203. /**
  21204. * Stores the value of the alpha mode
  21205. */
  21206. private _alphaMode;
  21207. /**
  21208. * Sets the value of the alpha mode.
  21209. *
  21210. * | Value | Type | Description |
  21211. * | --- | --- | --- |
  21212. * | 0 | ALPHA_DISABLE | |
  21213. * | 1 | ALPHA_ADD | |
  21214. * | 2 | ALPHA_COMBINE | |
  21215. * | 3 | ALPHA_SUBTRACT | |
  21216. * | 4 | ALPHA_MULTIPLY | |
  21217. * | 5 | ALPHA_MAXIMIZED | |
  21218. * | 6 | ALPHA_ONEONE | |
  21219. * | 7 | ALPHA_PREMULTIPLIED | |
  21220. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  21221. * | 9 | ALPHA_INTERPOLATE | |
  21222. * | 10 | ALPHA_SCREENMODE | |
  21223. *
  21224. */
  21225. /**
  21226. * Gets the value of the alpha mode
  21227. */
  21228. alphaMode: number;
  21229. /**
  21230. * Stores the state of the need depth pre-pass value
  21231. */
  21232. private _needDepthPrePass;
  21233. /**
  21234. * Sets the need depth pre-pass value
  21235. */
  21236. /**
  21237. * Gets the depth pre-pass value
  21238. */
  21239. needDepthPrePass: boolean;
  21240. /**
  21241. * Specifies if depth writing should be disabled
  21242. */
  21243. disableDepthWrite: boolean;
  21244. /**
  21245. * Specifies if depth writing should be forced
  21246. */
  21247. forceDepthWrite: boolean;
  21248. /**
  21249. * Specifies the depth function that should be used. 0 means the default engine function
  21250. */
  21251. depthFunction: number;
  21252. /**
  21253. * Specifies if there should be a separate pass for culling
  21254. */
  21255. separateCullingPass: boolean;
  21256. /**
  21257. * Stores the state specifing if fog should be enabled
  21258. */
  21259. private _fogEnabled;
  21260. /**
  21261. * Sets the state for enabling fog
  21262. */
  21263. /**
  21264. * Gets the value of the fog enabled state
  21265. */
  21266. fogEnabled: boolean;
  21267. /**
  21268. * Stores the size of points
  21269. */
  21270. pointSize: number;
  21271. /**
  21272. * Stores the z offset value
  21273. */
  21274. zOffset: number;
  21275. /**
  21276. * Gets a value specifying if wireframe mode is enabled
  21277. */
  21278. /**
  21279. * Sets the state of wireframe mode
  21280. */
  21281. wireframe: boolean;
  21282. /**
  21283. * Gets the value specifying if point clouds are enabled
  21284. */
  21285. /**
  21286. * Sets the state of point cloud mode
  21287. */
  21288. pointsCloud: boolean;
  21289. /**
  21290. * Gets the material fill mode
  21291. */
  21292. /**
  21293. * Sets the material fill mode
  21294. */
  21295. fillMode: number;
  21296. /**
  21297. * @hidden
  21298. * Stores the effects for the material
  21299. */
  21300. _effect: Nullable<Effect>;
  21301. /**
  21302. * @hidden
  21303. * Specifies if the material was previously ready
  21304. */
  21305. _wasPreviouslyReady: boolean;
  21306. /**
  21307. * Specifies if uniform buffers should be used
  21308. */
  21309. private _useUBO;
  21310. /**
  21311. * Stores a reference to the scene
  21312. */
  21313. private _scene;
  21314. /**
  21315. * Stores the fill mode state
  21316. */
  21317. private _fillMode;
  21318. /**
  21319. * Specifies if the depth write state should be cached
  21320. */
  21321. private _cachedDepthWriteState;
  21322. /**
  21323. * Specifies if the depth function state should be cached
  21324. */
  21325. private _cachedDepthFunctionState;
  21326. /**
  21327. * Stores the uniform buffer
  21328. */
  21329. protected _uniformBuffer: UniformBuffer;
  21330. /** @hidden */
  21331. _indexInSceneMaterialArray: number;
  21332. /** @hidden */
  21333. meshMap: Nullable<{
  21334. [id: string]: AbstractMesh | undefined;
  21335. }>;
  21336. /**
  21337. * Creates a material instance
  21338. * @param name defines the name of the material
  21339. * @param scene defines the scene to reference
  21340. * @param doNotAdd specifies if the material should be added to the scene
  21341. */
  21342. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  21343. /**
  21344. * Returns a string representation of the current material
  21345. * @param fullDetails defines a boolean indicating which levels of logging is desired
  21346. * @returns a string with material information
  21347. */
  21348. toString(fullDetails?: boolean): string;
  21349. /**
  21350. * Gets the class name of the material
  21351. * @returns a string with the class name of the material
  21352. */
  21353. getClassName(): string;
  21354. /**
  21355. * Specifies if updates for the material been locked
  21356. */
  21357. readonly isFrozen: boolean;
  21358. /**
  21359. * Locks updates for the material
  21360. */
  21361. freeze(): void;
  21362. /**
  21363. * Unlocks updates for the material
  21364. */
  21365. unfreeze(): void;
  21366. /**
  21367. * Specifies if the material is ready to be used
  21368. * @param mesh defines the mesh to check
  21369. * @param useInstances specifies if instances should be used
  21370. * @returns a boolean indicating if the material is ready to be used
  21371. */
  21372. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  21373. /**
  21374. * Specifies that the submesh is ready to be used
  21375. * @param mesh defines the mesh to check
  21376. * @param subMesh defines which submesh to check
  21377. * @param useInstances specifies that instances should be used
  21378. * @returns a boolean indicating that the submesh is ready or not
  21379. */
  21380. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21381. /**
  21382. * Returns the material effect
  21383. * @returns the effect associated with the material
  21384. */
  21385. getEffect(): Nullable<Effect>;
  21386. /**
  21387. * Returns the current scene
  21388. * @returns a Scene
  21389. */
  21390. getScene(): Scene;
  21391. /**
  21392. * Specifies if the material will require alpha blending
  21393. * @returns a boolean specifying if alpha blending is needed
  21394. */
  21395. needAlphaBlending(): boolean;
  21396. /**
  21397. * Specifies if the mesh will require alpha blending
  21398. * @param mesh defines the mesh to check
  21399. * @returns a boolean specifying if alpha blending is needed for the mesh
  21400. */
  21401. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  21402. /**
  21403. * Specifies if this material should be rendered in alpha test mode
  21404. * @returns a boolean specifying if an alpha test is needed.
  21405. */
  21406. needAlphaTesting(): boolean;
  21407. /**
  21408. * Gets the texture used for the alpha test
  21409. * @returns the texture to use for alpha testing
  21410. */
  21411. getAlphaTestTexture(): Nullable<BaseTexture>;
  21412. /**
  21413. * Marks the material to indicate that it needs to be re-calculated
  21414. */
  21415. markDirty(): void;
  21416. /** @hidden */
  21417. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  21418. /**
  21419. * Binds the material to the mesh
  21420. * @param world defines the world transformation matrix
  21421. * @param mesh defines the mesh to bind the material to
  21422. */
  21423. bind(world: Matrix, mesh?: Mesh): void;
  21424. /**
  21425. * Binds the submesh to the material
  21426. * @param world defines the world transformation matrix
  21427. * @param mesh defines the mesh containing the submesh
  21428. * @param subMesh defines the submesh to bind the material to
  21429. */
  21430. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  21431. /**
  21432. * Binds the world matrix to the material
  21433. * @param world defines the world transformation matrix
  21434. */
  21435. bindOnlyWorldMatrix(world: Matrix): void;
  21436. /**
  21437. * Binds the scene's uniform buffer to the effect.
  21438. * @param effect defines the effect to bind to the scene uniform buffer
  21439. * @param sceneUbo defines the uniform buffer storing scene data
  21440. */
  21441. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  21442. /**
  21443. * Binds the view matrix to the effect
  21444. * @param effect defines the effect to bind the view matrix to
  21445. */
  21446. bindView(effect: Effect): void;
  21447. /**
  21448. * Binds the view projection matrix to the effect
  21449. * @param effect defines the effect to bind the view projection matrix to
  21450. */
  21451. bindViewProjection(effect: Effect): void;
  21452. /**
  21453. * Specifies if material alpha testing should be turned on for the mesh
  21454. * @param mesh defines the mesh to check
  21455. */
  21456. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  21457. /**
  21458. * Processes to execute after binding the material to a mesh
  21459. * @param mesh defines the rendered mesh
  21460. */
  21461. protected _afterBind(mesh?: Mesh): void;
  21462. /**
  21463. * Unbinds the material from the mesh
  21464. */
  21465. unbind(): void;
  21466. /**
  21467. * Gets the active textures from the material
  21468. * @returns an array of textures
  21469. */
  21470. getActiveTextures(): BaseTexture[];
  21471. /**
  21472. * Specifies if the material uses a texture
  21473. * @param texture defines the texture to check against the material
  21474. * @returns a boolean specifying if the material uses the texture
  21475. */
  21476. hasTexture(texture: BaseTexture): boolean;
  21477. /**
  21478. * Makes a duplicate of the material, and gives it a new name
  21479. * @param name defines the new name for the duplicated material
  21480. * @returns the cloned material
  21481. */
  21482. clone(name: string): Nullable<Material>;
  21483. /**
  21484. * Gets the meshes bound to the material
  21485. * @returns an array of meshes bound to the material
  21486. */
  21487. getBindedMeshes(): AbstractMesh[];
  21488. /**
  21489. * Force shader compilation
  21490. * @param mesh defines the mesh associated with this material
  21491. * @param onCompiled defines a function to execute once the material is compiled
  21492. * @param options defines the options to configure the compilation
  21493. * @param onError defines a function to execute if the material fails compiling
  21494. */
  21495. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  21496. /**
  21497. * Force shader compilation
  21498. * @param mesh defines the mesh that will use this material
  21499. * @param options defines additional options for compiling the shaders
  21500. * @returns a promise that resolves when the compilation completes
  21501. */
  21502. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  21503. private static readonly _AllDirtyCallBack;
  21504. private static readonly _ImageProcessingDirtyCallBack;
  21505. private static readonly _TextureDirtyCallBack;
  21506. private static readonly _FresnelDirtyCallBack;
  21507. private static readonly _MiscDirtyCallBack;
  21508. private static readonly _LightsDirtyCallBack;
  21509. private static readonly _AttributeDirtyCallBack;
  21510. private static _FresnelAndMiscDirtyCallBack;
  21511. private static _TextureAndMiscDirtyCallBack;
  21512. private static readonly _DirtyCallbackArray;
  21513. private static readonly _RunDirtyCallBacks;
  21514. /**
  21515. * Marks a define in the material to indicate that it needs to be re-computed
  21516. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  21517. */
  21518. markAsDirty(flag: number): void;
  21519. /**
  21520. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  21521. * @param func defines a function which checks material defines against the submeshes
  21522. */
  21523. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  21524. /**
  21525. * Indicates that we need to re-calculated for all submeshes
  21526. */
  21527. protected _markAllSubMeshesAsAllDirty(): void;
  21528. /**
  21529. * Indicates that image processing needs to be re-calculated for all submeshes
  21530. */
  21531. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  21532. /**
  21533. * Indicates that textures need to be re-calculated for all submeshes
  21534. */
  21535. protected _markAllSubMeshesAsTexturesDirty(): void;
  21536. /**
  21537. * Indicates that fresnel needs to be re-calculated for all submeshes
  21538. */
  21539. protected _markAllSubMeshesAsFresnelDirty(): void;
  21540. /**
  21541. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  21542. */
  21543. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  21544. /**
  21545. * Indicates that lights need to be re-calculated for all submeshes
  21546. */
  21547. protected _markAllSubMeshesAsLightsDirty(): void;
  21548. /**
  21549. * Indicates that attributes need to be re-calculated for all submeshes
  21550. */
  21551. protected _markAllSubMeshesAsAttributesDirty(): void;
  21552. /**
  21553. * Indicates that misc needs to be re-calculated for all submeshes
  21554. */
  21555. protected _markAllSubMeshesAsMiscDirty(): void;
  21556. /**
  21557. * Indicates that textures and misc need to be re-calculated for all submeshes
  21558. */
  21559. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  21560. /**
  21561. * Disposes the material
  21562. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  21563. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  21564. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  21565. */
  21566. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  21567. /** @hidden */
  21568. private releaseVertexArrayObject;
  21569. /**
  21570. * Serializes this material
  21571. * @returns the serialized material object
  21572. */
  21573. serialize(): any;
  21574. /**
  21575. * Creates a material from parsed material data
  21576. * @param parsedMaterial defines parsed material data
  21577. * @param scene defines the hosting scene
  21578. * @param rootUrl defines the root URL to use to load textures
  21579. * @returns a new material
  21580. */
  21581. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21582. }
  21583. }
  21584. declare module "babylonjs/Materials/multiMaterial" {
  21585. import { Nullable } from "babylonjs/types";
  21586. import { Scene } from "babylonjs/scene";
  21587. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21588. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21589. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21590. import { Material } from "babylonjs/Materials/material";
  21591. /**
  21592. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21593. * separate meshes. This can be use to improve performances.
  21594. * @see http://doc.babylonjs.com/how_to/multi_materials
  21595. */
  21596. export class MultiMaterial extends Material {
  21597. private _subMaterials;
  21598. /**
  21599. * Gets or Sets the list of Materials used within the multi material.
  21600. * They need to be ordered according to the submeshes order in the associated mesh
  21601. */
  21602. subMaterials: Nullable<Material>[];
  21603. /**
  21604. * Function used to align with Node.getChildren()
  21605. * @returns the list of Materials used within the multi material
  21606. */
  21607. getChildren(): Nullable<Material>[];
  21608. /**
  21609. * Instantiates a new Multi Material
  21610. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21611. * separate meshes. This can be use to improve performances.
  21612. * @see http://doc.babylonjs.com/how_to/multi_materials
  21613. * @param name Define the name in the scene
  21614. * @param scene Define the scene the material belongs to
  21615. */
  21616. constructor(name: string, scene: Scene);
  21617. private _hookArray;
  21618. /**
  21619. * Get one of the submaterial by its index in the submaterials array
  21620. * @param index The index to look the sub material at
  21621. * @returns The Material if the index has been defined
  21622. */
  21623. getSubMaterial(index: number): Nullable<Material>;
  21624. /**
  21625. * Get the list of active textures for the whole sub materials list.
  21626. * @returns All the textures that will be used during the rendering
  21627. */
  21628. getActiveTextures(): BaseTexture[];
  21629. /**
  21630. * Gets the current class name of the material e.g. "MultiMaterial"
  21631. * Mainly use in serialization.
  21632. * @returns the class name
  21633. */
  21634. getClassName(): string;
  21635. /**
  21636. * Checks if the material is ready to render the requested sub mesh
  21637. * @param mesh Define the mesh the submesh belongs to
  21638. * @param subMesh Define the sub mesh to look readyness for
  21639. * @param useInstances Define whether or not the material is used with instances
  21640. * @returns true if ready, otherwise false
  21641. */
  21642. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21643. /**
  21644. * Clones the current material and its related sub materials
  21645. * @param name Define the name of the newly cloned material
  21646. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21647. * @returns the cloned material
  21648. */
  21649. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21650. /**
  21651. * Serializes the materials into a JSON representation.
  21652. * @returns the JSON representation
  21653. */
  21654. serialize(): any;
  21655. /**
  21656. * Dispose the material and release its associated resources
  21657. * @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)
  21658. * @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)
  21659. * @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)
  21660. */
  21661. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21662. /**
  21663. * Creates a MultiMaterial from parsed MultiMaterial data.
  21664. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21665. * @param scene defines the hosting scene
  21666. * @returns a new MultiMaterial
  21667. */
  21668. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21669. }
  21670. }
  21671. declare module "babylonjs/Meshes/subMesh" {
  21672. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21673. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21674. import { Engine } from "babylonjs/Engines/engine";
  21675. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21676. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21677. import { Effect } from "babylonjs/Materials/effect";
  21678. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21679. import { Plane } from "babylonjs/Maths/math.plane";
  21680. import { Collider } from "babylonjs/Collisions/collider";
  21681. import { Material } from "babylonjs/Materials/material";
  21682. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21683. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21684. import { Mesh } from "babylonjs/Meshes/mesh";
  21685. import { Ray } from "babylonjs/Culling/ray";
  21686. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21687. /**
  21688. * Base class for submeshes
  21689. */
  21690. export class BaseSubMesh {
  21691. /** @hidden */
  21692. _materialDefines: Nullable<MaterialDefines>;
  21693. /** @hidden */
  21694. _materialEffect: Nullable<Effect>;
  21695. /**
  21696. * Gets associated effect
  21697. */
  21698. readonly effect: Nullable<Effect>;
  21699. /**
  21700. * Sets associated effect (effect used to render this submesh)
  21701. * @param effect defines the effect to associate with
  21702. * @param defines defines the set of defines used to compile this effect
  21703. */
  21704. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21705. }
  21706. /**
  21707. * Defines a subdivision inside a mesh
  21708. */
  21709. export class SubMesh extends BaseSubMesh implements ICullable {
  21710. /** the material index to use */
  21711. materialIndex: number;
  21712. /** vertex index start */
  21713. verticesStart: number;
  21714. /** vertices count */
  21715. verticesCount: number;
  21716. /** index start */
  21717. indexStart: number;
  21718. /** indices count */
  21719. indexCount: number;
  21720. /** @hidden */
  21721. _linesIndexCount: number;
  21722. private _mesh;
  21723. private _renderingMesh;
  21724. private _boundingInfo;
  21725. private _linesIndexBuffer;
  21726. /** @hidden */
  21727. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21728. /** @hidden */
  21729. _trianglePlanes: Plane[];
  21730. /** @hidden */
  21731. _lastColliderTransformMatrix: Nullable<Matrix>;
  21732. /** @hidden */
  21733. _renderId: number;
  21734. /** @hidden */
  21735. _alphaIndex: number;
  21736. /** @hidden */
  21737. _distanceToCamera: number;
  21738. /** @hidden */
  21739. _id: number;
  21740. private _currentMaterial;
  21741. /**
  21742. * Add a new submesh to a mesh
  21743. * @param materialIndex defines the material index to use
  21744. * @param verticesStart defines vertex index start
  21745. * @param verticesCount defines vertices count
  21746. * @param indexStart defines index start
  21747. * @param indexCount defines indices count
  21748. * @param mesh defines the parent mesh
  21749. * @param renderingMesh defines an optional rendering mesh
  21750. * @param createBoundingBox defines if bounding box should be created for this submesh
  21751. * @returns the new submesh
  21752. */
  21753. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21754. /**
  21755. * Creates a new submesh
  21756. * @param materialIndex defines the material index to use
  21757. * @param verticesStart defines vertex index start
  21758. * @param verticesCount defines vertices count
  21759. * @param indexStart defines index start
  21760. * @param indexCount defines indices count
  21761. * @param mesh defines the parent mesh
  21762. * @param renderingMesh defines an optional rendering mesh
  21763. * @param createBoundingBox defines if bounding box should be created for this submesh
  21764. */
  21765. constructor(
  21766. /** the material index to use */
  21767. materialIndex: number,
  21768. /** vertex index start */
  21769. verticesStart: number,
  21770. /** vertices count */
  21771. verticesCount: number,
  21772. /** index start */
  21773. indexStart: number,
  21774. /** indices count */
  21775. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21776. /**
  21777. * Returns true if this submesh covers the entire parent mesh
  21778. * @ignorenaming
  21779. */
  21780. readonly IsGlobal: boolean;
  21781. /**
  21782. * Returns the submesh BoudingInfo object
  21783. * @returns current bounding info (or mesh's one if the submesh is global)
  21784. */
  21785. getBoundingInfo(): BoundingInfo;
  21786. /**
  21787. * Sets the submesh BoundingInfo
  21788. * @param boundingInfo defines the new bounding info to use
  21789. * @returns the SubMesh
  21790. */
  21791. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21792. /**
  21793. * Returns the mesh of the current submesh
  21794. * @return the parent mesh
  21795. */
  21796. getMesh(): AbstractMesh;
  21797. /**
  21798. * Returns the rendering mesh of the submesh
  21799. * @returns the rendering mesh (could be different from parent mesh)
  21800. */
  21801. getRenderingMesh(): Mesh;
  21802. /**
  21803. * Returns the submesh material
  21804. * @returns null or the current material
  21805. */
  21806. getMaterial(): Nullable<Material>;
  21807. /**
  21808. * Sets a new updated BoundingInfo object to the submesh
  21809. * @param data defines an optional position array to use to determine the bounding info
  21810. * @returns the SubMesh
  21811. */
  21812. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21813. /** @hidden */
  21814. _checkCollision(collider: Collider): boolean;
  21815. /**
  21816. * Updates the submesh BoundingInfo
  21817. * @param world defines the world matrix to use to update the bounding info
  21818. * @returns the submesh
  21819. */
  21820. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21821. /**
  21822. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21823. * @param frustumPlanes defines the frustum planes
  21824. * @returns true if the submesh is intersecting with the frustum
  21825. */
  21826. isInFrustum(frustumPlanes: Plane[]): boolean;
  21827. /**
  21828. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21829. * @param frustumPlanes defines the frustum planes
  21830. * @returns true if the submesh is inside the frustum
  21831. */
  21832. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21833. /**
  21834. * Renders the submesh
  21835. * @param enableAlphaMode defines if alpha needs to be used
  21836. * @returns the submesh
  21837. */
  21838. render(enableAlphaMode: boolean): SubMesh;
  21839. /**
  21840. * @hidden
  21841. */
  21842. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21843. /**
  21844. * Checks if the submesh intersects with a ray
  21845. * @param ray defines the ray to test
  21846. * @returns true is the passed ray intersects the submesh bounding box
  21847. */
  21848. canIntersects(ray: Ray): boolean;
  21849. /**
  21850. * Intersects current submesh with a ray
  21851. * @param ray defines the ray to test
  21852. * @param positions defines mesh's positions array
  21853. * @param indices defines mesh's indices array
  21854. * @param fastCheck defines if only bounding info should be used
  21855. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21856. * @returns intersection info or null if no intersection
  21857. */
  21858. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21859. /** @hidden */
  21860. private _intersectLines;
  21861. /** @hidden */
  21862. private _intersectUnIndexedLines;
  21863. /** @hidden */
  21864. private _intersectTriangles;
  21865. /** @hidden */
  21866. private _intersectUnIndexedTriangles;
  21867. /** @hidden */
  21868. _rebuild(): void;
  21869. /**
  21870. * Creates a new submesh from the passed mesh
  21871. * @param newMesh defines the new hosting mesh
  21872. * @param newRenderingMesh defines an optional rendering mesh
  21873. * @returns the new submesh
  21874. */
  21875. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21876. /**
  21877. * Release associated resources
  21878. */
  21879. dispose(): void;
  21880. /**
  21881. * Gets the class name
  21882. * @returns the string "SubMesh".
  21883. */
  21884. getClassName(): string;
  21885. /**
  21886. * Creates a new submesh from indices data
  21887. * @param materialIndex the index of the main mesh material
  21888. * @param startIndex the index where to start the copy in the mesh indices array
  21889. * @param indexCount the number of indices to copy then from the startIndex
  21890. * @param mesh the main mesh to create the submesh from
  21891. * @param renderingMesh the optional rendering mesh
  21892. * @returns a new submesh
  21893. */
  21894. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21895. }
  21896. }
  21897. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21898. /**
  21899. * Class used to represent data loading progression
  21900. */
  21901. export class SceneLoaderFlags {
  21902. private static _ForceFullSceneLoadingForIncremental;
  21903. private static _ShowLoadingScreen;
  21904. private static _CleanBoneMatrixWeights;
  21905. private static _loggingLevel;
  21906. /**
  21907. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21908. */
  21909. static ForceFullSceneLoadingForIncremental: boolean;
  21910. /**
  21911. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21912. */
  21913. static ShowLoadingScreen: boolean;
  21914. /**
  21915. * Defines the current logging level (while loading the scene)
  21916. * @ignorenaming
  21917. */
  21918. static loggingLevel: number;
  21919. /**
  21920. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21921. */
  21922. static CleanBoneMatrixWeights: boolean;
  21923. }
  21924. }
  21925. declare module "babylonjs/Meshes/geometry" {
  21926. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21927. import { Scene } from "babylonjs/scene";
  21928. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21929. import { Engine } from "babylonjs/Engines/engine";
  21930. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21931. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21932. import { Effect } from "babylonjs/Materials/effect";
  21933. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21934. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21935. import { Mesh } from "babylonjs/Meshes/mesh";
  21936. /**
  21937. * Class used to store geometry data (vertex buffers + index buffer)
  21938. */
  21939. export class Geometry implements IGetSetVerticesData {
  21940. /**
  21941. * Gets or sets the ID of the geometry
  21942. */
  21943. id: string;
  21944. /**
  21945. * Gets or sets the unique ID of the geometry
  21946. */
  21947. uniqueId: number;
  21948. /**
  21949. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21950. */
  21951. delayLoadState: number;
  21952. /**
  21953. * Gets the file containing the data to load when running in delay load state
  21954. */
  21955. delayLoadingFile: Nullable<string>;
  21956. /**
  21957. * Callback called when the geometry is updated
  21958. */
  21959. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21960. private _scene;
  21961. private _engine;
  21962. private _meshes;
  21963. private _totalVertices;
  21964. /** @hidden */
  21965. _indices: IndicesArray;
  21966. /** @hidden */
  21967. _vertexBuffers: {
  21968. [key: string]: VertexBuffer;
  21969. };
  21970. private _isDisposed;
  21971. private _extend;
  21972. private _boundingBias;
  21973. /** @hidden */
  21974. _delayInfo: Array<string>;
  21975. private _indexBuffer;
  21976. private _indexBufferIsUpdatable;
  21977. /** @hidden */
  21978. _boundingInfo: Nullable<BoundingInfo>;
  21979. /** @hidden */
  21980. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21981. /** @hidden */
  21982. _softwareSkinningFrameId: number;
  21983. private _vertexArrayObjects;
  21984. private _updatable;
  21985. /** @hidden */
  21986. _positions: Nullable<Vector3[]>;
  21987. /**
  21988. * 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
  21989. */
  21990. /**
  21991. * 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
  21992. */
  21993. boundingBias: Vector2;
  21994. /**
  21995. * Static function used to attach a new empty geometry to a mesh
  21996. * @param mesh defines the mesh to attach the geometry to
  21997. * @returns the new Geometry
  21998. */
  21999. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  22000. /**
  22001. * Creates a new geometry
  22002. * @param id defines the unique ID
  22003. * @param scene defines the hosting scene
  22004. * @param vertexData defines the VertexData used to get geometry data
  22005. * @param updatable defines if geometry must be updatable (false by default)
  22006. * @param mesh defines the mesh that will be associated with the geometry
  22007. */
  22008. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  22009. /**
  22010. * Gets the current extend of the geometry
  22011. */
  22012. readonly extend: {
  22013. minimum: Vector3;
  22014. maximum: Vector3;
  22015. };
  22016. /**
  22017. * Gets the hosting scene
  22018. * @returns the hosting Scene
  22019. */
  22020. getScene(): Scene;
  22021. /**
  22022. * Gets the hosting engine
  22023. * @returns the hosting Engine
  22024. */
  22025. getEngine(): Engine;
  22026. /**
  22027. * Defines if the geometry is ready to use
  22028. * @returns true if the geometry is ready to be used
  22029. */
  22030. isReady(): boolean;
  22031. /**
  22032. * Gets a value indicating that the geometry should not be serialized
  22033. */
  22034. readonly doNotSerialize: boolean;
  22035. /** @hidden */
  22036. _rebuild(): void;
  22037. /**
  22038. * Affects all geometry data in one call
  22039. * @param vertexData defines the geometry data
  22040. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  22041. */
  22042. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  22043. /**
  22044. * Set specific vertex data
  22045. * @param kind defines the data kind (Position, normal, etc...)
  22046. * @param data defines the vertex data to use
  22047. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22048. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22049. */
  22050. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  22051. /**
  22052. * Removes a specific vertex data
  22053. * @param kind defines the data kind (Position, normal, etc...)
  22054. */
  22055. removeVerticesData(kind: string): void;
  22056. /**
  22057. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  22058. * @param buffer defines the vertex buffer to use
  22059. * @param totalVertices defines the total number of vertices for position kind (could be null)
  22060. */
  22061. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  22062. /**
  22063. * Update a specific vertex buffer
  22064. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  22065. * It will do nothing if the buffer is not updatable
  22066. * @param kind defines the data kind (Position, normal, etc...)
  22067. * @param data defines the data to use
  22068. * @param offset defines the offset in the target buffer where to store the data
  22069. * @param useBytes set to true if the offset is in bytes
  22070. */
  22071. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  22072. /**
  22073. * Update a specific vertex buffer
  22074. * This function will create a new buffer if the current one is not updatable
  22075. * @param kind defines the data kind (Position, normal, etc...)
  22076. * @param data defines the data to use
  22077. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  22078. */
  22079. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  22080. private _updateBoundingInfo;
  22081. /** @hidden */
  22082. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  22083. /**
  22084. * Gets total number of vertices
  22085. * @returns the total number of vertices
  22086. */
  22087. getTotalVertices(): number;
  22088. /**
  22089. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22090. * @param kind defines the data kind (Position, normal, etc...)
  22091. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22092. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22093. * @returns a float array containing vertex data
  22094. */
  22095. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22096. /**
  22097. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  22098. * @param kind defines the data kind (Position, normal, etc...)
  22099. * @returns true if the vertex buffer with the specified kind is updatable
  22100. */
  22101. isVertexBufferUpdatable(kind: string): boolean;
  22102. /**
  22103. * Gets a specific vertex buffer
  22104. * @param kind defines the data kind (Position, normal, etc...)
  22105. * @returns a VertexBuffer
  22106. */
  22107. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  22108. /**
  22109. * Returns all vertex buffers
  22110. * @return an object holding all vertex buffers indexed by kind
  22111. */
  22112. getVertexBuffers(): Nullable<{
  22113. [key: string]: VertexBuffer;
  22114. }>;
  22115. /**
  22116. * Gets a boolean indicating if specific vertex buffer is present
  22117. * @param kind defines the data kind (Position, normal, etc...)
  22118. * @returns true if data is present
  22119. */
  22120. isVerticesDataPresent(kind: string): boolean;
  22121. /**
  22122. * Gets a list of all attached data kinds (Position, normal, etc...)
  22123. * @returns a list of string containing all kinds
  22124. */
  22125. getVerticesDataKinds(): string[];
  22126. /**
  22127. * Update index buffer
  22128. * @param indices defines the indices to store in the index buffer
  22129. * @param offset defines the offset in the target buffer where to store the data
  22130. * @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)
  22131. */
  22132. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  22133. /**
  22134. * Creates a new index buffer
  22135. * @param indices defines the indices to store in the index buffer
  22136. * @param totalVertices defines the total number of vertices (could be null)
  22137. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22138. */
  22139. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  22140. /**
  22141. * Return the total number of indices
  22142. * @returns the total number of indices
  22143. */
  22144. getTotalIndices(): number;
  22145. /**
  22146. * Gets the index buffer array
  22147. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22148. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22149. * @returns the index buffer array
  22150. */
  22151. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22152. /**
  22153. * Gets the index buffer
  22154. * @return the index buffer
  22155. */
  22156. getIndexBuffer(): Nullable<DataBuffer>;
  22157. /** @hidden */
  22158. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  22159. /**
  22160. * Release the associated resources for a specific mesh
  22161. * @param mesh defines the source mesh
  22162. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  22163. */
  22164. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  22165. /**
  22166. * Apply current geometry to a given mesh
  22167. * @param mesh defines the mesh to apply geometry to
  22168. */
  22169. applyToMesh(mesh: Mesh): void;
  22170. private _updateExtend;
  22171. private _applyToMesh;
  22172. private notifyUpdate;
  22173. /**
  22174. * Load the geometry if it was flagged as delay loaded
  22175. * @param scene defines the hosting scene
  22176. * @param onLoaded defines a callback called when the geometry is loaded
  22177. */
  22178. load(scene: Scene, onLoaded?: () => void): void;
  22179. private _queueLoad;
  22180. /**
  22181. * Invert the geometry to move from a right handed system to a left handed one.
  22182. */
  22183. toLeftHanded(): void;
  22184. /** @hidden */
  22185. _resetPointsArrayCache(): void;
  22186. /** @hidden */
  22187. _generatePointsArray(): boolean;
  22188. /**
  22189. * Gets a value indicating if the geometry is disposed
  22190. * @returns true if the geometry was disposed
  22191. */
  22192. isDisposed(): boolean;
  22193. private _disposeVertexArrayObjects;
  22194. /**
  22195. * Free all associated resources
  22196. */
  22197. dispose(): void;
  22198. /**
  22199. * Clone the current geometry into a new geometry
  22200. * @param id defines the unique ID of the new geometry
  22201. * @returns a new geometry object
  22202. */
  22203. copy(id: string): Geometry;
  22204. /**
  22205. * Serialize the current geometry info (and not the vertices data) into a JSON object
  22206. * @return a JSON representation of the current geometry data (without the vertices data)
  22207. */
  22208. serialize(): any;
  22209. private toNumberArray;
  22210. /**
  22211. * Serialize all vertices data into a JSON oject
  22212. * @returns a JSON representation of the current geometry data
  22213. */
  22214. serializeVerticeData(): any;
  22215. /**
  22216. * Extracts a clone of a mesh geometry
  22217. * @param mesh defines the source mesh
  22218. * @param id defines the unique ID of the new geometry object
  22219. * @returns the new geometry object
  22220. */
  22221. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  22222. /**
  22223. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  22224. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  22225. * Be aware Math.random() could cause collisions, but:
  22226. * "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"
  22227. * @returns a string containing a new GUID
  22228. */
  22229. static RandomId(): string;
  22230. /** @hidden */
  22231. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  22232. private static _CleanMatricesWeights;
  22233. /**
  22234. * Create a new geometry from persisted data (Using .babylon file format)
  22235. * @param parsedVertexData defines the persisted data
  22236. * @param scene defines the hosting scene
  22237. * @param rootUrl defines the root url to use to load assets (like delayed data)
  22238. * @returns the new geometry object
  22239. */
  22240. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  22241. }
  22242. }
  22243. declare module "babylonjs/Meshes/mesh.vertexData" {
  22244. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  22245. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  22246. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  22247. import { Geometry } from "babylonjs/Meshes/geometry";
  22248. import { Mesh } from "babylonjs/Meshes/mesh";
  22249. /**
  22250. * Define an interface for all classes that will get and set the data on vertices
  22251. */
  22252. export interface IGetSetVerticesData {
  22253. /**
  22254. * Gets a boolean indicating if specific vertex data is present
  22255. * @param kind defines the vertex data kind to use
  22256. * @returns true is data kind is present
  22257. */
  22258. isVerticesDataPresent(kind: string): boolean;
  22259. /**
  22260. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22261. * @param kind defines the data kind (Position, normal, etc...)
  22262. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22263. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22264. * @returns a float array containing vertex data
  22265. */
  22266. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22267. /**
  22268. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  22269. * @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.
  22270. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22271. * @returns the indices array or an empty array if the mesh has no geometry
  22272. */
  22273. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22274. /**
  22275. * Set specific vertex data
  22276. * @param kind defines the data kind (Position, normal, etc...)
  22277. * @param data defines the vertex data to use
  22278. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22279. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22280. */
  22281. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  22282. /**
  22283. * Update a specific associated vertex buffer
  22284. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  22285. * - VertexBuffer.PositionKind
  22286. * - VertexBuffer.UVKind
  22287. * - VertexBuffer.UV2Kind
  22288. * - VertexBuffer.UV3Kind
  22289. * - VertexBuffer.UV4Kind
  22290. * - VertexBuffer.UV5Kind
  22291. * - VertexBuffer.UV6Kind
  22292. * - VertexBuffer.ColorKind
  22293. * - VertexBuffer.MatricesIndicesKind
  22294. * - VertexBuffer.MatricesIndicesExtraKind
  22295. * - VertexBuffer.MatricesWeightsKind
  22296. * - VertexBuffer.MatricesWeightsExtraKind
  22297. * @param data defines the data source
  22298. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  22299. * @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)
  22300. */
  22301. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  22302. /**
  22303. * Creates a new index buffer
  22304. * @param indices defines the indices to store in the index buffer
  22305. * @param totalVertices defines the total number of vertices (could be null)
  22306. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22307. */
  22308. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  22309. }
  22310. /**
  22311. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  22312. */
  22313. export class VertexData {
  22314. /**
  22315. * Mesh side orientation : usually the external or front surface
  22316. */
  22317. static readonly FRONTSIDE: number;
  22318. /**
  22319. * Mesh side orientation : usually the internal or back surface
  22320. */
  22321. static readonly BACKSIDE: number;
  22322. /**
  22323. * Mesh side orientation : both internal and external or front and back surfaces
  22324. */
  22325. static readonly DOUBLESIDE: number;
  22326. /**
  22327. * Mesh side orientation : by default, `FRONTSIDE`
  22328. */
  22329. static readonly DEFAULTSIDE: number;
  22330. /**
  22331. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  22332. */
  22333. positions: Nullable<FloatArray>;
  22334. /**
  22335. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  22336. */
  22337. normals: Nullable<FloatArray>;
  22338. /**
  22339. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  22340. */
  22341. tangents: Nullable<FloatArray>;
  22342. /**
  22343. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22344. */
  22345. uvs: Nullable<FloatArray>;
  22346. /**
  22347. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22348. */
  22349. uvs2: Nullable<FloatArray>;
  22350. /**
  22351. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22352. */
  22353. uvs3: Nullable<FloatArray>;
  22354. /**
  22355. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22356. */
  22357. uvs4: Nullable<FloatArray>;
  22358. /**
  22359. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22360. */
  22361. uvs5: Nullable<FloatArray>;
  22362. /**
  22363. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22364. */
  22365. uvs6: Nullable<FloatArray>;
  22366. /**
  22367. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  22368. */
  22369. colors: Nullable<FloatArray>;
  22370. /**
  22371. * 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).
  22372. */
  22373. matricesIndices: Nullable<FloatArray>;
  22374. /**
  22375. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  22376. */
  22377. matricesWeights: Nullable<FloatArray>;
  22378. /**
  22379. * An array extending the number of possible indices
  22380. */
  22381. matricesIndicesExtra: Nullable<FloatArray>;
  22382. /**
  22383. * An array extending the number of possible weights when the number of indices is extended
  22384. */
  22385. matricesWeightsExtra: Nullable<FloatArray>;
  22386. /**
  22387. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  22388. */
  22389. indices: Nullable<IndicesArray>;
  22390. /**
  22391. * Uses the passed data array to set the set the values for the specified kind of data
  22392. * @param data a linear array of floating numbers
  22393. * @param kind the type of data that is being set, eg positions, colors etc
  22394. */
  22395. set(data: FloatArray, kind: string): void;
  22396. /**
  22397. * Associates the vertexData to the passed Mesh.
  22398. * Sets it as updatable or not (default `false`)
  22399. * @param mesh the mesh the vertexData is applied to
  22400. * @param updatable when used and having the value true allows new data to update the vertexData
  22401. * @returns the VertexData
  22402. */
  22403. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  22404. /**
  22405. * Associates the vertexData to the passed Geometry.
  22406. * Sets it as updatable or not (default `false`)
  22407. * @param geometry the geometry the vertexData is applied to
  22408. * @param updatable when used and having the value true allows new data to update the vertexData
  22409. * @returns VertexData
  22410. */
  22411. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  22412. /**
  22413. * Updates the associated mesh
  22414. * @param mesh the mesh to be updated
  22415. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22416. * @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
  22417. * @returns VertexData
  22418. */
  22419. updateMesh(mesh: Mesh): VertexData;
  22420. /**
  22421. * Updates the associated geometry
  22422. * @param geometry the geometry to be updated
  22423. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22424. * @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
  22425. * @returns VertexData.
  22426. */
  22427. updateGeometry(geometry: Geometry): VertexData;
  22428. private _applyTo;
  22429. private _update;
  22430. /**
  22431. * Transforms each position and each normal of the vertexData according to the passed Matrix
  22432. * @param matrix the transforming matrix
  22433. * @returns the VertexData
  22434. */
  22435. transform(matrix: Matrix): VertexData;
  22436. /**
  22437. * Merges the passed VertexData into the current one
  22438. * @param other the VertexData to be merged into the current one
  22439. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  22440. * @returns the modified VertexData
  22441. */
  22442. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  22443. private _mergeElement;
  22444. private _validate;
  22445. /**
  22446. * Serializes the VertexData
  22447. * @returns a serialized object
  22448. */
  22449. serialize(): any;
  22450. /**
  22451. * Extracts the vertexData from a mesh
  22452. * @param mesh the mesh from which to extract the VertexData
  22453. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  22454. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22455. * @returns the object VertexData associated to the passed mesh
  22456. */
  22457. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22458. /**
  22459. * Extracts the vertexData from the geometry
  22460. * @param geometry the geometry from which to extract the VertexData
  22461. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  22462. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22463. * @returns the object VertexData associated to the passed mesh
  22464. */
  22465. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22466. private static _ExtractFrom;
  22467. /**
  22468. * Creates the VertexData for a Ribbon
  22469. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  22470. * * pathArray array of paths, each of which an array of successive Vector3
  22471. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  22472. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  22473. * * 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
  22474. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22475. * * 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)
  22476. * * 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)
  22477. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  22478. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  22479. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  22480. * @returns the VertexData of the ribbon
  22481. */
  22482. static CreateRibbon(options: {
  22483. pathArray: Vector3[][];
  22484. closeArray?: boolean;
  22485. closePath?: boolean;
  22486. offset?: number;
  22487. sideOrientation?: number;
  22488. frontUVs?: Vector4;
  22489. backUVs?: Vector4;
  22490. invertUV?: boolean;
  22491. uvs?: Vector2[];
  22492. colors?: Color4[];
  22493. }): VertexData;
  22494. /**
  22495. * Creates the VertexData for a box
  22496. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22497. * * size sets the width, height and depth of the box to the value of size, optional default 1
  22498. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  22499. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  22500. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  22501. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22502. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22503. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22504. * * 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)
  22505. * * 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)
  22506. * @returns the VertexData of the box
  22507. */
  22508. static CreateBox(options: {
  22509. size?: number;
  22510. width?: number;
  22511. height?: number;
  22512. depth?: number;
  22513. faceUV?: Vector4[];
  22514. faceColors?: Color4[];
  22515. sideOrientation?: number;
  22516. frontUVs?: Vector4;
  22517. backUVs?: Vector4;
  22518. }): VertexData;
  22519. /**
  22520. * Creates the VertexData for a tiled box
  22521. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22522. * * faceTiles sets the pattern, tile size and number of tiles for a face
  22523. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22524. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22525. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22526. * @returns the VertexData of the box
  22527. */
  22528. static CreateTiledBox(options: {
  22529. pattern?: number;
  22530. width?: number;
  22531. height?: number;
  22532. depth?: number;
  22533. tileSize?: number;
  22534. tileWidth?: number;
  22535. tileHeight?: number;
  22536. alignHorizontal?: number;
  22537. alignVertical?: number;
  22538. faceUV?: Vector4[];
  22539. faceColors?: Color4[];
  22540. sideOrientation?: number;
  22541. }): VertexData;
  22542. /**
  22543. * Creates the VertexData for a tiled plane
  22544. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22545. * * pattern a limited pattern arrangement depending on the number
  22546. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  22547. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  22548. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  22549. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22550. * * 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)
  22551. * * 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)
  22552. * @returns the VertexData of the tiled plane
  22553. */
  22554. static CreateTiledPlane(options: {
  22555. pattern?: number;
  22556. tileSize?: number;
  22557. tileWidth?: number;
  22558. tileHeight?: number;
  22559. size?: number;
  22560. width?: number;
  22561. height?: number;
  22562. alignHorizontal?: number;
  22563. alignVertical?: number;
  22564. sideOrientation?: number;
  22565. frontUVs?: Vector4;
  22566. backUVs?: Vector4;
  22567. }): VertexData;
  22568. /**
  22569. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22570. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22571. * * segments sets the number of horizontal strips optional, default 32
  22572. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22573. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22574. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22575. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22576. * * 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
  22577. * * 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
  22578. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22579. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  22580. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  22581. * @returns the VertexData of the ellipsoid
  22582. */
  22583. static CreateSphere(options: {
  22584. segments?: number;
  22585. diameter?: number;
  22586. diameterX?: number;
  22587. diameterY?: number;
  22588. diameterZ?: number;
  22589. arc?: number;
  22590. slice?: number;
  22591. sideOrientation?: number;
  22592. frontUVs?: Vector4;
  22593. backUVs?: Vector4;
  22594. }): VertexData;
  22595. /**
  22596. * Creates the VertexData for a cylinder, cone or prism
  22597. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22598. * * height sets the height (y direction) of the cylinder, optional, default 2
  22599. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22600. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22601. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22602. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22603. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22604. * * 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
  22605. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22606. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22607. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22608. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22609. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22610. * * 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)
  22611. * * 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)
  22612. * @returns the VertexData of the cylinder, cone or prism
  22613. */
  22614. static CreateCylinder(options: {
  22615. height?: number;
  22616. diameterTop?: number;
  22617. diameterBottom?: number;
  22618. diameter?: number;
  22619. tessellation?: number;
  22620. subdivisions?: number;
  22621. arc?: number;
  22622. faceColors?: Color4[];
  22623. faceUV?: Vector4[];
  22624. hasRings?: boolean;
  22625. enclose?: boolean;
  22626. sideOrientation?: number;
  22627. frontUVs?: Vector4;
  22628. backUVs?: Vector4;
  22629. }): VertexData;
  22630. /**
  22631. * Creates the VertexData for a torus
  22632. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22633. * * diameter the diameter of the torus, optional default 1
  22634. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22635. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22636. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22637. * * 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)
  22638. * * 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)
  22639. * @returns the VertexData of the torus
  22640. */
  22641. static CreateTorus(options: {
  22642. diameter?: number;
  22643. thickness?: number;
  22644. tessellation?: number;
  22645. sideOrientation?: number;
  22646. frontUVs?: Vector4;
  22647. backUVs?: Vector4;
  22648. }): VertexData;
  22649. /**
  22650. * Creates the VertexData of the LineSystem
  22651. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22652. * - lines an array of lines, each line being an array of successive Vector3
  22653. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22654. * @returns the VertexData of the LineSystem
  22655. */
  22656. static CreateLineSystem(options: {
  22657. lines: Vector3[][];
  22658. colors?: Nullable<Color4[][]>;
  22659. }): VertexData;
  22660. /**
  22661. * Create the VertexData for a DashedLines
  22662. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22663. * - points an array successive Vector3
  22664. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22665. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22666. * - dashNb the intended total number of dashes, optional, default 200
  22667. * @returns the VertexData for the DashedLines
  22668. */
  22669. static CreateDashedLines(options: {
  22670. points: Vector3[];
  22671. dashSize?: number;
  22672. gapSize?: number;
  22673. dashNb?: number;
  22674. }): VertexData;
  22675. /**
  22676. * Creates the VertexData for a Ground
  22677. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22678. * - width the width (x direction) of the ground, optional, default 1
  22679. * - height the height (z direction) of the ground, optional, default 1
  22680. * - subdivisions the number of subdivisions per side, optional, default 1
  22681. * @returns the VertexData of the Ground
  22682. */
  22683. static CreateGround(options: {
  22684. width?: number;
  22685. height?: number;
  22686. subdivisions?: number;
  22687. subdivisionsX?: number;
  22688. subdivisionsY?: number;
  22689. }): VertexData;
  22690. /**
  22691. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22692. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22693. * * xmin the ground minimum X coordinate, optional, default -1
  22694. * * zmin the ground minimum Z coordinate, optional, default -1
  22695. * * xmax the ground maximum X coordinate, optional, default 1
  22696. * * zmax the ground maximum Z coordinate, optional, default 1
  22697. * * 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}
  22698. * * 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}
  22699. * @returns the VertexData of the TiledGround
  22700. */
  22701. static CreateTiledGround(options: {
  22702. xmin: number;
  22703. zmin: number;
  22704. xmax: number;
  22705. zmax: number;
  22706. subdivisions?: {
  22707. w: number;
  22708. h: number;
  22709. };
  22710. precision?: {
  22711. w: number;
  22712. h: number;
  22713. };
  22714. }): VertexData;
  22715. /**
  22716. * Creates the VertexData of the Ground designed from a heightmap
  22717. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22718. * * width the width (x direction) of the ground
  22719. * * height the height (z direction) of the ground
  22720. * * subdivisions the number of subdivisions per side
  22721. * * minHeight the minimum altitude on the ground, optional, default 0
  22722. * * maxHeight the maximum altitude on the ground, optional default 1
  22723. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22724. * * buffer the array holding the image color data
  22725. * * bufferWidth the width of image
  22726. * * bufferHeight the height of image
  22727. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22728. * @returns the VertexData of the Ground designed from a heightmap
  22729. */
  22730. static CreateGroundFromHeightMap(options: {
  22731. width: number;
  22732. height: number;
  22733. subdivisions: number;
  22734. minHeight: number;
  22735. maxHeight: number;
  22736. colorFilter: Color3;
  22737. buffer: Uint8Array;
  22738. bufferWidth: number;
  22739. bufferHeight: number;
  22740. alphaFilter: number;
  22741. }): VertexData;
  22742. /**
  22743. * Creates the VertexData for a Plane
  22744. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22745. * * size sets the width and height of the plane to the value of size, optional default 1
  22746. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22747. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22748. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22749. * * 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)
  22750. * * 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)
  22751. * @returns the VertexData of the box
  22752. */
  22753. static CreatePlane(options: {
  22754. size?: number;
  22755. width?: number;
  22756. height?: number;
  22757. sideOrientation?: number;
  22758. frontUVs?: Vector4;
  22759. backUVs?: Vector4;
  22760. }): VertexData;
  22761. /**
  22762. * Creates the VertexData of the Disc or regular Polygon
  22763. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22764. * * radius the radius of the disc, optional default 0.5
  22765. * * tessellation the number of polygon sides, optional, default 64
  22766. * * 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
  22767. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22768. * * 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)
  22769. * * 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)
  22770. * @returns the VertexData of the box
  22771. */
  22772. static CreateDisc(options: {
  22773. radius?: number;
  22774. tessellation?: number;
  22775. arc?: number;
  22776. sideOrientation?: number;
  22777. frontUVs?: Vector4;
  22778. backUVs?: Vector4;
  22779. }): VertexData;
  22780. /**
  22781. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22782. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22783. * @param polygon a mesh built from polygonTriangulation.build()
  22784. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22785. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22786. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22787. * @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)
  22788. * @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)
  22789. * @returns the VertexData of the Polygon
  22790. */
  22791. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22792. /**
  22793. * Creates the VertexData of the IcoSphere
  22794. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22795. * * radius the radius of the IcoSphere, optional default 1
  22796. * * radiusX allows stretching in the x direction, optional, default radius
  22797. * * radiusY allows stretching in the y direction, optional, default radius
  22798. * * radiusZ allows stretching in the z direction, optional, default radius
  22799. * * flat when true creates a flat shaded mesh, optional, default true
  22800. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22801. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22802. * * 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)
  22803. * * 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)
  22804. * @returns the VertexData of the IcoSphere
  22805. */
  22806. static CreateIcoSphere(options: {
  22807. radius?: number;
  22808. radiusX?: number;
  22809. radiusY?: number;
  22810. radiusZ?: number;
  22811. flat?: boolean;
  22812. subdivisions?: number;
  22813. sideOrientation?: number;
  22814. frontUVs?: Vector4;
  22815. backUVs?: Vector4;
  22816. }): VertexData;
  22817. /**
  22818. * Creates the VertexData for a Polyhedron
  22819. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22820. * * type provided types are:
  22821. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22822. * * 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)
  22823. * * size the size of the IcoSphere, optional default 1
  22824. * * sizeX allows stretching in the x direction, optional, default size
  22825. * * sizeY allows stretching in the y direction, optional, default size
  22826. * * sizeZ allows stretching in the z direction, optional, default size
  22827. * * 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
  22828. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22829. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22830. * * flat when true creates a flat shaded mesh, optional, default true
  22831. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22832. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22833. * * 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)
  22834. * * 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)
  22835. * @returns the VertexData of the Polyhedron
  22836. */
  22837. static CreatePolyhedron(options: {
  22838. type?: number;
  22839. size?: number;
  22840. sizeX?: number;
  22841. sizeY?: number;
  22842. sizeZ?: number;
  22843. custom?: any;
  22844. faceUV?: Vector4[];
  22845. faceColors?: Color4[];
  22846. flat?: boolean;
  22847. sideOrientation?: number;
  22848. frontUVs?: Vector4;
  22849. backUVs?: Vector4;
  22850. }): VertexData;
  22851. /**
  22852. * Creates the VertexData for a TorusKnot
  22853. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22854. * * radius the radius of the torus knot, optional, default 2
  22855. * * tube the thickness of the tube, optional, default 0.5
  22856. * * radialSegments the number of sides on each tube segments, optional, default 32
  22857. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22858. * * p the number of windings around the z axis, optional, default 2
  22859. * * q the number of windings around the x axis, optional, default 3
  22860. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22861. * * 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)
  22862. * * 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)
  22863. * @returns the VertexData of the Torus Knot
  22864. */
  22865. static CreateTorusKnot(options: {
  22866. radius?: number;
  22867. tube?: number;
  22868. radialSegments?: number;
  22869. tubularSegments?: number;
  22870. p?: number;
  22871. q?: number;
  22872. sideOrientation?: number;
  22873. frontUVs?: Vector4;
  22874. backUVs?: Vector4;
  22875. }): VertexData;
  22876. /**
  22877. * Compute normals for given positions and indices
  22878. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22879. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22880. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22881. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22882. * * facetNormals : optional array of facet normals (vector3)
  22883. * * facetPositions : optional array of facet positions (vector3)
  22884. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22885. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22886. * * bInfo : optional bounding info, required for facetPartitioning computation
  22887. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22888. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22889. * * useRightHandedSystem: optional boolean to for right handed system computation
  22890. * * depthSort : optional boolean to enable the facet depth sort computation
  22891. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22892. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22893. */
  22894. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22895. facetNormals?: any;
  22896. facetPositions?: any;
  22897. facetPartitioning?: any;
  22898. ratio?: number;
  22899. bInfo?: any;
  22900. bbSize?: Vector3;
  22901. subDiv?: any;
  22902. useRightHandedSystem?: boolean;
  22903. depthSort?: boolean;
  22904. distanceTo?: Vector3;
  22905. depthSortedFacets?: any;
  22906. }): void;
  22907. /** @hidden */
  22908. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22909. /**
  22910. * Applies VertexData created from the imported parameters to the geometry
  22911. * @param parsedVertexData the parsed data from an imported file
  22912. * @param geometry the geometry to apply the VertexData to
  22913. */
  22914. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22915. }
  22916. }
  22917. declare module "babylonjs/Morph/morphTarget" {
  22918. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22919. import { Observable } from "babylonjs/Misc/observable";
  22920. import { Nullable, FloatArray } from "babylonjs/types";
  22921. import { Scene } from "babylonjs/scene";
  22922. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22923. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22924. /**
  22925. * Defines a target to use with MorphTargetManager
  22926. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22927. */
  22928. export class MorphTarget implements IAnimatable {
  22929. /** defines the name of the target */
  22930. name: string;
  22931. /**
  22932. * Gets or sets the list of animations
  22933. */
  22934. animations: import("babylonjs/Animations/animation").Animation[];
  22935. private _scene;
  22936. private _positions;
  22937. private _normals;
  22938. private _tangents;
  22939. private _uvs;
  22940. private _influence;
  22941. private _uniqueId;
  22942. /**
  22943. * Observable raised when the influence changes
  22944. */
  22945. onInfluenceChanged: Observable<boolean>;
  22946. /** @hidden */
  22947. _onDataLayoutChanged: Observable<void>;
  22948. /**
  22949. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22950. */
  22951. influence: number;
  22952. /**
  22953. * Gets or sets the id of the morph Target
  22954. */
  22955. id: string;
  22956. private _animationPropertiesOverride;
  22957. /**
  22958. * Gets or sets the animation properties override
  22959. */
  22960. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22961. /**
  22962. * Creates a new MorphTarget
  22963. * @param name defines the name of the target
  22964. * @param influence defines the influence to use
  22965. * @param scene defines the scene the morphtarget belongs to
  22966. */
  22967. constructor(
  22968. /** defines the name of the target */
  22969. name: string, influence?: number, scene?: Nullable<Scene>);
  22970. /**
  22971. * Gets the unique ID of this manager
  22972. */
  22973. readonly uniqueId: number;
  22974. /**
  22975. * Gets a boolean defining if the target contains position data
  22976. */
  22977. readonly hasPositions: boolean;
  22978. /**
  22979. * Gets a boolean defining if the target contains normal data
  22980. */
  22981. readonly hasNormals: boolean;
  22982. /**
  22983. * Gets a boolean defining if the target contains tangent data
  22984. */
  22985. readonly hasTangents: boolean;
  22986. /**
  22987. * Gets a boolean defining if the target contains texture coordinates data
  22988. */
  22989. readonly hasUVs: boolean;
  22990. /**
  22991. * Affects position data to this target
  22992. * @param data defines the position data to use
  22993. */
  22994. setPositions(data: Nullable<FloatArray>): void;
  22995. /**
  22996. * Gets the position data stored in this target
  22997. * @returns a FloatArray containing the position data (or null if not present)
  22998. */
  22999. getPositions(): Nullable<FloatArray>;
  23000. /**
  23001. * Affects normal data to this target
  23002. * @param data defines the normal data to use
  23003. */
  23004. setNormals(data: Nullable<FloatArray>): void;
  23005. /**
  23006. * Gets the normal data stored in this target
  23007. * @returns a FloatArray containing the normal data (or null if not present)
  23008. */
  23009. getNormals(): Nullable<FloatArray>;
  23010. /**
  23011. * Affects tangent data to this target
  23012. * @param data defines the tangent data to use
  23013. */
  23014. setTangents(data: Nullable<FloatArray>): void;
  23015. /**
  23016. * Gets the tangent data stored in this target
  23017. * @returns a FloatArray containing the tangent data (or null if not present)
  23018. */
  23019. getTangents(): Nullable<FloatArray>;
  23020. /**
  23021. * Affects texture coordinates data to this target
  23022. * @param data defines the texture coordinates data to use
  23023. */
  23024. setUVs(data: Nullable<FloatArray>): void;
  23025. /**
  23026. * Gets the texture coordinates data stored in this target
  23027. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  23028. */
  23029. getUVs(): Nullable<FloatArray>;
  23030. /**
  23031. * Clone the current target
  23032. * @returns a new MorphTarget
  23033. */
  23034. clone(): MorphTarget;
  23035. /**
  23036. * Serializes the current target into a Serialization object
  23037. * @returns the serialized object
  23038. */
  23039. serialize(): any;
  23040. /**
  23041. * Returns the string "MorphTarget"
  23042. * @returns "MorphTarget"
  23043. */
  23044. getClassName(): string;
  23045. /**
  23046. * Creates a new target from serialized data
  23047. * @param serializationObject defines the serialized data to use
  23048. * @returns a new MorphTarget
  23049. */
  23050. static Parse(serializationObject: any): MorphTarget;
  23051. /**
  23052. * Creates a MorphTarget from mesh data
  23053. * @param mesh defines the source mesh
  23054. * @param name defines the name to use for the new target
  23055. * @param influence defines the influence to attach to the target
  23056. * @returns a new MorphTarget
  23057. */
  23058. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  23059. }
  23060. }
  23061. declare module "babylonjs/Morph/morphTargetManager" {
  23062. import { Nullable } from "babylonjs/types";
  23063. import { Scene } from "babylonjs/scene";
  23064. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  23065. /**
  23066. * This class is used to deform meshes using morphing between different targets
  23067. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  23068. */
  23069. export class MorphTargetManager {
  23070. private _targets;
  23071. private _targetInfluenceChangedObservers;
  23072. private _targetDataLayoutChangedObservers;
  23073. private _activeTargets;
  23074. private _scene;
  23075. private _influences;
  23076. private _supportsNormals;
  23077. private _supportsTangents;
  23078. private _supportsUVs;
  23079. private _vertexCount;
  23080. private _uniqueId;
  23081. private _tempInfluences;
  23082. /**
  23083. * Gets or sets a boolean indicating if normals must be morphed
  23084. */
  23085. enableNormalMorphing: boolean;
  23086. /**
  23087. * Gets or sets a boolean indicating if tangents must be morphed
  23088. */
  23089. enableTangentMorphing: boolean;
  23090. /**
  23091. * Gets or sets a boolean indicating if UV must be morphed
  23092. */
  23093. enableUVMorphing: boolean;
  23094. /**
  23095. * Creates a new MorphTargetManager
  23096. * @param scene defines the current scene
  23097. */
  23098. constructor(scene?: Nullable<Scene>);
  23099. /**
  23100. * Gets the unique ID of this manager
  23101. */
  23102. readonly uniqueId: number;
  23103. /**
  23104. * Gets the number of vertices handled by this manager
  23105. */
  23106. readonly vertexCount: number;
  23107. /**
  23108. * Gets a boolean indicating if this manager supports morphing of normals
  23109. */
  23110. readonly supportsNormals: boolean;
  23111. /**
  23112. * Gets a boolean indicating if this manager supports morphing of tangents
  23113. */
  23114. readonly supportsTangents: boolean;
  23115. /**
  23116. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  23117. */
  23118. readonly supportsUVs: boolean;
  23119. /**
  23120. * Gets the number of targets stored in this manager
  23121. */
  23122. readonly numTargets: number;
  23123. /**
  23124. * Gets the number of influencers (ie. the number of targets with influences > 0)
  23125. */
  23126. readonly numInfluencers: number;
  23127. /**
  23128. * Gets the list of influences (one per target)
  23129. */
  23130. readonly influences: Float32Array;
  23131. /**
  23132. * Gets the active target at specified index. An active target is a target with an influence > 0
  23133. * @param index defines the index to check
  23134. * @returns the requested target
  23135. */
  23136. getActiveTarget(index: number): MorphTarget;
  23137. /**
  23138. * Gets the target at specified index
  23139. * @param index defines the index to check
  23140. * @returns the requested target
  23141. */
  23142. getTarget(index: number): MorphTarget;
  23143. /**
  23144. * Add a new target to this manager
  23145. * @param target defines the target to add
  23146. */
  23147. addTarget(target: MorphTarget): void;
  23148. /**
  23149. * Removes a target from the manager
  23150. * @param target defines the target to remove
  23151. */
  23152. removeTarget(target: MorphTarget): void;
  23153. /**
  23154. * Clone the current manager
  23155. * @returns a new MorphTargetManager
  23156. */
  23157. clone(): MorphTargetManager;
  23158. /**
  23159. * Serializes the current manager into a Serialization object
  23160. * @returns the serialized object
  23161. */
  23162. serialize(): any;
  23163. private _syncActiveTargets;
  23164. /**
  23165. * Syncrhonize the targets with all the meshes using this morph target manager
  23166. */
  23167. synchronize(): void;
  23168. /**
  23169. * Creates a new MorphTargetManager from serialized data
  23170. * @param serializationObject defines the serialized data
  23171. * @param scene defines the hosting scene
  23172. * @returns the new MorphTargetManager
  23173. */
  23174. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  23175. }
  23176. }
  23177. declare module "babylonjs/Meshes/meshLODLevel" {
  23178. import { Mesh } from "babylonjs/Meshes/mesh";
  23179. import { Nullable } from "babylonjs/types";
  23180. /**
  23181. * Class used to represent a specific level of detail of a mesh
  23182. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  23183. */
  23184. export class MeshLODLevel {
  23185. /** Defines the distance where this level should start being displayed */
  23186. distance: number;
  23187. /** Defines the mesh to use to render this level */
  23188. mesh: Nullable<Mesh>;
  23189. /**
  23190. * Creates a new LOD level
  23191. * @param distance defines the distance where this level should star being displayed
  23192. * @param mesh defines the mesh to use to render this level
  23193. */
  23194. constructor(
  23195. /** Defines the distance where this level should start being displayed */
  23196. distance: number,
  23197. /** Defines the mesh to use to render this level */
  23198. mesh: Nullable<Mesh>);
  23199. }
  23200. }
  23201. declare module "babylonjs/Meshes/groundMesh" {
  23202. import { Scene } from "babylonjs/scene";
  23203. import { Vector3 } from "babylonjs/Maths/math.vector";
  23204. import { Mesh } from "babylonjs/Meshes/mesh";
  23205. /**
  23206. * Mesh representing the gorund
  23207. */
  23208. export class GroundMesh extends Mesh {
  23209. /** If octree should be generated */
  23210. generateOctree: boolean;
  23211. private _heightQuads;
  23212. /** @hidden */
  23213. _subdivisionsX: number;
  23214. /** @hidden */
  23215. _subdivisionsY: number;
  23216. /** @hidden */
  23217. _width: number;
  23218. /** @hidden */
  23219. _height: number;
  23220. /** @hidden */
  23221. _minX: number;
  23222. /** @hidden */
  23223. _maxX: number;
  23224. /** @hidden */
  23225. _minZ: number;
  23226. /** @hidden */
  23227. _maxZ: number;
  23228. constructor(name: string, scene: Scene);
  23229. /**
  23230. * "GroundMesh"
  23231. * @returns "GroundMesh"
  23232. */
  23233. getClassName(): string;
  23234. /**
  23235. * The minimum of x and y subdivisions
  23236. */
  23237. readonly subdivisions: number;
  23238. /**
  23239. * X subdivisions
  23240. */
  23241. readonly subdivisionsX: number;
  23242. /**
  23243. * Y subdivisions
  23244. */
  23245. readonly subdivisionsY: number;
  23246. /**
  23247. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  23248. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  23249. * @param chunksCount the number of subdivisions for x and y
  23250. * @param octreeBlocksSize (Default: 32)
  23251. */
  23252. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  23253. /**
  23254. * Returns a height (y) value in the Worl system :
  23255. * the ground altitude at the coordinates (x, z) expressed in the World system.
  23256. * @param x x coordinate
  23257. * @param z z coordinate
  23258. * @returns the ground y position if (x, z) are outside the ground surface.
  23259. */
  23260. getHeightAtCoordinates(x: number, z: number): number;
  23261. /**
  23262. * Returns a normalized vector (Vector3) orthogonal to the ground
  23263. * at the ground coordinates (x, z) expressed in the World system.
  23264. * @param x x coordinate
  23265. * @param z z coordinate
  23266. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  23267. */
  23268. getNormalAtCoordinates(x: number, z: number): Vector3;
  23269. /**
  23270. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  23271. * at the ground coordinates (x, z) expressed in the World system.
  23272. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  23273. * @param x x coordinate
  23274. * @param z z coordinate
  23275. * @param ref vector to store the result
  23276. * @returns the GroundMesh.
  23277. */
  23278. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  23279. /**
  23280. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  23281. * if the ground has been updated.
  23282. * This can be used in the render loop.
  23283. * @returns the GroundMesh.
  23284. */
  23285. updateCoordinateHeights(): GroundMesh;
  23286. private _getFacetAt;
  23287. private _initHeightQuads;
  23288. private _computeHeightQuads;
  23289. /**
  23290. * Serializes this ground mesh
  23291. * @param serializationObject object to write serialization to
  23292. */
  23293. serialize(serializationObject: any): void;
  23294. /**
  23295. * Parses a serialized ground mesh
  23296. * @param parsedMesh the serialized mesh
  23297. * @param scene the scene to create the ground mesh in
  23298. * @returns the created ground mesh
  23299. */
  23300. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  23301. }
  23302. }
  23303. declare module "babylonjs/Physics/physicsJoint" {
  23304. import { Vector3 } from "babylonjs/Maths/math.vector";
  23305. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  23306. /**
  23307. * Interface for Physics-Joint data
  23308. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23309. */
  23310. export interface PhysicsJointData {
  23311. /**
  23312. * The main pivot of the joint
  23313. */
  23314. mainPivot?: Vector3;
  23315. /**
  23316. * The connected pivot of the joint
  23317. */
  23318. connectedPivot?: Vector3;
  23319. /**
  23320. * The main axis of the joint
  23321. */
  23322. mainAxis?: Vector3;
  23323. /**
  23324. * The connected axis of the joint
  23325. */
  23326. connectedAxis?: Vector3;
  23327. /**
  23328. * The collision of the joint
  23329. */
  23330. collision?: boolean;
  23331. /**
  23332. * Native Oimo/Cannon/Energy data
  23333. */
  23334. nativeParams?: any;
  23335. }
  23336. /**
  23337. * This is a holder class for the physics joint created by the physics plugin
  23338. * It holds a set of functions to control the underlying joint
  23339. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23340. */
  23341. export class PhysicsJoint {
  23342. /**
  23343. * The type of the physics joint
  23344. */
  23345. type: number;
  23346. /**
  23347. * The data for the physics joint
  23348. */
  23349. jointData: PhysicsJointData;
  23350. private _physicsJoint;
  23351. protected _physicsPlugin: IPhysicsEnginePlugin;
  23352. /**
  23353. * Initializes the physics joint
  23354. * @param type The type of the physics joint
  23355. * @param jointData The data for the physics joint
  23356. */
  23357. constructor(
  23358. /**
  23359. * The type of the physics joint
  23360. */
  23361. type: number,
  23362. /**
  23363. * The data for the physics joint
  23364. */
  23365. jointData: PhysicsJointData);
  23366. /**
  23367. * Gets the physics joint
  23368. */
  23369. /**
  23370. * Sets the physics joint
  23371. */
  23372. physicsJoint: any;
  23373. /**
  23374. * Sets the physics plugin
  23375. */
  23376. physicsPlugin: IPhysicsEnginePlugin;
  23377. /**
  23378. * Execute a function that is physics-plugin specific.
  23379. * @param {Function} func the function that will be executed.
  23380. * It accepts two parameters: the physics world and the physics joint
  23381. */
  23382. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  23383. /**
  23384. * Distance-Joint type
  23385. */
  23386. static DistanceJoint: number;
  23387. /**
  23388. * Hinge-Joint type
  23389. */
  23390. static HingeJoint: number;
  23391. /**
  23392. * Ball-and-Socket joint type
  23393. */
  23394. static BallAndSocketJoint: number;
  23395. /**
  23396. * Wheel-Joint type
  23397. */
  23398. static WheelJoint: number;
  23399. /**
  23400. * Slider-Joint type
  23401. */
  23402. static SliderJoint: number;
  23403. /**
  23404. * Prismatic-Joint type
  23405. */
  23406. static PrismaticJoint: number;
  23407. /**
  23408. * Universal-Joint type
  23409. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  23410. */
  23411. static UniversalJoint: number;
  23412. /**
  23413. * Hinge-Joint 2 type
  23414. */
  23415. static Hinge2Joint: number;
  23416. /**
  23417. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  23418. */
  23419. static PointToPointJoint: number;
  23420. /**
  23421. * Spring-Joint type
  23422. */
  23423. static SpringJoint: number;
  23424. /**
  23425. * Lock-Joint type
  23426. */
  23427. static LockJoint: number;
  23428. }
  23429. /**
  23430. * A class representing a physics distance joint
  23431. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23432. */
  23433. export class DistanceJoint extends PhysicsJoint {
  23434. /**
  23435. *
  23436. * @param jointData The data for the Distance-Joint
  23437. */
  23438. constructor(jointData: DistanceJointData);
  23439. /**
  23440. * Update the predefined distance.
  23441. * @param maxDistance The maximum preferred distance
  23442. * @param minDistance The minimum preferred distance
  23443. */
  23444. updateDistance(maxDistance: number, minDistance?: number): void;
  23445. }
  23446. /**
  23447. * Represents a Motor-Enabled Joint
  23448. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23449. */
  23450. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  23451. /**
  23452. * Initializes the Motor-Enabled Joint
  23453. * @param type The type of the joint
  23454. * @param jointData The physica joint data for the joint
  23455. */
  23456. constructor(type: number, jointData: PhysicsJointData);
  23457. /**
  23458. * Set the motor values.
  23459. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23460. * @param force the force to apply
  23461. * @param maxForce max force for this motor.
  23462. */
  23463. setMotor(force?: number, maxForce?: number): void;
  23464. /**
  23465. * Set the motor's limits.
  23466. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23467. * @param upperLimit The upper limit of the motor
  23468. * @param lowerLimit The lower limit of the motor
  23469. */
  23470. setLimit(upperLimit: number, lowerLimit?: number): void;
  23471. }
  23472. /**
  23473. * This class represents a single physics Hinge-Joint
  23474. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23475. */
  23476. export class HingeJoint extends MotorEnabledJoint {
  23477. /**
  23478. * Initializes the Hinge-Joint
  23479. * @param jointData The joint data for the Hinge-Joint
  23480. */
  23481. constructor(jointData: PhysicsJointData);
  23482. /**
  23483. * Set the motor values.
  23484. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23485. * @param {number} force the force to apply
  23486. * @param {number} maxForce max force for this motor.
  23487. */
  23488. setMotor(force?: number, maxForce?: number): void;
  23489. /**
  23490. * Set the motor's limits.
  23491. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23492. * @param upperLimit The upper limit of the motor
  23493. * @param lowerLimit The lower limit of the motor
  23494. */
  23495. setLimit(upperLimit: number, lowerLimit?: number): void;
  23496. }
  23497. /**
  23498. * This class represents a dual hinge physics joint (same as wheel joint)
  23499. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23500. */
  23501. export class Hinge2Joint extends MotorEnabledJoint {
  23502. /**
  23503. * Initializes the Hinge2-Joint
  23504. * @param jointData The joint data for the Hinge2-Joint
  23505. */
  23506. constructor(jointData: PhysicsJointData);
  23507. /**
  23508. * Set the motor values.
  23509. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23510. * @param {number} targetSpeed the speed the motor is to reach
  23511. * @param {number} maxForce max force for this motor.
  23512. * @param {motorIndex} the motor's index, 0 or 1.
  23513. */
  23514. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  23515. /**
  23516. * Set the motor limits.
  23517. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23518. * @param {number} upperLimit the upper limit
  23519. * @param {number} lowerLimit lower limit
  23520. * @param {motorIndex} the motor's index, 0 or 1.
  23521. */
  23522. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23523. }
  23524. /**
  23525. * Interface for a motor enabled joint
  23526. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23527. */
  23528. export interface IMotorEnabledJoint {
  23529. /**
  23530. * Physics joint
  23531. */
  23532. physicsJoint: any;
  23533. /**
  23534. * Sets the motor of the motor-enabled joint
  23535. * @param force The force of the motor
  23536. * @param maxForce The maximum force of the motor
  23537. * @param motorIndex The index of the motor
  23538. */
  23539. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  23540. /**
  23541. * Sets the limit of the motor
  23542. * @param upperLimit The upper limit of the motor
  23543. * @param lowerLimit The lower limit of the motor
  23544. * @param motorIndex The index of the motor
  23545. */
  23546. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23547. }
  23548. /**
  23549. * Joint data for a Distance-Joint
  23550. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23551. */
  23552. export interface DistanceJointData extends PhysicsJointData {
  23553. /**
  23554. * Max distance the 2 joint objects can be apart
  23555. */
  23556. maxDistance: number;
  23557. }
  23558. /**
  23559. * Joint data from a spring joint
  23560. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23561. */
  23562. export interface SpringJointData extends PhysicsJointData {
  23563. /**
  23564. * Length of the spring
  23565. */
  23566. length: number;
  23567. /**
  23568. * Stiffness of the spring
  23569. */
  23570. stiffness: number;
  23571. /**
  23572. * Damping of the spring
  23573. */
  23574. damping: number;
  23575. /** this callback will be called when applying the force to the impostors. */
  23576. forceApplicationCallback: () => void;
  23577. }
  23578. }
  23579. declare module "babylonjs/Physics/physicsRaycastResult" {
  23580. import { Vector3 } from "babylonjs/Maths/math.vector";
  23581. /**
  23582. * Holds the data for the raycast result
  23583. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23584. */
  23585. export class PhysicsRaycastResult {
  23586. private _hasHit;
  23587. private _hitDistance;
  23588. private _hitNormalWorld;
  23589. private _hitPointWorld;
  23590. private _rayFromWorld;
  23591. private _rayToWorld;
  23592. /**
  23593. * Gets if there was a hit
  23594. */
  23595. readonly hasHit: boolean;
  23596. /**
  23597. * Gets the distance from the hit
  23598. */
  23599. readonly hitDistance: number;
  23600. /**
  23601. * Gets the hit normal/direction in the world
  23602. */
  23603. readonly hitNormalWorld: Vector3;
  23604. /**
  23605. * Gets the hit point in the world
  23606. */
  23607. readonly hitPointWorld: Vector3;
  23608. /**
  23609. * Gets the ray "start point" of the ray in the world
  23610. */
  23611. readonly rayFromWorld: Vector3;
  23612. /**
  23613. * Gets the ray "end point" of the ray in the world
  23614. */
  23615. readonly rayToWorld: Vector3;
  23616. /**
  23617. * Sets the hit data (normal & point in world space)
  23618. * @param hitNormalWorld defines the normal in world space
  23619. * @param hitPointWorld defines the point in world space
  23620. */
  23621. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23622. /**
  23623. * Sets the distance from the start point to the hit point
  23624. * @param distance
  23625. */
  23626. setHitDistance(distance: number): void;
  23627. /**
  23628. * Calculates the distance manually
  23629. */
  23630. calculateHitDistance(): void;
  23631. /**
  23632. * Resets all the values to default
  23633. * @param from The from point on world space
  23634. * @param to The to point on world space
  23635. */
  23636. reset(from?: Vector3, to?: Vector3): void;
  23637. }
  23638. /**
  23639. * Interface for the size containing width and height
  23640. */
  23641. interface IXYZ {
  23642. /**
  23643. * X
  23644. */
  23645. x: number;
  23646. /**
  23647. * Y
  23648. */
  23649. y: number;
  23650. /**
  23651. * Z
  23652. */
  23653. z: number;
  23654. }
  23655. }
  23656. declare module "babylonjs/Physics/IPhysicsEngine" {
  23657. import { Nullable } from "babylonjs/types";
  23658. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23659. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23660. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23661. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23662. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23663. /**
  23664. * Interface used to describe a physics joint
  23665. */
  23666. export interface PhysicsImpostorJoint {
  23667. /** Defines the main impostor to which the joint is linked */
  23668. mainImpostor: PhysicsImpostor;
  23669. /** Defines the impostor that is connected to the main impostor using this joint */
  23670. connectedImpostor: PhysicsImpostor;
  23671. /** Defines the joint itself */
  23672. joint: PhysicsJoint;
  23673. }
  23674. /** @hidden */
  23675. export interface IPhysicsEnginePlugin {
  23676. world: any;
  23677. name: string;
  23678. setGravity(gravity: Vector3): void;
  23679. setTimeStep(timeStep: number): void;
  23680. getTimeStep(): number;
  23681. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23682. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23683. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23684. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23685. removePhysicsBody(impostor: PhysicsImpostor): void;
  23686. generateJoint(joint: PhysicsImpostorJoint): void;
  23687. removeJoint(joint: PhysicsImpostorJoint): void;
  23688. isSupported(): boolean;
  23689. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23690. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23691. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23692. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23693. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23694. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23695. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23696. getBodyMass(impostor: PhysicsImpostor): number;
  23697. getBodyFriction(impostor: PhysicsImpostor): number;
  23698. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23699. getBodyRestitution(impostor: PhysicsImpostor): number;
  23700. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23701. getBodyPressure?(impostor: PhysicsImpostor): number;
  23702. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23703. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23704. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23705. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23706. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23707. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23708. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23709. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23710. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23711. sleepBody(impostor: PhysicsImpostor): void;
  23712. wakeUpBody(impostor: PhysicsImpostor): void;
  23713. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23714. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23715. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23716. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23717. getRadius(impostor: PhysicsImpostor): number;
  23718. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23719. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23720. dispose(): void;
  23721. }
  23722. /**
  23723. * Interface used to define a physics engine
  23724. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23725. */
  23726. export interface IPhysicsEngine {
  23727. /**
  23728. * Gets the gravity vector used by the simulation
  23729. */
  23730. gravity: Vector3;
  23731. /**
  23732. * Sets the gravity vector used by the simulation
  23733. * @param gravity defines the gravity vector to use
  23734. */
  23735. setGravity(gravity: Vector3): void;
  23736. /**
  23737. * Set the time step of the physics engine.
  23738. * Default is 1/60.
  23739. * To slow it down, enter 1/600 for example.
  23740. * To speed it up, 1/30
  23741. * @param newTimeStep the new timestep to apply to this world.
  23742. */
  23743. setTimeStep(newTimeStep: number): void;
  23744. /**
  23745. * Get the time step of the physics engine.
  23746. * @returns the current time step
  23747. */
  23748. getTimeStep(): number;
  23749. /**
  23750. * Release all resources
  23751. */
  23752. dispose(): void;
  23753. /**
  23754. * Gets the name of the current physics plugin
  23755. * @returns the name of the plugin
  23756. */
  23757. getPhysicsPluginName(): string;
  23758. /**
  23759. * Adding a new impostor for the impostor tracking.
  23760. * This will be done by the impostor itself.
  23761. * @param impostor the impostor to add
  23762. */
  23763. addImpostor(impostor: PhysicsImpostor): void;
  23764. /**
  23765. * Remove an impostor from the engine.
  23766. * This impostor and its mesh will not longer be updated by the physics engine.
  23767. * @param impostor the impostor to remove
  23768. */
  23769. removeImpostor(impostor: PhysicsImpostor): void;
  23770. /**
  23771. * Add a joint to the physics engine
  23772. * @param mainImpostor defines the main impostor to which the joint is added.
  23773. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23774. * @param joint defines the joint that will connect both impostors.
  23775. */
  23776. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23777. /**
  23778. * Removes a joint from the simulation
  23779. * @param mainImpostor defines the impostor used with the joint
  23780. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23781. * @param joint defines the joint to remove
  23782. */
  23783. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23784. /**
  23785. * Gets the current plugin used to run the simulation
  23786. * @returns current plugin
  23787. */
  23788. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23789. /**
  23790. * Gets the list of physic impostors
  23791. * @returns an array of PhysicsImpostor
  23792. */
  23793. getImpostors(): Array<PhysicsImpostor>;
  23794. /**
  23795. * Gets the impostor for a physics enabled object
  23796. * @param object defines the object impersonated by the impostor
  23797. * @returns the PhysicsImpostor or null if not found
  23798. */
  23799. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23800. /**
  23801. * Gets the impostor for a physics body object
  23802. * @param body defines physics body used by the impostor
  23803. * @returns the PhysicsImpostor or null if not found
  23804. */
  23805. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23806. /**
  23807. * Does a raycast in the physics world
  23808. * @param from when should the ray start?
  23809. * @param to when should the ray end?
  23810. * @returns PhysicsRaycastResult
  23811. */
  23812. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23813. /**
  23814. * Called by the scene. No need to call it.
  23815. * @param delta defines the timespam between frames
  23816. */
  23817. _step(delta: number): void;
  23818. }
  23819. }
  23820. declare module "babylonjs/Physics/physicsImpostor" {
  23821. import { Nullable, IndicesArray } from "babylonjs/types";
  23822. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23823. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23824. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23825. import { Scene } from "babylonjs/scene";
  23826. import { Bone } from "babylonjs/Bones/bone";
  23827. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23828. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23829. import { Space } from "babylonjs/Maths/math.axis";
  23830. /**
  23831. * The interface for the physics imposter parameters
  23832. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23833. */
  23834. export interface PhysicsImpostorParameters {
  23835. /**
  23836. * The mass of the physics imposter
  23837. */
  23838. mass: number;
  23839. /**
  23840. * The friction of the physics imposter
  23841. */
  23842. friction?: number;
  23843. /**
  23844. * The coefficient of restitution of the physics imposter
  23845. */
  23846. restitution?: number;
  23847. /**
  23848. * The native options of the physics imposter
  23849. */
  23850. nativeOptions?: any;
  23851. /**
  23852. * Specifies if the parent should be ignored
  23853. */
  23854. ignoreParent?: boolean;
  23855. /**
  23856. * Specifies if bi-directional transformations should be disabled
  23857. */
  23858. disableBidirectionalTransformation?: boolean;
  23859. /**
  23860. * The pressure inside the physics imposter, soft object only
  23861. */
  23862. pressure?: number;
  23863. /**
  23864. * The stiffness the physics imposter, soft object only
  23865. */
  23866. stiffness?: number;
  23867. /**
  23868. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23869. */
  23870. velocityIterations?: number;
  23871. /**
  23872. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23873. */
  23874. positionIterations?: number;
  23875. /**
  23876. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23877. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23878. * Add to fix multiple points
  23879. */
  23880. fixedPoints?: number;
  23881. /**
  23882. * The collision margin around a soft object
  23883. */
  23884. margin?: number;
  23885. /**
  23886. * The collision margin around a soft object
  23887. */
  23888. damping?: number;
  23889. /**
  23890. * The path for a rope based on an extrusion
  23891. */
  23892. path?: any;
  23893. /**
  23894. * The shape of an extrusion used for a rope based on an extrusion
  23895. */
  23896. shape?: any;
  23897. }
  23898. /**
  23899. * Interface for a physics-enabled object
  23900. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23901. */
  23902. export interface IPhysicsEnabledObject {
  23903. /**
  23904. * The position of the physics-enabled object
  23905. */
  23906. position: Vector3;
  23907. /**
  23908. * The rotation of the physics-enabled object
  23909. */
  23910. rotationQuaternion: Nullable<Quaternion>;
  23911. /**
  23912. * The scale of the physics-enabled object
  23913. */
  23914. scaling: Vector3;
  23915. /**
  23916. * The rotation of the physics-enabled object
  23917. */
  23918. rotation?: Vector3;
  23919. /**
  23920. * The parent of the physics-enabled object
  23921. */
  23922. parent?: any;
  23923. /**
  23924. * The bounding info of the physics-enabled object
  23925. * @returns The bounding info of the physics-enabled object
  23926. */
  23927. getBoundingInfo(): BoundingInfo;
  23928. /**
  23929. * Computes the world matrix
  23930. * @param force Specifies if the world matrix should be computed by force
  23931. * @returns A world matrix
  23932. */
  23933. computeWorldMatrix(force: boolean): Matrix;
  23934. /**
  23935. * Gets the world matrix
  23936. * @returns A world matrix
  23937. */
  23938. getWorldMatrix?(): Matrix;
  23939. /**
  23940. * Gets the child meshes
  23941. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23942. * @returns An array of abstract meshes
  23943. */
  23944. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23945. /**
  23946. * Gets the vertex data
  23947. * @param kind The type of vertex data
  23948. * @returns A nullable array of numbers, or a float32 array
  23949. */
  23950. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23951. /**
  23952. * Gets the indices from the mesh
  23953. * @returns A nullable array of index arrays
  23954. */
  23955. getIndices?(): Nullable<IndicesArray>;
  23956. /**
  23957. * Gets the scene from the mesh
  23958. * @returns the indices array or null
  23959. */
  23960. getScene?(): Scene;
  23961. /**
  23962. * Gets the absolute position from the mesh
  23963. * @returns the absolute position
  23964. */
  23965. getAbsolutePosition(): Vector3;
  23966. /**
  23967. * Gets the absolute pivot point from the mesh
  23968. * @returns the absolute pivot point
  23969. */
  23970. getAbsolutePivotPoint(): Vector3;
  23971. /**
  23972. * Rotates the mesh
  23973. * @param axis The axis of rotation
  23974. * @param amount The amount of rotation
  23975. * @param space The space of the rotation
  23976. * @returns The rotation transform node
  23977. */
  23978. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23979. /**
  23980. * Translates the mesh
  23981. * @param axis The axis of translation
  23982. * @param distance The distance of translation
  23983. * @param space The space of the translation
  23984. * @returns The transform node
  23985. */
  23986. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23987. /**
  23988. * Sets the absolute position of the mesh
  23989. * @param absolutePosition The absolute position of the mesh
  23990. * @returns The transform node
  23991. */
  23992. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23993. /**
  23994. * Gets the class name of the mesh
  23995. * @returns The class name
  23996. */
  23997. getClassName(): string;
  23998. }
  23999. /**
  24000. * Represents a physics imposter
  24001. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  24002. */
  24003. export class PhysicsImpostor {
  24004. /**
  24005. * The physics-enabled object used as the physics imposter
  24006. */
  24007. object: IPhysicsEnabledObject;
  24008. /**
  24009. * The type of the physics imposter
  24010. */
  24011. type: number;
  24012. private _options;
  24013. private _scene?;
  24014. /**
  24015. * The default object size of the imposter
  24016. */
  24017. static DEFAULT_OBJECT_SIZE: Vector3;
  24018. /**
  24019. * The identity quaternion of the imposter
  24020. */
  24021. static IDENTITY_QUATERNION: Quaternion;
  24022. /** @hidden */
  24023. _pluginData: any;
  24024. private _physicsEngine;
  24025. private _physicsBody;
  24026. private _bodyUpdateRequired;
  24027. private _onBeforePhysicsStepCallbacks;
  24028. private _onAfterPhysicsStepCallbacks;
  24029. /** @hidden */
  24030. _onPhysicsCollideCallbacks: Array<{
  24031. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  24032. otherImpostors: Array<PhysicsImpostor>;
  24033. }>;
  24034. private _deltaPosition;
  24035. private _deltaRotation;
  24036. private _deltaRotationConjugated;
  24037. /** @hidden */
  24038. _isFromLine: boolean;
  24039. private _parent;
  24040. private _isDisposed;
  24041. private static _tmpVecs;
  24042. private static _tmpQuat;
  24043. /**
  24044. * Specifies if the physics imposter is disposed
  24045. */
  24046. readonly isDisposed: boolean;
  24047. /**
  24048. * Gets the mass of the physics imposter
  24049. */
  24050. mass: number;
  24051. /**
  24052. * Gets the coefficient of friction
  24053. */
  24054. /**
  24055. * Sets the coefficient of friction
  24056. */
  24057. friction: number;
  24058. /**
  24059. * Gets the coefficient of restitution
  24060. */
  24061. /**
  24062. * Sets the coefficient of restitution
  24063. */
  24064. restitution: number;
  24065. /**
  24066. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  24067. */
  24068. /**
  24069. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  24070. */
  24071. pressure: number;
  24072. /**
  24073. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  24074. */
  24075. /**
  24076. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  24077. */
  24078. stiffness: number;
  24079. /**
  24080. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  24081. */
  24082. /**
  24083. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  24084. */
  24085. velocityIterations: number;
  24086. /**
  24087. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  24088. */
  24089. /**
  24090. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  24091. */
  24092. positionIterations: number;
  24093. /**
  24094. * The unique id of the physics imposter
  24095. * set by the physics engine when adding this impostor to the array
  24096. */
  24097. uniqueId: number;
  24098. /**
  24099. * @hidden
  24100. */
  24101. soft: boolean;
  24102. /**
  24103. * @hidden
  24104. */
  24105. segments: number;
  24106. private _joints;
  24107. /**
  24108. * Initializes the physics imposter
  24109. * @param object The physics-enabled object used as the physics imposter
  24110. * @param type The type of the physics imposter
  24111. * @param _options The options for the physics imposter
  24112. * @param _scene The Babylon scene
  24113. */
  24114. constructor(
  24115. /**
  24116. * The physics-enabled object used as the physics imposter
  24117. */
  24118. object: IPhysicsEnabledObject,
  24119. /**
  24120. * The type of the physics imposter
  24121. */
  24122. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  24123. /**
  24124. * This function will completly initialize this impostor.
  24125. * It will create a new body - but only if this mesh has no parent.
  24126. * If it has, this impostor will not be used other than to define the impostor
  24127. * of the child mesh.
  24128. * @hidden
  24129. */
  24130. _init(): void;
  24131. private _getPhysicsParent;
  24132. /**
  24133. * Should a new body be generated.
  24134. * @returns boolean specifying if body initialization is required
  24135. */
  24136. isBodyInitRequired(): boolean;
  24137. /**
  24138. * Sets the updated scaling
  24139. * @param updated Specifies if the scaling is updated
  24140. */
  24141. setScalingUpdated(): void;
  24142. /**
  24143. * Force a regeneration of this or the parent's impostor's body.
  24144. * Use under cautious - This will remove all joints already implemented.
  24145. */
  24146. forceUpdate(): void;
  24147. /**
  24148. * Gets the body that holds this impostor. Either its own, or its parent.
  24149. */
  24150. /**
  24151. * Set the physics body. Used mainly by the physics engine/plugin
  24152. */
  24153. physicsBody: any;
  24154. /**
  24155. * Get the parent of the physics imposter
  24156. * @returns Physics imposter or null
  24157. */
  24158. /**
  24159. * Sets the parent of the physics imposter
  24160. */
  24161. parent: Nullable<PhysicsImpostor>;
  24162. /**
  24163. * Resets the update flags
  24164. */
  24165. resetUpdateFlags(): void;
  24166. /**
  24167. * Gets the object extend size
  24168. * @returns the object extend size
  24169. */
  24170. getObjectExtendSize(): Vector3;
  24171. /**
  24172. * Gets the object center
  24173. * @returns The object center
  24174. */
  24175. getObjectCenter(): Vector3;
  24176. /**
  24177. * Get a specific parametes from the options parameter
  24178. * @param paramName The object parameter name
  24179. * @returns The object parameter
  24180. */
  24181. getParam(paramName: string): any;
  24182. /**
  24183. * Sets a specific parameter in the options given to the physics plugin
  24184. * @param paramName The parameter name
  24185. * @param value The value of the parameter
  24186. */
  24187. setParam(paramName: string, value: number): void;
  24188. /**
  24189. * Specifically change the body's mass option. Won't recreate the physics body object
  24190. * @param mass The mass of the physics imposter
  24191. */
  24192. setMass(mass: number): void;
  24193. /**
  24194. * Gets the linear velocity
  24195. * @returns linear velocity or null
  24196. */
  24197. getLinearVelocity(): Nullable<Vector3>;
  24198. /**
  24199. * Sets the linear velocity
  24200. * @param velocity linear velocity or null
  24201. */
  24202. setLinearVelocity(velocity: Nullable<Vector3>): void;
  24203. /**
  24204. * Gets the angular velocity
  24205. * @returns angular velocity or null
  24206. */
  24207. getAngularVelocity(): Nullable<Vector3>;
  24208. /**
  24209. * Sets the angular velocity
  24210. * @param velocity The velocity or null
  24211. */
  24212. setAngularVelocity(velocity: Nullable<Vector3>): void;
  24213. /**
  24214. * Execute a function with the physics plugin native code
  24215. * Provide a function the will have two variables - the world object and the physics body object
  24216. * @param func The function to execute with the physics plugin native code
  24217. */
  24218. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  24219. /**
  24220. * Register a function that will be executed before the physics world is stepping forward
  24221. * @param func The function to execute before the physics world is stepped forward
  24222. */
  24223. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24224. /**
  24225. * Unregister a function that will be executed before the physics world is stepping forward
  24226. * @param func The function to execute before the physics world is stepped forward
  24227. */
  24228. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24229. /**
  24230. * Register a function that will be executed after the physics step
  24231. * @param func The function to execute after physics step
  24232. */
  24233. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24234. /**
  24235. * Unregisters a function that will be executed after the physics step
  24236. * @param func The function to execute after physics step
  24237. */
  24238. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24239. /**
  24240. * register a function that will be executed when this impostor collides against a different body
  24241. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  24242. * @param func Callback that is executed on collision
  24243. */
  24244. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  24245. /**
  24246. * Unregisters the physics imposter on contact
  24247. * @param collideAgainst The physics object to collide against
  24248. * @param func Callback to execute on collision
  24249. */
  24250. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  24251. private _tmpQuat;
  24252. private _tmpQuat2;
  24253. /**
  24254. * Get the parent rotation
  24255. * @returns The parent rotation
  24256. */
  24257. getParentsRotation(): Quaternion;
  24258. /**
  24259. * this function is executed by the physics engine.
  24260. */
  24261. beforeStep: () => void;
  24262. /**
  24263. * this function is executed by the physics engine
  24264. */
  24265. afterStep: () => void;
  24266. /**
  24267. * Legacy collision detection event support
  24268. */
  24269. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  24270. /**
  24271. * event and body object due to cannon's event-based architecture.
  24272. */
  24273. onCollide: (e: {
  24274. body: any;
  24275. }) => void;
  24276. /**
  24277. * Apply a force
  24278. * @param force The force to apply
  24279. * @param contactPoint The contact point for the force
  24280. * @returns The physics imposter
  24281. */
  24282. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24283. /**
  24284. * Apply an impulse
  24285. * @param force The impulse force
  24286. * @param contactPoint The contact point for the impulse force
  24287. * @returns The physics imposter
  24288. */
  24289. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24290. /**
  24291. * A help function to create a joint
  24292. * @param otherImpostor A physics imposter used to create a joint
  24293. * @param jointType The type of joint
  24294. * @param jointData The data for the joint
  24295. * @returns The physics imposter
  24296. */
  24297. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  24298. /**
  24299. * Add a joint to this impostor with a different impostor
  24300. * @param otherImpostor A physics imposter used to add a joint
  24301. * @param joint The joint to add
  24302. * @returns The physics imposter
  24303. */
  24304. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  24305. /**
  24306. * Add an anchor to a cloth impostor
  24307. * @param otherImpostor rigid impostor to anchor to
  24308. * @param width ratio across width from 0 to 1
  24309. * @param height ratio up height from 0 to 1
  24310. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  24311. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  24312. * @returns impostor the soft imposter
  24313. */
  24314. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24315. /**
  24316. * Add a hook to a rope impostor
  24317. * @param otherImpostor rigid impostor to anchor to
  24318. * @param length ratio across rope from 0 to 1
  24319. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  24320. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  24321. * @returns impostor the rope imposter
  24322. */
  24323. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24324. /**
  24325. * Will keep this body still, in a sleep mode.
  24326. * @returns the physics imposter
  24327. */
  24328. sleep(): PhysicsImpostor;
  24329. /**
  24330. * Wake the body up.
  24331. * @returns The physics imposter
  24332. */
  24333. wakeUp(): PhysicsImpostor;
  24334. /**
  24335. * Clones the physics imposter
  24336. * @param newObject The physics imposter clones to this physics-enabled object
  24337. * @returns A nullable physics imposter
  24338. */
  24339. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  24340. /**
  24341. * Disposes the physics imposter
  24342. */
  24343. dispose(): void;
  24344. /**
  24345. * Sets the delta position
  24346. * @param position The delta position amount
  24347. */
  24348. setDeltaPosition(position: Vector3): void;
  24349. /**
  24350. * Sets the delta rotation
  24351. * @param rotation The delta rotation amount
  24352. */
  24353. setDeltaRotation(rotation: Quaternion): void;
  24354. /**
  24355. * Gets the box size of the physics imposter and stores the result in the input parameter
  24356. * @param result Stores the box size
  24357. * @returns The physics imposter
  24358. */
  24359. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  24360. /**
  24361. * Gets the radius of the physics imposter
  24362. * @returns Radius of the physics imposter
  24363. */
  24364. getRadius(): number;
  24365. /**
  24366. * Sync a bone with this impostor
  24367. * @param bone The bone to sync to the impostor.
  24368. * @param boneMesh The mesh that the bone is influencing.
  24369. * @param jointPivot The pivot of the joint / bone in local space.
  24370. * @param distToJoint Optional distance from the impostor to the joint.
  24371. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24372. */
  24373. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  24374. /**
  24375. * Sync impostor to a bone
  24376. * @param bone The bone that the impostor will be synced to.
  24377. * @param boneMesh The mesh that the bone is influencing.
  24378. * @param jointPivot The pivot of the joint / bone in local space.
  24379. * @param distToJoint Optional distance from the impostor to the joint.
  24380. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24381. * @param boneAxis Optional vector3 axis the bone is aligned with
  24382. */
  24383. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  24384. /**
  24385. * No-Imposter type
  24386. */
  24387. static NoImpostor: number;
  24388. /**
  24389. * Sphere-Imposter type
  24390. */
  24391. static SphereImpostor: number;
  24392. /**
  24393. * Box-Imposter type
  24394. */
  24395. static BoxImpostor: number;
  24396. /**
  24397. * Plane-Imposter type
  24398. */
  24399. static PlaneImpostor: number;
  24400. /**
  24401. * Mesh-imposter type
  24402. */
  24403. static MeshImpostor: number;
  24404. /**
  24405. * Capsule-Impostor type (Ammo.js plugin only)
  24406. */
  24407. static CapsuleImpostor: number;
  24408. /**
  24409. * Cylinder-Imposter type
  24410. */
  24411. static CylinderImpostor: number;
  24412. /**
  24413. * Particle-Imposter type
  24414. */
  24415. static ParticleImpostor: number;
  24416. /**
  24417. * Heightmap-Imposter type
  24418. */
  24419. static HeightmapImpostor: number;
  24420. /**
  24421. * ConvexHull-Impostor type (Ammo.js plugin only)
  24422. */
  24423. static ConvexHullImpostor: number;
  24424. /**
  24425. * Rope-Imposter type
  24426. */
  24427. static RopeImpostor: number;
  24428. /**
  24429. * Cloth-Imposter type
  24430. */
  24431. static ClothImpostor: number;
  24432. /**
  24433. * Softbody-Imposter type
  24434. */
  24435. static SoftbodyImpostor: number;
  24436. }
  24437. }
  24438. declare module "babylonjs/Meshes/mesh" {
  24439. import { Observable } from "babylonjs/Misc/observable";
  24440. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24441. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  24442. import { Camera } from "babylonjs/Cameras/camera";
  24443. import { Scene } from "babylonjs/scene";
  24444. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  24445. import { Color4 } from "babylonjs/Maths/math.color";
  24446. import { Engine } from "babylonjs/Engines/engine";
  24447. import { Node } from "babylonjs/node";
  24448. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  24449. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  24450. import { Buffer } from "babylonjs/Meshes/buffer";
  24451. import { Geometry } from "babylonjs/Meshes/geometry";
  24452. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24453. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24454. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  24455. import { Effect } from "babylonjs/Materials/effect";
  24456. import { Material } from "babylonjs/Materials/material";
  24457. import { Skeleton } from "babylonjs/Bones/skeleton";
  24458. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  24459. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  24460. import { Path3D } from "babylonjs/Maths/math.path";
  24461. import { Plane } from "babylonjs/Maths/math.plane";
  24462. import { TransformNode } from "babylonjs/Meshes/transformNode";
  24463. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  24464. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  24465. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  24466. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  24467. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  24468. /**
  24469. * @hidden
  24470. **/
  24471. export class _CreationDataStorage {
  24472. closePath?: boolean;
  24473. closeArray?: boolean;
  24474. idx: number[];
  24475. dashSize: number;
  24476. gapSize: number;
  24477. path3D: Path3D;
  24478. pathArray: Vector3[][];
  24479. arc: number;
  24480. radius: number;
  24481. cap: number;
  24482. tessellation: number;
  24483. }
  24484. /**
  24485. * @hidden
  24486. **/
  24487. class _InstanceDataStorage {
  24488. visibleInstances: any;
  24489. batchCache: _InstancesBatch;
  24490. instancesBufferSize: number;
  24491. instancesBuffer: Nullable<Buffer>;
  24492. instancesData: Float32Array;
  24493. overridenInstanceCount: number;
  24494. isFrozen: boolean;
  24495. previousBatch: Nullable<_InstancesBatch>;
  24496. hardwareInstancedRendering: boolean;
  24497. sideOrientation: number;
  24498. manualUpdate: boolean;
  24499. }
  24500. /**
  24501. * @hidden
  24502. **/
  24503. export class _InstancesBatch {
  24504. mustReturn: boolean;
  24505. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  24506. renderSelf: boolean[];
  24507. hardwareInstancedRendering: boolean[];
  24508. }
  24509. /**
  24510. * Class used to represent renderable models
  24511. */
  24512. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  24513. /**
  24514. * Mesh side orientation : usually the external or front surface
  24515. */
  24516. static readonly FRONTSIDE: number;
  24517. /**
  24518. * Mesh side orientation : usually the internal or back surface
  24519. */
  24520. static readonly BACKSIDE: number;
  24521. /**
  24522. * Mesh side orientation : both internal and external or front and back surfaces
  24523. */
  24524. static readonly DOUBLESIDE: number;
  24525. /**
  24526. * Mesh side orientation : by default, `FRONTSIDE`
  24527. */
  24528. static readonly DEFAULTSIDE: number;
  24529. /**
  24530. * Mesh cap setting : no cap
  24531. */
  24532. static readonly NO_CAP: number;
  24533. /**
  24534. * Mesh cap setting : one cap at the beginning of the mesh
  24535. */
  24536. static readonly CAP_START: number;
  24537. /**
  24538. * Mesh cap setting : one cap at the end of the mesh
  24539. */
  24540. static readonly CAP_END: number;
  24541. /**
  24542. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  24543. */
  24544. static readonly CAP_ALL: number;
  24545. /**
  24546. * Mesh pattern setting : no flip or rotate
  24547. */
  24548. static readonly NO_FLIP: number;
  24549. /**
  24550. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  24551. */
  24552. static readonly FLIP_TILE: number;
  24553. /**
  24554. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  24555. */
  24556. static readonly ROTATE_TILE: number;
  24557. /**
  24558. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  24559. */
  24560. static readonly FLIP_ROW: number;
  24561. /**
  24562. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  24563. */
  24564. static readonly ROTATE_ROW: number;
  24565. /**
  24566. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  24567. */
  24568. static readonly FLIP_N_ROTATE_TILE: number;
  24569. /**
  24570. * Mesh pattern setting : rotate pattern and rotate
  24571. */
  24572. static readonly FLIP_N_ROTATE_ROW: number;
  24573. /**
  24574. * Mesh tile positioning : part tiles same on left/right or top/bottom
  24575. */
  24576. static readonly CENTER: number;
  24577. /**
  24578. * Mesh tile positioning : part tiles on left
  24579. */
  24580. static readonly LEFT: number;
  24581. /**
  24582. * Mesh tile positioning : part tiles on right
  24583. */
  24584. static readonly RIGHT: number;
  24585. /**
  24586. * Mesh tile positioning : part tiles on top
  24587. */
  24588. static readonly TOP: number;
  24589. /**
  24590. * Mesh tile positioning : part tiles on bottom
  24591. */
  24592. static readonly BOTTOM: number;
  24593. /**
  24594. * Gets the default side orientation.
  24595. * @param orientation the orientation to value to attempt to get
  24596. * @returns the default orientation
  24597. * @hidden
  24598. */
  24599. static _GetDefaultSideOrientation(orientation?: number): number;
  24600. private _internalMeshDataInfo;
  24601. /**
  24602. * An event triggered before rendering the mesh
  24603. */
  24604. readonly onBeforeRenderObservable: Observable<Mesh>;
  24605. /**
  24606. * An event triggered before binding the mesh
  24607. */
  24608. readonly onBeforeBindObservable: Observable<Mesh>;
  24609. /**
  24610. * An event triggered after rendering the mesh
  24611. */
  24612. readonly onAfterRenderObservable: Observable<Mesh>;
  24613. /**
  24614. * An event triggered before drawing the mesh
  24615. */
  24616. readonly onBeforeDrawObservable: Observable<Mesh>;
  24617. private _onBeforeDrawObserver;
  24618. /**
  24619. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24620. */
  24621. onBeforeDraw: () => void;
  24622. readonly hasInstances: boolean;
  24623. /**
  24624. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24625. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24626. */
  24627. delayLoadState: number;
  24628. /**
  24629. * Gets the list of instances created from this mesh
  24630. * it is not supposed to be modified manually.
  24631. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24632. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24633. */
  24634. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24635. /**
  24636. * Gets the file containing delay loading data for this mesh
  24637. */
  24638. delayLoadingFile: string;
  24639. /** @hidden */
  24640. _binaryInfo: any;
  24641. /**
  24642. * User defined function used to change how LOD level selection is done
  24643. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24644. */
  24645. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24646. /**
  24647. * Gets or sets the morph target manager
  24648. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24649. */
  24650. morphTargetManager: Nullable<MorphTargetManager>;
  24651. /** @hidden */
  24652. _creationDataStorage: Nullable<_CreationDataStorage>;
  24653. /** @hidden */
  24654. _geometry: Nullable<Geometry>;
  24655. /** @hidden */
  24656. _delayInfo: Array<string>;
  24657. /** @hidden */
  24658. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24659. /** @hidden */
  24660. _instanceDataStorage: _InstanceDataStorage;
  24661. private _effectiveMaterial;
  24662. /** @hidden */
  24663. _shouldGenerateFlatShading: boolean;
  24664. /** @hidden */
  24665. _originalBuilderSideOrientation: number;
  24666. /**
  24667. * Use this property to change the original side orientation defined at construction time
  24668. */
  24669. overrideMaterialSideOrientation: Nullable<number>;
  24670. /**
  24671. * Gets the source mesh (the one used to clone this one from)
  24672. */
  24673. readonly source: Nullable<Mesh>;
  24674. /**
  24675. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24676. */
  24677. isUnIndexed: boolean;
  24678. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  24679. readonly worldMatrixInstancedBuffer: Float32Array;
  24680. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  24681. manualUpdateOfWorldMatrixInstancedBuffer: boolean;
  24682. /**
  24683. * @constructor
  24684. * @param name The value used by scene.getMeshByName() to do a lookup.
  24685. * @param scene The scene to add this mesh to.
  24686. * @param parent The parent of this mesh, if it has one
  24687. * @param source An optional Mesh from which geometry is shared, cloned.
  24688. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24689. * When false, achieved by calling a clone(), also passing False.
  24690. * This will make creation of children, recursive.
  24691. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24692. */
  24693. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24694. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  24695. doNotInstantiate: boolean;
  24696. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  24697. /**
  24698. * Gets the class name
  24699. * @returns the string "Mesh".
  24700. */
  24701. getClassName(): string;
  24702. /** @hidden */
  24703. readonly _isMesh: boolean;
  24704. /**
  24705. * Returns a description of this mesh
  24706. * @param fullDetails define if full details about this mesh must be used
  24707. * @returns a descriptive string representing this mesh
  24708. */
  24709. toString(fullDetails?: boolean): string;
  24710. /** @hidden */
  24711. _unBindEffect(): void;
  24712. /**
  24713. * Gets a boolean indicating if this mesh has LOD
  24714. */
  24715. readonly hasLODLevels: boolean;
  24716. /**
  24717. * Gets the list of MeshLODLevel associated with the current mesh
  24718. * @returns an array of MeshLODLevel
  24719. */
  24720. getLODLevels(): MeshLODLevel[];
  24721. private _sortLODLevels;
  24722. /**
  24723. * Add a mesh as LOD level triggered at the given distance.
  24724. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24725. * @param distance The distance from the center of the object to show this level
  24726. * @param mesh The mesh to be added as LOD level (can be null)
  24727. * @return This mesh (for chaining)
  24728. */
  24729. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24730. /**
  24731. * Returns the LOD level mesh at the passed distance or null if not found.
  24732. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24733. * @param distance The distance from the center of the object to show this level
  24734. * @returns a Mesh or `null`
  24735. */
  24736. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24737. /**
  24738. * Remove a mesh from the LOD array
  24739. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24740. * @param mesh defines the mesh to be removed
  24741. * @return This mesh (for chaining)
  24742. */
  24743. removeLODLevel(mesh: Mesh): Mesh;
  24744. /**
  24745. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24746. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24747. * @param camera defines the camera to use to compute distance
  24748. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24749. * @return This mesh (for chaining)
  24750. */
  24751. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24752. /**
  24753. * Gets the mesh internal Geometry object
  24754. */
  24755. readonly geometry: Nullable<Geometry>;
  24756. /**
  24757. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24758. * @returns the total number of vertices
  24759. */
  24760. getTotalVertices(): number;
  24761. /**
  24762. * Returns the content of an associated vertex buffer
  24763. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24764. * - VertexBuffer.PositionKind
  24765. * - VertexBuffer.UVKind
  24766. * - VertexBuffer.UV2Kind
  24767. * - VertexBuffer.UV3Kind
  24768. * - VertexBuffer.UV4Kind
  24769. * - VertexBuffer.UV5Kind
  24770. * - VertexBuffer.UV6Kind
  24771. * - VertexBuffer.ColorKind
  24772. * - VertexBuffer.MatricesIndicesKind
  24773. * - VertexBuffer.MatricesIndicesExtraKind
  24774. * - VertexBuffer.MatricesWeightsKind
  24775. * - VertexBuffer.MatricesWeightsExtraKind
  24776. * @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
  24777. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24778. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24779. */
  24780. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24781. /**
  24782. * Returns the mesh VertexBuffer object from the requested `kind`
  24783. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24784. * - VertexBuffer.PositionKind
  24785. * - VertexBuffer.NormalKind
  24786. * - VertexBuffer.UVKind
  24787. * - VertexBuffer.UV2Kind
  24788. * - VertexBuffer.UV3Kind
  24789. * - VertexBuffer.UV4Kind
  24790. * - VertexBuffer.UV5Kind
  24791. * - VertexBuffer.UV6Kind
  24792. * - VertexBuffer.ColorKind
  24793. * - VertexBuffer.MatricesIndicesKind
  24794. * - VertexBuffer.MatricesIndicesExtraKind
  24795. * - VertexBuffer.MatricesWeightsKind
  24796. * - VertexBuffer.MatricesWeightsExtraKind
  24797. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24798. */
  24799. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24800. /**
  24801. * Tests if a specific vertex buffer is associated with this mesh
  24802. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24803. * - VertexBuffer.PositionKind
  24804. * - VertexBuffer.NormalKind
  24805. * - VertexBuffer.UVKind
  24806. * - VertexBuffer.UV2Kind
  24807. * - VertexBuffer.UV3Kind
  24808. * - VertexBuffer.UV4Kind
  24809. * - VertexBuffer.UV5Kind
  24810. * - VertexBuffer.UV6Kind
  24811. * - VertexBuffer.ColorKind
  24812. * - VertexBuffer.MatricesIndicesKind
  24813. * - VertexBuffer.MatricesIndicesExtraKind
  24814. * - VertexBuffer.MatricesWeightsKind
  24815. * - VertexBuffer.MatricesWeightsExtraKind
  24816. * @returns a boolean
  24817. */
  24818. isVerticesDataPresent(kind: string): boolean;
  24819. /**
  24820. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24821. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24822. * - VertexBuffer.PositionKind
  24823. * - VertexBuffer.UVKind
  24824. * - VertexBuffer.UV2Kind
  24825. * - VertexBuffer.UV3Kind
  24826. * - VertexBuffer.UV4Kind
  24827. * - VertexBuffer.UV5Kind
  24828. * - VertexBuffer.UV6Kind
  24829. * - VertexBuffer.ColorKind
  24830. * - VertexBuffer.MatricesIndicesKind
  24831. * - VertexBuffer.MatricesIndicesExtraKind
  24832. * - VertexBuffer.MatricesWeightsKind
  24833. * - VertexBuffer.MatricesWeightsExtraKind
  24834. * @returns a boolean
  24835. */
  24836. isVertexBufferUpdatable(kind: string): boolean;
  24837. /**
  24838. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24839. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24840. * - VertexBuffer.PositionKind
  24841. * - VertexBuffer.NormalKind
  24842. * - VertexBuffer.UVKind
  24843. * - VertexBuffer.UV2Kind
  24844. * - VertexBuffer.UV3Kind
  24845. * - VertexBuffer.UV4Kind
  24846. * - VertexBuffer.UV5Kind
  24847. * - VertexBuffer.UV6Kind
  24848. * - VertexBuffer.ColorKind
  24849. * - VertexBuffer.MatricesIndicesKind
  24850. * - VertexBuffer.MatricesIndicesExtraKind
  24851. * - VertexBuffer.MatricesWeightsKind
  24852. * - VertexBuffer.MatricesWeightsExtraKind
  24853. * @returns an array of strings
  24854. */
  24855. getVerticesDataKinds(): string[];
  24856. /**
  24857. * Returns a positive integer : the total number of indices in this mesh geometry.
  24858. * @returns the numner of indices or zero if the mesh has no geometry.
  24859. */
  24860. getTotalIndices(): number;
  24861. /**
  24862. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24863. * @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.
  24864. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24865. * @returns the indices array or an empty array if the mesh has no geometry
  24866. */
  24867. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24868. readonly isBlocked: boolean;
  24869. /**
  24870. * Determine if the current mesh is ready to be rendered
  24871. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24872. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24873. * @returns true if all associated assets are ready (material, textures, shaders)
  24874. */
  24875. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24876. /**
  24877. * 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.
  24878. */
  24879. readonly areNormalsFrozen: boolean;
  24880. /**
  24881. * 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.
  24882. * @returns the current mesh
  24883. */
  24884. freezeNormals(): Mesh;
  24885. /**
  24886. * 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
  24887. * @returns the current mesh
  24888. */
  24889. unfreezeNormals(): Mesh;
  24890. /**
  24891. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24892. */
  24893. overridenInstanceCount: number;
  24894. /** @hidden */
  24895. _preActivate(): Mesh;
  24896. /** @hidden */
  24897. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24898. /** @hidden */
  24899. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24900. /**
  24901. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24902. * This means the mesh underlying bounding box and sphere are recomputed.
  24903. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24904. * @returns the current mesh
  24905. */
  24906. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24907. /** @hidden */
  24908. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24909. /**
  24910. * This function will subdivide the mesh into multiple submeshes
  24911. * @param count defines the expected number of submeshes
  24912. */
  24913. subdivide(count: number): void;
  24914. /**
  24915. * Copy a FloatArray into a specific associated vertex buffer
  24916. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24917. * - VertexBuffer.PositionKind
  24918. * - VertexBuffer.UVKind
  24919. * - VertexBuffer.UV2Kind
  24920. * - VertexBuffer.UV3Kind
  24921. * - VertexBuffer.UV4Kind
  24922. * - VertexBuffer.UV5Kind
  24923. * - VertexBuffer.UV6Kind
  24924. * - VertexBuffer.ColorKind
  24925. * - VertexBuffer.MatricesIndicesKind
  24926. * - VertexBuffer.MatricesIndicesExtraKind
  24927. * - VertexBuffer.MatricesWeightsKind
  24928. * - VertexBuffer.MatricesWeightsExtraKind
  24929. * @param data defines the data source
  24930. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24931. * @param stride defines the data stride size (can be null)
  24932. * @returns the current mesh
  24933. */
  24934. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  24935. /**
  24936. * Delete a vertex buffer associated with this mesh
  24937. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  24938. * - VertexBuffer.PositionKind
  24939. * - VertexBuffer.UVKind
  24940. * - VertexBuffer.UV2Kind
  24941. * - VertexBuffer.UV3Kind
  24942. * - VertexBuffer.UV4Kind
  24943. * - VertexBuffer.UV5Kind
  24944. * - VertexBuffer.UV6Kind
  24945. * - VertexBuffer.ColorKind
  24946. * - VertexBuffer.MatricesIndicesKind
  24947. * - VertexBuffer.MatricesIndicesExtraKind
  24948. * - VertexBuffer.MatricesWeightsKind
  24949. * - VertexBuffer.MatricesWeightsExtraKind
  24950. */
  24951. removeVerticesData(kind: string): void;
  24952. /**
  24953. * Flags an associated vertex buffer as updatable
  24954. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24955. * - VertexBuffer.PositionKind
  24956. * - VertexBuffer.UVKind
  24957. * - VertexBuffer.UV2Kind
  24958. * - VertexBuffer.UV3Kind
  24959. * - VertexBuffer.UV4Kind
  24960. * - VertexBuffer.UV5Kind
  24961. * - VertexBuffer.UV6Kind
  24962. * - VertexBuffer.ColorKind
  24963. * - VertexBuffer.MatricesIndicesKind
  24964. * - VertexBuffer.MatricesIndicesExtraKind
  24965. * - VertexBuffer.MatricesWeightsKind
  24966. * - VertexBuffer.MatricesWeightsExtraKind
  24967. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24968. */
  24969. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24970. /**
  24971. * Sets the mesh global Vertex Buffer
  24972. * @param buffer defines the buffer to use
  24973. * @returns the current mesh
  24974. */
  24975. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24976. /**
  24977. * Update a specific associated vertex buffer
  24978. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24979. * - VertexBuffer.PositionKind
  24980. * - VertexBuffer.UVKind
  24981. * - VertexBuffer.UV2Kind
  24982. * - VertexBuffer.UV3Kind
  24983. * - VertexBuffer.UV4Kind
  24984. * - VertexBuffer.UV5Kind
  24985. * - VertexBuffer.UV6Kind
  24986. * - VertexBuffer.ColorKind
  24987. * - VertexBuffer.MatricesIndicesKind
  24988. * - VertexBuffer.MatricesIndicesExtraKind
  24989. * - VertexBuffer.MatricesWeightsKind
  24990. * - VertexBuffer.MatricesWeightsExtraKind
  24991. * @param data defines the data source
  24992. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24993. * @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)
  24994. * @returns the current mesh
  24995. */
  24996. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  24997. /**
  24998. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24999. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  25000. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  25001. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  25002. * @returns the current mesh
  25003. */
  25004. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  25005. /**
  25006. * Creates a un-shared specific occurence of the geometry for the mesh.
  25007. * @returns the current mesh
  25008. */
  25009. makeGeometryUnique(): Mesh;
  25010. /**
  25011. * Set the index buffer of this mesh
  25012. * @param indices defines the source data
  25013. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  25014. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  25015. * @returns the current mesh
  25016. */
  25017. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  25018. /**
  25019. * Update the current index buffer
  25020. * @param indices defines the source data
  25021. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  25022. * @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)
  25023. * @returns the current mesh
  25024. */
  25025. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  25026. /**
  25027. * Invert the geometry to move from a right handed system to a left handed one.
  25028. * @returns the current mesh
  25029. */
  25030. toLeftHanded(): Mesh;
  25031. /** @hidden */
  25032. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  25033. /** @hidden */
  25034. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  25035. /**
  25036. * Registers for this mesh a javascript function called just before the rendering process
  25037. * @param func defines the function to call before rendering this mesh
  25038. * @returns the current mesh
  25039. */
  25040. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  25041. /**
  25042. * Disposes a previously registered javascript function called before the rendering
  25043. * @param func defines the function to remove
  25044. * @returns the current mesh
  25045. */
  25046. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  25047. /**
  25048. * Registers for this mesh a javascript function called just after the rendering is complete
  25049. * @param func defines the function to call after rendering this mesh
  25050. * @returns the current mesh
  25051. */
  25052. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  25053. /**
  25054. * Disposes a previously registered javascript function called after the rendering.
  25055. * @param func defines the function to remove
  25056. * @returns the current mesh
  25057. */
  25058. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  25059. /** @hidden */
  25060. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  25061. /** @hidden */
  25062. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  25063. /** @hidden */
  25064. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  25065. /** @hidden */
  25066. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  25067. /** @hidden */
  25068. _rebuild(): void;
  25069. /** @hidden */
  25070. _freeze(): void;
  25071. /** @hidden */
  25072. _unFreeze(): void;
  25073. /**
  25074. * 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
  25075. * @param subMesh defines the subMesh to render
  25076. * @param enableAlphaMode defines if alpha mode can be changed
  25077. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  25078. * @returns the current mesh
  25079. */
  25080. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  25081. private _onBeforeDraw;
  25082. /**
  25083. * Renormalize the mesh and patch it up if there are no weights
  25084. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  25085. * However in the case of zero weights then we set just a single influence to 1.
  25086. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  25087. */
  25088. cleanMatrixWeights(): void;
  25089. private normalizeSkinFourWeights;
  25090. private normalizeSkinWeightsAndExtra;
  25091. /**
  25092. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  25093. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  25094. * the user know there was an issue with importing the mesh
  25095. * @returns a validation object with skinned, valid and report string
  25096. */
  25097. validateSkinning(): {
  25098. skinned: boolean;
  25099. valid: boolean;
  25100. report: string;
  25101. };
  25102. /** @hidden */
  25103. _checkDelayState(): Mesh;
  25104. private _queueLoad;
  25105. /**
  25106. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  25107. * A mesh is in the frustum if its bounding box intersects the frustum
  25108. * @param frustumPlanes defines the frustum to test
  25109. * @returns true if the mesh is in the frustum planes
  25110. */
  25111. isInFrustum(frustumPlanes: Plane[]): boolean;
  25112. /**
  25113. * Sets the mesh material by the material or multiMaterial `id` property
  25114. * @param id is a string identifying the material or the multiMaterial
  25115. * @returns the current mesh
  25116. */
  25117. setMaterialByID(id: string): Mesh;
  25118. /**
  25119. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  25120. * @returns an array of IAnimatable
  25121. */
  25122. getAnimatables(): IAnimatable[];
  25123. /**
  25124. * Modifies the mesh geometry according to the passed transformation matrix.
  25125. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  25126. * The mesh normals are modified using the same transformation.
  25127. * Note that, under the hood, this method sets a new VertexBuffer each call.
  25128. * @param transform defines the transform matrix to use
  25129. * @see http://doc.babylonjs.com/resources/baking_transformations
  25130. * @returns the current mesh
  25131. */
  25132. bakeTransformIntoVertices(transform: Matrix): Mesh;
  25133. /**
  25134. * Modifies the mesh geometry according to its own current World Matrix.
  25135. * The mesh World Matrix is then reset.
  25136. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  25137. * Note that, under the hood, this method sets a new VertexBuffer each call.
  25138. * @see http://doc.babylonjs.com/resources/baking_transformations
  25139. * @returns the current mesh
  25140. */
  25141. bakeCurrentTransformIntoVertices(): Mesh;
  25142. /** @hidden */
  25143. readonly _positions: Nullable<Vector3[]>;
  25144. /** @hidden */
  25145. _resetPointsArrayCache(): Mesh;
  25146. /** @hidden */
  25147. _generatePointsArray(): boolean;
  25148. /**
  25149. * Returns a new Mesh object generated from the current mesh properties.
  25150. * This method must not get confused with createInstance()
  25151. * @param name is a string, the name given to the new mesh
  25152. * @param newParent can be any Node object (default `null`)
  25153. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  25154. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  25155. * @returns a new mesh
  25156. */
  25157. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  25158. /**
  25159. * Releases resources associated with this mesh.
  25160. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25161. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25162. */
  25163. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25164. /** @hidden */
  25165. _disposeInstanceSpecificData(): void;
  25166. /**
  25167. * Modifies the mesh geometry according to a displacement map.
  25168. * 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.
  25169. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25170. * @param url is a string, the URL from the image file is to be downloaded.
  25171. * @param minHeight is the lower limit of the displacement.
  25172. * @param maxHeight is the upper limit of the displacement.
  25173. * @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.
  25174. * @param uvOffset is an optional vector2 used to offset UV.
  25175. * @param uvScale is an optional vector2 used to scale UV.
  25176. * @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.
  25177. * @returns the Mesh.
  25178. */
  25179. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25180. /**
  25181. * Modifies the mesh geometry according to a displacementMap buffer.
  25182. * 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.
  25183. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25184. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  25185. * @param heightMapWidth is the width of the buffer image.
  25186. * @param heightMapHeight is the height of the buffer image.
  25187. * @param minHeight is the lower limit of the displacement.
  25188. * @param maxHeight is the upper limit of the displacement.
  25189. * @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.
  25190. * @param uvOffset is an optional vector2 used to offset UV.
  25191. * @param uvScale is an optional vector2 used to scale UV.
  25192. * @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.
  25193. * @returns the Mesh.
  25194. */
  25195. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25196. /**
  25197. * Modify the mesh to get a flat shading rendering.
  25198. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  25199. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  25200. * @returns current mesh
  25201. */
  25202. convertToFlatShadedMesh(): Mesh;
  25203. /**
  25204. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  25205. * In other words, more vertices, no more indices and a single bigger VBO.
  25206. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  25207. * @returns current mesh
  25208. */
  25209. convertToUnIndexedMesh(): Mesh;
  25210. /**
  25211. * Inverses facet orientations.
  25212. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25213. * @param flipNormals will also inverts the normals
  25214. * @returns current mesh
  25215. */
  25216. flipFaces(flipNormals?: boolean): Mesh;
  25217. /**
  25218. * Increase the number of facets and hence vertices in a mesh
  25219. * Vertex normals are interpolated from existing vertex normals
  25220. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25221. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  25222. */
  25223. increaseVertices(numberPerEdge: number): void;
  25224. /**
  25225. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  25226. * This will undo any application of covertToFlatShadedMesh
  25227. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25228. */
  25229. forceSharedVertices(): void;
  25230. /** @hidden */
  25231. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  25232. /** @hidden */
  25233. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  25234. /**
  25235. * Creates a new InstancedMesh object from the mesh model.
  25236. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  25237. * @param name defines the name of the new instance
  25238. * @returns a new InstancedMesh
  25239. */
  25240. createInstance(name: string): InstancedMesh;
  25241. /**
  25242. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  25243. * After this call, all the mesh instances have the same submeshes than the current mesh.
  25244. * @returns the current mesh
  25245. */
  25246. synchronizeInstances(): Mesh;
  25247. /**
  25248. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  25249. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  25250. * This should be used together with the simplification to avoid disappearing triangles.
  25251. * @param successCallback an optional success callback to be called after the optimization finished.
  25252. * @returns the current mesh
  25253. */
  25254. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  25255. /**
  25256. * Serialize current mesh
  25257. * @param serializationObject defines the object which will receive the serialization data
  25258. */
  25259. serialize(serializationObject: any): void;
  25260. /** @hidden */
  25261. _syncGeometryWithMorphTargetManager(): void;
  25262. /** @hidden */
  25263. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  25264. /**
  25265. * Returns a new Mesh object parsed from the source provided.
  25266. * @param parsedMesh is the source
  25267. * @param scene defines the hosting scene
  25268. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  25269. * @returns a new Mesh
  25270. */
  25271. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  25272. /**
  25273. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  25274. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25275. * @param name defines the name of the mesh to create
  25276. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  25277. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  25278. * @param closePath creates a seam between the first and the last points of each path of the path array
  25279. * @param offset is taken in account only if the `pathArray` is containing a single path
  25280. * @param scene defines the hosting scene
  25281. * @param updatable defines if the mesh must be flagged as updatable
  25282. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25283. * @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)
  25284. * @returns a new Mesh
  25285. */
  25286. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25287. /**
  25288. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  25289. * @param name defines the name of the mesh to create
  25290. * @param radius sets the radius size (float) of the polygon (default 0.5)
  25291. * @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
  25292. * @param scene defines the hosting scene
  25293. * @param updatable defines if the mesh must be flagged as updatable
  25294. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25295. * @returns a new Mesh
  25296. */
  25297. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25298. /**
  25299. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  25300. * @param name defines the name of the mesh to create
  25301. * @param size sets the size (float) of each box side (default 1)
  25302. * @param scene defines the hosting scene
  25303. * @param updatable defines if the mesh must be flagged as updatable
  25304. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25305. * @returns a new Mesh
  25306. */
  25307. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25308. /**
  25309. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  25310. * @param name defines the name of the mesh to create
  25311. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25312. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25313. * @param scene defines the hosting scene
  25314. * @param updatable defines if the mesh must be flagged as updatable
  25315. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25316. * @returns a new Mesh
  25317. */
  25318. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25319. /**
  25320. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  25321. * @param name defines the name of the mesh to create
  25322. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25323. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25324. * @param scene defines the hosting scene
  25325. * @returns a new Mesh
  25326. */
  25327. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  25328. /**
  25329. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  25330. * @param name defines the name of the mesh to create
  25331. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  25332. * @param diameterTop set the top cap diameter (floats, default 1)
  25333. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  25334. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  25335. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  25336. * @param scene defines the hosting scene
  25337. * @param updatable defines if the mesh must be flagged as updatable
  25338. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25339. * @returns a new Mesh
  25340. */
  25341. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  25342. /**
  25343. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  25344. * @param name defines the name of the mesh to create
  25345. * @param diameter sets the diameter size (float) of the torus (default 1)
  25346. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  25347. * @param tessellation sets the number of torus sides (postive integer, default 16)
  25348. * @param scene defines the hosting scene
  25349. * @param updatable defines if the mesh must be flagged as updatable
  25350. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25351. * @returns a new Mesh
  25352. */
  25353. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25354. /**
  25355. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  25356. * @param name defines the name of the mesh to create
  25357. * @param radius sets the global radius size (float) of the torus knot (default 2)
  25358. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  25359. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  25360. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  25361. * @param p the number of windings on X axis (positive integers, default 2)
  25362. * @param q the number of windings on Y axis (positive integers, default 3)
  25363. * @param scene defines the hosting scene
  25364. * @param updatable defines if the mesh must be flagged as updatable
  25365. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25366. * @returns a new Mesh
  25367. */
  25368. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25369. /**
  25370. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  25371. * @param name defines the name of the mesh to create
  25372. * @param points is an array successive Vector3
  25373. * @param scene defines the hosting scene
  25374. * @param updatable defines if the mesh must be flagged as updatable
  25375. * @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).
  25376. * @returns a new Mesh
  25377. */
  25378. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  25379. /**
  25380. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  25381. * @param name defines the name of the mesh to create
  25382. * @param points is an array successive Vector3
  25383. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  25384. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  25385. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  25386. * @param scene defines the hosting scene
  25387. * @param updatable defines if the mesh must be flagged as updatable
  25388. * @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)
  25389. * @returns a new Mesh
  25390. */
  25391. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  25392. /**
  25393. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  25394. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  25395. * 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.
  25396. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25397. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  25398. * Remember you can only change the shape positions, not their number when updating a polygon.
  25399. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  25400. * @param name defines the name of the mesh to create
  25401. * @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
  25402. * @param scene defines the hosting scene
  25403. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25404. * @param updatable defines if the mesh must be flagged as updatable
  25405. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25406. * @param earcutInjection can be used to inject your own earcut reference
  25407. * @returns a new Mesh
  25408. */
  25409. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25410. /**
  25411. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  25412. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  25413. * @param name defines the name of the mesh to create
  25414. * @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
  25415. * @param depth defines the height of extrusion
  25416. * @param scene defines the hosting scene
  25417. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25418. * @param updatable defines if the mesh must be flagged as updatable
  25419. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25420. * @param earcutInjection can be used to inject your own earcut reference
  25421. * @returns a new Mesh
  25422. */
  25423. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25424. /**
  25425. * Creates an extruded shape mesh.
  25426. * 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
  25427. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25428. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25429. * @param name defines the name of the mesh to create
  25430. * @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
  25431. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25432. * @param scale is the value to scale the shape
  25433. * @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
  25434. * @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
  25435. * @param scene defines the hosting scene
  25436. * @param updatable defines if the mesh must be flagged as updatable
  25437. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25438. * @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)
  25439. * @returns a new Mesh
  25440. */
  25441. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25442. /**
  25443. * Creates an custom extruded shape mesh.
  25444. * The custom extrusion is a parametric shape.
  25445. * It has no predefined shape. Its final shape will depend on the input parameters.
  25446. * Please consider using the same method from the MeshBuilder class instead
  25447. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25448. * @param name defines the name of the mesh to create
  25449. * @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
  25450. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25451. * @param scaleFunction is a custom Javascript function called on each path point
  25452. * @param rotationFunction is a custom Javascript function called on each path point
  25453. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  25454. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  25455. * @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
  25456. * @param scene defines the hosting scene
  25457. * @param updatable defines if the mesh must be flagged as updatable
  25458. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25459. * @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)
  25460. * @returns a new Mesh
  25461. */
  25462. 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;
  25463. /**
  25464. * Creates lathe mesh.
  25465. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  25466. * Please consider using the same method from the MeshBuilder class instead
  25467. * @param name defines the name of the mesh to create
  25468. * @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
  25469. * @param radius is the radius value of the lathe
  25470. * @param tessellation is the side number of the lathe.
  25471. * @param scene defines the hosting scene
  25472. * @param updatable defines if the mesh must be flagged as updatable
  25473. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25474. * @returns a new Mesh
  25475. */
  25476. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25477. /**
  25478. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  25479. * @param name defines the name of the mesh to create
  25480. * @param size sets the size (float) of both sides of the plane at once (default 1)
  25481. * @param scene defines the hosting scene
  25482. * @param updatable defines if the mesh must be flagged as updatable
  25483. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25484. * @returns a new Mesh
  25485. */
  25486. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25487. /**
  25488. * Creates a ground mesh.
  25489. * Please consider using the same method from the MeshBuilder class instead
  25490. * @param name defines the name of the mesh to create
  25491. * @param width set the width of the ground
  25492. * @param height set the height of the ground
  25493. * @param subdivisions sets the number of subdivisions per side
  25494. * @param scene defines the hosting scene
  25495. * @param updatable defines if the mesh must be flagged as updatable
  25496. * @returns a new Mesh
  25497. */
  25498. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  25499. /**
  25500. * Creates a tiled ground mesh.
  25501. * Please consider using the same method from the MeshBuilder class instead
  25502. * @param name defines the name of the mesh to create
  25503. * @param xmin set the ground minimum X coordinate
  25504. * @param zmin set the ground minimum Y coordinate
  25505. * @param xmax set the ground maximum X coordinate
  25506. * @param zmax set the ground maximum Z coordinate
  25507. * @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
  25508. * @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
  25509. * @param scene defines the hosting scene
  25510. * @param updatable defines if the mesh must be flagged as updatable
  25511. * @returns a new Mesh
  25512. */
  25513. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  25514. w: number;
  25515. h: number;
  25516. }, precision: {
  25517. w: number;
  25518. h: number;
  25519. }, scene: Scene, updatable?: boolean): Mesh;
  25520. /**
  25521. * Creates a ground mesh from a height map.
  25522. * Please consider using the same method from the MeshBuilder class instead
  25523. * @see http://doc.babylonjs.com/babylon101/height_map
  25524. * @param name defines the name of the mesh to create
  25525. * @param url sets the URL of the height map image resource
  25526. * @param width set the ground width size
  25527. * @param height set the ground height size
  25528. * @param subdivisions sets the number of subdivision per side
  25529. * @param minHeight is the minimum altitude on the ground
  25530. * @param maxHeight is the maximum altitude on the ground
  25531. * @param scene defines the hosting scene
  25532. * @param updatable defines if the mesh must be flagged as updatable
  25533. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  25534. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  25535. * @returns a new Mesh
  25536. */
  25537. 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;
  25538. /**
  25539. * Creates a tube mesh.
  25540. * The tube is a parametric shape.
  25541. * It has no predefined shape. Its final shape will depend on the input parameters.
  25542. * Please consider using the same method from the MeshBuilder class instead
  25543. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25544. * @param name defines the name of the mesh to create
  25545. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  25546. * @param radius sets the tube radius size
  25547. * @param tessellation is the number of sides on the tubular surface
  25548. * @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
  25549. * @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
  25550. * @param scene defines the hosting scene
  25551. * @param updatable defines if the mesh must be flagged as updatable
  25552. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25553. * @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)
  25554. * @returns a new Mesh
  25555. */
  25556. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  25557. (i: number, distance: number): number;
  25558. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25559. /**
  25560. * Creates a polyhedron mesh.
  25561. * Please consider using the same method from the MeshBuilder class instead.
  25562. * * 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
  25563. * * The parameter `size` (positive float, default 1) sets the polygon size
  25564. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  25565. * * 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`
  25566. * * 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
  25567. * * 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)`)
  25568. * * 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
  25569. * * 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
  25570. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25571. * * If you create a double-sided mesh, you can choose what parts of 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
  25572. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25573. * @param name defines the name of the mesh to create
  25574. * @param options defines the options used to create the mesh
  25575. * @param scene defines the hosting scene
  25576. * @returns a new Mesh
  25577. */
  25578. static CreatePolyhedron(name: string, options: {
  25579. type?: number;
  25580. size?: number;
  25581. sizeX?: number;
  25582. sizeY?: number;
  25583. sizeZ?: number;
  25584. custom?: any;
  25585. faceUV?: Vector4[];
  25586. faceColors?: Color4[];
  25587. updatable?: boolean;
  25588. sideOrientation?: number;
  25589. }, scene: Scene): Mesh;
  25590. /**
  25591. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  25592. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  25593. * * 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`)
  25594. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  25595. * * 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
  25596. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25597. * * If you create a double-sided mesh, you can choose what parts of 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
  25598. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25599. * @param name defines the name of the mesh
  25600. * @param options defines the options used to create the mesh
  25601. * @param scene defines the hosting scene
  25602. * @returns a new Mesh
  25603. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  25604. */
  25605. static CreateIcoSphere(name: string, options: {
  25606. radius?: number;
  25607. flat?: boolean;
  25608. subdivisions?: number;
  25609. sideOrientation?: number;
  25610. updatable?: boolean;
  25611. }, scene: Scene): Mesh;
  25612. /**
  25613. * Creates a decal mesh.
  25614. * Please consider using the same method from the MeshBuilder class instead.
  25615. * A decal is a mesh usually applied as a model onto the surface of another mesh
  25616. * @param name defines the name of the mesh
  25617. * @param sourceMesh defines the mesh receiving the decal
  25618. * @param position sets the position of the decal in world coordinates
  25619. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25620. * @param size sets the decal scaling
  25621. * @param angle sets the angle to rotate the decal
  25622. * @returns a new Mesh
  25623. */
  25624. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25625. /**
  25626. * Prepare internal position array for software CPU skinning
  25627. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25628. */
  25629. setPositionsForCPUSkinning(): Float32Array;
  25630. /**
  25631. * Prepare internal normal array for software CPU skinning
  25632. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25633. */
  25634. setNormalsForCPUSkinning(): Float32Array;
  25635. /**
  25636. * Updates the vertex buffer by applying transformation from the bones
  25637. * @param skeleton defines the skeleton to apply to current mesh
  25638. * @returns the current mesh
  25639. */
  25640. applySkeleton(skeleton: Skeleton): Mesh;
  25641. /**
  25642. * 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
  25643. * @param meshes defines the list of meshes to scan
  25644. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25645. */
  25646. static MinMax(meshes: AbstractMesh[]): {
  25647. min: Vector3;
  25648. max: Vector3;
  25649. };
  25650. /**
  25651. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25652. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25653. * @returns a vector3
  25654. */
  25655. static Center(meshesOrMinMaxVector: {
  25656. min: Vector3;
  25657. max: Vector3;
  25658. } | AbstractMesh[]): Vector3;
  25659. /**
  25660. * Merge the array of meshes into a single mesh for performance reasons.
  25661. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25662. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25663. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25664. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25665. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25666. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25667. * @returns a new mesh
  25668. */
  25669. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25670. /** @hidden */
  25671. addInstance(instance: InstancedMesh): void;
  25672. /** @hidden */
  25673. removeInstance(instance: InstancedMesh): void;
  25674. }
  25675. }
  25676. declare module "babylonjs/Cameras/camera" {
  25677. import { SmartArray } from "babylonjs/Misc/smartArray";
  25678. import { Observable } from "babylonjs/Misc/observable";
  25679. import { Nullable } from "babylonjs/types";
  25680. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25681. import { Scene } from "babylonjs/scene";
  25682. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  25683. import { Node } from "babylonjs/node";
  25684. import { Mesh } from "babylonjs/Meshes/mesh";
  25685. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25686. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25687. import { Viewport } from "babylonjs/Maths/math.viewport";
  25688. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25689. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25690. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25691. import { Ray } from "babylonjs/Culling/ray";
  25692. /**
  25693. * This is the base class of all the camera used in the application.
  25694. * @see http://doc.babylonjs.com/features/cameras
  25695. */
  25696. export class Camera extends Node {
  25697. /** @hidden */
  25698. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25699. /**
  25700. * This is the default projection mode used by the cameras.
  25701. * It helps recreating a feeling of perspective and better appreciate depth.
  25702. * This is the best way to simulate real life cameras.
  25703. */
  25704. static readonly PERSPECTIVE_CAMERA: number;
  25705. /**
  25706. * This helps creating camera with an orthographic mode.
  25707. * 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.
  25708. */
  25709. static readonly ORTHOGRAPHIC_CAMERA: number;
  25710. /**
  25711. * This is the default FOV mode for perspective cameras.
  25712. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25713. */
  25714. static readonly FOVMODE_VERTICAL_FIXED: number;
  25715. /**
  25716. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25717. */
  25718. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25719. /**
  25720. * This specifies ther is no need for a camera rig.
  25721. * Basically only one eye is rendered corresponding to the camera.
  25722. */
  25723. static readonly RIG_MODE_NONE: number;
  25724. /**
  25725. * Simulates a camera Rig with one blue eye and one red eye.
  25726. * This can be use with 3d blue and red glasses.
  25727. */
  25728. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25729. /**
  25730. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25731. */
  25732. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25733. /**
  25734. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25735. */
  25736. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25737. /**
  25738. * Defines that both eyes of the camera will be rendered over under each other.
  25739. */
  25740. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25741. /**
  25742. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25743. */
  25744. static readonly RIG_MODE_VR: number;
  25745. /**
  25746. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25747. */
  25748. static readonly RIG_MODE_WEBVR: number;
  25749. /**
  25750. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25751. */
  25752. static readonly RIG_MODE_CUSTOM: number;
  25753. /**
  25754. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25755. */
  25756. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25757. /**
  25758. * Define the input manager associated with the camera.
  25759. */
  25760. inputs: CameraInputsManager<Camera>;
  25761. /** @hidden */
  25762. _position: Vector3;
  25763. /**
  25764. * Define the current local position of the camera in the scene
  25765. */
  25766. position: Vector3;
  25767. /**
  25768. * The vector the camera should consider as up.
  25769. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25770. */
  25771. upVector: Vector3;
  25772. /**
  25773. * Define the current limit on the left side for an orthographic camera
  25774. * In scene unit
  25775. */
  25776. orthoLeft: Nullable<number>;
  25777. /**
  25778. * Define the current limit on the right side for an orthographic camera
  25779. * In scene unit
  25780. */
  25781. orthoRight: Nullable<number>;
  25782. /**
  25783. * Define the current limit on the bottom side for an orthographic camera
  25784. * In scene unit
  25785. */
  25786. orthoBottom: Nullable<number>;
  25787. /**
  25788. * Define the current limit on the top side for an orthographic camera
  25789. * In scene unit
  25790. */
  25791. orthoTop: Nullable<number>;
  25792. /**
  25793. * Field Of View is set in Radians. (default is 0.8)
  25794. */
  25795. fov: number;
  25796. /**
  25797. * Define the minimum distance the camera can see from.
  25798. * This is important to note that the depth buffer are not infinite and the closer it starts
  25799. * the more your scene might encounter depth fighting issue.
  25800. */
  25801. minZ: number;
  25802. /**
  25803. * Define the maximum distance the camera can see to.
  25804. * This is important to note that the depth buffer are not infinite and the further it end
  25805. * the more your scene might encounter depth fighting issue.
  25806. */
  25807. maxZ: number;
  25808. /**
  25809. * Define the default inertia of the camera.
  25810. * This helps giving a smooth feeling to the camera movement.
  25811. */
  25812. inertia: number;
  25813. /**
  25814. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25815. */
  25816. mode: number;
  25817. /**
  25818. * Define wether the camera is intermediate.
  25819. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25820. */
  25821. isIntermediate: boolean;
  25822. /**
  25823. * Define the viewport of the camera.
  25824. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25825. */
  25826. viewport: Viewport;
  25827. /**
  25828. * Restricts the camera to viewing objects with the same layerMask.
  25829. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25830. */
  25831. layerMask: number;
  25832. /**
  25833. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25834. */
  25835. fovMode: number;
  25836. /**
  25837. * Rig mode of the camera.
  25838. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25839. * This is normally controlled byt the camera themselves as internal use.
  25840. */
  25841. cameraRigMode: number;
  25842. /**
  25843. * Defines the distance between both "eyes" in case of a RIG
  25844. */
  25845. interaxialDistance: number;
  25846. /**
  25847. * Defines if stereoscopic rendering is done side by side or over under.
  25848. */
  25849. isStereoscopicSideBySide: boolean;
  25850. /**
  25851. * 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
  25852. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25853. * else in the scene. (Eg. security camera)
  25854. *
  25855. * 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)
  25856. */
  25857. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25858. /**
  25859. * When set, the camera will render to this render target instead of the default canvas
  25860. *
  25861. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25862. */
  25863. outputRenderTarget: Nullable<RenderTargetTexture>;
  25864. /**
  25865. * Observable triggered when the camera view matrix has changed.
  25866. */
  25867. onViewMatrixChangedObservable: Observable<Camera>;
  25868. /**
  25869. * Observable triggered when the camera Projection matrix has changed.
  25870. */
  25871. onProjectionMatrixChangedObservable: Observable<Camera>;
  25872. /**
  25873. * Observable triggered when the inputs have been processed.
  25874. */
  25875. onAfterCheckInputsObservable: Observable<Camera>;
  25876. /**
  25877. * Observable triggered when reset has been called and applied to the camera.
  25878. */
  25879. onRestoreStateObservable: Observable<Camera>;
  25880. /** @hidden */
  25881. _cameraRigParams: any;
  25882. /** @hidden */
  25883. _rigCameras: Camera[];
  25884. /** @hidden */
  25885. _rigPostProcess: Nullable<PostProcess>;
  25886. protected _webvrViewMatrix: Matrix;
  25887. /** @hidden */
  25888. _skipRendering: boolean;
  25889. /** @hidden */
  25890. _projectionMatrix: Matrix;
  25891. /** @hidden */
  25892. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25893. /** @hidden */
  25894. _activeMeshes: SmartArray<AbstractMesh>;
  25895. protected _globalPosition: Vector3;
  25896. /** @hidden */
  25897. _computedViewMatrix: Matrix;
  25898. private _doNotComputeProjectionMatrix;
  25899. private _transformMatrix;
  25900. private _frustumPlanes;
  25901. private _refreshFrustumPlanes;
  25902. private _storedFov;
  25903. private _stateStored;
  25904. /**
  25905. * Instantiates a new camera object.
  25906. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25907. * @see http://doc.babylonjs.com/features/cameras
  25908. * @param name Defines the name of the camera in the scene
  25909. * @param position Defines the position of the camera
  25910. * @param scene Defines the scene the camera belongs too
  25911. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25912. */
  25913. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25914. /**
  25915. * Store current camera state (fov, position, etc..)
  25916. * @returns the camera
  25917. */
  25918. storeState(): Camera;
  25919. /**
  25920. * Restores the camera state values if it has been stored. You must call storeState() first
  25921. */
  25922. protected _restoreStateValues(): boolean;
  25923. /**
  25924. * Restored camera state. You must call storeState() first.
  25925. * @returns true if restored and false otherwise
  25926. */
  25927. restoreState(): boolean;
  25928. /**
  25929. * Gets the class name of the camera.
  25930. * @returns the class name
  25931. */
  25932. getClassName(): string;
  25933. /** @hidden */
  25934. readonly _isCamera: boolean;
  25935. /**
  25936. * Gets a string representation of the camera useful for debug purpose.
  25937. * @param fullDetails Defines that a more verboe level of logging is required
  25938. * @returns the string representation
  25939. */
  25940. toString(fullDetails?: boolean): string;
  25941. /**
  25942. * Gets the current world space position of the camera.
  25943. */
  25944. readonly globalPosition: Vector3;
  25945. /**
  25946. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25947. * @returns the active meshe list
  25948. */
  25949. getActiveMeshes(): SmartArray<AbstractMesh>;
  25950. /**
  25951. * Check wether a mesh is part of the current active mesh list of the camera
  25952. * @param mesh Defines the mesh to check
  25953. * @returns true if active, false otherwise
  25954. */
  25955. isActiveMesh(mesh: Mesh): boolean;
  25956. /**
  25957. * Is this camera ready to be used/rendered
  25958. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25959. * @return true if the camera is ready
  25960. */
  25961. isReady(completeCheck?: boolean): boolean;
  25962. /** @hidden */
  25963. _initCache(): void;
  25964. /** @hidden */
  25965. _updateCache(ignoreParentClass?: boolean): void;
  25966. /** @hidden */
  25967. _isSynchronized(): boolean;
  25968. /** @hidden */
  25969. _isSynchronizedViewMatrix(): boolean;
  25970. /** @hidden */
  25971. _isSynchronizedProjectionMatrix(): boolean;
  25972. /**
  25973. * Attach the input controls to a specific dom element to get the input from.
  25974. * @param element Defines the element the controls should be listened from
  25975. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25976. */
  25977. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25978. /**
  25979. * Detach the current controls from the specified dom element.
  25980. * @param element Defines the element to stop listening the inputs from
  25981. */
  25982. detachControl(element: HTMLElement): void;
  25983. /**
  25984. * Update the camera state according to the different inputs gathered during the frame.
  25985. */
  25986. update(): void;
  25987. /** @hidden */
  25988. _checkInputs(): void;
  25989. /** @hidden */
  25990. readonly rigCameras: Camera[];
  25991. /**
  25992. * Gets the post process used by the rig cameras
  25993. */
  25994. readonly rigPostProcess: Nullable<PostProcess>;
  25995. /**
  25996. * Internal, gets the first post proces.
  25997. * @returns the first post process to be run on this camera.
  25998. */
  25999. _getFirstPostProcess(): Nullable<PostProcess>;
  26000. private _cascadePostProcessesToRigCams;
  26001. /**
  26002. * Attach a post process to the camera.
  26003. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  26004. * @param postProcess The post process to attach to the camera
  26005. * @param insertAt The position of the post process in case several of them are in use in the scene
  26006. * @returns the position the post process has been inserted at
  26007. */
  26008. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  26009. /**
  26010. * Detach a post process to the camera.
  26011. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  26012. * @param postProcess The post process to detach from the camera
  26013. */
  26014. detachPostProcess(postProcess: PostProcess): void;
  26015. /**
  26016. * Gets the current world matrix of the camera
  26017. */
  26018. getWorldMatrix(): Matrix;
  26019. /** @hidden */
  26020. _getViewMatrix(): Matrix;
  26021. /**
  26022. * Gets the current view matrix of the camera.
  26023. * @param force forces the camera to recompute the matrix without looking at the cached state
  26024. * @returns the view matrix
  26025. */
  26026. getViewMatrix(force?: boolean): Matrix;
  26027. /**
  26028. * Freeze the projection matrix.
  26029. * It will prevent the cache check of the camera projection compute and can speed up perf
  26030. * if no parameter of the camera are meant to change
  26031. * @param projection Defines manually a projection if necessary
  26032. */
  26033. freezeProjectionMatrix(projection?: Matrix): void;
  26034. /**
  26035. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  26036. */
  26037. unfreezeProjectionMatrix(): void;
  26038. /**
  26039. * Gets the current projection matrix of the camera.
  26040. * @param force forces the camera to recompute the matrix without looking at the cached state
  26041. * @returns the projection matrix
  26042. */
  26043. getProjectionMatrix(force?: boolean): Matrix;
  26044. /**
  26045. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  26046. * @returns a Matrix
  26047. */
  26048. getTransformationMatrix(): Matrix;
  26049. private _updateFrustumPlanes;
  26050. /**
  26051. * Checks if a cullable object (mesh...) is in the camera frustum
  26052. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  26053. * @param target The object to check
  26054. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  26055. * @returns true if the object is in frustum otherwise false
  26056. */
  26057. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  26058. /**
  26059. * Checks if a cullable object (mesh...) is in the camera frustum
  26060. * Unlike isInFrustum this cheks the full bounding box
  26061. * @param target The object to check
  26062. * @returns true if the object is in frustum otherwise false
  26063. */
  26064. isCompletelyInFrustum(target: ICullable): boolean;
  26065. /**
  26066. * Gets a ray in the forward direction from the camera.
  26067. * @param length Defines the length of the ray to create
  26068. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  26069. * @param origin Defines the start point of the ray which defaults to the camera position
  26070. * @returns the forward ray
  26071. */
  26072. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  26073. /**
  26074. * Releases resources associated with this node.
  26075. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  26076. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  26077. */
  26078. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  26079. /** @hidden */
  26080. _isLeftCamera: boolean;
  26081. /**
  26082. * Gets the left camera of a rig setup in case of Rigged Camera
  26083. */
  26084. readonly isLeftCamera: boolean;
  26085. /** @hidden */
  26086. _isRightCamera: boolean;
  26087. /**
  26088. * Gets the right camera of a rig setup in case of Rigged Camera
  26089. */
  26090. readonly isRightCamera: boolean;
  26091. /**
  26092. * Gets the left camera of a rig setup in case of Rigged Camera
  26093. */
  26094. readonly leftCamera: Nullable<FreeCamera>;
  26095. /**
  26096. * Gets the right camera of a rig setup in case of Rigged Camera
  26097. */
  26098. readonly rightCamera: Nullable<FreeCamera>;
  26099. /**
  26100. * Gets the left camera target of a rig setup in case of Rigged Camera
  26101. * @returns the target position
  26102. */
  26103. getLeftTarget(): Nullable<Vector3>;
  26104. /**
  26105. * Gets the right camera target of a rig setup in case of Rigged Camera
  26106. * @returns the target position
  26107. */
  26108. getRightTarget(): Nullable<Vector3>;
  26109. /**
  26110. * @hidden
  26111. */
  26112. setCameraRigMode(mode: number, rigParams: any): void;
  26113. /** @hidden */
  26114. static _setStereoscopicRigMode(camera: Camera): void;
  26115. /** @hidden */
  26116. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  26117. /** @hidden */
  26118. static _setVRRigMode(camera: Camera, rigParams: any): void;
  26119. /** @hidden */
  26120. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  26121. /** @hidden */
  26122. _getVRProjectionMatrix(): Matrix;
  26123. protected _updateCameraRotationMatrix(): void;
  26124. protected _updateWebVRCameraRotationMatrix(): void;
  26125. /**
  26126. * This function MUST be overwritten by the different WebVR cameras available.
  26127. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  26128. * @hidden
  26129. */
  26130. _getWebVRProjectionMatrix(): Matrix;
  26131. /**
  26132. * This function MUST be overwritten by the different WebVR cameras available.
  26133. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  26134. * @hidden
  26135. */
  26136. _getWebVRViewMatrix(): Matrix;
  26137. /** @hidden */
  26138. setCameraRigParameter(name: string, value: any): void;
  26139. /**
  26140. * needs to be overridden by children so sub has required properties to be copied
  26141. * @hidden
  26142. */
  26143. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  26144. /**
  26145. * May need to be overridden by children
  26146. * @hidden
  26147. */
  26148. _updateRigCameras(): void;
  26149. /** @hidden */
  26150. _setupInputs(): void;
  26151. /**
  26152. * Serialiaze the camera setup to a json represention
  26153. * @returns the JSON representation
  26154. */
  26155. serialize(): any;
  26156. /**
  26157. * Clones the current camera.
  26158. * @param name The cloned camera name
  26159. * @returns the cloned camera
  26160. */
  26161. clone(name: string): Camera;
  26162. /**
  26163. * Gets the direction of the camera relative to a given local axis.
  26164. * @param localAxis Defines the reference axis to provide a relative direction.
  26165. * @return the direction
  26166. */
  26167. getDirection(localAxis: Vector3): Vector3;
  26168. /**
  26169. * Returns the current camera absolute rotation
  26170. */
  26171. readonly absoluteRotation: Quaternion;
  26172. /**
  26173. * Gets the direction of the camera relative to a given local axis into a passed vector.
  26174. * @param localAxis Defines the reference axis to provide a relative direction.
  26175. * @param result Defines the vector to store the result in
  26176. */
  26177. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  26178. /**
  26179. * Gets a camera constructor for a given camera type
  26180. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  26181. * @param name The name of the camera the result will be able to instantiate
  26182. * @param scene The scene the result will construct the camera in
  26183. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  26184. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  26185. * @returns a factory method to construc the camera
  26186. */
  26187. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  26188. /**
  26189. * Compute the world matrix of the camera.
  26190. * @returns the camera world matrix
  26191. */
  26192. computeWorldMatrix(): Matrix;
  26193. /**
  26194. * Parse a JSON and creates the camera from the parsed information
  26195. * @param parsedCamera The JSON to parse
  26196. * @param scene The scene to instantiate the camera in
  26197. * @returns the newly constructed camera
  26198. */
  26199. static Parse(parsedCamera: any, scene: Scene): Camera;
  26200. }
  26201. }
  26202. declare module "babylonjs/Meshes/Builders/discBuilder" {
  26203. import { Nullable } from "babylonjs/types";
  26204. import { Scene } from "babylonjs/scene";
  26205. import { Vector4 } from "babylonjs/Maths/math.vector";
  26206. import { Mesh } from "babylonjs/Meshes/mesh";
  26207. /**
  26208. * Class containing static functions to help procedurally build meshes
  26209. */
  26210. export class DiscBuilder {
  26211. /**
  26212. * Creates a plane polygonal mesh. By default, this is a disc
  26213. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  26214. * * 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
  26215. * * 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
  26216. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  26217. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  26218. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  26219. * @param name defines the name of the mesh
  26220. * @param options defines the options used to create the mesh
  26221. * @param scene defines the hosting scene
  26222. * @returns the plane polygonal mesh
  26223. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  26224. */
  26225. static CreateDisc(name: string, options: {
  26226. radius?: number;
  26227. tessellation?: number;
  26228. arc?: number;
  26229. updatable?: boolean;
  26230. sideOrientation?: number;
  26231. frontUVs?: Vector4;
  26232. backUVs?: Vector4;
  26233. }, scene?: Nullable<Scene>): Mesh;
  26234. }
  26235. }
  26236. declare module "babylonjs/Particles/solidParticleSystem" {
  26237. import { Nullable } from "babylonjs/types";
  26238. import { Vector3 } from "babylonjs/Maths/math.vector";
  26239. import { Mesh } from "babylonjs/Meshes/mesh";
  26240. import { Scene, IDisposable } from "babylonjs/scene";
  26241. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  26242. /**
  26243. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  26244. *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.
  26245. * The SPS is also a particle system. It provides some methods to manage the particles.
  26246. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  26247. *
  26248. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  26249. */
  26250. export class SolidParticleSystem implements IDisposable {
  26251. /**
  26252. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  26253. * Example : var p = SPS.particles[i];
  26254. */
  26255. particles: SolidParticle[];
  26256. /**
  26257. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  26258. */
  26259. nbParticles: number;
  26260. /**
  26261. * If the particles must ever face the camera (default false). Useful for planar particles.
  26262. */
  26263. billboard: boolean;
  26264. /**
  26265. * Recompute normals when adding a shape
  26266. */
  26267. recomputeNormals: boolean;
  26268. /**
  26269. * This a counter ofr your own usage. It's not set by any SPS functions.
  26270. */
  26271. counter: number;
  26272. /**
  26273. * The SPS name. This name is also given to the underlying mesh.
  26274. */
  26275. name: string;
  26276. /**
  26277. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  26278. */
  26279. mesh: Mesh;
  26280. /**
  26281. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  26282. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  26283. */
  26284. vars: any;
  26285. /**
  26286. * This array is populated when the SPS is set as 'pickable'.
  26287. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  26288. * Each element of this array is an object `{idx: int, faceId: int}`.
  26289. * `idx` is the picked particle index in the `SPS.particles` array
  26290. * `faceId` is the picked face index counted within this particle.
  26291. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  26292. */
  26293. pickedParticles: {
  26294. idx: number;
  26295. faceId: number;
  26296. }[];
  26297. /**
  26298. * This array is populated when `enableDepthSort` is set to true.
  26299. * Each element of this array is an instance of the class DepthSortedParticle.
  26300. */
  26301. depthSortedParticles: DepthSortedParticle[];
  26302. /**
  26303. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  26304. * @hidden
  26305. */
  26306. _bSphereOnly: boolean;
  26307. /**
  26308. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  26309. * @hidden
  26310. */
  26311. _bSphereRadiusFactor: number;
  26312. private _scene;
  26313. private _positions;
  26314. private _indices;
  26315. private _normals;
  26316. private _colors;
  26317. private _uvs;
  26318. private _indices32;
  26319. private _positions32;
  26320. private _normals32;
  26321. private _fixedNormal32;
  26322. private _colors32;
  26323. private _uvs32;
  26324. private _index;
  26325. private _updatable;
  26326. private _pickable;
  26327. private _isVisibilityBoxLocked;
  26328. private _alwaysVisible;
  26329. private _depthSort;
  26330. private _expandable;
  26331. private _shapeCounter;
  26332. private _copy;
  26333. private _color;
  26334. private _computeParticleColor;
  26335. private _computeParticleTexture;
  26336. private _computeParticleRotation;
  26337. private _computeParticleVertex;
  26338. private _computeBoundingBox;
  26339. private _depthSortParticles;
  26340. private _camera;
  26341. private _mustUnrotateFixedNormals;
  26342. private _particlesIntersect;
  26343. private _needs32Bits;
  26344. private _isNotBuilt;
  26345. private _lastParticleId;
  26346. private _idxOfId;
  26347. /**
  26348. * Creates a SPS (Solid Particle System) object.
  26349. * @param name (String) is the SPS name, this will be the underlying mesh name.
  26350. * @param scene (Scene) is the scene in which the SPS is added.
  26351. * @param options defines the options of the sps e.g.
  26352. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  26353. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  26354. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  26355. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  26356. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  26357. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  26358. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  26359. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  26360. */
  26361. constructor(name: string, scene: Scene, options?: {
  26362. updatable?: boolean;
  26363. isPickable?: boolean;
  26364. enableDepthSort?: boolean;
  26365. particleIntersection?: boolean;
  26366. boundingSphereOnly?: boolean;
  26367. bSphereRadiusFactor?: number;
  26368. expandable?: boolean;
  26369. });
  26370. /**
  26371. * Builds the SPS underlying mesh. Returns a standard Mesh.
  26372. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  26373. * @returns the created mesh
  26374. */
  26375. buildMesh(): Mesh;
  26376. /**
  26377. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  26378. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  26379. * Thus the particles generated from `digest()` have their property `position` set yet.
  26380. * @param mesh ( Mesh ) is the mesh to be digested
  26381. * @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
  26382. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  26383. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  26384. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  26385. * @returns the current SPS
  26386. */
  26387. digest(mesh: Mesh, options?: {
  26388. facetNb?: number;
  26389. number?: number;
  26390. delta?: number;
  26391. storage?: [];
  26392. }): SolidParticleSystem;
  26393. /**
  26394. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  26395. * @hidden
  26396. */
  26397. private _unrotateFixedNormals;
  26398. /**
  26399. * Resets the temporary working copy particle
  26400. * @hidden
  26401. */
  26402. private _resetCopy;
  26403. /**
  26404. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  26405. * @param p the current index in the positions array to be updated
  26406. * @param shape a Vector3 array, the shape geometry
  26407. * @param positions the positions array to be updated
  26408. * @param meshInd the shape indices array
  26409. * @param indices the indices array to be updated
  26410. * @param meshUV the shape uv array
  26411. * @param uvs the uv array to be updated
  26412. * @param meshCol the shape color array
  26413. * @param colors the color array to be updated
  26414. * @param meshNor the shape normals array
  26415. * @param normals the normals array to be updated
  26416. * @param idx the particle index
  26417. * @param idxInShape the particle index in its shape
  26418. * @param options the addShape() method passed options
  26419. * @hidden
  26420. */
  26421. private _meshBuilder;
  26422. /**
  26423. * Returns a shape Vector3 array from positions float array
  26424. * @param positions float array
  26425. * @returns a vector3 array
  26426. * @hidden
  26427. */
  26428. private _posToShape;
  26429. /**
  26430. * Returns a shapeUV array from a float uvs (array deep copy)
  26431. * @param uvs as a float array
  26432. * @returns a shapeUV array
  26433. * @hidden
  26434. */
  26435. private _uvsToShapeUV;
  26436. /**
  26437. * Adds a new particle object in the particles array
  26438. * @param idx particle index in particles array
  26439. * @param id particle id
  26440. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  26441. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  26442. * @param model particle ModelShape object
  26443. * @param shapeId model shape identifier
  26444. * @param idxInShape index of the particle in the current model
  26445. * @param bInfo model bounding info object
  26446. * @param storage target storage array, if any
  26447. * @hidden
  26448. */
  26449. private _addParticle;
  26450. /**
  26451. * Adds some particles to the SPS from the model shape. Returns the shape id.
  26452. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  26453. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  26454. * @param nb (positive integer) the number of particles to be created from this model
  26455. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  26456. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  26457. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  26458. * @returns the number of shapes in the system
  26459. */
  26460. addShape(mesh: Mesh, nb: number, options?: {
  26461. positionFunction?: any;
  26462. vertexFunction?: any;
  26463. storage?: [];
  26464. }): number;
  26465. /**
  26466. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  26467. * @hidden
  26468. */
  26469. private _rebuildParticle;
  26470. /**
  26471. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  26472. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  26473. * @returns the SPS.
  26474. */
  26475. rebuildMesh(reset?: boolean): SolidParticleSystem;
  26476. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  26477. * Returns an array with the removed particles.
  26478. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  26479. * The SPS can't be empty so at least one particle needs to remain in place.
  26480. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  26481. * @param start index of the first particle to remove
  26482. * @param end index of the last particle to remove (included)
  26483. * @returns an array populated with the removed particles
  26484. */
  26485. removeParticles(start: number, end: number): SolidParticle[];
  26486. /**
  26487. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  26488. * @param solidParticleArray an array populated with Solid Particles objects
  26489. * @returns the SPS
  26490. */
  26491. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  26492. /**
  26493. * Creates a new particle and modifies the SPS mesh geometry :
  26494. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  26495. * - calls _addParticle() to populate the particle array
  26496. * factorized code from addShape() and insertParticlesFromArray()
  26497. * @param idx particle index in the particles array
  26498. * @param i particle index in its shape
  26499. * @param modelShape particle ModelShape object
  26500. * @param shape shape vertex array
  26501. * @param meshInd shape indices array
  26502. * @param meshUV shape uv array
  26503. * @param meshCol shape color array
  26504. * @param meshNor shape normals array
  26505. * @param bbInfo shape bounding info
  26506. * @param storage target particle storage
  26507. * @options addShape() passed options
  26508. * @hidden
  26509. */
  26510. private _insertNewParticle;
  26511. /**
  26512. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  26513. * This method calls `updateParticle()` for each particle of the SPS.
  26514. * For an animated SPS, it is usually called within the render loop.
  26515. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  26516. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  26517. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  26518. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  26519. * @returns the SPS.
  26520. */
  26521. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  26522. /**
  26523. * Disposes the SPS.
  26524. */
  26525. dispose(): void;
  26526. /**
  26527. * Returns a SolidParticle object from its identifier : particle.id
  26528. * @param id (integer) the particle Id
  26529. * @returns the searched particle or null if not found in the SPS.
  26530. */
  26531. getParticleById(id: number): Nullable<SolidParticle>;
  26532. /**
  26533. * Returns a new array populated with the particles having the passed shapeId.
  26534. * @param shapeId (integer) the shape identifier
  26535. * @returns a new solid particle array
  26536. */
  26537. getParticlesByShapeId(shapeId: number): SolidParticle[];
  26538. /**
  26539. * Populates the passed array "ref" with the particles having the passed shapeId.
  26540. * @param shapeId the shape identifier
  26541. * @returns the SPS
  26542. * @param ref
  26543. */
  26544. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  26545. /**
  26546. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  26547. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26548. * @returns the SPS.
  26549. */
  26550. refreshVisibleSize(): SolidParticleSystem;
  26551. /**
  26552. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  26553. * @param size the size (float) of the visibility box
  26554. * note : this doesn't lock the SPS mesh bounding box.
  26555. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26556. */
  26557. setVisibilityBox(size: number): void;
  26558. /**
  26559. * Gets whether the SPS as always visible or not
  26560. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26561. */
  26562. /**
  26563. * Sets the SPS as always visible or not
  26564. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26565. */
  26566. isAlwaysVisible: boolean;
  26567. /**
  26568. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26569. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26570. */
  26571. /**
  26572. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26573. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26574. */
  26575. isVisibilityBoxLocked: boolean;
  26576. /**
  26577. * Tells to `setParticles()` to compute the particle rotations or not.
  26578. * Default value : true. The SPS is faster when it's set to false.
  26579. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26580. */
  26581. /**
  26582. * Gets if `setParticles()` computes the particle rotations or not.
  26583. * Default value : true. The SPS is faster when it's set to false.
  26584. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26585. */
  26586. computeParticleRotation: boolean;
  26587. /**
  26588. * Tells to `setParticles()` to compute the particle colors or not.
  26589. * Default value : true. The SPS is faster when it's set to false.
  26590. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26591. */
  26592. /**
  26593. * Gets if `setParticles()` computes the particle colors or not.
  26594. * Default value : true. The SPS is faster when it's set to false.
  26595. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26596. */
  26597. computeParticleColor: boolean;
  26598. /**
  26599. * Gets if `setParticles()` computes the particle textures or not.
  26600. * Default value : true. The SPS is faster when it's set to false.
  26601. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  26602. */
  26603. computeParticleTexture: boolean;
  26604. /**
  26605. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  26606. * Default value : false. The SPS is faster when it's set to false.
  26607. * Note : the particle custom vertex positions aren't stored values.
  26608. */
  26609. /**
  26610. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  26611. * Default value : false. The SPS is faster when it's set to false.
  26612. * Note : the particle custom vertex positions aren't stored values.
  26613. */
  26614. computeParticleVertex: boolean;
  26615. /**
  26616. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  26617. */
  26618. /**
  26619. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  26620. */
  26621. computeBoundingBox: boolean;
  26622. /**
  26623. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  26624. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26625. * Default : `true`
  26626. */
  26627. /**
  26628. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  26629. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26630. * Default : `true`
  26631. */
  26632. depthSortParticles: boolean;
  26633. /**
  26634. * Gets if the SPS is created as expandable at construction time.
  26635. * Default : `false`
  26636. */
  26637. readonly expandable: boolean;
  26638. /**
  26639. * This function does nothing. It may be overwritten to set all the particle first values.
  26640. * The SPS doesn't call this function, you may have to call it by your own.
  26641. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26642. */
  26643. initParticles(): void;
  26644. /**
  26645. * This function does nothing. It may be overwritten to recycle a particle.
  26646. * The SPS doesn't call this function, you may have to call it by your own.
  26647. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26648. * @param particle The particle to recycle
  26649. * @returns the recycled particle
  26650. */
  26651. recycleParticle(particle: SolidParticle): SolidParticle;
  26652. /**
  26653. * Updates a particle : this function should be overwritten by the user.
  26654. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  26655. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26656. * @example : just set a particle position or velocity and recycle conditions
  26657. * @param particle The particle to update
  26658. * @returns the updated particle
  26659. */
  26660. updateParticle(particle: SolidParticle): SolidParticle;
  26661. /**
  26662. * Updates a vertex of a particle : it can be overwritten by the user.
  26663. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  26664. * @param particle the current particle
  26665. * @param vertex the current index of the current particle
  26666. * @param pt the index of the current vertex in the particle shape
  26667. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  26668. * @example : just set a vertex particle position
  26669. * @returns the updated vertex
  26670. */
  26671. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  26672. /**
  26673. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  26674. * This does nothing and may be overwritten by the user.
  26675. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26676. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26677. * @param update the boolean update value actually passed to setParticles()
  26678. */
  26679. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26680. /**
  26681. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  26682. * This will be passed three parameters.
  26683. * This does nothing and may be overwritten by the user.
  26684. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26685. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26686. * @param update the boolean update value actually passed to setParticles()
  26687. */
  26688. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26689. }
  26690. }
  26691. declare module "babylonjs/Particles/solidParticle" {
  26692. import { Nullable } from "babylonjs/types";
  26693. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  26694. import { Color4 } from "babylonjs/Maths/math.color";
  26695. import { Mesh } from "babylonjs/Meshes/mesh";
  26696. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26697. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  26698. import { Plane } from "babylonjs/Maths/math.plane";
  26699. /**
  26700. * Represents one particle of a solid particle system.
  26701. */
  26702. export class SolidParticle {
  26703. /**
  26704. * particle global index
  26705. */
  26706. idx: number;
  26707. /**
  26708. * particle identifier
  26709. */
  26710. id: number;
  26711. /**
  26712. * The color of the particle
  26713. */
  26714. color: Nullable<Color4>;
  26715. /**
  26716. * The world space position of the particle.
  26717. */
  26718. position: Vector3;
  26719. /**
  26720. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  26721. */
  26722. rotation: Vector3;
  26723. /**
  26724. * The world space rotation quaternion of the particle.
  26725. */
  26726. rotationQuaternion: Nullable<Quaternion>;
  26727. /**
  26728. * The scaling of the particle.
  26729. */
  26730. scaling: Vector3;
  26731. /**
  26732. * The uvs of the particle.
  26733. */
  26734. uvs: Vector4;
  26735. /**
  26736. * The current speed of the particle.
  26737. */
  26738. velocity: Vector3;
  26739. /**
  26740. * The pivot point in the particle local space.
  26741. */
  26742. pivot: Vector3;
  26743. /**
  26744. * Must the particle be translated from its pivot point in its local space ?
  26745. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  26746. * Default : false
  26747. */
  26748. translateFromPivot: boolean;
  26749. /**
  26750. * Is the particle active or not ?
  26751. */
  26752. alive: boolean;
  26753. /**
  26754. * Is the particle visible or not ?
  26755. */
  26756. isVisible: boolean;
  26757. /**
  26758. * Index of this particle in the global "positions" array (Internal use)
  26759. * @hidden
  26760. */
  26761. _pos: number;
  26762. /**
  26763. * @hidden Index of this particle in the global "indices" array (Internal use)
  26764. */
  26765. _ind: number;
  26766. /**
  26767. * @hidden ModelShape of this particle (Internal use)
  26768. */
  26769. _model: ModelShape;
  26770. /**
  26771. * ModelShape id of this particle
  26772. */
  26773. shapeId: number;
  26774. /**
  26775. * Index of the particle in its shape id
  26776. */
  26777. idxInShape: number;
  26778. /**
  26779. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26780. */
  26781. _modelBoundingInfo: BoundingInfo;
  26782. /**
  26783. * @hidden Particle BoundingInfo object (Internal use)
  26784. */
  26785. _boundingInfo: BoundingInfo;
  26786. /**
  26787. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26788. */
  26789. _sps: SolidParticleSystem;
  26790. /**
  26791. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26792. */
  26793. _stillInvisible: boolean;
  26794. /**
  26795. * @hidden Last computed particle rotation matrix
  26796. */
  26797. _rotationMatrix: number[];
  26798. /**
  26799. * Parent particle Id, if any.
  26800. * Default null.
  26801. */
  26802. parentId: Nullable<number>;
  26803. /**
  26804. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26805. * The possible values are :
  26806. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26807. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26808. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26809. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26810. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26811. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26812. * */
  26813. cullingStrategy: number;
  26814. /**
  26815. * @hidden Internal global position in the SPS.
  26816. */
  26817. _globalPosition: Vector3;
  26818. /**
  26819. * Creates a Solid Particle object.
  26820. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26821. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  26822. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  26823. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26824. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26825. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26826. * @param shapeId (integer) is the model shape identifier in the SPS.
  26827. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26828. * @param sps defines the sps it is associated to
  26829. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26830. */
  26831. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26832. /**
  26833. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  26834. * @param target the particle target
  26835. * @returns the current particle
  26836. */
  26837. copyToRef(target: SolidParticle): SolidParticle;
  26838. /**
  26839. * Legacy support, changed scale to scaling
  26840. */
  26841. /**
  26842. * Legacy support, changed scale to scaling
  26843. */
  26844. scale: Vector3;
  26845. /**
  26846. * Legacy support, changed quaternion to rotationQuaternion
  26847. */
  26848. /**
  26849. * Legacy support, changed quaternion to rotationQuaternion
  26850. */
  26851. quaternion: Nullable<Quaternion>;
  26852. /**
  26853. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26854. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26855. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26856. * @returns true if it intersects
  26857. */
  26858. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26859. /**
  26860. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26861. * A particle is in the frustum if its bounding box intersects the frustum
  26862. * @param frustumPlanes defines the frustum to test
  26863. * @returns true if the particle is in the frustum planes
  26864. */
  26865. isInFrustum(frustumPlanes: Plane[]): boolean;
  26866. /**
  26867. * get the rotation matrix of the particle
  26868. * @hidden
  26869. */
  26870. getRotationMatrix(m: Matrix): void;
  26871. }
  26872. /**
  26873. * Represents the shape of the model used by one particle of a solid particle system.
  26874. * SPS internal tool, don't use it manually.
  26875. */
  26876. export class ModelShape {
  26877. /**
  26878. * The shape id
  26879. * @hidden
  26880. */
  26881. shapeID: number;
  26882. /**
  26883. * flat array of model positions (internal use)
  26884. * @hidden
  26885. */
  26886. _shape: Vector3[];
  26887. /**
  26888. * flat array of model UVs (internal use)
  26889. * @hidden
  26890. */
  26891. _shapeUV: number[];
  26892. /**
  26893. * color array of the model
  26894. * @hidden
  26895. */
  26896. _shapeColors: number[];
  26897. /**
  26898. * indices array of the model
  26899. * @hidden
  26900. */
  26901. _indices: number[];
  26902. /**
  26903. * normals array of the model
  26904. * @hidden
  26905. */
  26906. _normals: number[];
  26907. /**
  26908. * length of the shape in the model indices array (internal use)
  26909. * @hidden
  26910. */
  26911. _indicesLength: number;
  26912. /**
  26913. * Custom position function (internal use)
  26914. * @hidden
  26915. */
  26916. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26917. /**
  26918. * Custom vertex function (internal use)
  26919. * @hidden
  26920. */
  26921. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26922. /**
  26923. * 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.
  26924. * SPS internal tool, don't use it manually.
  26925. * @hidden
  26926. */
  26927. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  26928. }
  26929. /**
  26930. * Represents a Depth Sorted Particle in the solid particle system.
  26931. */
  26932. export class DepthSortedParticle {
  26933. /**
  26934. * Index of the particle in the "indices" array
  26935. */
  26936. ind: number;
  26937. /**
  26938. * Length of the particle shape in the "indices" array
  26939. */
  26940. indicesLength: number;
  26941. /**
  26942. * Squared distance from the particle to the camera
  26943. */
  26944. sqDistance: number;
  26945. }
  26946. }
  26947. declare module "babylonjs/Collisions/meshCollisionData" {
  26948. import { Collider } from "babylonjs/Collisions/collider";
  26949. import { Vector3 } from "babylonjs/Maths/math.vector";
  26950. import { Nullable } from "babylonjs/types";
  26951. import { Observer } from "babylonjs/Misc/observable";
  26952. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26953. /**
  26954. * @hidden
  26955. */
  26956. export class _MeshCollisionData {
  26957. _checkCollisions: boolean;
  26958. _collisionMask: number;
  26959. _collisionGroup: number;
  26960. _collider: Nullable<Collider>;
  26961. _oldPositionForCollisions: Vector3;
  26962. _diffPositionForCollisions: Vector3;
  26963. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26964. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26965. }
  26966. }
  26967. declare module "babylonjs/Meshes/abstractMesh" {
  26968. import { Observable } from "babylonjs/Misc/observable";
  26969. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26970. import { Camera } from "babylonjs/Cameras/camera";
  26971. import { Scene, IDisposable } from "babylonjs/scene";
  26972. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26973. import { Node } from "babylonjs/node";
  26974. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26975. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26976. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26977. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26978. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26979. import { Material } from "babylonjs/Materials/material";
  26980. import { Light } from "babylonjs/Lights/light";
  26981. import { Skeleton } from "babylonjs/Bones/skeleton";
  26982. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26983. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26984. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26985. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26986. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26987. import { Plane } from "babylonjs/Maths/math.plane";
  26988. import { Ray } from "babylonjs/Culling/ray";
  26989. import { Collider } from "babylonjs/Collisions/collider";
  26990. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26991. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26992. /** @hidden */
  26993. class _FacetDataStorage {
  26994. facetPositions: Vector3[];
  26995. facetNormals: Vector3[];
  26996. facetPartitioning: number[][];
  26997. facetNb: number;
  26998. partitioningSubdivisions: number;
  26999. partitioningBBoxRatio: number;
  27000. facetDataEnabled: boolean;
  27001. facetParameters: any;
  27002. bbSize: Vector3;
  27003. subDiv: {
  27004. max: number;
  27005. X: number;
  27006. Y: number;
  27007. Z: number;
  27008. };
  27009. facetDepthSort: boolean;
  27010. facetDepthSortEnabled: boolean;
  27011. depthSortedIndices: IndicesArray;
  27012. depthSortedFacets: {
  27013. ind: number;
  27014. sqDistance: number;
  27015. }[];
  27016. facetDepthSortFunction: (f1: {
  27017. ind: number;
  27018. sqDistance: number;
  27019. }, f2: {
  27020. ind: number;
  27021. sqDistance: number;
  27022. }) => number;
  27023. facetDepthSortFrom: Vector3;
  27024. facetDepthSortOrigin: Vector3;
  27025. invertedMatrix: Matrix;
  27026. }
  27027. /**
  27028. * @hidden
  27029. **/
  27030. class _InternalAbstractMeshDataInfo {
  27031. _hasVertexAlpha: boolean;
  27032. _useVertexColors: boolean;
  27033. _numBoneInfluencers: number;
  27034. _applyFog: boolean;
  27035. _receiveShadows: boolean;
  27036. _facetData: _FacetDataStorage;
  27037. _visibility: number;
  27038. _skeleton: Nullable<Skeleton>;
  27039. _layerMask: number;
  27040. _computeBonesUsingShaders: boolean;
  27041. _isActive: boolean;
  27042. _onlyForInstances: boolean;
  27043. _isActiveIntermediate: boolean;
  27044. _onlyForInstancesIntermediate: boolean;
  27045. _actAsRegularMesh: boolean;
  27046. }
  27047. /**
  27048. * Class used to store all common mesh properties
  27049. */
  27050. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  27051. /** No occlusion */
  27052. static OCCLUSION_TYPE_NONE: number;
  27053. /** Occlusion set to optimisitic */
  27054. static OCCLUSION_TYPE_OPTIMISTIC: number;
  27055. /** Occlusion set to strict */
  27056. static OCCLUSION_TYPE_STRICT: number;
  27057. /** Use an accurante occlusion algorithm */
  27058. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  27059. /** Use a conservative occlusion algorithm */
  27060. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  27061. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  27062. * Test order :
  27063. * Is the bounding sphere outside the frustum ?
  27064. * If not, are the bounding box vertices outside the frustum ?
  27065. * It not, then the cullable object is in the frustum.
  27066. */
  27067. static readonly CULLINGSTRATEGY_STANDARD: number;
  27068. /** Culling strategy : Bounding Sphere Only.
  27069. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  27070. * It's also less accurate than the standard because some not visible objects can still be selected.
  27071. * Test : is the bounding sphere outside the frustum ?
  27072. * If not, then the cullable object is in the frustum.
  27073. */
  27074. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  27075. /** Culling strategy : Optimistic Inclusion.
  27076. * This in an inclusion test first, then the standard exclusion test.
  27077. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  27078. * 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.
  27079. * Anyway, it's as accurate as the standard strategy.
  27080. * Test :
  27081. * Is the cullable object bounding sphere center in the frustum ?
  27082. * If not, apply the default culling strategy.
  27083. */
  27084. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  27085. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  27086. * This in an inclusion test first, then the bounding sphere only exclusion test.
  27087. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  27088. * 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.
  27089. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  27090. * Test :
  27091. * Is the cullable object bounding sphere center in the frustum ?
  27092. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  27093. */
  27094. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  27095. /**
  27096. * No billboard
  27097. */
  27098. static readonly BILLBOARDMODE_NONE: number;
  27099. /** Billboard on X axis */
  27100. static readonly BILLBOARDMODE_X: number;
  27101. /** Billboard on Y axis */
  27102. static readonly BILLBOARDMODE_Y: number;
  27103. /** Billboard on Z axis */
  27104. static readonly BILLBOARDMODE_Z: number;
  27105. /** Billboard on all axes */
  27106. static readonly BILLBOARDMODE_ALL: number;
  27107. /** Billboard on using position instead of orientation */
  27108. static readonly BILLBOARDMODE_USE_POSITION: number;
  27109. /** @hidden */
  27110. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  27111. /**
  27112. * The culling strategy to use to check whether the mesh must be rendered or not.
  27113. * This value can be changed at any time and will be used on the next render mesh selection.
  27114. * The possible values are :
  27115. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  27116. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  27117. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  27118. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  27119. * Please read each static variable documentation to get details about the culling process.
  27120. * */
  27121. cullingStrategy: number;
  27122. /**
  27123. * Gets the number of facets in the mesh
  27124. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  27125. */
  27126. readonly facetNb: number;
  27127. /**
  27128. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  27129. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  27130. */
  27131. partitioningSubdivisions: number;
  27132. /**
  27133. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  27134. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  27135. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  27136. */
  27137. partitioningBBoxRatio: number;
  27138. /**
  27139. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  27140. * Works only for updatable meshes.
  27141. * Doesn't work with multi-materials
  27142. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  27143. */
  27144. mustDepthSortFacets: boolean;
  27145. /**
  27146. * The location (Vector3) where the facet depth sort must be computed from.
  27147. * By default, the active camera position.
  27148. * Used only when facet depth sort is enabled
  27149. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  27150. */
  27151. facetDepthSortFrom: Vector3;
  27152. /**
  27153. * gets a boolean indicating if facetData is enabled
  27154. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  27155. */
  27156. readonly isFacetDataEnabled: boolean;
  27157. /** @hidden */
  27158. _updateNonUniformScalingState(value: boolean): boolean;
  27159. /**
  27160. * An event triggered when this mesh collides with another one
  27161. */
  27162. onCollideObservable: Observable<AbstractMesh>;
  27163. /** Set a function to call when this mesh collides with another one */
  27164. onCollide: () => void;
  27165. /**
  27166. * An event triggered when the collision's position changes
  27167. */
  27168. onCollisionPositionChangeObservable: Observable<Vector3>;
  27169. /** Set a function to call when the collision's position changes */
  27170. onCollisionPositionChange: () => void;
  27171. /**
  27172. * An event triggered when material is changed
  27173. */
  27174. onMaterialChangedObservable: Observable<AbstractMesh>;
  27175. /**
  27176. * Gets or sets the orientation for POV movement & rotation
  27177. */
  27178. definedFacingForward: boolean;
  27179. /** @hidden */
  27180. _occlusionQuery: Nullable<WebGLQuery>;
  27181. /** @hidden */
  27182. _renderingGroup: Nullable<RenderingGroup>;
  27183. /**
  27184. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  27185. */
  27186. /**
  27187. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  27188. */
  27189. visibility: number;
  27190. /** Gets or sets the alpha index used to sort transparent meshes
  27191. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  27192. */
  27193. alphaIndex: number;
  27194. /**
  27195. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  27196. */
  27197. isVisible: boolean;
  27198. /**
  27199. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  27200. */
  27201. isPickable: boolean;
  27202. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  27203. showSubMeshesBoundingBox: boolean;
  27204. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  27205. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  27206. */
  27207. isBlocker: boolean;
  27208. /**
  27209. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  27210. */
  27211. enablePointerMoveEvents: boolean;
  27212. /**
  27213. * Specifies the rendering group id for this mesh (0 by default)
  27214. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  27215. */
  27216. renderingGroupId: number;
  27217. private _material;
  27218. /** Gets or sets current material */
  27219. material: Nullable<Material>;
  27220. /**
  27221. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  27222. * @see http://doc.babylonjs.com/babylon101/shadows
  27223. */
  27224. receiveShadows: boolean;
  27225. /** Defines color to use when rendering outline */
  27226. outlineColor: Color3;
  27227. /** Define width to use when rendering outline */
  27228. outlineWidth: number;
  27229. /** Defines color to use when rendering overlay */
  27230. overlayColor: Color3;
  27231. /** Defines alpha to use when rendering overlay */
  27232. overlayAlpha: number;
  27233. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  27234. hasVertexAlpha: boolean;
  27235. /** 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) */
  27236. useVertexColors: boolean;
  27237. /**
  27238. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  27239. */
  27240. computeBonesUsingShaders: boolean;
  27241. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  27242. numBoneInfluencers: number;
  27243. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  27244. applyFog: boolean;
  27245. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  27246. useOctreeForRenderingSelection: boolean;
  27247. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  27248. useOctreeForPicking: boolean;
  27249. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  27250. useOctreeForCollisions: boolean;
  27251. /**
  27252. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  27253. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  27254. */
  27255. layerMask: number;
  27256. /**
  27257. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  27258. */
  27259. alwaysSelectAsActiveMesh: boolean;
  27260. /**
  27261. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  27262. */
  27263. doNotSyncBoundingInfo: boolean;
  27264. /**
  27265. * Gets or sets the current action manager
  27266. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27267. */
  27268. actionManager: Nullable<AbstractActionManager>;
  27269. private _meshCollisionData;
  27270. /**
  27271. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  27272. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27273. */
  27274. ellipsoid: Vector3;
  27275. /**
  27276. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  27277. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27278. */
  27279. ellipsoidOffset: Vector3;
  27280. /**
  27281. * Gets or sets a collision mask used to mask collisions (default is -1).
  27282. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  27283. */
  27284. collisionMask: number;
  27285. /**
  27286. * Gets or sets the current collision group mask (-1 by default).
  27287. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  27288. */
  27289. collisionGroup: number;
  27290. /**
  27291. * Defines edge width used when edgesRenderer is enabled
  27292. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27293. */
  27294. edgesWidth: number;
  27295. /**
  27296. * Defines edge color used when edgesRenderer is enabled
  27297. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27298. */
  27299. edgesColor: Color4;
  27300. /** @hidden */
  27301. _edgesRenderer: Nullable<IEdgesRenderer>;
  27302. /** @hidden */
  27303. _masterMesh: Nullable<AbstractMesh>;
  27304. /** @hidden */
  27305. _boundingInfo: Nullable<BoundingInfo>;
  27306. /** @hidden */
  27307. _renderId: number;
  27308. /**
  27309. * Gets or sets the list of subMeshes
  27310. * @see http://doc.babylonjs.com/how_to/multi_materials
  27311. */
  27312. subMeshes: SubMesh[];
  27313. /** @hidden */
  27314. _intersectionsInProgress: AbstractMesh[];
  27315. /** @hidden */
  27316. _unIndexed: boolean;
  27317. /** @hidden */
  27318. _lightSources: Light[];
  27319. /** Gets the list of lights affecting that mesh */
  27320. readonly lightSources: Light[];
  27321. /** @hidden */
  27322. readonly _positions: Nullable<Vector3[]>;
  27323. /** @hidden */
  27324. _waitingData: {
  27325. lods: Nullable<any>;
  27326. actions: Nullable<any>;
  27327. freezeWorldMatrix: Nullable<boolean>;
  27328. };
  27329. /** @hidden */
  27330. _bonesTransformMatrices: Nullable<Float32Array>;
  27331. /** @hidden */
  27332. _transformMatrixTexture: Nullable<RawTexture>;
  27333. /**
  27334. * Gets or sets a skeleton to apply skining transformations
  27335. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  27336. */
  27337. skeleton: Nullable<Skeleton>;
  27338. /**
  27339. * An event triggered when the mesh is rebuilt.
  27340. */
  27341. onRebuildObservable: Observable<AbstractMesh>;
  27342. /**
  27343. * Creates a new AbstractMesh
  27344. * @param name defines the name of the mesh
  27345. * @param scene defines the hosting scene
  27346. */
  27347. constructor(name: string, scene?: Nullable<Scene>);
  27348. /**
  27349. * Returns the string "AbstractMesh"
  27350. * @returns "AbstractMesh"
  27351. */
  27352. getClassName(): string;
  27353. /**
  27354. * Gets a string representation of the current mesh
  27355. * @param fullDetails defines a boolean indicating if full details must be included
  27356. * @returns a string representation of the current mesh
  27357. */
  27358. toString(fullDetails?: boolean): string;
  27359. /**
  27360. * @hidden
  27361. */
  27362. protected _getEffectiveParent(): Nullable<Node>;
  27363. /** @hidden */
  27364. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27365. /** @hidden */
  27366. _rebuild(): void;
  27367. /** @hidden */
  27368. _resyncLightSources(): void;
  27369. /** @hidden */
  27370. _resyncLighSource(light: Light): void;
  27371. /** @hidden */
  27372. _unBindEffect(): void;
  27373. /** @hidden */
  27374. _removeLightSource(light: Light, dispose: boolean): void;
  27375. private _markSubMeshesAsDirty;
  27376. /** @hidden */
  27377. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  27378. /** @hidden */
  27379. _markSubMeshesAsAttributesDirty(): void;
  27380. /** @hidden */
  27381. _markSubMeshesAsMiscDirty(): void;
  27382. /**
  27383. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  27384. */
  27385. scaling: Vector3;
  27386. /**
  27387. * Returns true if the mesh is blocked. Implemented by child classes
  27388. */
  27389. readonly isBlocked: boolean;
  27390. /**
  27391. * Returns the mesh itself by default. Implemented by child classes
  27392. * @param camera defines the camera to use to pick the right LOD level
  27393. * @returns the currentAbstractMesh
  27394. */
  27395. getLOD(camera: Camera): Nullable<AbstractMesh>;
  27396. /**
  27397. * Returns 0 by default. Implemented by child classes
  27398. * @returns an integer
  27399. */
  27400. getTotalVertices(): number;
  27401. /**
  27402. * Returns a positive integer : the total number of indices in this mesh geometry.
  27403. * @returns the numner of indices or zero if the mesh has no geometry.
  27404. */
  27405. getTotalIndices(): number;
  27406. /**
  27407. * Returns null by default. Implemented by child classes
  27408. * @returns null
  27409. */
  27410. getIndices(): Nullable<IndicesArray>;
  27411. /**
  27412. * Returns the array of the requested vertex data kind. Implemented by child classes
  27413. * @param kind defines the vertex data kind to use
  27414. * @returns null
  27415. */
  27416. getVerticesData(kind: string): Nullable<FloatArray>;
  27417. /**
  27418. * Sets the vertex data of the mesh geometry for the requested `kind`.
  27419. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  27420. * Note that a new underlying VertexBuffer object is created each call.
  27421. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  27422. * @param kind defines vertex data kind:
  27423. * * VertexBuffer.PositionKind
  27424. * * VertexBuffer.UVKind
  27425. * * VertexBuffer.UV2Kind
  27426. * * VertexBuffer.UV3Kind
  27427. * * VertexBuffer.UV4Kind
  27428. * * VertexBuffer.UV5Kind
  27429. * * VertexBuffer.UV6Kind
  27430. * * VertexBuffer.ColorKind
  27431. * * VertexBuffer.MatricesIndicesKind
  27432. * * VertexBuffer.MatricesIndicesExtraKind
  27433. * * VertexBuffer.MatricesWeightsKind
  27434. * * VertexBuffer.MatricesWeightsExtraKind
  27435. * @param data defines the data source
  27436. * @param updatable defines if the data must be flagged as updatable (or static)
  27437. * @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
  27438. * @returns the current mesh
  27439. */
  27440. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  27441. /**
  27442. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  27443. * If the mesh has no geometry, it is simply returned as it is.
  27444. * @param kind defines vertex data kind:
  27445. * * VertexBuffer.PositionKind
  27446. * * VertexBuffer.UVKind
  27447. * * VertexBuffer.UV2Kind
  27448. * * VertexBuffer.UV3Kind
  27449. * * VertexBuffer.UV4Kind
  27450. * * VertexBuffer.UV5Kind
  27451. * * VertexBuffer.UV6Kind
  27452. * * VertexBuffer.ColorKind
  27453. * * VertexBuffer.MatricesIndicesKind
  27454. * * VertexBuffer.MatricesIndicesExtraKind
  27455. * * VertexBuffer.MatricesWeightsKind
  27456. * * VertexBuffer.MatricesWeightsExtraKind
  27457. * @param data defines the data source
  27458. * @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
  27459. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  27460. * @returns the current mesh
  27461. */
  27462. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  27463. /**
  27464. * Sets the mesh indices,
  27465. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  27466. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  27467. * @param totalVertices Defines the total number of vertices
  27468. * @returns the current mesh
  27469. */
  27470. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  27471. /**
  27472. * Gets a boolean indicating if specific vertex data is present
  27473. * @param kind defines the vertex data kind to use
  27474. * @returns true is data kind is present
  27475. */
  27476. isVerticesDataPresent(kind: string): boolean;
  27477. /**
  27478. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  27479. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  27480. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  27481. * @returns a BoundingInfo
  27482. */
  27483. getBoundingInfo(): BoundingInfo;
  27484. /**
  27485. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  27486. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  27487. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  27488. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  27489. * @returns the current mesh
  27490. */
  27491. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  27492. /**
  27493. * Overwrite the current bounding info
  27494. * @param boundingInfo defines the new bounding info
  27495. * @returns the current mesh
  27496. */
  27497. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  27498. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  27499. readonly useBones: boolean;
  27500. /** @hidden */
  27501. _preActivate(): void;
  27502. /** @hidden */
  27503. _preActivateForIntermediateRendering(renderId: number): void;
  27504. /** @hidden */
  27505. _activate(renderId: number, intermediateRendering: boolean): boolean;
  27506. /** @hidden */
  27507. _postActivate(): void;
  27508. /** @hidden */
  27509. _freeze(): void;
  27510. /** @hidden */
  27511. _unFreeze(): void;
  27512. /**
  27513. * Gets the current world matrix
  27514. * @returns a Matrix
  27515. */
  27516. getWorldMatrix(): Matrix;
  27517. /** @hidden */
  27518. _getWorldMatrixDeterminant(): number;
  27519. /**
  27520. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  27521. */
  27522. readonly isAnInstance: boolean;
  27523. /**
  27524. * Gets a boolean indicating if this mesh has instances
  27525. */
  27526. readonly hasInstances: boolean;
  27527. /**
  27528. * Perform relative position change from the point of view of behind the front of the mesh.
  27529. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27530. * Supports definition of mesh facing forward or backward
  27531. * @param amountRight defines the distance on the right axis
  27532. * @param amountUp defines the distance on the up axis
  27533. * @param amountForward defines the distance on the forward axis
  27534. * @returns the current mesh
  27535. */
  27536. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  27537. /**
  27538. * Calculate relative position change from the point of view of behind the front of the mesh.
  27539. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27540. * Supports definition of mesh facing forward or backward
  27541. * @param amountRight defines the distance on the right axis
  27542. * @param amountUp defines the distance on the up axis
  27543. * @param amountForward defines the distance on the forward axis
  27544. * @returns the new displacement vector
  27545. */
  27546. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  27547. /**
  27548. * Perform relative rotation change from the point of view of behind the front of the mesh.
  27549. * Supports definition of mesh facing forward or backward
  27550. * @param flipBack defines the flip
  27551. * @param twirlClockwise defines the twirl
  27552. * @param tiltRight defines the tilt
  27553. * @returns the current mesh
  27554. */
  27555. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  27556. /**
  27557. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  27558. * Supports definition of mesh facing forward or backward.
  27559. * @param flipBack defines the flip
  27560. * @param twirlClockwise defines the twirl
  27561. * @param tiltRight defines the tilt
  27562. * @returns the new rotation vector
  27563. */
  27564. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  27565. /**
  27566. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  27567. * This means the mesh underlying bounding box and sphere are recomputed.
  27568. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  27569. * @returns the current mesh
  27570. */
  27571. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  27572. /** @hidden */
  27573. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  27574. /** @hidden */
  27575. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  27576. /** @hidden */
  27577. _updateBoundingInfo(): AbstractMesh;
  27578. /** @hidden */
  27579. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  27580. /** @hidden */
  27581. protected _afterComputeWorldMatrix(): void;
  27582. /** @hidden */
  27583. readonly _effectiveMesh: AbstractMesh;
  27584. /**
  27585. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  27586. * A mesh is in the frustum if its bounding box intersects the frustum
  27587. * @param frustumPlanes defines the frustum to test
  27588. * @returns true if the mesh is in the frustum planes
  27589. */
  27590. isInFrustum(frustumPlanes: Plane[]): boolean;
  27591. /**
  27592. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  27593. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  27594. * @param frustumPlanes defines the frustum to test
  27595. * @returns true if the mesh is completely in the frustum planes
  27596. */
  27597. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  27598. /**
  27599. * True if the mesh intersects another mesh or a SolidParticle object
  27600. * @param mesh defines a target mesh or SolidParticle to test
  27601. * @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)
  27602. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  27603. * @returns true if there is an intersection
  27604. */
  27605. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  27606. /**
  27607. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  27608. * @param point defines the point to test
  27609. * @returns true if there is an intersection
  27610. */
  27611. intersectsPoint(point: Vector3): boolean;
  27612. /**
  27613. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  27614. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27615. */
  27616. checkCollisions: boolean;
  27617. /**
  27618. * Gets Collider object used to compute collisions (not physics)
  27619. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27620. */
  27621. readonly collider: Nullable<Collider>;
  27622. /**
  27623. * Move the mesh using collision engine
  27624. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27625. * @param displacement defines the requested displacement vector
  27626. * @returns the current mesh
  27627. */
  27628. moveWithCollisions(displacement: Vector3): AbstractMesh;
  27629. private _onCollisionPositionChange;
  27630. /** @hidden */
  27631. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  27632. /** @hidden */
  27633. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  27634. /** @hidden */
  27635. _checkCollision(collider: Collider): AbstractMesh;
  27636. /** @hidden */
  27637. _generatePointsArray(): boolean;
  27638. /**
  27639. * Checks if the passed Ray intersects with the mesh
  27640. * @param ray defines the ray to use
  27641. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  27642. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  27643. * @returns the picking info
  27644. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  27645. */
  27646. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  27647. /**
  27648. * Clones the current mesh
  27649. * @param name defines the mesh name
  27650. * @param newParent defines the new mesh parent
  27651. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  27652. * @returns the new mesh
  27653. */
  27654. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  27655. /**
  27656. * Disposes all the submeshes of the current meshnp
  27657. * @returns the current mesh
  27658. */
  27659. releaseSubMeshes(): AbstractMesh;
  27660. /**
  27661. * Releases resources associated with this abstract mesh.
  27662. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27663. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27664. */
  27665. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27666. /**
  27667. * Adds the passed mesh as a child to the current mesh
  27668. * @param mesh defines the child mesh
  27669. * @returns the current mesh
  27670. */
  27671. addChild(mesh: AbstractMesh): AbstractMesh;
  27672. /**
  27673. * Removes the passed mesh from the current mesh children list
  27674. * @param mesh defines the child mesh
  27675. * @returns the current mesh
  27676. */
  27677. removeChild(mesh: AbstractMesh): AbstractMesh;
  27678. /** @hidden */
  27679. private _initFacetData;
  27680. /**
  27681. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  27682. * This method can be called within the render loop.
  27683. * 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
  27684. * @returns the current mesh
  27685. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27686. */
  27687. updateFacetData(): AbstractMesh;
  27688. /**
  27689. * Returns the facetLocalNormals array.
  27690. * The normals are expressed in the mesh local spac
  27691. * @returns an array of Vector3
  27692. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27693. */
  27694. getFacetLocalNormals(): Vector3[];
  27695. /**
  27696. * Returns the facetLocalPositions array.
  27697. * The facet positions are expressed in the mesh local space
  27698. * @returns an array of Vector3
  27699. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27700. */
  27701. getFacetLocalPositions(): Vector3[];
  27702. /**
  27703. * Returns the facetLocalPartioning array
  27704. * @returns an array of array of numbers
  27705. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27706. */
  27707. getFacetLocalPartitioning(): number[][];
  27708. /**
  27709. * Returns the i-th facet position in the world system.
  27710. * This method allocates a new Vector3 per call
  27711. * @param i defines the facet index
  27712. * @returns a new Vector3
  27713. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27714. */
  27715. getFacetPosition(i: number): Vector3;
  27716. /**
  27717. * Sets the reference Vector3 with the i-th facet position in the world system
  27718. * @param i defines the facet index
  27719. * @param ref defines the target vector
  27720. * @returns the current mesh
  27721. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27722. */
  27723. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  27724. /**
  27725. * Returns the i-th facet normal in the world system.
  27726. * This method allocates a new Vector3 per call
  27727. * @param i defines the facet index
  27728. * @returns a new Vector3
  27729. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27730. */
  27731. getFacetNormal(i: number): Vector3;
  27732. /**
  27733. * Sets the reference Vector3 with the i-th facet normal in the world system
  27734. * @param i defines the facet index
  27735. * @param ref defines the target vector
  27736. * @returns the current mesh
  27737. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27738. */
  27739. getFacetNormalToRef(i: number, ref: Vector3): this;
  27740. /**
  27741. * 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)
  27742. * @param x defines x coordinate
  27743. * @param y defines y coordinate
  27744. * @param z defines z coordinate
  27745. * @returns the array of facet indexes
  27746. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27747. */
  27748. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  27749. /**
  27750. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  27751. * @param projected sets as the (x,y,z) world projection on the facet
  27752. * @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
  27753. * @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
  27754. * @param x defines x coordinate
  27755. * @param y defines y coordinate
  27756. * @param z defines z coordinate
  27757. * @returns the face index if found (or null instead)
  27758. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27759. */
  27760. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27761. /**
  27762. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  27763. * @param projected sets as the (x,y,z) local projection on the facet
  27764. * @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
  27765. * @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
  27766. * @param x defines x coordinate
  27767. * @param y defines y coordinate
  27768. * @param z defines z coordinate
  27769. * @returns the face index if found (or null instead)
  27770. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27771. */
  27772. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27773. /**
  27774. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  27775. * @returns the parameters
  27776. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27777. */
  27778. getFacetDataParameters(): any;
  27779. /**
  27780. * Disables the feature FacetData and frees the related memory
  27781. * @returns the current mesh
  27782. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27783. */
  27784. disableFacetData(): AbstractMesh;
  27785. /**
  27786. * Updates the AbstractMesh indices array
  27787. * @param indices defines the data source
  27788. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27789. * @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)
  27790. * @returns the current mesh
  27791. */
  27792. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27793. /**
  27794. * Creates new normals data for the mesh
  27795. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27796. * @returns the current mesh
  27797. */
  27798. createNormals(updatable: boolean): AbstractMesh;
  27799. /**
  27800. * Align the mesh with a normal
  27801. * @param normal defines the normal to use
  27802. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27803. * @returns the current mesh
  27804. */
  27805. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27806. /** @hidden */
  27807. _checkOcclusionQuery(): boolean;
  27808. /**
  27809. * Disables the mesh edge rendering mode
  27810. * @returns the currentAbstractMesh
  27811. */
  27812. disableEdgesRendering(): AbstractMesh;
  27813. /**
  27814. * Enables the edge rendering mode on the mesh.
  27815. * This mode makes the mesh edges visible
  27816. * @param epsilon defines the maximal distance between two angles to detect a face
  27817. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27818. * @returns the currentAbstractMesh
  27819. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27820. */
  27821. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27822. }
  27823. }
  27824. declare module "babylonjs/Actions/actionEvent" {
  27825. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27826. import { Nullable } from "babylonjs/types";
  27827. import { Sprite } from "babylonjs/Sprites/sprite";
  27828. import { Scene } from "babylonjs/scene";
  27829. import { Vector2 } from "babylonjs/Maths/math.vector";
  27830. /**
  27831. * Interface used to define ActionEvent
  27832. */
  27833. export interface IActionEvent {
  27834. /** The mesh or sprite that triggered the action */
  27835. source: any;
  27836. /** The X mouse cursor position at the time of the event */
  27837. pointerX: number;
  27838. /** The Y mouse cursor position at the time of the event */
  27839. pointerY: number;
  27840. /** The mesh that is currently pointed at (can be null) */
  27841. meshUnderPointer: Nullable<AbstractMesh>;
  27842. /** the original (browser) event that triggered the ActionEvent */
  27843. sourceEvent?: any;
  27844. /** additional data for the event */
  27845. additionalData?: any;
  27846. }
  27847. /**
  27848. * ActionEvent is the event being sent when an action is triggered.
  27849. */
  27850. export class ActionEvent implements IActionEvent {
  27851. /** The mesh or sprite that triggered the action */
  27852. source: any;
  27853. /** The X mouse cursor position at the time of the event */
  27854. pointerX: number;
  27855. /** The Y mouse cursor position at the time of the event */
  27856. pointerY: number;
  27857. /** The mesh that is currently pointed at (can be null) */
  27858. meshUnderPointer: Nullable<AbstractMesh>;
  27859. /** the original (browser) event that triggered the ActionEvent */
  27860. sourceEvent?: any;
  27861. /** additional data for the event */
  27862. additionalData?: any;
  27863. /**
  27864. * Creates a new ActionEvent
  27865. * @param source The mesh or sprite that triggered the action
  27866. * @param pointerX The X mouse cursor position at the time of the event
  27867. * @param pointerY The Y mouse cursor position at the time of the event
  27868. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27869. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27870. * @param additionalData additional data for the event
  27871. */
  27872. constructor(
  27873. /** The mesh or sprite that triggered the action */
  27874. source: any,
  27875. /** The X mouse cursor position at the time of the event */
  27876. pointerX: number,
  27877. /** The Y mouse cursor position at the time of the event */
  27878. pointerY: number,
  27879. /** The mesh that is currently pointed at (can be null) */
  27880. meshUnderPointer: Nullable<AbstractMesh>,
  27881. /** the original (browser) event that triggered the ActionEvent */
  27882. sourceEvent?: any,
  27883. /** additional data for the event */
  27884. additionalData?: any);
  27885. /**
  27886. * Helper function to auto-create an ActionEvent from a source mesh.
  27887. * @param source The source mesh that triggered the event
  27888. * @param evt The original (browser) event
  27889. * @param additionalData additional data for the event
  27890. * @returns the new ActionEvent
  27891. */
  27892. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27893. /**
  27894. * Helper function to auto-create an ActionEvent from a source sprite
  27895. * @param source The source sprite that triggered the event
  27896. * @param scene Scene associated with the sprite
  27897. * @param evt The original (browser) event
  27898. * @param additionalData additional data for the event
  27899. * @returns the new ActionEvent
  27900. */
  27901. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27902. /**
  27903. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27904. * @param scene the scene where the event occurred
  27905. * @param evt The original (browser) event
  27906. * @returns the new ActionEvent
  27907. */
  27908. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27909. /**
  27910. * Helper function to auto-create an ActionEvent from a primitive
  27911. * @param prim defines the target primitive
  27912. * @param pointerPos defines the pointer position
  27913. * @param evt The original (browser) event
  27914. * @param additionalData additional data for the event
  27915. * @returns the new ActionEvent
  27916. */
  27917. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27918. }
  27919. }
  27920. declare module "babylonjs/Actions/abstractActionManager" {
  27921. import { IDisposable } from "babylonjs/scene";
  27922. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27923. import { IAction } from "babylonjs/Actions/action";
  27924. import { Nullable } from "babylonjs/types";
  27925. /**
  27926. * Abstract class used to decouple action Manager from scene and meshes.
  27927. * Do not instantiate.
  27928. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27929. */
  27930. export abstract class AbstractActionManager implements IDisposable {
  27931. /** Gets the list of active triggers */
  27932. static Triggers: {
  27933. [key: string]: number;
  27934. };
  27935. /** Gets the cursor to use when hovering items */
  27936. hoverCursor: string;
  27937. /** Gets the list of actions */
  27938. actions: IAction[];
  27939. /**
  27940. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27941. */
  27942. isRecursive: boolean;
  27943. /**
  27944. * Releases all associated resources
  27945. */
  27946. abstract dispose(): void;
  27947. /**
  27948. * Does this action manager has pointer triggers
  27949. */
  27950. abstract readonly hasPointerTriggers: boolean;
  27951. /**
  27952. * Does this action manager has pick triggers
  27953. */
  27954. abstract readonly hasPickTriggers: boolean;
  27955. /**
  27956. * Process a specific trigger
  27957. * @param trigger defines the trigger to process
  27958. * @param evt defines the event details to be processed
  27959. */
  27960. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27961. /**
  27962. * Does this action manager handles actions of any of the given triggers
  27963. * @param triggers defines the triggers to be tested
  27964. * @return a boolean indicating whether one (or more) of the triggers is handled
  27965. */
  27966. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27967. /**
  27968. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27969. * speed.
  27970. * @param triggerA defines the trigger to be tested
  27971. * @param triggerB defines the trigger to be tested
  27972. * @return a boolean indicating whether one (or more) of the triggers is handled
  27973. */
  27974. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27975. /**
  27976. * Does this action manager handles actions of a given trigger
  27977. * @param trigger defines the trigger to be tested
  27978. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27979. * @return whether the trigger is handled
  27980. */
  27981. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27982. /**
  27983. * Serialize this manager to a JSON object
  27984. * @param name defines the property name to store this manager
  27985. * @returns a JSON representation of this manager
  27986. */
  27987. abstract serialize(name: string): any;
  27988. /**
  27989. * Registers an action to this action manager
  27990. * @param action defines the action to be registered
  27991. * @return the action amended (prepared) after registration
  27992. */
  27993. abstract registerAction(action: IAction): Nullable<IAction>;
  27994. /**
  27995. * Unregisters an action to this action manager
  27996. * @param action defines the action to be unregistered
  27997. * @return a boolean indicating whether the action has been unregistered
  27998. */
  27999. abstract unregisterAction(action: IAction): Boolean;
  28000. /**
  28001. * Does exist one action manager with at least one trigger
  28002. **/
  28003. static readonly HasTriggers: boolean;
  28004. /**
  28005. * Does exist one action manager with at least one pick trigger
  28006. **/
  28007. static readonly HasPickTriggers: boolean;
  28008. /**
  28009. * Does exist one action manager that handles actions of a given trigger
  28010. * @param trigger defines the trigger to be tested
  28011. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  28012. **/
  28013. static HasSpecificTrigger(trigger: number): boolean;
  28014. }
  28015. }
  28016. declare module "babylonjs/node" {
  28017. import { Scene } from "babylonjs/scene";
  28018. import { Nullable } from "babylonjs/types";
  28019. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  28020. import { Engine } from "babylonjs/Engines/engine";
  28021. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  28022. import { Observable } from "babylonjs/Misc/observable";
  28023. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  28024. import { IInspectable } from "babylonjs/Misc/iInspectable";
  28025. import { Animatable } from "babylonjs/Animations/animatable";
  28026. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  28027. import { Animation } from "babylonjs/Animations/animation";
  28028. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28029. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28030. /**
  28031. * Defines how a node can be built from a string name.
  28032. */
  28033. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  28034. /**
  28035. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  28036. */
  28037. export class Node implements IBehaviorAware<Node> {
  28038. /** @hidden */
  28039. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  28040. private static _NodeConstructors;
  28041. /**
  28042. * Add a new node constructor
  28043. * @param type defines the type name of the node to construct
  28044. * @param constructorFunc defines the constructor function
  28045. */
  28046. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  28047. /**
  28048. * Returns a node constructor based on type name
  28049. * @param type defines the type name
  28050. * @param name defines the new node name
  28051. * @param scene defines the hosting scene
  28052. * @param options defines optional options to transmit to constructors
  28053. * @returns the new constructor or null
  28054. */
  28055. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  28056. /**
  28057. * Gets or sets the name of the node
  28058. */
  28059. name: string;
  28060. /**
  28061. * Gets or sets the id of the node
  28062. */
  28063. id: string;
  28064. /**
  28065. * Gets or sets the unique id of the node
  28066. */
  28067. uniqueId: number;
  28068. /**
  28069. * Gets or sets a string used to store user defined state for the node
  28070. */
  28071. state: string;
  28072. /**
  28073. * Gets or sets an object used to store user defined information for the node
  28074. */
  28075. metadata: any;
  28076. /**
  28077. * For internal use only. Please do not use.
  28078. */
  28079. reservedDataStore: any;
  28080. /**
  28081. * List of inspectable custom properties (used by the Inspector)
  28082. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  28083. */
  28084. inspectableCustomProperties: IInspectable[];
  28085. private _doNotSerialize;
  28086. /**
  28087. * Gets or sets a boolean used to define if the node must be serialized
  28088. */
  28089. doNotSerialize: boolean;
  28090. /** @hidden */
  28091. _isDisposed: boolean;
  28092. /**
  28093. * Gets a list of Animations associated with the node
  28094. */
  28095. animations: import("babylonjs/Animations/animation").Animation[];
  28096. protected _ranges: {
  28097. [name: string]: Nullable<AnimationRange>;
  28098. };
  28099. /**
  28100. * Callback raised when the node is ready to be used
  28101. */
  28102. onReady: Nullable<(node: Node) => void>;
  28103. private _isEnabled;
  28104. private _isParentEnabled;
  28105. private _isReady;
  28106. /** @hidden */
  28107. _currentRenderId: number;
  28108. private _parentUpdateId;
  28109. /** @hidden */
  28110. _childUpdateId: number;
  28111. /** @hidden */
  28112. _waitingParentId: Nullable<string>;
  28113. /** @hidden */
  28114. _scene: Scene;
  28115. /** @hidden */
  28116. _cache: any;
  28117. private _parentNode;
  28118. private _children;
  28119. /** @hidden */
  28120. _worldMatrix: Matrix;
  28121. /** @hidden */
  28122. _worldMatrixDeterminant: number;
  28123. /** @hidden */
  28124. _worldMatrixDeterminantIsDirty: boolean;
  28125. /** @hidden */
  28126. private _sceneRootNodesIndex;
  28127. /**
  28128. * Gets a boolean indicating if the node has been disposed
  28129. * @returns true if the node was disposed
  28130. */
  28131. isDisposed(): boolean;
  28132. /**
  28133. * Gets or sets the parent of the node (without keeping the current position in the scene)
  28134. * @see https://doc.babylonjs.com/how_to/parenting
  28135. */
  28136. parent: Nullable<Node>;
  28137. /** @hidden */
  28138. _addToSceneRootNodes(): void;
  28139. /** @hidden */
  28140. _removeFromSceneRootNodes(): void;
  28141. private _animationPropertiesOverride;
  28142. /**
  28143. * Gets or sets the animation properties override
  28144. */
  28145. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  28146. /**
  28147. * Gets a string idenfifying the name of the class
  28148. * @returns "Node" string
  28149. */
  28150. getClassName(): string;
  28151. /** @hidden */
  28152. readonly _isNode: boolean;
  28153. /**
  28154. * An event triggered when the mesh is disposed
  28155. */
  28156. onDisposeObservable: Observable<Node>;
  28157. private _onDisposeObserver;
  28158. /**
  28159. * Sets a callback that will be raised when the node will be disposed
  28160. */
  28161. onDispose: () => void;
  28162. /**
  28163. * Creates a new Node
  28164. * @param name the name and id to be given to this node
  28165. * @param scene the scene this node will be added to
  28166. */
  28167. constructor(name: string, scene?: Nullable<Scene>);
  28168. /**
  28169. * Gets the scene of the node
  28170. * @returns a scene
  28171. */
  28172. getScene(): Scene;
  28173. /**
  28174. * Gets the engine of the node
  28175. * @returns a Engine
  28176. */
  28177. getEngine(): Engine;
  28178. private _behaviors;
  28179. /**
  28180. * Attach a behavior to the node
  28181. * @see http://doc.babylonjs.com/features/behaviour
  28182. * @param behavior defines the behavior to attach
  28183. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  28184. * @returns the current Node
  28185. */
  28186. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  28187. /**
  28188. * Remove an attached behavior
  28189. * @see http://doc.babylonjs.com/features/behaviour
  28190. * @param behavior defines the behavior to attach
  28191. * @returns the current Node
  28192. */
  28193. removeBehavior(behavior: Behavior<Node>): Node;
  28194. /**
  28195. * Gets the list of attached behaviors
  28196. * @see http://doc.babylonjs.com/features/behaviour
  28197. */
  28198. readonly behaviors: Behavior<Node>[];
  28199. /**
  28200. * Gets an attached behavior by name
  28201. * @param name defines the name of the behavior to look for
  28202. * @see http://doc.babylonjs.com/features/behaviour
  28203. * @returns null if behavior was not found else the requested behavior
  28204. */
  28205. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  28206. /**
  28207. * Returns the latest update of the World matrix
  28208. * @returns a Matrix
  28209. */
  28210. getWorldMatrix(): Matrix;
  28211. /** @hidden */
  28212. _getWorldMatrixDeterminant(): number;
  28213. /**
  28214. * Returns directly the latest state of the mesh World matrix.
  28215. * A Matrix is returned.
  28216. */
  28217. readonly worldMatrixFromCache: Matrix;
  28218. /** @hidden */
  28219. _initCache(): void;
  28220. /** @hidden */
  28221. updateCache(force?: boolean): void;
  28222. /** @hidden */
  28223. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  28224. /** @hidden */
  28225. _updateCache(ignoreParentClass?: boolean): void;
  28226. /** @hidden */
  28227. _isSynchronized(): boolean;
  28228. /** @hidden */
  28229. _markSyncedWithParent(): void;
  28230. /** @hidden */
  28231. isSynchronizedWithParent(): boolean;
  28232. /** @hidden */
  28233. isSynchronized(): boolean;
  28234. /**
  28235. * Is this node ready to be used/rendered
  28236. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  28237. * @return true if the node is ready
  28238. */
  28239. isReady(completeCheck?: boolean): boolean;
  28240. /**
  28241. * Is this node enabled?
  28242. * 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
  28243. * @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
  28244. * @return whether this node (and its parent) is enabled
  28245. */
  28246. isEnabled(checkAncestors?: boolean): boolean;
  28247. /** @hidden */
  28248. protected _syncParentEnabledState(): void;
  28249. /**
  28250. * Set the enabled state of this node
  28251. * @param value defines the new enabled state
  28252. */
  28253. setEnabled(value: boolean): void;
  28254. /**
  28255. * Is this node a descendant of the given node?
  28256. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  28257. * @param ancestor defines the parent node to inspect
  28258. * @returns a boolean indicating if this node is a descendant of the given node
  28259. */
  28260. isDescendantOf(ancestor: Node): boolean;
  28261. /** @hidden */
  28262. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  28263. /**
  28264. * Will return all nodes that have this node as ascendant
  28265. * @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
  28266. * @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
  28267. * @return all children nodes of all types
  28268. */
  28269. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  28270. /**
  28271. * Get all child-meshes of this node
  28272. * @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)
  28273. * @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
  28274. * @returns an array of AbstractMesh
  28275. */
  28276. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  28277. /**
  28278. * Get all direct children of this node
  28279. * @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
  28280. * @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)
  28281. * @returns an array of Node
  28282. */
  28283. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  28284. /** @hidden */
  28285. _setReady(state: boolean): void;
  28286. /**
  28287. * Get an animation by name
  28288. * @param name defines the name of the animation to look for
  28289. * @returns null if not found else the requested animation
  28290. */
  28291. getAnimationByName(name: string): Nullable<Animation>;
  28292. /**
  28293. * Creates an animation range for this node
  28294. * @param name defines the name of the range
  28295. * @param from defines the starting key
  28296. * @param to defines the end key
  28297. */
  28298. createAnimationRange(name: string, from: number, to: number): void;
  28299. /**
  28300. * Delete a specific animation range
  28301. * @param name defines the name of the range to delete
  28302. * @param deleteFrames defines if animation frames from the range must be deleted as well
  28303. */
  28304. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  28305. /**
  28306. * Get an animation range by name
  28307. * @param name defines the name of the animation range to look for
  28308. * @returns null if not found else the requested animation range
  28309. */
  28310. getAnimationRange(name: string): Nullable<AnimationRange>;
  28311. /**
  28312. * Gets the list of all animation ranges defined on this node
  28313. * @returns an array
  28314. */
  28315. getAnimationRanges(): Nullable<AnimationRange>[];
  28316. /**
  28317. * Will start the animation sequence
  28318. * @param name defines the range frames for animation sequence
  28319. * @param loop defines if the animation should loop (false by default)
  28320. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  28321. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  28322. * @returns the object created for this animation. If range does not exist, it will return null
  28323. */
  28324. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  28325. /**
  28326. * Serialize animation ranges into a JSON compatible object
  28327. * @returns serialization object
  28328. */
  28329. serializeAnimationRanges(): any;
  28330. /**
  28331. * Computes the world matrix of the node
  28332. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  28333. * @returns the world matrix
  28334. */
  28335. computeWorldMatrix(force?: boolean): Matrix;
  28336. /**
  28337. * Releases resources associated with this node.
  28338. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  28339. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  28340. */
  28341. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  28342. /**
  28343. * Parse animation range data from a serialization object and store them into a given node
  28344. * @param node defines where to store the animation ranges
  28345. * @param parsedNode defines the serialization object to read data from
  28346. * @param scene defines the hosting scene
  28347. */
  28348. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  28349. /**
  28350. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  28351. * @param includeDescendants Include bounding info from descendants as well (true by default)
  28352. * @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
  28353. * @returns the new bounding vectors
  28354. */
  28355. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  28356. min: Vector3;
  28357. max: Vector3;
  28358. };
  28359. }
  28360. }
  28361. declare module "babylonjs/Animations/animation" {
  28362. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  28363. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  28364. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  28365. import { Nullable } from "babylonjs/types";
  28366. import { Scene } from "babylonjs/scene";
  28367. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  28368. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28369. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  28370. import { Node } from "babylonjs/node";
  28371. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28372. import { Size } from "babylonjs/Maths/math.size";
  28373. import { Animatable } from "babylonjs/Animations/animatable";
  28374. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  28375. /**
  28376. * @hidden
  28377. */
  28378. export class _IAnimationState {
  28379. key: number;
  28380. repeatCount: number;
  28381. workValue?: any;
  28382. loopMode?: number;
  28383. offsetValue?: any;
  28384. highLimitValue?: any;
  28385. }
  28386. /**
  28387. * Class used to store any kind of animation
  28388. */
  28389. export class Animation {
  28390. /**Name of the animation */
  28391. name: string;
  28392. /**Property to animate */
  28393. targetProperty: string;
  28394. /**The frames per second of the animation */
  28395. framePerSecond: number;
  28396. /**The data type of the animation */
  28397. dataType: number;
  28398. /**The loop mode of the animation */
  28399. loopMode?: number | undefined;
  28400. /**Specifies if blending should be enabled */
  28401. enableBlending?: boolean | undefined;
  28402. /**
  28403. * Use matrix interpolation instead of using direct key value when animating matrices
  28404. */
  28405. static AllowMatricesInterpolation: boolean;
  28406. /**
  28407. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  28408. */
  28409. static AllowMatrixDecomposeForInterpolation: boolean;
  28410. /**
  28411. * Stores the key frames of the animation
  28412. */
  28413. private _keys;
  28414. /**
  28415. * Stores the easing function of the animation
  28416. */
  28417. private _easingFunction;
  28418. /**
  28419. * @hidden Internal use only
  28420. */
  28421. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  28422. /**
  28423. * The set of event that will be linked to this animation
  28424. */
  28425. private _events;
  28426. /**
  28427. * Stores an array of target property paths
  28428. */
  28429. targetPropertyPath: string[];
  28430. /**
  28431. * Stores the blending speed of the animation
  28432. */
  28433. blendingSpeed: number;
  28434. /**
  28435. * Stores the animation ranges for the animation
  28436. */
  28437. private _ranges;
  28438. /**
  28439. * @hidden Internal use
  28440. */
  28441. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  28442. /**
  28443. * Sets up an animation
  28444. * @param property The property to animate
  28445. * @param animationType The animation type to apply
  28446. * @param framePerSecond The frames per second of the animation
  28447. * @param easingFunction The easing function used in the animation
  28448. * @returns The created animation
  28449. */
  28450. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  28451. /**
  28452. * Create and start an animation on a node
  28453. * @param name defines the name of the global animation that will be run on all nodes
  28454. * @param node defines the root node where the animation will take place
  28455. * @param targetProperty defines property to animate
  28456. * @param framePerSecond defines the number of frame per second yo use
  28457. * @param totalFrame defines the number of frames in total
  28458. * @param from defines the initial value
  28459. * @param to defines the final value
  28460. * @param loopMode defines which loop mode you want to use (off by default)
  28461. * @param easingFunction defines the easing function to use (linear by default)
  28462. * @param onAnimationEnd defines the callback to call when animation end
  28463. * @returns the animatable created for this animation
  28464. */
  28465. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28466. /**
  28467. * Create and start an animation on a node and its descendants
  28468. * @param name defines the name of the global animation that will be run on all nodes
  28469. * @param node defines the root node where the animation will take place
  28470. * @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
  28471. * @param targetProperty defines property to animate
  28472. * @param framePerSecond defines the number of frame per second to use
  28473. * @param totalFrame defines the number of frames in total
  28474. * @param from defines the initial value
  28475. * @param to defines the final value
  28476. * @param loopMode defines which loop mode you want to use (off by default)
  28477. * @param easingFunction defines the easing function to use (linear by default)
  28478. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  28479. * @returns the list of animatables created for all nodes
  28480. * @example https://www.babylonjs-playground.com/#MH0VLI
  28481. */
  28482. 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[]>;
  28483. /**
  28484. * Creates a new animation, merges it with the existing animations and starts it
  28485. * @param name Name of the animation
  28486. * @param node Node which contains the scene that begins the animations
  28487. * @param targetProperty Specifies which property to animate
  28488. * @param framePerSecond The frames per second of the animation
  28489. * @param totalFrame The total number of frames
  28490. * @param from The frame at the beginning of the animation
  28491. * @param to The frame at the end of the animation
  28492. * @param loopMode Specifies the loop mode of the animation
  28493. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  28494. * @param onAnimationEnd Callback to run once the animation is complete
  28495. * @returns Nullable animation
  28496. */
  28497. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28498. /**
  28499. * Transition property of an host to the target Value
  28500. * @param property The property to transition
  28501. * @param targetValue The target Value of the property
  28502. * @param host The object where the property to animate belongs
  28503. * @param scene Scene used to run the animation
  28504. * @param frameRate Framerate (in frame/s) to use
  28505. * @param transition The transition type we want to use
  28506. * @param duration The duration of the animation, in milliseconds
  28507. * @param onAnimationEnd Callback trigger at the end of the animation
  28508. * @returns Nullable animation
  28509. */
  28510. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  28511. /**
  28512. * Return the array of runtime animations currently using this animation
  28513. */
  28514. readonly runtimeAnimations: RuntimeAnimation[];
  28515. /**
  28516. * Specifies if any of the runtime animations are currently running
  28517. */
  28518. readonly hasRunningRuntimeAnimations: boolean;
  28519. /**
  28520. * Initializes the animation
  28521. * @param name Name of the animation
  28522. * @param targetProperty Property to animate
  28523. * @param framePerSecond The frames per second of the animation
  28524. * @param dataType The data type of the animation
  28525. * @param loopMode The loop mode of the animation
  28526. * @param enableBlending Specifies if blending should be enabled
  28527. */
  28528. constructor(
  28529. /**Name of the animation */
  28530. name: string,
  28531. /**Property to animate */
  28532. targetProperty: string,
  28533. /**The frames per second of the animation */
  28534. framePerSecond: number,
  28535. /**The data type of the animation */
  28536. dataType: number,
  28537. /**The loop mode of the animation */
  28538. loopMode?: number | undefined,
  28539. /**Specifies if blending should be enabled */
  28540. enableBlending?: boolean | undefined);
  28541. /**
  28542. * Converts the animation to a string
  28543. * @param fullDetails support for multiple levels of logging within scene loading
  28544. * @returns String form of the animation
  28545. */
  28546. toString(fullDetails?: boolean): string;
  28547. /**
  28548. * Add an event to this animation
  28549. * @param event Event to add
  28550. */
  28551. addEvent(event: AnimationEvent): void;
  28552. /**
  28553. * Remove all events found at the given frame
  28554. * @param frame The frame to remove events from
  28555. */
  28556. removeEvents(frame: number): void;
  28557. /**
  28558. * Retrieves all the events from the animation
  28559. * @returns Events from the animation
  28560. */
  28561. getEvents(): AnimationEvent[];
  28562. /**
  28563. * Creates an animation range
  28564. * @param name Name of the animation range
  28565. * @param from Starting frame of the animation range
  28566. * @param to Ending frame of the animation
  28567. */
  28568. createRange(name: string, from: number, to: number): void;
  28569. /**
  28570. * Deletes an animation range by name
  28571. * @param name Name of the animation range to delete
  28572. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  28573. */
  28574. deleteRange(name: string, deleteFrames?: boolean): void;
  28575. /**
  28576. * Gets the animation range by name, or null if not defined
  28577. * @param name Name of the animation range
  28578. * @returns Nullable animation range
  28579. */
  28580. getRange(name: string): Nullable<AnimationRange>;
  28581. /**
  28582. * Gets the key frames from the animation
  28583. * @returns The key frames of the animation
  28584. */
  28585. getKeys(): Array<IAnimationKey>;
  28586. /**
  28587. * Gets the highest frame rate of the animation
  28588. * @returns Highest frame rate of the animation
  28589. */
  28590. getHighestFrame(): number;
  28591. /**
  28592. * Gets the easing function of the animation
  28593. * @returns Easing function of the animation
  28594. */
  28595. getEasingFunction(): IEasingFunction;
  28596. /**
  28597. * Sets the easing function of the animation
  28598. * @param easingFunction A custom mathematical formula for animation
  28599. */
  28600. setEasingFunction(easingFunction: EasingFunction): void;
  28601. /**
  28602. * Interpolates a scalar linearly
  28603. * @param startValue Start value of the animation curve
  28604. * @param endValue End value of the animation curve
  28605. * @param gradient Scalar amount to interpolate
  28606. * @returns Interpolated scalar value
  28607. */
  28608. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  28609. /**
  28610. * Interpolates a scalar cubically
  28611. * @param startValue Start value of the animation curve
  28612. * @param outTangent End tangent of the animation
  28613. * @param endValue End value of the animation curve
  28614. * @param inTangent Start tangent of the animation curve
  28615. * @param gradient Scalar amount to interpolate
  28616. * @returns Interpolated scalar value
  28617. */
  28618. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  28619. /**
  28620. * Interpolates a quaternion using a spherical linear interpolation
  28621. * @param startValue Start value of the animation curve
  28622. * @param endValue End value of the animation curve
  28623. * @param gradient Scalar amount to interpolate
  28624. * @returns Interpolated quaternion value
  28625. */
  28626. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  28627. /**
  28628. * Interpolates a quaternion cubically
  28629. * @param startValue Start value of the animation curve
  28630. * @param outTangent End tangent of the animation curve
  28631. * @param endValue End value of the animation curve
  28632. * @param inTangent Start tangent of the animation curve
  28633. * @param gradient Scalar amount to interpolate
  28634. * @returns Interpolated quaternion value
  28635. */
  28636. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  28637. /**
  28638. * Interpolates a Vector3 linearl
  28639. * @param startValue Start value of the animation curve
  28640. * @param endValue End value of the animation curve
  28641. * @param gradient Scalar amount to interpolate
  28642. * @returns Interpolated scalar value
  28643. */
  28644. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  28645. /**
  28646. * Interpolates a Vector3 cubically
  28647. * @param startValue Start value of the animation curve
  28648. * @param outTangent End tangent of the animation
  28649. * @param endValue End value of the animation curve
  28650. * @param inTangent Start tangent of the animation curve
  28651. * @param gradient Scalar amount to interpolate
  28652. * @returns InterpolatedVector3 value
  28653. */
  28654. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  28655. /**
  28656. * Interpolates a Vector2 linearly
  28657. * @param startValue Start value of the animation curve
  28658. * @param endValue End value of the animation curve
  28659. * @param gradient Scalar amount to interpolate
  28660. * @returns Interpolated Vector2 value
  28661. */
  28662. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  28663. /**
  28664. * Interpolates a Vector2 cubically
  28665. * @param startValue Start value of the animation curve
  28666. * @param outTangent End tangent of the animation
  28667. * @param endValue End value of the animation curve
  28668. * @param inTangent Start tangent of the animation curve
  28669. * @param gradient Scalar amount to interpolate
  28670. * @returns Interpolated Vector2 value
  28671. */
  28672. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  28673. /**
  28674. * Interpolates a size linearly
  28675. * @param startValue Start value of the animation curve
  28676. * @param endValue End value of the animation curve
  28677. * @param gradient Scalar amount to interpolate
  28678. * @returns Interpolated Size value
  28679. */
  28680. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  28681. /**
  28682. * Interpolates a Color3 linearly
  28683. * @param startValue Start value of the animation curve
  28684. * @param endValue End value of the animation curve
  28685. * @param gradient Scalar amount to interpolate
  28686. * @returns Interpolated Color3 value
  28687. */
  28688. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  28689. /**
  28690. * Interpolates a Color4 linearly
  28691. * @param startValue Start value of the animation curve
  28692. * @param endValue End value of the animation curve
  28693. * @param gradient Scalar amount to interpolate
  28694. * @returns Interpolated Color3 value
  28695. */
  28696. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  28697. /**
  28698. * @hidden Internal use only
  28699. */
  28700. _getKeyValue(value: any): any;
  28701. /**
  28702. * @hidden Internal use only
  28703. */
  28704. _interpolate(currentFrame: number, state: _IAnimationState): any;
  28705. /**
  28706. * Defines the function to use to interpolate matrices
  28707. * @param startValue defines the start matrix
  28708. * @param endValue defines the end matrix
  28709. * @param gradient defines the gradient between both matrices
  28710. * @param result defines an optional target matrix where to store the interpolation
  28711. * @returns the interpolated matrix
  28712. */
  28713. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  28714. /**
  28715. * Makes a copy of the animation
  28716. * @returns Cloned animation
  28717. */
  28718. clone(): Animation;
  28719. /**
  28720. * Sets the key frames of the animation
  28721. * @param values The animation key frames to set
  28722. */
  28723. setKeys(values: Array<IAnimationKey>): void;
  28724. /**
  28725. * Serializes the animation to an object
  28726. * @returns Serialized object
  28727. */
  28728. serialize(): any;
  28729. /**
  28730. * Float animation type
  28731. */
  28732. static readonly ANIMATIONTYPE_FLOAT: number;
  28733. /**
  28734. * Vector3 animation type
  28735. */
  28736. static readonly ANIMATIONTYPE_VECTOR3: number;
  28737. /**
  28738. * Quaternion animation type
  28739. */
  28740. static readonly ANIMATIONTYPE_QUATERNION: number;
  28741. /**
  28742. * Matrix animation type
  28743. */
  28744. static readonly ANIMATIONTYPE_MATRIX: number;
  28745. /**
  28746. * Color3 animation type
  28747. */
  28748. static readonly ANIMATIONTYPE_COLOR3: number;
  28749. /**
  28750. * Color3 animation type
  28751. */
  28752. static readonly ANIMATIONTYPE_COLOR4: number;
  28753. /**
  28754. * Vector2 animation type
  28755. */
  28756. static readonly ANIMATIONTYPE_VECTOR2: number;
  28757. /**
  28758. * Size animation type
  28759. */
  28760. static readonly ANIMATIONTYPE_SIZE: number;
  28761. /**
  28762. * Relative Loop Mode
  28763. */
  28764. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28765. /**
  28766. * Cycle Loop Mode
  28767. */
  28768. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28769. /**
  28770. * Constant Loop Mode
  28771. */
  28772. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28773. /** @hidden */
  28774. static _UniversalLerp(left: any, right: any, amount: number): any;
  28775. /**
  28776. * Parses an animation object and creates an animation
  28777. * @param parsedAnimation Parsed animation object
  28778. * @returns Animation object
  28779. */
  28780. static Parse(parsedAnimation: any): Animation;
  28781. /**
  28782. * Appends the serialized animations from the source animations
  28783. * @param source Source containing the animations
  28784. * @param destination Target to store the animations
  28785. */
  28786. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28787. }
  28788. }
  28789. declare module "babylonjs/Animations/animatable.interface" {
  28790. import { Nullable } from "babylonjs/types";
  28791. import { Animation } from "babylonjs/Animations/animation";
  28792. /**
  28793. * Interface containing an array of animations
  28794. */
  28795. export interface IAnimatable {
  28796. /**
  28797. * Array of animations
  28798. */
  28799. animations: Nullable<Array<Animation>>;
  28800. }
  28801. }
  28802. declare module "babylonjs/Materials/fresnelParameters" {
  28803. import { Color3 } from "babylonjs/Maths/math.color";
  28804. /**
  28805. * This represents all the required information to add a fresnel effect on a material:
  28806. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28807. */
  28808. export class FresnelParameters {
  28809. private _isEnabled;
  28810. /**
  28811. * Define if the fresnel effect is enable or not.
  28812. */
  28813. isEnabled: boolean;
  28814. /**
  28815. * Define the color used on edges (grazing angle)
  28816. */
  28817. leftColor: Color3;
  28818. /**
  28819. * Define the color used on center
  28820. */
  28821. rightColor: Color3;
  28822. /**
  28823. * Define bias applied to computed fresnel term
  28824. */
  28825. bias: number;
  28826. /**
  28827. * Defined the power exponent applied to fresnel term
  28828. */
  28829. power: number;
  28830. /**
  28831. * Clones the current fresnel and its valuues
  28832. * @returns a clone fresnel configuration
  28833. */
  28834. clone(): FresnelParameters;
  28835. /**
  28836. * Serializes the current fresnel parameters to a JSON representation.
  28837. * @return the JSON serialization
  28838. */
  28839. serialize(): any;
  28840. /**
  28841. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28842. * @param parsedFresnelParameters Define the JSON representation
  28843. * @returns the parsed parameters
  28844. */
  28845. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28846. }
  28847. }
  28848. declare module "babylonjs/Misc/decorators" {
  28849. import { Nullable } from "babylonjs/types";
  28850. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28851. import { Scene } from "babylonjs/scene";
  28852. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28853. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28854. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28855. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28856. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28857. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28858. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28859. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28860. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28861. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28862. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28863. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28864. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28865. /**
  28866. * Decorator used to define property that can be serialized as reference to a camera
  28867. * @param sourceName defines the name of the property to decorate
  28868. */
  28869. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28870. /**
  28871. * Class used to help serialization objects
  28872. */
  28873. export class SerializationHelper {
  28874. /** @hidden */
  28875. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28876. /** @hidden */
  28877. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28878. /** @hidden */
  28879. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28880. /** @hidden */
  28881. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28882. /**
  28883. * Appends the serialized animations from the source animations
  28884. * @param source Source containing the animations
  28885. * @param destination Target to store the animations
  28886. */
  28887. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28888. /**
  28889. * Static function used to serialized a specific entity
  28890. * @param entity defines the entity to serialize
  28891. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28892. * @returns a JSON compatible object representing the serialization of the entity
  28893. */
  28894. static Serialize<T>(entity: T, serializationObject?: any): any;
  28895. /**
  28896. * Creates a new entity from a serialization data object
  28897. * @param creationFunction defines a function used to instanciated the new entity
  28898. * @param source defines the source serialization data
  28899. * @param scene defines the hosting scene
  28900. * @param rootUrl defines the root url for resources
  28901. * @returns a new entity
  28902. */
  28903. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28904. /**
  28905. * Clones an object
  28906. * @param creationFunction defines the function used to instanciate the new object
  28907. * @param source defines the source object
  28908. * @returns the cloned object
  28909. */
  28910. static Clone<T>(creationFunction: () => T, source: T): T;
  28911. /**
  28912. * Instanciates a new object based on a source one (some data will be shared between both object)
  28913. * @param creationFunction defines the function used to instanciate the new object
  28914. * @param source defines the source object
  28915. * @returns the new object
  28916. */
  28917. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28918. }
  28919. }
  28920. declare module "babylonjs/Misc/guid" {
  28921. /**
  28922. * Class used to manipulate GUIDs
  28923. */
  28924. export class GUID {
  28925. /**
  28926. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28927. * Be aware Math.random() could cause collisions, but:
  28928. * "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"
  28929. * @returns a pseudo random id
  28930. */
  28931. static RandomId(): string;
  28932. }
  28933. }
  28934. declare module "babylonjs/Materials/Textures/baseTexture" {
  28935. import { Observable } from "babylonjs/Misc/observable";
  28936. import { Nullable } from "babylonjs/types";
  28937. import { Scene } from "babylonjs/scene";
  28938. import { Matrix } from "babylonjs/Maths/math.vector";
  28939. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28940. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28941. import { ISize } from "babylonjs/Maths/math.size";
  28942. /**
  28943. * Base class of all the textures in babylon.
  28944. * It groups all the common properties the materials, post process, lights... might need
  28945. * in order to make a correct use of the texture.
  28946. */
  28947. export class BaseTexture implements IAnimatable {
  28948. /**
  28949. * Default anisotropic filtering level for the application.
  28950. * It is set to 4 as a good tradeoff between perf and quality.
  28951. */
  28952. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28953. /**
  28954. * Gets or sets the unique id of the texture
  28955. */
  28956. uniqueId: number;
  28957. /**
  28958. * Define the name of the texture.
  28959. */
  28960. name: string;
  28961. /**
  28962. * Gets or sets an object used to store user defined information.
  28963. */
  28964. metadata: any;
  28965. /**
  28966. * For internal use only. Please do not use.
  28967. */
  28968. reservedDataStore: any;
  28969. private _hasAlpha;
  28970. /**
  28971. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28972. */
  28973. hasAlpha: boolean;
  28974. /**
  28975. * Defines if the alpha value should be determined via the rgb values.
  28976. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28977. */
  28978. getAlphaFromRGB: boolean;
  28979. /**
  28980. * Intensity or strength of the texture.
  28981. * It is commonly used by materials to fine tune the intensity of the texture
  28982. */
  28983. level: number;
  28984. /**
  28985. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28986. * This is part of the texture as textures usually maps to one uv set.
  28987. */
  28988. coordinatesIndex: number;
  28989. private _coordinatesMode;
  28990. /**
  28991. * How a texture is mapped.
  28992. *
  28993. * | Value | Type | Description |
  28994. * | ----- | ----------------------------------- | ----------- |
  28995. * | 0 | EXPLICIT_MODE | |
  28996. * | 1 | SPHERICAL_MODE | |
  28997. * | 2 | PLANAR_MODE | |
  28998. * | 3 | CUBIC_MODE | |
  28999. * | 4 | PROJECTION_MODE | |
  29000. * | 5 | SKYBOX_MODE | |
  29001. * | 6 | INVCUBIC_MODE | |
  29002. * | 7 | EQUIRECTANGULAR_MODE | |
  29003. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  29004. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  29005. */
  29006. coordinatesMode: number;
  29007. /**
  29008. * | Value | Type | Description |
  29009. * | ----- | ------------------ | ----------- |
  29010. * | 0 | CLAMP_ADDRESSMODE | |
  29011. * | 1 | WRAP_ADDRESSMODE | |
  29012. * | 2 | MIRROR_ADDRESSMODE | |
  29013. */
  29014. wrapU: number;
  29015. /**
  29016. * | Value | Type | Description |
  29017. * | ----- | ------------------ | ----------- |
  29018. * | 0 | CLAMP_ADDRESSMODE | |
  29019. * | 1 | WRAP_ADDRESSMODE | |
  29020. * | 2 | MIRROR_ADDRESSMODE | |
  29021. */
  29022. wrapV: number;
  29023. /**
  29024. * | Value | Type | Description |
  29025. * | ----- | ------------------ | ----------- |
  29026. * | 0 | CLAMP_ADDRESSMODE | |
  29027. * | 1 | WRAP_ADDRESSMODE | |
  29028. * | 2 | MIRROR_ADDRESSMODE | |
  29029. */
  29030. wrapR: number;
  29031. /**
  29032. * With compliant hardware and browser (supporting anisotropic filtering)
  29033. * this defines the level of anisotropic filtering in the texture.
  29034. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  29035. */
  29036. anisotropicFilteringLevel: number;
  29037. /**
  29038. * Define if the texture is a cube texture or if false a 2d texture.
  29039. */
  29040. isCube: boolean;
  29041. /**
  29042. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  29043. */
  29044. is3D: boolean;
  29045. /**
  29046. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  29047. */
  29048. is2DArray: boolean;
  29049. /**
  29050. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  29051. * HDR texture are usually stored in linear space.
  29052. * This only impacts the PBR and Background materials
  29053. */
  29054. gammaSpace: boolean;
  29055. /**
  29056. * Gets or sets whether or not the texture contains RGBD data.
  29057. */
  29058. isRGBD: boolean;
  29059. /**
  29060. * Is Z inverted in the texture (useful in a cube texture).
  29061. */
  29062. invertZ: boolean;
  29063. /**
  29064. * Are mip maps generated for this texture or not.
  29065. */
  29066. readonly noMipmap: boolean;
  29067. /**
  29068. * @hidden
  29069. */
  29070. lodLevelInAlpha: boolean;
  29071. /**
  29072. * With prefiltered texture, defined the offset used during the prefiltering steps.
  29073. */
  29074. lodGenerationOffset: number;
  29075. /**
  29076. * With prefiltered texture, defined the scale used during the prefiltering steps.
  29077. */
  29078. lodGenerationScale: number;
  29079. /**
  29080. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  29081. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  29082. * average roughness values.
  29083. */
  29084. linearSpecularLOD: boolean;
  29085. /**
  29086. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  29087. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  29088. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  29089. */
  29090. irradianceTexture: Nullable<BaseTexture>;
  29091. /**
  29092. * Define if the texture is a render target.
  29093. */
  29094. isRenderTarget: boolean;
  29095. /**
  29096. * Define the unique id of the texture in the scene.
  29097. */
  29098. readonly uid: string;
  29099. /**
  29100. * Return a string representation of the texture.
  29101. * @returns the texture as a string
  29102. */
  29103. toString(): string;
  29104. /**
  29105. * Get the class name of the texture.
  29106. * @returns "BaseTexture"
  29107. */
  29108. getClassName(): string;
  29109. /**
  29110. * Define the list of animation attached to the texture.
  29111. */
  29112. animations: import("babylonjs/Animations/animation").Animation[];
  29113. /**
  29114. * An event triggered when the texture is disposed.
  29115. */
  29116. onDisposeObservable: Observable<BaseTexture>;
  29117. private _onDisposeObserver;
  29118. /**
  29119. * Callback triggered when the texture has been disposed.
  29120. * Kept for back compatibility, you can use the onDisposeObservable instead.
  29121. */
  29122. onDispose: () => void;
  29123. /**
  29124. * Define the current state of the loading sequence when in delayed load mode.
  29125. */
  29126. delayLoadState: number;
  29127. private _scene;
  29128. /** @hidden */
  29129. _texture: Nullable<InternalTexture>;
  29130. private _uid;
  29131. /**
  29132. * Define if the texture is preventinga material to render or not.
  29133. * If not and the texture is not ready, the engine will use a default black texture instead.
  29134. */
  29135. readonly isBlocking: boolean;
  29136. /**
  29137. * Instantiates a new BaseTexture.
  29138. * Base class of all the textures in babylon.
  29139. * It groups all the common properties the materials, post process, lights... might need
  29140. * in order to make a correct use of the texture.
  29141. * @param scene Define the scene the texture blongs to
  29142. */
  29143. constructor(scene: Nullable<Scene>);
  29144. /**
  29145. * Get the scene the texture belongs to.
  29146. * @returns the scene or null if undefined
  29147. */
  29148. getScene(): Nullable<Scene>;
  29149. /**
  29150. * Get the texture transform matrix used to offset tile the texture for istance.
  29151. * @returns the transformation matrix
  29152. */
  29153. getTextureMatrix(): Matrix;
  29154. /**
  29155. * Get the texture reflection matrix used to rotate/transform the reflection.
  29156. * @returns the reflection matrix
  29157. */
  29158. getReflectionTextureMatrix(): Matrix;
  29159. /**
  29160. * Get the underlying lower level texture from Babylon.
  29161. * @returns the insternal texture
  29162. */
  29163. getInternalTexture(): Nullable<InternalTexture>;
  29164. /**
  29165. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  29166. * @returns true if ready or not blocking
  29167. */
  29168. isReadyOrNotBlocking(): boolean;
  29169. /**
  29170. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  29171. * @returns true if fully ready
  29172. */
  29173. isReady(): boolean;
  29174. private _cachedSize;
  29175. /**
  29176. * Get the size of the texture.
  29177. * @returns the texture size.
  29178. */
  29179. getSize(): ISize;
  29180. /**
  29181. * Get the base size of the texture.
  29182. * It can be different from the size if the texture has been resized for POT for instance
  29183. * @returns the base size
  29184. */
  29185. getBaseSize(): ISize;
  29186. /**
  29187. * Update the sampling mode of the texture.
  29188. * Default is Trilinear mode.
  29189. *
  29190. * | Value | Type | Description |
  29191. * | ----- | ------------------ | ----------- |
  29192. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  29193. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  29194. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  29195. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  29196. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  29197. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  29198. * | 7 | NEAREST_LINEAR | |
  29199. * | 8 | NEAREST_NEAREST | |
  29200. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  29201. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  29202. * | 11 | LINEAR_LINEAR | |
  29203. * | 12 | LINEAR_NEAREST | |
  29204. *
  29205. * > _mag_: magnification filter (close to the viewer)
  29206. * > _min_: minification filter (far from the viewer)
  29207. * > _mip_: filter used between mip map levels
  29208. *@param samplingMode Define the new sampling mode of the texture
  29209. */
  29210. updateSamplingMode(samplingMode: number): void;
  29211. /**
  29212. * Scales the texture if is `canRescale()`
  29213. * @param ratio the resize factor we want to use to rescale
  29214. */
  29215. scale(ratio: number): void;
  29216. /**
  29217. * Get if the texture can rescale.
  29218. */
  29219. readonly canRescale: boolean;
  29220. /** @hidden */
  29221. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  29222. /** @hidden */
  29223. _rebuild(): void;
  29224. /**
  29225. * Triggers the load sequence in delayed load mode.
  29226. */
  29227. delayLoad(): void;
  29228. /**
  29229. * Clones the texture.
  29230. * @returns the cloned texture
  29231. */
  29232. clone(): Nullable<BaseTexture>;
  29233. /**
  29234. * Get the texture underlying type (INT, FLOAT...)
  29235. */
  29236. readonly textureType: number;
  29237. /**
  29238. * Get the texture underlying format (RGB, RGBA...)
  29239. */
  29240. readonly textureFormat: number;
  29241. /**
  29242. * Indicates that textures need to be re-calculated for all materials
  29243. */
  29244. protected _markAllSubMeshesAsTexturesDirty(): void;
  29245. /**
  29246. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  29247. * This will returns an RGBA array buffer containing either in values (0-255) or
  29248. * float values (0-1) depending of the underlying buffer type.
  29249. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  29250. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  29251. * @param buffer defines a user defined buffer to fill with data (can be null)
  29252. * @returns The Array buffer containing the pixels data.
  29253. */
  29254. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  29255. /**
  29256. * Release and destroy the underlying lower level texture aka internalTexture.
  29257. */
  29258. releaseInternalTexture(): void;
  29259. /** @hidden */
  29260. readonly _lodTextureHigh: Nullable<BaseTexture>;
  29261. /** @hidden */
  29262. readonly _lodTextureMid: Nullable<BaseTexture>;
  29263. /** @hidden */
  29264. readonly _lodTextureLow: Nullable<BaseTexture>;
  29265. /**
  29266. * Dispose the texture and release its associated resources.
  29267. */
  29268. dispose(): void;
  29269. /**
  29270. * Serialize the texture into a JSON representation that can be parsed later on.
  29271. * @returns the JSON representation of the texture
  29272. */
  29273. serialize(): any;
  29274. /**
  29275. * Helper function to be called back once a list of texture contains only ready textures.
  29276. * @param textures Define the list of textures to wait for
  29277. * @param callback Define the callback triggered once the entire list will be ready
  29278. */
  29279. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  29280. }
  29281. }
  29282. declare module "babylonjs/Materials/effect" {
  29283. import { Observable } from "babylonjs/Misc/observable";
  29284. import { Nullable } from "babylonjs/types";
  29285. import { IDisposable } from "babylonjs/scene";
  29286. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  29287. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29288. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  29289. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  29290. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  29291. import { Engine } from "babylonjs/Engines/engine";
  29292. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29293. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29294. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29295. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29296. /**
  29297. * Options to be used when creating an effect.
  29298. */
  29299. export interface IEffectCreationOptions {
  29300. /**
  29301. * Atrributes that will be used in the shader.
  29302. */
  29303. attributes: string[];
  29304. /**
  29305. * Uniform varible names that will be set in the shader.
  29306. */
  29307. uniformsNames: string[];
  29308. /**
  29309. * Uniform buffer variable names that will be set in the shader.
  29310. */
  29311. uniformBuffersNames: string[];
  29312. /**
  29313. * Sampler texture variable names that will be set in the shader.
  29314. */
  29315. samplers: string[];
  29316. /**
  29317. * Define statements that will be set in the shader.
  29318. */
  29319. defines: any;
  29320. /**
  29321. * Possible fallbacks for this effect to improve performance when needed.
  29322. */
  29323. fallbacks: Nullable<IEffectFallbacks>;
  29324. /**
  29325. * Callback that will be called when the shader is compiled.
  29326. */
  29327. onCompiled: Nullable<(effect: Effect) => void>;
  29328. /**
  29329. * Callback that will be called if an error occurs during shader compilation.
  29330. */
  29331. onError: Nullable<(effect: Effect, errors: string) => void>;
  29332. /**
  29333. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29334. */
  29335. indexParameters?: any;
  29336. /**
  29337. * Max number of lights that can be used in the shader.
  29338. */
  29339. maxSimultaneousLights?: number;
  29340. /**
  29341. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  29342. */
  29343. transformFeedbackVaryings?: Nullable<string[]>;
  29344. }
  29345. /**
  29346. * Effect containing vertex and fragment shader that can be executed on an object.
  29347. */
  29348. export class Effect implements IDisposable {
  29349. /**
  29350. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29351. */
  29352. static ShadersRepository: string;
  29353. /**
  29354. * Name of the effect.
  29355. */
  29356. name: any;
  29357. /**
  29358. * String container all the define statements that should be set on the shader.
  29359. */
  29360. defines: string;
  29361. /**
  29362. * Callback that will be called when the shader is compiled.
  29363. */
  29364. onCompiled: Nullable<(effect: Effect) => void>;
  29365. /**
  29366. * Callback that will be called if an error occurs during shader compilation.
  29367. */
  29368. onError: Nullable<(effect: Effect, errors: string) => void>;
  29369. /**
  29370. * Callback that will be called when effect is bound.
  29371. */
  29372. onBind: Nullable<(effect: Effect) => void>;
  29373. /**
  29374. * Unique ID of the effect.
  29375. */
  29376. uniqueId: number;
  29377. /**
  29378. * Observable that will be called when the shader is compiled.
  29379. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29380. */
  29381. onCompileObservable: Observable<Effect>;
  29382. /**
  29383. * Observable that will be called if an error occurs during shader compilation.
  29384. */
  29385. onErrorObservable: Observable<Effect>;
  29386. /** @hidden */
  29387. _onBindObservable: Nullable<Observable<Effect>>;
  29388. /**
  29389. * Observable that will be called when effect is bound.
  29390. */
  29391. readonly onBindObservable: Observable<Effect>;
  29392. /** @hidden */
  29393. _bonesComputationForcedToCPU: boolean;
  29394. private static _uniqueIdSeed;
  29395. private _engine;
  29396. private _uniformBuffersNames;
  29397. private _uniformsNames;
  29398. private _samplerList;
  29399. private _samplers;
  29400. private _isReady;
  29401. private _compilationError;
  29402. private _allFallbacksProcessed;
  29403. private _attributesNames;
  29404. private _attributes;
  29405. private _uniforms;
  29406. /**
  29407. * Key for the effect.
  29408. * @hidden
  29409. */
  29410. _key: string;
  29411. private _indexParameters;
  29412. private _fallbacks;
  29413. private _vertexSourceCode;
  29414. private _fragmentSourceCode;
  29415. private _vertexSourceCodeOverride;
  29416. private _fragmentSourceCodeOverride;
  29417. private _transformFeedbackVaryings;
  29418. /**
  29419. * Compiled shader to webGL program.
  29420. * @hidden
  29421. */
  29422. _pipelineContext: Nullable<IPipelineContext>;
  29423. private _valueCache;
  29424. private static _baseCache;
  29425. /**
  29426. * Instantiates an effect.
  29427. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29428. * @param baseName Name of the effect.
  29429. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29430. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29431. * @param samplers List of sampler variables that will be passed to the shader.
  29432. * @param engine Engine to be used to render the effect
  29433. * @param defines Define statements to be added to the shader.
  29434. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29435. * @param onCompiled Callback that will be called when the shader is compiled.
  29436. * @param onError Callback that will be called if an error occurs during shader compilation.
  29437. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29438. */
  29439. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  29440. private _useFinalCode;
  29441. /**
  29442. * Unique key for this effect
  29443. */
  29444. readonly key: string;
  29445. /**
  29446. * If the effect has been compiled and prepared.
  29447. * @returns if the effect is compiled and prepared.
  29448. */
  29449. isReady(): boolean;
  29450. private _isReadyInternal;
  29451. /**
  29452. * The engine the effect was initialized with.
  29453. * @returns the engine.
  29454. */
  29455. getEngine(): Engine;
  29456. /**
  29457. * The pipeline context for this effect
  29458. * @returns the associated pipeline context
  29459. */
  29460. getPipelineContext(): Nullable<IPipelineContext>;
  29461. /**
  29462. * The set of names of attribute variables for the shader.
  29463. * @returns An array of attribute names.
  29464. */
  29465. getAttributesNames(): string[];
  29466. /**
  29467. * Returns the attribute at the given index.
  29468. * @param index The index of the attribute.
  29469. * @returns The location of the attribute.
  29470. */
  29471. getAttributeLocation(index: number): number;
  29472. /**
  29473. * Returns the attribute based on the name of the variable.
  29474. * @param name of the attribute to look up.
  29475. * @returns the attribute location.
  29476. */
  29477. getAttributeLocationByName(name: string): number;
  29478. /**
  29479. * The number of attributes.
  29480. * @returns the numnber of attributes.
  29481. */
  29482. getAttributesCount(): number;
  29483. /**
  29484. * Gets the index of a uniform variable.
  29485. * @param uniformName of the uniform to look up.
  29486. * @returns the index.
  29487. */
  29488. getUniformIndex(uniformName: string): number;
  29489. /**
  29490. * Returns the attribute based on the name of the variable.
  29491. * @param uniformName of the uniform to look up.
  29492. * @returns the location of the uniform.
  29493. */
  29494. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29495. /**
  29496. * Returns an array of sampler variable names
  29497. * @returns The array of sampler variable neames.
  29498. */
  29499. getSamplers(): string[];
  29500. /**
  29501. * The error from the last compilation.
  29502. * @returns the error string.
  29503. */
  29504. getCompilationError(): string;
  29505. /**
  29506. * Gets a boolean indicating that all fallbacks were used during compilation
  29507. * @returns true if all fallbacks were used
  29508. */
  29509. allFallbacksProcessed(): boolean;
  29510. /**
  29511. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29512. * @param func The callback to be used.
  29513. */
  29514. executeWhenCompiled(func: (effect: Effect) => void): void;
  29515. private _checkIsReady;
  29516. private _loadShader;
  29517. /**
  29518. * Recompiles the webGL program
  29519. * @param vertexSourceCode The source code for the vertex shader.
  29520. * @param fragmentSourceCode The source code for the fragment shader.
  29521. * @param onCompiled Callback called when completed.
  29522. * @param onError Callback called on error.
  29523. * @hidden
  29524. */
  29525. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29526. /**
  29527. * Prepares the effect
  29528. * @hidden
  29529. */
  29530. _prepareEffect(): void;
  29531. private _processCompilationErrors;
  29532. /**
  29533. * Checks if the effect is supported. (Must be called after compilation)
  29534. */
  29535. readonly isSupported: boolean;
  29536. /**
  29537. * Binds a texture to the engine to be used as output of the shader.
  29538. * @param channel Name of the output variable.
  29539. * @param texture Texture to bind.
  29540. * @hidden
  29541. */
  29542. _bindTexture(channel: string, texture: InternalTexture): void;
  29543. /**
  29544. * Sets a texture on the engine to be used in the shader.
  29545. * @param channel Name of the sampler variable.
  29546. * @param texture Texture to set.
  29547. */
  29548. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29549. /**
  29550. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29551. * @param channel Name of the sampler variable.
  29552. * @param texture Texture to set.
  29553. */
  29554. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29555. /**
  29556. * Sets an array of textures on the engine to be used in the shader.
  29557. * @param channel Name of the variable.
  29558. * @param textures Textures to set.
  29559. */
  29560. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29561. /**
  29562. * 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)
  29563. * @param channel Name of the sampler variable.
  29564. * @param postProcess Post process to get the input texture from.
  29565. */
  29566. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29567. /**
  29568. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29569. * 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)
  29570. * @param channel Name of the sampler variable.
  29571. * @param postProcess Post process to get the output texture from.
  29572. */
  29573. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29574. /** @hidden */
  29575. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29576. /** @hidden */
  29577. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29578. /** @hidden */
  29579. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29580. /** @hidden */
  29581. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29582. /**
  29583. * Binds a buffer to a uniform.
  29584. * @param buffer Buffer to bind.
  29585. * @param name Name of the uniform variable to bind to.
  29586. */
  29587. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29588. /**
  29589. * Binds block to a uniform.
  29590. * @param blockName Name of the block to bind.
  29591. * @param index Index to bind.
  29592. */
  29593. bindUniformBlock(blockName: string, index: number): void;
  29594. /**
  29595. * Sets an interger value on a uniform variable.
  29596. * @param uniformName Name of the variable.
  29597. * @param value Value to be set.
  29598. * @returns this effect.
  29599. */
  29600. setInt(uniformName: string, value: number): Effect;
  29601. /**
  29602. * Sets an int array on a uniform variable.
  29603. * @param uniformName Name of the variable.
  29604. * @param array array to be set.
  29605. * @returns this effect.
  29606. */
  29607. setIntArray(uniformName: string, array: Int32Array): Effect;
  29608. /**
  29609. * 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)
  29610. * @param uniformName Name of the variable.
  29611. * @param array array to be set.
  29612. * @returns this effect.
  29613. */
  29614. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29615. /**
  29616. * 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)
  29617. * @param uniformName Name of the variable.
  29618. * @param array array to be set.
  29619. * @returns this effect.
  29620. */
  29621. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29622. /**
  29623. * 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)
  29624. * @param uniformName Name of the variable.
  29625. * @param array array to be set.
  29626. * @returns this effect.
  29627. */
  29628. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29629. /**
  29630. * Sets an float array on a uniform variable.
  29631. * @param uniformName Name of the variable.
  29632. * @param array array to be set.
  29633. * @returns this effect.
  29634. */
  29635. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29636. /**
  29637. * 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)
  29638. * @param uniformName Name of the variable.
  29639. * @param array array to be set.
  29640. * @returns this effect.
  29641. */
  29642. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29643. /**
  29644. * 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)
  29645. * @param uniformName Name of the variable.
  29646. * @param array array to be set.
  29647. * @returns this effect.
  29648. */
  29649. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29650. /**
  29651. * 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)
  29652. * @param uniformName Name of the variable.
  29653. * @param array array to be set.
  29654. * @returns this effect.
  29655. */
  29656. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29657. /**
  29658. * Sets an array on a uniform variable.
  29659. * @param uniformName Name of the variable.
  29660. * @param array array to be set.
  29661. * @returns this effect.
  29662. */
  29663. setArray(uniformName: string, array: number[]): Effect;
  29664. /**
  29665. * 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)
  29666. * @param uniformName Name of the variable.
  29667. * @param array array to be set.
  29668. * @returns this effect.
  29669. */
  29670. setArray2(uniformName: string, array: number[]): Effect;
  29671. /**
  29672. * 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)
  29673. * @param uniformName Name of the variable.
  29674. * @param array array to be set.
  29675. * @returns this effect.
  29676. */
  29677. setArray3(uniformName: string, array: number[]): Effect;
  29678. /**
  29679. * 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)
  29680. * @param uniformName Name of the variable.
  29681. * @param array array to be set.
  29682. * @returns this effect.
  29683. */
  29684. setArray4(uniformName: string, array: number[]): Effect;
  29685. /**
  29686. * Sets matrices on a uniform variable.
  29687. * @param uniformName Name of the variable.
  29688. * @param matrices matrices to be set.
  29689. * @returns this effect.
  29690. */
  29691. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29692. /**
  29693. * Sets matrix on a uniform variable.
  29694. * @param uniformName Name of the variable.
  29695. * @param matrix matrix to be set.
  29696. * @returns this effect.
  29697. */
  29698. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29699. /**
  29700. * 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)
  29701. * @param uniformName Name of the variable.
  29702. * @param matrix matrix to be set.
  29703. * @returns this effect.
  29704. */
  29705. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29706. /**
  29707. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29708. * @param uniformName Name of the variable.
  29709. * @param matrix matrix to be set.
  29710. * @returns this effect.
  29711. */
  29712. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29713. /**
  29714. * Sets a float on a uniform variable.
  29715. * @param uniformName Name of the variable.
  29716. * @param value value to be set.
  29717. * @returns this effect.
  29718. */
  29719. setFloat(uniformName: string, value: number): Effect;
  29720. /**
  29721. * Sets a boolean on a uniform variable.
  29722. * @param uniformName Name of the variable.
  29723. * @param bool value to be set.
  29724. * @returns this effect.
  29725. */
  29726. setBool(uniformName: string, bool: boolean): Effect;
  29727. /**
  29728. * Sets a Vector2 on a uniform variable.
  29729. * @param uniformName Name of the variable.
  29730. * @param vector2 vector2 to be set.
  29731. * @returns this effect.
  29732. */
  29733. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29734. /**
  29735. * Sets a float2 on a uniform variable.
  29736. * @param uniformName Name of the variable.
  29737. * @param x First float in float2.
  29738. * @param y Second float in float2.
  29739. * @returns this effect.
  29740. */
  29741. setFloat2(uniformName: string, x: number, y: number): Effect;
  29742. /**
  29743. * Sets a Vector3 on a uniform variable.
  29744. * @param uniformName Name of the variable.
  29745. * @param vector3 Value to be set.
  29746. * @returns this effect.
  29747. */
  29748. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29749. /**
  29750. * Sets a float3 on a uniform variable.
  29751. * @param uniformName Name of the variable.
  29752. * @param x First float in float3.
  29753. * @param y Second float in float3.
  29754. * @param z Third float in float3.
  29755. * @returns this effect.
  29756. */
  29757. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29758. /**
  29759. * Sets a Vector4 on a uniform variable.
  29760. * @param uniformName Name of the variable.
  29761. * @param vector4 Value to be set.
  29762. * @returns this effect.
  29763. */
  29764. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29765. /**
  29766. * Sets a float4 on a uniform variable.
  29767. * @param uniformName Name of the variable.
  29768. * @param x First float in float4.
  29769. * @param y Second float in float4.
  29770. * @param z Third float in float4.
  29771. * @param w Fourth float in float4.
  29772. * @returns this effect.
  29773. */
  29774. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29775. /**
  29776. * Sets a Color3 on a uniform variable.
  29777. * @param uniformName Name of the variable.
  29778. * @param color3 Value to be set.
  29779. * @returns this effect.
  29780. */
  29781. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29782. /**
  29783. * Sets a Color4 on a uniform variable.
  29784. * @param uniformName Name of the variable.
  29785. * @param color3 Value to be set.
  29786. * @param alpha Alpha value to be set.
  29787. * @returns this effect.
  29788. */
  29789. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29790. /**
  29791. * Sets a Color4 on a uniform variable
  29792. * @param uniformName defines the name of the variable
  29793. * @param color4 defines the value to be set
  29794. * @returns this effect.
  29795. */
  29796. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29797. /** Release all associated resources */
  29798. dispose(): void;
  29799. /**
  29800. * This function will add a new shader to the shader store
  29801. * @param name the name of the shader
  29802. * @param pixelShader optional pixel shader content
  29803. * @param vertexShader optional vertex shader content
  29804. */
  29805. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29806. /**
  29807. * Store of each shader (The can be looked up using effect.key)
  29808. */
  29809. static ShadersStore: {
  29810. [key: string]: string;
  29811. };
  29812. /**
  29813. * Store of each included file for a shader (The can be looked up using effect.key)
  29814. */
  29815. static IncludesShadersStore: {
  29816. [key: string]: string;
  29817. };
  29818. /**
  29819. * Resets the cache of effects.
  29820. */
  29821. static ResetCache(): void;
  29822. }
  29823. }
  29824. declare module "babylonjs/Engines/engineCapabilities" {
  29825. /**
  29826. * Interface used to describe the capabilities of the engine relatively to the current browser
  29827. */
  29828. export interface EngineCapabilities {
  29829. /** Maximum textures units per fragment shader */
  29830. maxTexturesImageUnits: number;
  29831. /** Maximum texture units per vertex shader */
  29832. maxVertexTextureImageUnits: number;
  29833. /** Maximum textures units in the entire pipeline */
  29834. maxCombinedTexturesImageUnits: number;
  29835. /** Maximum texture size */
  29836. maxTextureSize: number;
  29837. /** Maximum texture samples */
  29838. maxSamples?: number;
  29839. /** Maximum cube texture size */
  29840. maxCubemapTextureSize: number;
  29841. /** Maximum render texture size */
  29842. maxRenderTextureSize: number;
  29843. /** Maximum number of vertex attributes */
  29844. maxVertexAttribs: number;
  29845. /** Maximum number of varyings */
  29846. maxVaryingVectors: number;
  29847. /** Maximum number of uniforms per vertex shader */
  29848. maxVertexUniformVectors: number;
  29849. /** Maximum number of uniforms per fragment shader */
  29850. maxFragmentUniformVectors: number;
  29851. /** Defines if standard derivates (dx/dy) are supported */
  29852. standardDerivatives: boolean;
  29853. /** Defines if s3tc texture compression is supported */
  29854. s3tc?: WEBGL_compressed_texture_s3tc;
  29855. /** Defines if pvrtc texture compression is supported */
  29856. pvrtc: any;
  29857. /** Defines if etc1 texture compression is supported */
  29858. etc1: any;
  29859. /** Defines if etc2 texture compression is supported */
  29860. etc2: any;
  29861. /** Defines if astc texture compression is supported */
  29862. astc: any;
  29863. /** Defines if float textures are supported */
  29864. textureFloat: boolean;
  29865. /** Defines if vertex array objects are supported */
  29866. vertexArrayObject: boolean;
  29867. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  29868. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  29869. /** Gets the maximum level of anisotropy supported */
  29870. maxAnisotropy: number;
  29871. /** Defines if instancing is supported */
  29872. instancedArrays: boolean;
  29873. /** Defines if 32 bits indices are supported */
  29874. uintIndices: boolean;
  29875. /** Defines if high precision shaders are supported */
  29876. highPrecisionShaderSupported: boolean;
  29877. /** Defines if depth reading in the fragment shader is supported */
  29878. fragmentDepthSupported: boolean;
  29879. /** Defines if float texture linear filtering is supported*/
  29880. textureFloatLinearFiltering: boolean;
  29881. /** Defines if rendering to float textures is supported */
  29882. textureFloatRender: boolean;
  29883. /** Defines if half float textures are supported*/
  29884. textureHalfFloat: boolean;
  29885. /** Defines if half float texture linear filtering is supported*/
  29886. textureHalfFloatLinearFiltering: boolean;
  29887. /** Defines if rendering to half float textures is supported */
  29888. textureHalfFloatRender: boolean;
  29889. /** Defines if textureLOD shader command is supported */
  29890. textureLOD: boolean;
  29891. /** Defines if draw buffers extension is supported */
  29892. drawBuffersExtension: boolean;
  29893. /** Defines if depth textures are supported */
  29894. depthTextureExtension: boolean;
  29895. /** Defines if float color buffer are supported */
  29896. colorBufferFloat: boolean;
  29897. /** Gets disjoint timer query extension (null if not supported) */
  29898. timerQuery?: EXT_disjoint_timer_query;
  29899. /** Defines if timestamp can be used with timer query */
  29900. canUseTimestampForTimerQuery: boolean;
  29901. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  29902. multiview?: any;
  29903. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  29904. oculusMultiview?: any;
  29905. /** Function used to let the system compiles shaders in background */
  29906. parallelShaderCompile?: {
  29907. COMPLETION_STATUS_KHR: number;
  29908. };
  29909. /** Max number of texture samples for MSAA */
  29910. maxMSAASamples: number;
  29911. /** Defines if the blend min max extension is supported */
  29912. blendMinMax: boolean;
  29913. }
  29914. }
  29915. declare module "babylonjs/States/depthCullingState" {
  29916. import { Nullable } from "babylonjs/types";
  29917. /**
  29918. * @hidden
  29919. **/
  29920. export class DepthCullingState {
  29921. private _isDepthTestDirty;
  29922. private _isDepthMaskDirty;
  29923. private _isDepthFuncDirty;
  29924. private _isCullFaceDirty;
  29925. private _isCullDirty;
  29926. private _isZOffsetDirty;
  29927. private _isFrontFaceDirty;
  29928. private _depthTest;
  29929. private _depthMask;
  29930. private _depthFunc;
  29931. private _cull;
  29932. private _cullFace;
  29933. private _zOffset;
  29934. private _frontFace;
  29935. /**
  29936. * Initializes the state.
  29937. */
  29938. constructor();
  29939. readonly isDirty: boolean;
  29940. zOffset: number;
  29941. cullFace: Nullable<number>;
  29942. cull: Nullable<boolean>;
  29943. depthFunc: Nullable<number>;
  29944. depthMask: boolean;
  29945. depthTest: boolean;
  29946. frontFace: Nullable<number>;
  29947. reset(): void;
  29948. apply(gl: WebGLRenderingContext): void;
  29949. }
  29950. }
  29951. declare module "babylonjs/States/stencilState" {
  29952. /**
  29953. * @hidden
  29954. **/
  29955. export class StencilState {
  29956. /** 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 */
  29957. static readonly ALWAYS: number;
  29958. /** Passed to stencilOperation to specify that stencil value must be kept */
  29959. static readonly KEEP: number;
  29960. /** Passed to stencilOperation to specify that stencil value must be replaced */
  29961. static readonly REPLACE: number;
  29962. private _isStencilTestDirty;
  29963. private _isStencilMaskDirty;
  29964. private _isStencilFuncDirty;
  29965. private _isStencilOpDirty;
  29966. private _stencilTest;
  29967. private _stencilMask;
  29968. private _stencilFunc;
  29969. private _stencilFuncRef;
  29970. private _stencilFuncMask;
  29971. private _stencilOpStencilFail;
  29972. private _stencilOpDepthFail;
  29973. private _stencilOpStencilDepthPass;
  29974. readonly isDirty: boolean;
  29975. stencilFunc: number;
  29976. stencilFuncRef: number;
  29977. stencilFuncMask: number;
  29978. stencilOpStencilFail: number;
  29979. stencilOpDepthFail: number;
  29980. stencilOpStencilDepthPass: number;
  29981. stencilMask: number;
  29982. stencilTest: boolean;
  29983. constructor();
  29984. reset(): void;
  29985. apply(gl: WebGLRenderingContext): void;
  29986. }
  29987. }
  29988. declare module "babylonjs/States/alphaCullingState" {
  29989. /**
  29990. * @hidden
  29991. **/
  29992. export class AlphaState {
  29993. private _isAlphaBlendDirty;
  29994. private _isBlendFunctionParametersDirty;
  29995. private _isBlendEquationParametersDirty;
  29996. private _isBlendConstantsDirty;
  29997. private _alphaBlend;
  29998. private _blendFunctionParameters;
  29999. private _blendEquationParameters;
  30000. private _blendConstants;
  30001. /**
  30002. * Initializes the state.
  30003. */
  30004. constructor();
  30005. readonly isDirty: boolean;
  30006. alphaBlend: boolean;
  30007. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  30008. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  30009. setAlphaEquationParameters(rgb: number, alpha: number): void;
  30010. reset(): void;
  30011. apply(gl: WebGLRenderingContext): void;
  30012. }
  30013. }
  30014. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  30015. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30016. /** @hidden */
  30017. export class WebGL2ShaderProcessor implements IShaderProcessor {
  30018. attributeProcessor(attribute: string): string;
  30019. varyingProcessor(varying: string, isFragment: boolean): string;
  30020. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  30021. }
  30022. }
  30023. declare module "babylonjs/Engines/instancingAttributeInfo" {
  30024. /**
  30025. * Interface for attribute information associated with buffer instanciation
  30026. */
  30027. export interface InstancingAttributeInfo {
  30028. /**
  30029. * Index/offset of the attribute in the vertex shader
  30030. */
  30031. index: number;
  30032. /**
  30033. * size of the attribute, 1, 2, 3 or 4
  30034. */
  30035. attributeSize: number;
  30036. /**
  30037. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  30038. * default is FLOAT
  30039. */
  30040. attributeType: number;
  30041. /**
  30042. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  30043. */
  30044. normalized: boolean;
  30045. /**
  30046. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  30047. */
  30048. offset: number;
  30049. /**
  30050. * Name of the GLSL attribute, for debugging purpose only
  30051. */
  30052. attributeName: string;
  30053. }
  30054. }
  30055. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  30056. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30057. import { Nullable } from "babylonjs/types";
  30058. module "babylonjs/Engines/thinEngine" {
  30059. interface ThinEngine {
  30060. /**
  30061. * Update a video texture
  30062. * @param texture defines the texture to update
  30063. * @param video defines the video element to use
  30064. * @param invertY defines if data must be stored with Y axis inverted
  30065. */
  30066. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  30067. }
  30068. }
  30069. }
  30070. declare module "babylonjs/Materials/Textures/videoTexture" {
  30071. import { Observable } from "babylonjs/Misc/observable";
  30072. import { Nullable } from "babylonjs/types";
  30073. import { Scene } from "babylonjs/scene";
  30074. import { Texture } from "babylonjs/Materials/Textures/texture";
  30075. import "babylonjs/Engines/Extensions/engine.videoTexture";
  30076. /**
  30077. * Settings for finer control over video usage
  30078. */
  30079. export interface VideoTextureSettings {
  30080. /**
  30081. * Applies `autoplay` to video, if specified
  30082. */
  30083. autoPlay?: boolean;
  30084. /**
  30085. * Applies `loop` to video, if specified
  30086. */
  30087. loop?: boolean;
  30088. /**
  30089. * Automatically updates internal texture from video at every frame in the render loop
  30090. */
  30091. autoUpdateTexture: boolean;
  30092. /**
  30093. * Image src displayed during the video loading or until the user interacts with the video.
  30094. */
  30095. poster?: string;
  30096. }
  30097. /**
  30098. * If you want to display a video in your scene, this is the special texture for that.
  30099. * This special texture works similar to other textures, with the exception of a few parameters.
  30100. * @see https://doc.babylonjs.com/how_to/video_texture
  30101. */
  30102. export class VideoTexture extends Texture {
  30103. /**
  30104. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  30105. */
  30106. readonly autoUpdateTexture: boolean;
  30107. /**
  30108. * The video instance used by the texture internally
  30109. */
  30110. readonly video: HTMLVideoElement;
  30111. private _onUserActionRequestedObservable;
  30112. /**
  30113. * Event triggerd when a dom action is required by the user to play the video.
  30114. * This happens due to recent changes in browser policies preventing video to auto start.
  30115. */
  30116. readonly onUserActionRequestedObservable: Observable<Texture>;
  30117. private _generateMipMaps;
  30118. private _engine;
  30119. private _stillImageCaptured;
  30120. private _displayingPosterTexture;
  30121. private _settings;
  30122. private _createInternalTextureOnEvent;
  30123. private _frameId;
  30124. /**
  30125. * Creates a video texture.
  30126. * If you want to display a video in your scene, this is the special texture for that.
  30127. * This special texture works similar to other textures, with the exception of a few parameters.
  30128. * @see https://doc.babylonjs.com/how_to/video_texture
  30129. * @param name optional name, will detect from video source, if not defined
  30130. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  30131. * @param scene is obviously the current scene.
  30132. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  30133. * @param invertY is false by default but can be used to invert video on Y axis
  30134. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  30135. * @param settings allows finer control over video usage
  30136. */
  30137. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  30138. private _getName;
  30139. private _getVideo;
  30140. private _createInternalTexture;
  30141. private reset;
  30142. /**
  30143. * @hidden Internal method to initiate `update`.
  30144. */
  30145. _rebuild(): void;
  30146. /**
  30147. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  30148. */
  30149. update(): void;
  30150. /**
  30151. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  30152. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  30153. */
  30154. updateTexture(isVisible: boolean): void;
  30155. protected _updateInternalTexture: () => void;
  30156. /**
  30157. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  30158. * @param url New url.
  30159. */
  30160. updateURL(url: string): void;
  30161. /**
  30162. * Dispose the texture and release its associated resources.
  30163. */
  30164. dispose(): void;
  30165. /**
  30166. * Creates a video texture straight from a stream.
  30167. * @param scene Define the scene the texture should be created in
  30168. * @param stream Define the stream the texture should be created from
  30169. * @returns The created video texture as a promise
  30170. */
  30171. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  30172. /**
  30173. * Creates a video texture straight from your WebCam video feed.
  30174. * @param scene Define the scene the texture should be created in
  30175. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30176. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30177. * @returns The created video texture as a promise
  30178. */
  30179. static CreateFromWebCamAsync(scene: Scene, constraints: {
  30180. minWidth: number;
  30181. maxWidth: number;
  30182. minHeight: number;
  30183. maxHeight: number;
  30184. deviceId: string;
  30185. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  30186. /**
  30187. * Creates a video texture straight from your WebCam video feed.
  30188. * @param scene Define the scene the texture should be created in
  30189. * @param onReady Define a callback to triggered once the texture will be ready
  30190. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30191. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30192. */
  30193. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  30194. minWidth: number;
  30195. maxWidth: number;
  30196. minHeight: number;
  30197. maxHeight: number;
  30198. deviceId: string;
  30199. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  30200. }
  30201. }
  30202. declare module "babylonjs/Engines/thinEngine" {
  30203. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  30204. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  30205. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30206. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  30207. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  30208. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  30209. import { Observable } from "babylonjs/Misc/observable";
  30210. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  30211. import { StencilState } from "babylonjs/States/stencilState";
  30212. import { AlphaState } from "babylonjs/States/alphaCullingState";
  30213. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30214. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  30215. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30216. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  30217. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30218. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  30219. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  30220. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  30221. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30222. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  30223. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  30224. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  30225. /**
  30226. * Defines the interface used by objects working like Scene
  30227. * @hidden
  30228. */
  30229. interface ISceneLike {
  30230. _addPendingData(data: any): void;
  30231. _removePendingData(data: any): void;
  30232. offlineProvider: IOfflineProvider;
  30233. }
  30234. /** Interface defining initialization parameters for Engine class */
  30235. export interface EngineOptions extends WebGLContextAttributes {
  30236. /**
  30237. * Defines if the engine should no exceed a specified device ratio
  30238. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  30239. */
  30240. limitDeviceRatio?: number;
  30241. /**
  30242. * Defines if webvr should be enabled automatically
  30243. * @see http://doc.babylonjs.com/how_to/webvr_camera
  30244. */
  30245. autoEnableWebVR?: boolean;
  30246. /**
  30247. * Defines if webgl2 should be turned off even if supported
  30248. * @see http://doc.babylonjs.com/features/webgl2
  30249. */
  30250. disableWebGL2Support?: boolean;
  30251. /**
  30252. * Defines if webaudio should be initialized as well
  30253. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  30254. */
  30255. audioEngine?: boolean;
  30256. /**
  30257. * Defines if animations should run using a deterministic lock step
  30258. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  30259. */
  30260. deterministicLockstep?: boolean;
  30261. /** Defines the maximum steps to use with deterministic lock step mode */
  30262. lockstepMaxSteps?: number;
  30263. /**
  30264. * Defines that engine should ignore context lost events
  30265. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  30266. */
  30267. doNotHandleContextLost?: boolean;
  30268. /**
  30269. * Defines that engine should ignore modifying touch action attribute and style
  30270. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  30271. */
  30272. doNotHandleTouchAction?: boolean;
  30273. /**
  30274. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  30275. */
  30276. useHighPrecisionFloats?: boolean;
  30277. }
  30278. /**
  30279. * The base engine class (root of all engines)
  30280. */
  30281. export class ThinEngine {
  30282. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  30283. static ExceptionList: ({
  30284. key: string;
  30285. capture: string;
  30286. captureConstraint: number;
  30287. targets: string[];
  30288. } | {
  30289. key: string;
  30290. capture: null;
  30291. captureConstraint: null;
  30292. targets: string[];
  30293. })[];
  30294. /** @hidden */
  30295. static _TextureLoaders: IInternalTextureLoader[];
  30296. /**
  30297. * Returns the current npm package of the sdk
  30298. */
  30299. static readonly NpmPackage: string;
  30300. /**
  30301. * Returns the current version of the framework
  30302. */
  30303. static readonly Version: string;
  30304. /**
  30305. * Returns a string describing the current engine
  30306. */
  30307. readonly description: string;
  30308. /**
  30309. * Gets or sets the epsilon value used by collision engine
  30310. */
  30311. static CollisionsEpsilon: number;
  30312. /**
  30313. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30314. */
  30315. static ShadersRepository: string;
  30316. /** @hidden */
  30317. _shaderProcessor: IShaderProcessor;
  30318. /**
  30319. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30320. */
  30321. forcePOTTextures: boolean;
  30322. /**
  30323. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30324. */
  30325. isFullscreen: boolean;
  30326. /**
  30327. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30328. */
  30329. cullBackFaces: boolean;
  30330. /**
  30331. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30332. */
  30333. renderEvenInBackground: boolean;
  30334. /**
  30335. * Gets or sets a boolean indicating that cache can be kept between frames
  30336. */
  30337. preventCacheWipeBetweenFrames: boolean;
  30338. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30339. validateShaderPrograms: boolean;
  30340. /**
  30341. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  30342. * This can provide greater z depth for distant objects.
  30343. */
  30344. useReverseDepthBuffer: boolean;
  30345. /**
  30346. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30347. */
  30348. disableUniformBuffers: boolean;
  30349. /** @hidden */
  30350. _uniformBuffers: UniformBuffer[];
  30351. /**
  30352. * Gets a boolean indicating that the engine supports uniform buffers
  30353. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30354. */
  30355. readonly supportsUniformBuffers: boolean;
  30356. /** @hidden */
  30357. _gl: WebGLRenderingContext;
  30358. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  30359. protected _windowIsBackground: boolean;
  30360. protected _webGLVersion: number;
  30361. protected _creationOptions: EngineOptions;
  30362. protected _highPrecisionShadersAllowed: boolean;
  30363. /** @hidden */
  30364. readonly _shouldUseHighPrecisionShader: boolean;
  30365. /**
  30366. * Gets a boolean indicating that only power of 2 textures are supported
  30367. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  30368. */
  30369. readonly needPOTTextures: boolean;
  30370. /** @hidden */
  30371. _badOS: boolean;
  30372. /** @hidden */
  30373. _badDesktopOS: boolean;
  30374. private _hardwareScalingLevel;
  30375. /** @hidden */
  30376. _caps: EngineCapabilities;
  30377. private _isStencilEnable;
  30378. protected _colorWrite: boolean;
  30379. private _glVersion;
  30380. private _glRenderer;
  30381. private _glVendor;
  30382. /** @hidden */
  30383. _videoTextureSupported: boolean;
  30384. protected _renderingQueueLaunched: boolean;
  30385. protected _activeRenderLoops: (() => void)[];
  30386. /**
  30387. * Observable signaled when a context lost event is raised
  30388. */
  30389. onContextLostObservable: Observable<ThinEngine>;
  30390. /**
  30391. * Observable signaled when a context restored event is raised
  30392. */
  30393. onContextRestoredObservable: Observable<ThinEngine>;
  30394. private _onContextLost;
  30395. private _onContextRestored;
  30396. protected _contextWasLost: boolean;
  30397. /** @hidden */
  30398. _doNotHandleContextLost: boolean;
  30399. /**
  30400. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  30401. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  30402. */
  30403. doNotHandleContextLost: boolean;
  30404. /**
  30405. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  30406. */
  30407. disableVertexArrayObjects: boolean;
  30408. /** @hidden */
  30409. protected _depthCullingState: DepthCullingState;
  30410. /** @hidden */
  30411. protected _stencilState: StencilState;
  30412. /** @hidden */
  30413. protected _alphaState: AlphaState;
  30414. /** @hidden */
  30415. _internalTexturesCache: InternalTexture[];
  30416. /** @hidden */
  30417. protected _activeChannel: number;
  30418. private _currentTextureChannel;
  30419. /** @hidden */
  30420. protected _boundTexturesCache: {
  30421. [key: string]: Nullable<InternalTexture>;
  30422. };
  30423. /** @hidden */
  30424. protected _currentEffect: Nullable<Effect>;
  30425. /** @hidden */
  30426. protected _currentProgram: Nullable<WebGLProgram>;
  30427. private _compiledEffects;
  30428. private _vertexAttribArraysEnabled;
  30429. /** @hidden */
  30430. protected _cachedViewport: Nullable<IViewportLike>;
  30431. private _cachedVertexArrayObject;
  30432. /** @hidden */
  30433. protected _cachedVertexBuffers: any;
  30434. /** @hidden */
  30435. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  30436. /** @hidden */
  30437. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  30438. /** @hidden */
  30439. _currentRenderTarget: Nullable<InternalTexture>;
  30440. private _uintIndicesCurrentlySet;
  30441. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  30442. /** @hidden */
  30443. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  30444. private _currentBufferPointers;
  30445. private _currentInstanceLocations;
  30446. private _currentInstanceBuffers;
  30447. private _textureUnits;
  30448. /** @hidden */
  30449. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  30450. /** @hidden */
  30451. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  30452. /** @hidden */
  30453. _boundRenderFunction: any;
  30454. private _vaoRecordInProgress;
  30455. private _mustWipeVertexAttributes;
  30456. private _emptyTexture;
  30457. private _emptyCubeTexture;
  30458. private _emptyTexture3D;
  30459. private _emptyTexture2DArray;
  30460. /** @hidden */
  30461. _frameHandler: number;
  30462. private _nextFreeTextureSlots;
  30463. private _maxSimultaneousTextures;
  30464. private _activeRequests;
  30465. protected _texturesSupported: string[];
  30466. /** @hidden */
  30467. _textureFormatInUse: Nullable<string>;
  30468. protected readonly _supportsHardwareTextureRescaling: boolean;
  30469. /**
  30470. * Gets the list of texture formats supported
  30471. */
  30472. readonly texturesSupported: Array<string>;
  30473. /**
  30474. * Gets the list of texture formats in use
  30475. */
  30476. readonly textureFormatInUse: Nullable<string>;
  30477. /**
  30478. * Gets the current viewport
  30479. */
  30480. readonly currentViewport: Nullable<IViewportLike>;
  30481. /**
  30482. * Gets the default empty texture
  30483. */
  30484. readonly emptyTexture: InternalTexture;
  30485. /**
  30486. * Gets the default empty 3D texture
  30487. */
  30488. readonly emptyTexture3D: InternalTexture;
  30489. /**
  30490. * Gets the default empty 2D array texture
  30491. */
  30492. readonly emptyTexture2DArray: InternalTexture;
  30493. /**
  30494. * Gets the default empty cube texture
  30495. */
  30496. readonly emptyCubeTexture: InternalTexture;
  30497. /**
  30498. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  30499. */
  30500. readonly premultipliedAlpha: boolean;
  30501. /**
  30502. * Observable event triggered before each texture is initialized
  30503. */
  30504. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30505. /**
  30506. * Creates a new engine
  30507. * @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
  30508. * @param antialias defines enable antialiasing (default: false)
  30509. * @param options defines further options to be sent to the getContext() function
  30510. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  30511. */
  30512. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  30513. private _rebuildInternalTextures;
  30514. private _rebuildEffects;
  30515. /**
  30516. * Gets a boolean indicating if all created effects are ready
  30517. * @returns true if all effects are ready
  30518. */
  30519. areAllEffectsReady(): boolean;
  30520. protected _rebuildBuffers(): void;
  30521. private _initGLContext;
  30522. /**
  30523. * Gets version of the current webGL context
  30524. */
  30525. readonly webGLVersion: number;
  30526. /**
  30527. * Gets a string idenfifying the name of the class
  30528. * @returns "Engine" string
  30529. */
  30530. getClassName(): string;
  30531. /**
  30532. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  30533. */
  30534. readonly isStencilEnable: boolean;
  30535. /** @hidden */
  30536. _prepareWorkingCanvas(): void;
  30537. /**
  30538. * Reset the texture cache to empty state
  30539. */
  30540. resetTextureCache(): void;
  30541. /**
  30542. * Gets an object containing information about the current webGL context
  30543. * @returns an object containing the vender, the renderer and the version of the current webGL context
  30544. */
  30545. getGlInfo(): {
  30546. vendor: string;
  30547. renderer: string;
  30548. version: string;
  30549. };
  30550. /**
  30551. * Defines the hardware scaling level.
  30552. * By default the hardware scaling level is computed from the window device ratio.
  30553. * 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.
  30554. * @param level defines the level to use
  30555. */
  30556. setHardwareScalingLevel(level: number): void;
  30557. /**
  30558. * Gets the current hardware scaling level.
  30559. * By default the hardware scaling level is computed from the window device ratio.
  30560. * 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.
  30561. * @returns a number indicating the current hardware scaling level
  30562. */
  30563. getHardwareScalingLevel(): number;
  30564. /**
  30565. * Gets the list of loaded textures
  30566. * @returns an array containing all loaded textures
  30567. */
  30568. getLoadedTexturesCache(): InternalTexture[];
  30569. /**
  30570. * Gets the object containing all engine capabilities
  30571. * @returns the EngineCapabilities object
  30572. */
  30573. getCaps(): EngineCapabilities;
  30574. /**
  30575. * stop executing a render loop function and remove it from the execution array
  30576. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  30577. */
  30578. stopRenderLoop(renderFunction?: () => void): void;
  30579. /** @hidden */
  30580. _renderLoop(): void;
  30581. /**
  30582. * Gets the HTML canvas attached with the current webGL context
  30583. * @returns a HTML canvas
  30584. */
  30585. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  30586. /**
  30587. * Gets host window
  30588. * @returns the host window object
  30589. */
  30590. getHostWindow(): Nullable<Window>;
  30591. /**
  30592. * Gets the current render width
  30593. * @param useScreen defines if screen size must be used (or the current render target if any)
  30594. * @returns a number defining the current render width
  30595. */
  30596. getRenderWidth(useScreen?: boolean): number;
  30597. /**
  30598. * Gets the current render height
  30599. * @param useScreen defines if screen size must be used (or the current render target if any)
  30600. * @returns a number defining the current render height
  30601. */
  30602. getRenderHeight(useScreen?: boolean): number;
  30603. /**
  30604. * Can be used to override the current requestAnimationFrame requester.
  30605. * @hidden
  30606. */
  30607. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  30608. /**
  30609. * Register and execute a render loop. The engine can have more than one render function
  30610. * @param renderFunction defines the function to continuously execute
  30611. */
  30612. runRenderLoop(renderFunction: () => void): void;
  30613. /**
  30614. * Clear the current render buffer or the current render target (if any is set up)
  30615. * @param color defines the color to use
  30616. * @param backBuffer defines if the back buffer must be cleared
  30617. * @param depth defines if the depth buffer must be cleared
  30618. * @param stencil defines if the stencil buffer must be cleared
  30619. */
  30620. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  30621. private _viewportCached;
  30622. /** @hidden */
  30623. _viewport(x: number, y: number, width: number, height: number): void;
  30624. /**
  30625. * Set the WebGL's viewport
  30626. * @param viewport defines the viewport element to be used
  30627. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  30628. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  30629. */
  30630. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  30631. /**
  30632. * Begin a new frame
  30633. */
  30634. beginFrame(): void;
  30635. /**
  30636. * Enf the current frame
  30637. */
  30638. endFrame(): void;
  30639. /**
  30640. * Resize the view according to the canvas' size
  30641. */
  30642. resize(): void;
  30643. /**
  30644. * Force a specific size of the canvas
  30645. * @param width defines the new canvas' width
  30646. * @param height defines the new canvas' height
  30647. */
  30648. setSize(width: number, height: number): void;
  30649. /**
  30650. * Binds the frame buffer to the specified texture.
  30651. * @param texture The texture to render to or null for the default canvas
  30652. * @param faceIndex The face of the texture to render to in case of cube texture
  30653. * @param requiredWidth The width of the target to render to
  30654. * @param requiredHeight The height of the target to render to
  30655. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  30656. * @param depthStencilTexture The depth stencil texture to use to render
  30657. * @param lodLevel defines le lod level to bind to the frame buffer
  30658. */
  30659. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  30660. /** @hidden */
  30661. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  30662. /**
  30663. * Unbind the current render target texture from the webGL context
  30664. * @param texture defines the render target texture to unbind
  30665. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  30666. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  30667. */
  30668. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  30669. /**
  30670. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  30671. */
  30672. flushFramebuffer(): void;
  30673. /**
  30674. * Unbind the current render target and bind the default framebuffer
  30675. */
  30676. restoreDefaultFramebuffer(): void;
  30677. /** @hidden */
  30678. protected _resetVertexBufferBinding(): void;
  30679. /**
  30680. * Creates a vertex buffer
  30681. * @param data the data for the vertex buffer
  30682. * @returns the new WebGL static buffer
  30683. */
  30684. createVertexBuffer(data: DataArray): DataBuffer;
  30685. private _createVertexBuffer;
  30686. /**
  30687. * Creates a dynamic vertex buffer
  30688. * @param data the data for the dynamic vertex buffer
  30689. * @returns the new WebGL dynamic buffer
  30690. */
  30691. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  30692. protected _resetIndexBufferBinding(): void;
  30693. /**
  30694. * Creates a new index buffer
  30695. * @param indices defines the content of the index buffer
  30696. * @param updatable defines if the index buffer must be updatable
  30697. * @returns a new webGL buffer
  30698. */
  30699. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  30700. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  30701. /**
  30702. * Bind a webGL buffer to the webGL context
  30703. * @param buffer defines the buffer to bind
  30704. */
  30705. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  30706. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  30707. private bindBuffer;
  30708. /**
  30709. * update the bound buffer with the given data
  30710. * @param data defines the data to update
  30711. */
  30712. updateArrayBuffer(data: Float32Array): void;
  30713. private _vertexAttribPointer;
  30714. private _bindIndexBufferWithCache;
  30715. private _bindVertexBuffersAttributes;
  30716. /**
  30717. * Records a vertex array object
  30718. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30719. * @param vertexBuffers defines the list of vertex buffers to store
  30720. * @param indexBuffer defines the index buffer to store
  30721. * @param effect defines the effect to store
  30722. * @returns the new vertex array object
  30723. */
  30724. recordVertexArrayObject(vertexBuffers: {
  30725. [key: string]: VertexBuffer;
  30726. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  30727. /**
  30728. * Bind a specific vertex array object
  30729. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30730. * @param vertexArrayObject defines the vertex array object to bind
  30731. * @param indexBuffer defines the index buffer to bind
  30732. */
  30733. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  30734. /**
  30735. * Bind webGl buffers directly to the webGL context
  30736. * @param vertexBuffer defines the vertex buffer to bind
  30737. * @param indexBuffer defines the index buffer to bind
  30738. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  30739. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  30740. * @param effect defines the effect associated with the vertex buffer
  30741. */
  30742. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  30743. private _unbindVertexArrayObject;
  30744. /**
  30745. * Bind a list of vertex buffers to the webGL context
  30746. * @param vertexBuffers defines the list of vertex buffers to bind
  30747. * @param indexBuffer defines the index buffer to bind
  30748. * @param effect defines the effect associated with the vertex buffers
  30749. */
  30750. bindBuffers(vertexBuffers: {
  30751. [key: string]: Nullable<VertexBuffer>;
  30752. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  30753. /**
  30754. * Unbind all instance attributes
  30755. */
  30756. unbindInstanceAttributes(): void;
  30757. /**
  30758. * Release and free the memory of a vertex array object
  30759. * @param vao defines the vertex array object to delete
  30760. */
  30761. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  30762. /** @hidden */
  30763. _releaseBuffer(buffer: DataBuffer): boolean;
  30764. protected _deleteBuffer(buffer: DataBuffer): void;
  30765. /**
  30766. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  30767. * @param instancesBuffer defines the webGL buffer to update and bind
  30768. * @param data defines the data to store in the buffer
  30769. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  30770. */
  30771. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  30772. /**
  30773. * Apply all cached states (depth, culling, stencil and alpha)
  30774. */
  30775. applyStates(): void;
  30776. /**
  30777. * Send a draw order
  30778. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30779. * @param indexStart defines the starting index
  30780. * @param indexCount defines the number of index to draw
  30781. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30782. */
  30783. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  30784. /**
  30785. * Draw a list of points
  30786. * @param verticesStart defines the index of first vertex to draw
  30787. * @param verticesCount defines the count of vertices to draw
  30788. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30789. */
  30790. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30791. /**
  30792. * Draw a list of unindexed primitives
  30793. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30794. * @param verticesStart defines the index of first vertex to draw
  30795. * @param verticesCount defines the count of vertices to draw
  30796. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30797. */
  30798. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30799. /**
  30800. * Draw a list of indexed primitives
  30801. * @param fillMode defines the primitive to use
  30802. * @param indexStart defines the starting index
  30803. * @param indexCount defines the number of index to draw
  30804. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30805. */
  30806. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  30807. /**
  30808. * Draw a list of unindexed primitives
  30809. * @param fillMode defines the primitive to use
  30810. * @param verticesStart defines the index of first vertex to draw
  30811. * @param verticesCount defines the count of vertices to draw
  30812. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30813. */
  30814. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30815. private _drawMode;
  30816. /** @hidden */
  30817. protected _reportDrawCall(): void;
  30818. /** @hidden */
  30819. _releaseEffect(effect: Effect): void;
  30820. /** @hidden */
  30821. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  30822. /**
  30823. * Create a new effect (used to store vertex/fragment shaders)
  30824. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  30825. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  30826. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  30827. * @param samplers defines an array of string used to represent textures
  30828. * @param defines defines the string containing the defines to use to compile the shaders
  30829. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  30830. * @param onCompiled defines a function to call when the effect creation is successful
  30831. * @param onError defines a function to call when the effect creation has failed
  30832. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  30833. * @returns the new Effect
  30834. */
  30835. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  30836. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  30837. private _compileShader;
  30838. private _compileRawShader;
  30839. /**
  30840. * Directly creates a webGL program
  30841. * @param pipelineContext defines the pipeline context to attach to
  30842. * @param vertexCode defines the vertex shader code to use
  30843. * @param fragmentCode defines the fragment shader code to use
  30844. * @param context defines the webGL context to use (if not set, the current one will be used)
  30845. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30846. * @returns the new webGL program
  30847. */
  30848. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30849. /**
  30850. * Creates a webGL program
  30851. * @param pipelineContext defines the pipeline context to attach to
  30852. * @param vertexCode defines the vertex shader code to use
  30853. * @param fragmentCode defines the fragment shader code to use
  30854. * @param defines defines the string containing the defines to use to compile the shaders
  30855. * @param context defines the webGL context to use (if not set, the current one will be used)
  30856. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30857. * @returns the new webGL program
  30858. */
  30859. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30860. /**
  30861. * Creates a new pipeline context
  30862. * @returns the new pipeline
  30863. */
  30864. createPipelineContext(): IPipelineContext;
  30865. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30866. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  30867. /** @hidden */
  30868. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  30869. /** @hidden */
  30870. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  30871. /** @hidden */
  30872. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  30873. /**
  30874. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  30875. * @param pipelineContext defines the pipeline context to use
  30876. * @param uniformsNames defines the list of uniform names
  30877. * @returns an array of webGL uniform locations
  30878. */
  30879. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  30880. /**
  30881. * Gets the lsit of active attributes for a given webGL program
  30882. * @param pipelineContext defines the pipeline context to use
  30883. * @param attributesNames defines the list of attribute names to get
  30884. * @returns an array of indices indicating the offset of each attribute
  30885. */
  30886. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  30887. /**
  30888. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  30889. * @param effect defines the effect to activate
  30890. */
  30891. enableEffect(effect: Nullable<Effect>): void;
  30892. /**
  30893. * Set the value of an uniform to a number (int)
  30894. * @param uniform defines the webGL uniform location where to store the value
  30895. * @param value defines the int number to store
  30896. */
  30897. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30898. /**
  30899. * Set the value of an uniform to an array of int32
  30900. * @param uniform defines the webGL uniform location where to store the value
  30901. * @param array defines the array of int32 to store
  30902. */
  30903. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30904. /**
  30905. * Set the value of an uniform to an array of int32 (stored as vec2)
  30906. * @param uniform defines the webGL uniform location where to store the value
  30907. * @param array defines the array of int32 to store
  30908. */
  30909. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30910. /**
  30911. * Set the value of an uniform to an array of int32 (stored as vec3)
  30912. * @param uniform defines the webGL uniform location where to store the value
  30913. * @param array defines the array of int32 to store
  30914. */
  30915. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30916. /**
  30917. * Set the value of an uniform to an array of int32 (stored as vec4)
  30918. * @param uniform defines the webGL uniform location where to store the value
  30919. * @param array defines the array of int32 to store
  30920. */
  30921. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30922. /**
  30923. * Set the value of an uniform to an array of number
  30924. * @param uniform defines the webGL uniform location where to store the value
  30925. * @param array defines the array of number to store
  30926. */
  30927. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30928. /**
  30929. * Set the value of an uniform to an array of number (stored as vec2)
  30930. * @param uniform defines the webGL uniform location where to store the value
  30931. * @param array defines the array of number to store
  30932. */
  30933. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30934. /**
  30935. * Set the value of an uniform to an array of number (stored as vec3)
  30936. * @param uniform defines the webGL uniform location where to store the value
  30937. * @param array defines the array of number to store
  30938. */
  30939. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30940. /**
  30941. * Set the value of an uniform to an array of number (stored as vec4)
  30942. * @param uniform defines the webGL uniform location where to store the value
  30943. * @param array defines the array of number to store
  30944. */
  30945. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30946. /**
  30947. * Set the value of an uniform to an array of float32 (stored as matrices)
  30948. * @param uniform defines the webGL uniform location where to store the value
  30949. * @param matrices defines the array of float32 to store
  30950. */
  30951. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  30952. /**
  30953. * Set the value of an uniform to a matrix (3x3)
  30954. * @param uniform defines the webGL uniform location where to store the value
  30955. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  30956. */
  30957. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30958. /**
  30959. * Set the value of an uniform to a matrix (2x2)
  30960. * @param uniform defines the webGL uniform location where to store the value
  30961. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  30962. */
  30963. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30964. /**
  30965. * Set the value of an uniform to a number (float)
  30966. * @param uniform defines the webGL uniform location where to store the value
  30967. * @param value defines the float number to store
  30968. */
  30969. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30970. /**
  30971. * Set the value of an uniform to a vec2
  30972. * @param uniform defines the webGL uniform location where to store the value
  30973. * @param x defines the 1st component of the value
  30974. * @param y defines the 2nd component of the value
  30975. */
  30976. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  30977. /**
  30978. * Set the value of an uniform to a vec3
  30979. * @param uniform defines the webGL uniform location where to store the value
  30980. * @param x defines the 1st component of the value
  30981. * @param y defines the 2nd component of the value
  30982. * @param z defines the 3rd component of the value
  30983. */
  30984. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  30985. /**
  30986. * Set the value of an uniform to a vec4
  30987. * @param uniform defines the webGL uniform location where to store the value
  30988. * @param x defines the 1st component of the value
  30989. * @param y defines the 2nd component of the value
  30990. * @param z defines the 3rd component of the value
  30991. * @param w defines the 4th component of the value
  30992. */
  30993. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  30994. /**
  30995. * Gets the depth culling state manager
  30996. */
  30997. readonly depthCullingState: DepthCullingState;
  30998. /**
  30999. * Gets the alpha state manager
  31000. */
  31001. readonly alphaState: AlphaState;
  31002. /**
  31003. * Gets the stencil state manager
  31004. */
  31005. readonly stencilState: StencilState;
  31006. /**
  31007. * Clears the list of texture accessible through engine.
  31008. * This can help preventing texture load conflict due to name collision.
  31009. */
  31010. clearInternalTexturesCache(): void;
  31011. /**
  31012. * Force the entire cache to be cleared
  31013. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  31014. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  31015. */
  31016. wipeCaches(bruteForce?: boolean): void;
  31017. /** @hidden */
  31018. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  31019. min: number;
  31020. mag: number;
  31021. };
  31022. /** @hidden */
  31023. _createTexture(): WebGLTexture;
  31024. /**
  31025. * Usually called from Texture.ts.
  31026. * Passed information to create a WebGLTexture
  31027. * @param urlArg defines a value which contains one of the following:
  31028. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  31029. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  31030. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  31031. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  31032. * @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)
  31033. * @param scene needed for loading to the correct scene
  31034. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  31035. * @param onLoad optional callback to be called upon successful completion
  31036. * @param onError optional callback to be called upon failure
  31037. * @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
  31038. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  31039. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  31040. * @param forcedExtension defines the extension to use to pick the right loader
  31041. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  31042. * @param mimeType defines an optional mime type
  31043. * @returns a InternalTexture for assignment back into BABYLON.Texture
  31044. */
  31045. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  31046. /**
  31047. * @hidden
  31048. */
  31049. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  31050. /**
  31051. * Creates a raw texture
  31052. * @param data defines the data to store in the texture
  31053. * @param width defines the width of the texture
  31054. * @param height defines the height of the texture
  31055. * @param format defines the format of the data
  31056. * @param generateMipMaps defines if the engine should generate the mip levels
  31057. * @param invertY defines if data must be stored with Y axis inverted
  31058. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  31059. * @param compression defines the compression used (null by default)
  31060. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  31061. * @returns the raw texture inside an InternalTexture
  31062. */
  31063. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  31064. /**
  31065. * Creates a new raw cube texture
  31066. * @param data defines the array of data to use to create each face
  31067. * @param size defines the size of the textures
  31068. * @param format defines the format of the data
  31069. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  31070. * @param generateMipMaps defines if the engine should generate the mip levels
  31071. * @param invertY defines if data must be stored with Y axis inverted
  31072. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  31073. * @param compression defines the compression used (null by default)
  31074. * @returns the cube texture as an InternalTexture
  31075. */
  31076. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  31077. /**
  31078. * Creates a new raw 3D texture
  31079. * @param data defines the data used to create the texture
  31080. * @param width defines the width of the texture
  31081. * @param height defines the height of the texture
  31082. * @param depth defines the depth of the texture
  31083. * @param format defines the format of the texture
  31084. * @param generateMipMaps defines if the engine must generate mip levels
  31085. * @param invertY defines if data must be stored with Y axis inverted
  31086. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  31087. * @param compression defines the compressed used (can be null)
  31088. * @param textureType defines the compressed used (can be null)
  31089. * @returns a new raw 3D texture (stored in an InternalTexture)
  31090. */
  31091. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  31092. /**
  31093. * Creates a new raw 2D array texture
  31094. * @param data defines the data used to create the texture
  31095. * @param width defines the width of the texture
  31096. * @param height defines the height of the texture
  31097. * @param depth defines the number of layers of the texture
  31098. * @param format defines the format of the texture
  31099. * @param generateMipMaps defines if the engine must generate mip levels
  31100. * @param invertY defines if data must be stored with Y axis inverted
  31101. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  31102. * @param compression defines the compressed used (can be null)
  31103. * @param textureType defines the compressed used (can be null)
  31104. * @returns a new raw 2D array texture (stored in an InternalTexture)
  31105. */
  31106. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  31107. private _unpackFlipYCached;
  31108. /**
  31109. * In case you are sharing the context with other applications, it might
  31110. * be interested to not cache the unpack flip y state to ensure a consistent
  31111. * value would be set.
  31112. */
  31113. enableUnpackFlipYCached: boolean;
  31114. /** @hidden */
  31115. _unpackFlipY(value: boolean): void;
  31116. /** @hidden */
  31117. _getUnpackAlignement(): number;
  31118. /**
  31119. * Update the sampling mode of a given texture
  31120. * @param samplingMode defines the required sampling mode
  31121. * @param texture defines the texture to update
  31122. */
  31123. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  31124. /** @hidden */
  31125. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  31126. width: number;
  31127. height: number;
  31128. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  31129. /** @hidden */
  31130. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  31131. /** @hidden */
  31132. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  31133. /** @hidden */
  31134. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  31135. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  31136. private _prepareWebGLTexture;
  31137. /** @hidden */
  31138. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  31139. /** @hidden */
  31140. _releaseFramebufferObjects(texture: InternalTexture): void;
  31141. /** @hidden */
  31142. _releaseTexture(texture: InternalTexture): void;
  31143. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  31144. protected _setProgram(program: WebGLProgram): void;
  31145. protected _boundUniforms: {
  31146. [key: number]: WebGLUniformLocation;
  31147. };
  31148. /**
  31149. * Binds an effect to the webGL context
  31150. * @param effect defines the effect to bind
  31151. */
  31152. bindSamplers(effect: Effect): void;
  31153. private _activateCurrentTexture;
  31154. /** @hidden */
  31155. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  31156. /** @hidden */
  31157. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  31158. /**
  31159. * Unbind all textures from the webGL context
  31160. */
  31161. unbindAllTextures(): void;
  31162. /**
  31163. * Sets a texture to the according uniform.
  31164. * @param channel The texture channel
  31165. * @param uniform The uniform to set
  31166. * @param texture The texture to apply
  31167. */
  31168. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  31169. private _bindSamplerUniformToChannel;
  31170. private _getTextureWrapMode;
  31171. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  31172. /**
  31173. * Sets an array of texture to the webGL context
  31174. * @param channel defines the channel where the texture array must be set
  31175. * @param uniform defines the associated uniform location
  31176. * @param textures defines the array of textures to bind
  31177. */
  31178. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  31179. /** @hidden */
  31180. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  31181. private _setTextureParameterFloat;
  31182. private _setTextureParameterInteger;
  31183. /**
  31184. * Unbind all vertex attributes from the webGL context
  31185. */
  31186. unbindAllAttributes(): void;
  31187. /**
  31188. * 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
  31189. */
  31190. releaseEffects(): void;
  31191. /**
  31192. * Dispose and release all associated resources
  31193. */
  31194. dispose(): void;
  31195. /**
  31196. * Attach a new callback raised when context lost event is fired
  31197. * @param callback defines the callback to call
  31198. */
  31199. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  31200. /**
  31201. * Attach a new callback raised when context restored event is fired
  31202. * @param callback defines the callback to call
  31203. */
  31204. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  31205. /**
  31206. * Get the current error code of the webGL context
  31207. * @returns the error code
  31208. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  31209. */
  31210. getError(): number;
  31211. private _canRenderToFloatFramebuffer;
  31212. private _canRenderToHalfFloatFramebuffer;
  31213. private _canRenderToFramebuffer;
  31214. /** @hidden */
  31215. _getWebGLTextureType(type: number): number;
  31216. /** @hidden */
  31217. _getInternalFormat(format: number): number;
  31218. /** @hidden */
  31219. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  31220. /** @hidden */
  31221. _getRGBAMultiSampleBufferFormat(type: number): number;
  31222. /** @hidden */
  31223. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  31224. /**
  31225. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  31226. * @returns true if the engine can be created
  31227. * @ignorenaming
  31228. */
  31229. static isSupported(): boolean;
  31230. /**
  31231. * Find the next highest power of two.
  31232. * @param x Number to start search from.
  31233. * @return Next highest power of two.
  31234. */
  31235. static CeilingPOT(x: number): number;
  31236. /**
  31237. * Find the next lowest power of two.
  31238. * @param x Number to start search from.
  31239. * @return Next lowest power of two.
  31240. */
  31241. static FloorPOT(x: number): number;
  31242. /**
  31243. * Find the nearest power of two.
  31244. * @param x Number to start search from.
  31245. * @return Next nearest power of two.
  31246. */
  31247. static NearestPOT(x: number): number;
  31248. /**
  31249. * Get the closest exponent of two
  31250. * @param value defines the value to approximate
  31251. * @param max defines the maximum value to return
  31252. * @param mode defines how to define the closest value
  31253. * @returns closest exponent of two of the given value
  31254. */
  31255. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  31256. /**
  31257. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  31258. * @param func - the function to be called
  31259. * @param requester - the object that will request the next frame. Falls back to window.
  31260. * @returns frame number
  31261. */
  31262. static QueueNewFrame(func: () => void, requester?: any): number;
  31263. }
  31264. }
  31265. declare module "babylonjs/Maths/sphericalPolynomial" {
  31266. import { Vector3 } from "babylonjs/Maths/math.vector";
  31267. import { Color3 } from "babylonjs/Maths/math.color";
  31268. /**
  31269. * Class representing spherical harmonics coefficients to the 3rd degree
  31270. */
  31271. export class SphericalHarmonics {
  31272. /**
  31273. * Defines whether or not the harmonics have been prescaled for rendering.
  31274. */
  31275. preScaled: boolean;
  31276. /**
  31277. * The l0,0 coefficients of the spherical harmonics
  31278. */
  31279. l00: Vector3;
  31280. /**
  31281. * The l1,-1 coefficients of the spherical harmonics
  31282. */
  31283. l1_1: Vector3;
  31284. /**
  31285. * The l1,0 coefficients of the spherical harmonics
  31286. */
  31287. l10: Vector3;
  31288. /**
  31289. * The l1,1 coefficients of the spherical harmonics
  31290. */
  31291. l11: Vector3;
  31292. /**
  31293. * The l2,-2 coefficients of the spherical harmonics
  31294. */
  31295. l2_2: Vector3;
  31296. /**
  31297. * The l2,-1 coefficients of the spherical harmonics
  31298. */
  31299. l2_1: Vector3;
  31300. /**
  31301. * The l2,0 coefficients of the spherical harmonics
  31302. */
  31303. l20: Vector3;
  31304. /**
  31305. * The l2,1 coefficients of the spherical harmonics
  31306. */
  31307. l21: Vector3;
  31308. /**
  31309. * The l2,2 coefficients of the spherical harmonics
  31310. */
  31311. l22: Vector3;
  31312. /**
  31313. * Adds a light to the spherical harmonics
  31314. * @param direction the direction of the light
  31315. * @param color the color of the light
  31316. * @param deltaSolidAngle the delta solid angle of the light
  31317. */
  31318. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  31319. /**
  31320. * Scales the spherical harmonics by the given amount
  31321. * @param scale the amount to scale
  31322. */
  31323. scaleInPlace(scale: number): void;
  31324. /**
  31325. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  31326. *
  31327. * ```
  31328. * E_lm = A_l * L_lm
  31329. * ```
  31330. *
  31331. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  31332. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  31333. * the scaling factors are given in equation 9.
  31334. */
  31335. convertIncidentRadianceToIrradiance(): void;
  31336. /**
  31337. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  31338. *
  31339. * ```
  31340. * L = (1/pi) * E * rho
  31341. * ```
  31342. *
  31343. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  31344. */
  31345. convertIrradianceToLambertianRadiance(): void;
  31346. /**
  31347. * Integrates the reconstruction coefficients directly in to the SH preventing further
  31348. * required operations at run time.
  31349. *
  31350. * This is simply done by scaling back the SH with Ylm constants parameter.
  31351. * The trigonometric part being applied by the shader at run time.
  31352. */
  31353. preScaleForRendering(): void;
  31354. /**
  31355. * Constructs a spherical harmonics from an array.
  31356. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  31357. * @returns the spherical harmonics
  31358. */
  31359. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  31360. /**
  31361. * Gets the spherical harmonics from polynomial
  31362. * @param polynomial the spherical polynomial
  31363. * @returns the spherical harmonics
  31364. */
  31365. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  31366. }
  31367. /**
  31368. * Class representing spherical polynomial coefficients to the 3rd degree
  31369. */
  31370. export class SphericalPolynomial {
  31371. private _harmonics;
  31372. /**
  31373. * The spherical harmonics used to create the polynomials.
  31374. */
  31375. readonly preScaledHarmonics: SphericalHarmonics;
  31376. /**
  31377. * The x coefficients of the spherical polynomial
  31378. */
  31379. x: Vector3;
  31380. /**
  31381. * The y coefficients of the spherical polynomial
  31382. */
  31383. y: Vector3;
  31384. /**
  31385. * The z coefficients of the spherical polynomial
  31386. */
  31387. z: Vector3;
  31388. /**
  31389. * The xx coefficients of the spherical polynomial
  31390. */
  31391. xx: Vector3;
  31392. /**
  31393. * The yy coefficients of the spherical polynomial
  31394. */
  31395. yy: Vector3;
  31396. /**
  31397. * The zz coefficients of the spherical polynomial
  31398. */
  31399. zz: Vector3;
  31400. /**
  31401. * The xy coefficients of the spherical polynomial
  31402. */
  31403. xy: Vector3;
  31404. /**
  31405. * The yz coefficients of the spherical polynomial
  31406. */
  31407. yz: Vector3;
  31408. /**
  31409. * The zx coefficients of the spherical polynomial
  31410. */
  31411. zx: Vector3;
  31412. /**
  31413. * Adds an ambient color to the spherical polynomial
  31414. * @param color the color to add
  31415. */
  31416. addAmbient(color: Color3): void;
  31417. /**
  31418. * Scales the spherical polynomial by the given amount
  31419. * @param scale the amount to scale
  31420. */
  31421. scaleInPlace(scale: number): void;
  31422. /**
  31423. * Gets the spherical polynomial from harmonics
  31424. * @param harmonics the spherical harmonics
  31425. * @returns the spherical polynomial
  31426. */
  31427. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  31428. /**
  31429. * Constructs a spherical polynomial from an array.
  31430. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  31431. * @returns the spherical polynomial
  31432. */
  31433. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  31434. }
  31435. }
  31436. declare module "babylonjs/Materials/Textures/internalTexture" {
  31437. import { Observable } from "babylonjs/Misc/observable";
  31438. import { Nullable, int } from "babylonjs/types";
  31439. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  31440. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31441. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  31442. /**
  31443. * Defines the source of the internal texture
  31444. */
  31445. export enum InternalTextureSource {
  31446. /**
  31447. * The source of the texture data is unknown
  31448. */
  31449. Unknown = 0,
  31450. /**
  31451. * Texture data comes from an URL
  31452. */
  31453. Url = 1,
  31454. /**
  31455. * Texture data is only used for temporary storage
  31456. */
  31457. Temp = 2,
  31458. /**
  31459. * Texture data comes from raw data (ArrayBuffer)
  31460. */
  31461. Raw = 3,
  31462. /**
  31463. * Texture content is dynamic (video or dynamic texture)
  31464. */
  31465. Dynamic = 4,
  31466. /**
  31467. * Texture content is generated by rendering to it
  31468. */
  31469. RenderTarget = 5,
  31470. /**
  31471. * Texture content is part of a multi render target process
  31472. */
  31473. MultiRenderTarget = 6,
  31474. /**
  31475. * Texture data comes from a cube data file
  31476. */
  31477. Cube = 7,
  31478. /**
  31479. * Texture data comes from a raw cube data
  31480. */
  31481. CubeRaw = 8,
  31482. /**
  31483. * Texture data come from a prefiltered cube data file
  31484. */
  31485. CubePrefiltered = 9,
  31486. /**
  31487. * Texture content is raw 3D data
  31488. */
  31489. Raw3D = 10,
  31490. /**
  31491. * Texture content is raw 2D array data
  31492. */
  31493. Raw2DArray = 11,
  31494. /**
  31495. * Texture content is a depth texture
  31496. */
  31497. Depth = 12,
  31498. /**
  31499. * Texture data comes from a raw cube data encoded with RGBD
  31500. */
  31501. CubeRawRGBD = 13
  31502. }
  31503. /**
  31504. * Class used to store data associated with WebGL texture data for the engine
  31505. * This class should not be used directly
  31506. */
  31507. export class InternalTexture {
  31508. /** @hidden */
  31509. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<import("babylonjs/Maths/sphericalPolynomial").SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  31510. /**
  31511. * Defines if the texture is ready
  31512. */
  31513. isReady: boolean;
  31514. /**
  31515. * Defines if the texture is a cube texture
  31516. */
  31517. isCube: boolean;
  31518. /**
  31519. * Defines if the texture contains 3D data
  31520. */
  31521. is3D: boolean;
  31522. /**
  31523. * Defines if the texture contains 2D array data
  31524. */
  31525. is2DArray: boolean;
  31526. /**
  31527. * Defines if the texture contains multiview data
  31528. */
  31529. isMultiview: boolean;
  31530. /**
  31531. * Gets the URL used to load this texture
  31532. */
  31533. url: string;
  31534. /**
  31535. * Gets the sampling mode of the texture
  31536. */
  31537. samplingMode: number;
  31538. /**
  31539. * Gets a boolean indicating if the texture needs mipmaps generation
  31540. */
  31541. generateMipMaps: boolean;
  31542. /**
  31543. * Gets the number of samples used by the texture (WebGL2+ only)
  31544. */
  31545. samples: number;
  31546. /**
  31547. * Gets the type of the texture (int, float...)
  31548. */
  31549. type: number;
  31550. /**
  31551. * Gets the format of the texture (RGB, RGBA...)
  31552. */
  31553. format: number;
  31554. /**
  31555. * Observable called when the texture is loaded
  31556. */
  31557. onLoadedObservable: Observable<InternalTexture>;
  31558. /**
  31559. * Gets the width of the texture
  31560. */
  31561. width: number;
  31562. /**
  31563. * Gets the height of the texture
  31564. */
  31565. height: number;
  31566. /**
  31567. * Gets the depth of the texture
  31568. */
  31569. depth: number;
  31570. /**
  31571. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  31572. */
  31573. baseWidth: number;
  31574. /**
  31575. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  31576. */
  31577. baseHeight: number;
  31578. /**
  31579. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  31580. */
  31581. baseDepth: number;
  31582. /**
  31583. * Gets a boolean indicating if the texture is inverted on Y axis
  31584. */
  31585. invertY: boolean;
  31586. /** @hidden */
  31587. _invertVScale: boolean;
  31588. /** @hidden */
  31589. _associatedChannel: number;
  31590. /** @hidden */
  31591. _source: InternalTextureSource;
  31592. /** @hidden */
  31593. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  31594. /** @hidden */
  31595. _bufferView: Nullable<ArrayBufferView>;
  31596. /** @hidden */
  31597. _bufferViewArray: Nullable<ArrayBufferView[]>;
  31598. /** @hidden */
  31599. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  31600. /** @hidden */
  31601. _size: number;
  31602. /** @hidden */
  31603. _extension: string;
  31604. /** @hidden */
  31605. _files: Nullable<string[]>;
  31606. /** @hidden */
  31607. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  31608. /** @hidden */
  31609. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  31610. /** @hidden */
  31611. _framebuffer: Nullable<WebGLFramebuffer>;
  31612. /** @hidden */
  31613. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  31614. /** @hidden */
  31615. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  31616. /** @hidden */
  31617. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  31618. /** @hidden */
  31619. _attachments: Nullable<number[]>;
  31620. /** @hidden */
  31621. _cachedCoordinatesMode: Nullable<number>;
  31622. /** @hidden */
  31623. _cachedWrapU: Nullable<number>;
  31624. /** @hidden */
  31625. _cachedWrapV: Nullable<number>;
  31626. /** @hidden */
  31627. _cachedWrapR: Nullable<number>;
  31628. /** @hidden */
  31629. _cachedAnisotropicFilteringLevel: Nullable<number>;
  31630. /** @hidden */
  31631. _isDisabled: boolean;
  31632. /** @hidden */
  31633. _compression: Nullable<string>;
  31634. /** @hidden */
  31635. _generateStencilBuffer: boolean;
  31636. /** @hidden */
  31637. _generateDepthBuffer: boolean;
  31638. /** @hidden */
  31639. _comparisonFunction: number;
  31640. /** @hidden */
  31641. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  31642. /** @hidden */
  31643. _lodGenerationScale: number;
  31644. /** @hidden */
  31645. _lodGenerationOffset: number;
  31646. /** @hidden */
  31647. _colorTextureArray: Nullable<WebGLTexture>;
  31648. /** @hidden */
  31649. _depthStencilTextureArray: Nullable<WebGLTexture>;
  31650. /** @hidden */
  31651. _lodTextureHigh: Nullable<BaseTexture>;
  31652. /** @hidden */
  31653. _lodTextureMid: Nullable<BaseTexture>;
  31654. /** @hidden */
  31655. _lodTextureLow: Nullable<BaseTexture>;
  31656. /** @hidden */
  31657. _isRGBD: boolean;
  31658. /** @hidden */
  31659. _linearSpecularLOD: boolean;
  31660. /** @hidden */
  31661. _irradianceTexture: Nullable<BaseTexture>;
  31662. /** @hidden */
  31663. _webGLTexture: Nullable<WebGLTexture>;
  31664. /** @hidden */
  31665. _references: number;
  31666. private _engine;
  31667. /**
  31668. * Gets the Engine the texture belongs to.
  31669. * @returns The babylon engine
  31670. */
  31671. getEngine(): ThinEngine;
  31672. /**
  31673. * Gets the data source type of the texture
  31674. */
  31675. readonly source: InternalTextureSource;
  31676. /**
  31677. * Creates a new InternalTexture
  31678. * @param engine defines the engine to use
  31679. * @param source defines the type of data that will be used
  31680. * @param delayAllocation if the texture allocation should be delayed (default: false)
  31681. */
  31682. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  31683. /**
  31684. * Increments the number of references (ie. the number of Texture that point to it)
  31685. */
  31686. incrementReferences(): void;
  31687. /**
  31688. * Change the size of the texture (not the size of the content)
  31689. * @param width defines the new width
  31690. * @param height defines the new height
  31691. * @param depth defines the new depth (1 by default)
  31692. */
  31693. updateSize(width: int, height: int, depth?: int): void;
  31694. /** @hidden */
  31695. _rebuild(): void;
  31696. /** @hidden */
  31697. _swapAndDie(target: InternalTexture): void;
  31698. /**
  31699. * Dispose the current allocated resources
  31700. */
  31701. dispose(): void;
  31702. }
  31703. }
  31704. declare module "babylonjs/Audio/analyser" {
  31705. import { Scene } from "babylonjs/scene";
  31706. /**
  31707. * Class used to work with sound analyzer using fast fourier transform (FFT)
  31708. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31709. */
  31710. export class Analyser {
  31711. /**
  31712. * Gets or sets the smoothing
  31713. * @ignorenaming
  31714. */
  31715. SMOOTHING: number;
  31716. /**
  31717. * Gets or sets the FFT table size
  31718. * @ignorenaming
  31719. */
  31720. FFT_SIZE: number;
  31721. /**
  31722. * Gets or sets the bar graph amplitude
  31723. * @ignorenaming
  31724. */
  31725. BARGRAPHAMPLITUDE: number;
  31726. /**
  31727. * Gets or sets the position of the debug canvas
  31728. * @ignorenaming
  31729. */
  31730. DEBUGCANVASPOS: {
  31731. x: number;
  31732. y: number;
  31733. };
  31734. /**
  31735. * Gets or sets the debug canvas size
  31736. * @ignorenaming
  31737. */
  31738. DEBUGCANVASSIZE: {
  31739. width: number;
  31740. height: number;
  31741. };
  31742. private _byteFreqs;
  31743. private _byteTime;
  31744. private _floatFreqs;
  31745. private _webAudioAnalyser;
  31746. private _debugCanvas;
  31747. private _debugCanvasContext;
  31748. private _scene;
  31749. private _registerFunc;
  31750. private _audioEngine;
  31751. /**
  31752. * Creates a new analyser
  31753. * @param scene defines hosting scene
  31754. */
  31755. constructor(scene: Scene);
  31756. /**
  31757. * Get the number of data values you will have to play with for the visualization
  31758. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  31759. * @returns a number
  31760. */
  31761. getFrequencyBinCount(): number;
  31762. /**
  31763. * Gets the current frequency data as a byte array
  31764. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31765. * @returns a Uint8Array
  31766. */
  31767. getByteFrequencyData(): Uint8Array;
  31768. /**
  31769. * Gets the current waveform as a byte array
  31770. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  31771. * @returns a Uint8Array
  31772. */
  31773. getByteTimeDomainData(): Uint8Array;
  31774. /**
  31775. * Gets the current frequency data as a float array
  31776. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31777. * @returns a Float32Array
  31778. */
  31779. getFloatFrequencyData(): Float32Array;
  31780. /**
  31781. * Renders the debug canvas
  31782. */
  31783. drawDebugCanvas(): void;
  31784. /**
  31785. * Stops rendering the debug canvas and removes it
  31786. */
  31787. stopDebugCanvas(): void;
  31788. /**
  31789. * Connects two audio nodes
  31790. * @param inputAudioNode defines first node to connect
  31791. * @param outputAudioNode defines second node to connect
  31792. */
  31793. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  31794. /**
  31795. * Releases all associated resources
  31796. */
  31797. dispose(): void;
  31798. }
  31799. }
  31800. declare module "babylonjs/Audio/audioEngine" {
  31801. import { IDisposable } from "babylonjs/scene";
  31802. import { Analyser } from "babylonjs/Audio/analyser";
  31803. import { Nullable } from "babylonjs/types";
  31804. import { Observable } from "babylonjs/Misc/observable";
  31805. /**
  31806. * This represents an audio engine and it is responsible
  31807. * to play, synchronize and analyse sounds throughout the application.
  31808. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31809. */
  31810. export interface IAudioEngine extends IDisposable {
  31811. /**
  31812. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31813. */
  31814. readonly canUseWebAudio: boolean;
  31815. /**
  31816. * Gets the current AudioContext if available.
  31817. */
  31818. readonly audioContext: Nullable<AudioContext>;
  31819. /**
  31820. * The master gain node defines the global audio volume of your audio engine.
  31821. */
  31822. readonly masterGain: GainNode;
  31823. /**
  31824. * Gets whether or not mp3 are supported by your browser.
  31825. */
  31826. readonly isMP3supported: boolean;
  31827. /**
  31828. * Gets whether or not ogg are supported by your browser.
  31829. */
  31830. readonly isOGGsupported: boolean;
  31831. /**
  31832. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31833. * @ignoreNaming
  31834. */
  31835. WarnedWebAudioUnsupported: boolean;
  31836. /**
  31837. * Defines if the audio engine relies on a custom unlocked button.
  31838. * In this case, the embedded button will not be displayed.
  31839. */
  31840. useCustomUnlockedButton: boolean;
  31841. /**
  31842. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  31843. */
  31844. readonly unlocked: boolean;
  31845. /**
  31846. * Event raised when audio has been unlocked on the browser.
  31847. */
  31848. onAudioUnlockedObservable: Observable<AudioEngine>;
  31849. /**
  31850. * Event raised when audio has been locked on the browser.
  31851. */
  31852. onAudioLockedObservable: Observable<AudioEngine>;
  31853. /**
  31854. * Flags the audio engine in Locked state.
  31855. * This happens due to new browser policies preventing audio to autoplay.
  31856. */
  31857. lock(): void;
  31858. /**
  31859. * Unlocks the audio engine once a user action has been done on the dom.
  31860. * This is helpful to resume play once browser policies have been satisfied.
  31861. */
  31862. unlock(): void;
  31863. }
  31864. /**
  31865. * This represents the default audio engine used in babylon.
  31866. * It is responsible to play, synchronize and analyse sounds throughout the application.
  31867. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31868. */
  31869. export class AudioEngine implements IAudioEngine {
  31870. private _audioContext;
  31871. private _audioContextInitialized;
  31872. private _muteButton;
  31873. private _hostElement;
  31874. /**
  31875. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31876. */
  31877. canUseWebAudio: boolean;
  31878. /**
  31879. * The master gain node defines the global audio volume of your audio engine.
  31880. */
  31881. masterGain: GainNode;
  31882. /**
  31883. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31884. * @ignoreNaming
  31885. */
  31886. WarnedWebAudioUnsupported: boolean;
  31887. /**
  31888. * Gets whether or not mp3 are supported by your browser.
  31889. */
  31890. isMP3supported: boolean;
  31891. /**
  31892. * Gets whether or not ogg are supported by your browser.
  31893. */
  31894. isOGGsupported: boolean;
  31895. /**
  31896. * Gets whether audio has been unlocked on the device.
  31897. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  31898. * a user interaction has happened.
  31899. */
  31900. unlocked: boolean;
  31901. /**
  31902. * Defines if the audio engine relies on a custom unlocked button.
  31903. * In this case, the embedded button will not be displayed.
  31904. */
  31905. useCustomUnlockedButton: boolean;
  31906. /**
  31907. * Event raised when audio has been unlocked on the browser.
  31908. */
  31909. onAudioUnlockedObservable: Observable<AudioEngine>;
  31910. /**
  31911. * Event raised when audio has been locked on the browser.
  31912. */
  31913. onAudioLockedObservable: Observable<AudioEngine>;
  31914. /**
  31915. * Gets the current AudioContext if available.
  31916. */
  31917. readonly audioContext: Nullable<AudioContext>;
  31918. private _connectedAnalyser;
  31919. /**
  31920. * Instantiates a new audio engine.
  31921. *
  31922. * There should be only one per page as some browsers restrict the number
  31923. * of audio contexts you can create.
  31924. * @param hostElement defines the host element where to display the mute icon if necessary
  31925. */
  31926. constructor(hostElement?: Nullable<HTMLElement>);
  31927. /**
  31928. * Flags the audio engine in Locked state.
  31929. * This happens due to new browser policies preventing audio to autoplay.
  31930. */
  31931. lock(): void;
  31932. /**
  31933. * Unlocks the audio engine once a user action has been done on the dom.
  31934. * This is helpful to resume play once browser policies have been satisfied.
  31935. */
  31936. unlock(): void;
  31937. private _resumeAudioContext;
  31938. private _initializeAudioContext;
  31939. private _tryToRun;
  31940. private _triggerRunningState;
  31941. private _triggerSuspendedState;
  31942. private _displayMuteButton;
  31943. private _moveButtonToTopLeft;
  31944. private _onResize;
  31945. private _hideMuteButton;
  31946. /**
  31947. * Destroy and release the resources associated with the audio ccontext.
  31948. */
  31949. dispose(): void;
  31950. /**
  31951. * Gets the global volume sets on the master gain.
  31952. * @returns the global volume if set or -1 otherwise
  31953. */
  31954. getGlobalVolume(): number;
  31955. /**
  31956. * Sets the global volume of your experience (sets on the master gain).
  31957. * @param newVolume Defines the new global volume of the application
  31958. */
  31959. setGlobalVolume(newVolume: number): void;
  31960. /**
  31961. * Connect the audio engine to an audio analyser allowing some amazing
  31962. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  31963. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  31964. * @param analyser The analyser to connect to the engine
  31965. */
  31966. connectToAnalyser(analyser: Analyser): void;
  31967. }
  31968. }
  31969. declare module "babylonjs/Loading/loadingScreen" {
  31970. /**
  31971. * Interface used to present a loading screen while loading a scene
  31972. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31973. */
  31974. export interface ILoadingScreen {
  31975. /**
  31976. * Function called to display the loading screen
  31977. */
  31978. displayLoadingUI: () => void;
  31979. /**
  31980. * Function called to hide the loading screen
  31981. */
  31982. hideLoadingUI: () => void;
  31983. /**
  31984. * Gets or sets the color to use for the background
  31985. */
  31986. loadingUIBackgroundColor: string;
  31987. /**
  31988. * Gets or sets the text to display while loading
  31989. */
  31990. loadingUIText: string;
  31991. }
  31992. /**
  31993. * Class used for the default loading screen
  31994. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31995. */
  31996. export class DefaultLoadingScreen implements ILoadingScreen {
  31997. private _renderingCanvas;
  31998. private _loadingText;
  31999. private _loadingDivBackgroundColor;
  32000. private _loadingDiv;
  32001. private _loadingTextDiv;
  32002. /** Gets or sets the logo url to use for the default loading screen */
  32003. static DefaultLogoUrl: string;
  32004. /** Gets or sets the spinner url to use for the default loading screen */
  32005. static DefaultSpinnerUrl: string;
  32006. /**
  32007. * Creates a new default loading screen
  32008. * @param _renderingCanvas defines the canvas used to render the scene
  32009. * @param _loadingText defines the default text to display
  32010. * @param _loadingDivBackgroundColor defines the default background color
  32011. */
  32012. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  32013. /**
  32014. * Function called to display the loading screen
  32015. */
  32016. displayLoadingUI(): void;
  32017. /**
  32018. * Function called to hide the loading screen
  32019. */
  32020. hideLoadingUI(): void;
  32021. /**
  32022. * Gets or sets the text to display while loading
  32023. */
  32024. loadingUIText: string;
  32025. /**
  32026. * Gets or sets the color to use for the background
  32027. */
  32028. loadingUIBackgroundColor: string;
  32029. private _resizeLoadingUI;
  32030. }
  32031. }
  32032. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  32033. /**
  32034. * Interface for any object that can request an animation frame
  32035. */
  32036. export interface ICustomAnimationFrameRequester {
  32037. /**
  32038. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  32039. */
  32040. renderFunction?: Function;
  32041. /**
  32042. * Called to request the next frame to render to
  32043. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  32044. */
  32045. requestAnimationFrame: Function;
  32046. /**
  32047. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  32048. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  32049. */
  32050. requestID?: number;
  32051. }
  32052. }
  32053. declare module "babylonjs/Misc/performanceMonitor" {
  32054. /**
  32055. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  32056. */
  32057. export class PerformanceMonitor {
  32058. private _enabled;
  32059. private _rollingFrameTime;
  32060. private _lastFrameTimeMs;
  32061. /**
  32062. * constructor
  32063. * @param frameSampleSize The number of samples required to saturate the sliding window
  32064. */
  32065. constructor(frameSampleSize?: number);
  32066. /**
  32067. * Samples current frame
  32068. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  32069. */
  32070. sampleFrame(timeMs?: number): void;
  32071. /**
  32072. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  32073. */
  32074. readonly averageFrameTime: number;
  32075. /**
  32076. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  32077. */
  32078. readonly averageFrameTimeVariance: number;
  32079. /**
  32080. * Returns the frame time of the most recent frame
  32081. */
  32082. readonly instantaneousFrameTime: number;
  32083. /**
  32084. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  32085. */
  32086. readonly averageFPS: number;
  32087. /**
  32088. * Returns the average framerate in frames per second using the most recent frame time
  32089. */
  32090. readonly instantaneousFPS: number;
  32091. /**
  32092. * Returns true if enough samples have been taken to completely fill the sliding window
  32093. */
  32094. readonly isSaturated: boolean;
  32095. /**
  32096. * Enables contributions to the sliding window sample set
  32097. */
  32098. enable(): void;
  32099. /**
  32100. * Disables contributions to the sliding window sample set
  32101. * Samples will not be interpolated over the disabled period
  32102. */
  32103. disable(): void;
  32104. /**
  32105. * Returns true if sampling is enabled
  32106. */
  32107. readonly isEnabled: boolean;
  32108. /**
  32109. * Resets performance monitor
  32110. */
  32111. reset(): void;
  32112. }
  32113. /**
  32114. * RollingAverage
  32115. *
  32116. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  32117. */
  32118. export class RollingAverage {
  32119. /**
  32120. * Current average
  32121. */
  32122. average: number;
  32123. /**
  32124. * Current variance
  32125. */
  32126. variance: number;
  32127. protected _samples: Array<number>;
  32128. protected _sampleCount: number;
  32129. protected _pos: number;
  32130. protected _m2: number;
  32131. /**
  32132. * constructor
  32133. * @param length The number of samples required to saturate the sliding window
  32134. */
  32135. constructor(length: number);
  32136. /**
  32137. * Adds a sample to the sample set
  32138. * @param v The sample value
  32139. */
  32140. add(v: number): void;
  32141. /**
  32142. * Returns previously added values or null if outside of history or outside the sliding window domain
  32143. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  32144. * @return Value previously recorded with add() or null if outside of range
  32145. */
  32146. history(i: number): number;
  32147. /**
  32148. * Returns true if enough samples have been taken to completely fill the sliding window
  32149. * @return true if sample-set saturated
  32150. */
  32151. isSaturated(): boolean;
  32152. /**
  32153. * Resets the rolling average (equivalent to 0 samples taken so far)
  32154. */
  32155. reset(): void;
  32156. /**
  32157. * Wraps a value around the sample range boundaries
  32158. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  32159. * @return Wrapped position in sample range
  32160. */
  32161. protected _wrapPosition(i: number): number;
  32162. }
  32163. }
  32164. declare module "babylonjs/Misc/perfCounter" {
  32165. /**
  32166. * This class is used to track a performance counter which is number based.
  32167. * The user has access to many properties which give statistics of different nature.
  32168. *
  32169. * The implementer can track two kinds of Performance Counter: time and count.
  32170. * 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.
  32171. * 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.
  32172. */
  32173. export class PerfCounter {
  32174. /**
  32175. * Gets or sets a global boolean to turn on and off all the counters
  32176. */
  32177. static Enabled: boolean;
  32178. /**
  32179. * Returns the smallest value ever
  32180. */
  32181. readonly min: number;
  32182. /**
  32183. * Returns the biggest value ever
  32184. */
  32185. readonly max: number;
  32186. /**
  32187. * Returns the average value since the performance counter is running
  32188. */
  32189. readonly average: number;
  32190. /**
  32191. * Returns the average value of the last second the counter was monitored
  32192. */
  32193. readonly lastSecAverage: number;
  32194. /**
  32195. * Returns the current value
  32196. */
  32197. readonly current: number;
  32198. /**
  32199. * Gets the accumulated total
  32200. */
  32201. readonly total: number;
  32202. /**
  32203. * Gets the total value count
  32204. */
  32205. readonly count: number;
  32206. /**
  32207. * Creates a new counter
  32208. */
  32209. constructor();
  32210. /**
  32211. * Call this method to start monitoring a new frame.
  32212. * 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.
  32213. */
  32214. fetchNewFrame(): void;
  32215. /**
  32216. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  32217. * @param newCount the count value to add to the monitored count
  32218. * @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.
  32219. */
  32220. addCount(newCount: number, fetchResult: boolean): void;
  32221. /**
  32222. * Start monitoring this performance counter
  32223. */
  32224. beginMonitoring(): void;
  32225. /**
  32226. * Compute the time lapsed since the previous beginMonitoring() call.
  32227. * @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
  32228. */
  32229. endMonitoring(newFrame?: boolean): void;
  32230. private _fetchResult;
  32231. private _startMonitoringTime;
  32232. private _min;
  32233. private _max;
  32234. private _average;
  32235. private _current;
  32236. private _totalValueCount;
  32237. private _totalAccumulated;
  32238. private _lastSecAverage;
  32239. private _lastSecAccumulated;
  32240. private _lastSecTime;
  32241. private _lastSecValueCount;
  32242. }
  32243. }
  32244. declare module "babylonjs/Engines/engine" {
  32245. import { Observable } from "babylonjs/Misc/observable";
  32246. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  32247. import { Scene } from "babylonjs/scene";
  32248. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  32249. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  32250. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32251. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  32252. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  32253. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  32254. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  32255. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  32256. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  32257. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  32258. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  32259. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  32260. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  32261. import { Material } from "babylonjs/Materials/material";
  32262. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  32263. /**
  32264. * Defines the interface used by display changed events
  32265. */
  32266. export interface IDisplayChangedEventArgs {
  32267. /** Gets the vrDisplay object (if any) */
  32268. vrDisplay: Nullable<any>;
  32269. /** Gets a boolean indicating if webVR is supported */
  32270. vrSupported: boolean;
  32271. }
  32272. /**
  32273. * Defines the interface used by objects containing a viewport (like a camera)
  32274. */
  32275. interface IViewportOwnerLike {
  32276. /**
  32277. * Gets or sets the viewport
  32278. */
  32279. viewport: IViewportLike;
  32280. }
  32281. /**
  32282. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  32283. */
  32284. export class Engine extends ThinEngine {
  32285. /** Defines that alpha blending is disabled */
  32286. static readonly ALPHA_DISABLE: number;
  32287. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  32288. static readonly ALPHA_ADD: number;
  32289. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  32290. static readonly ALPHA_COMBINE: number;
  32291. /** Defines that alpha blending to DEST - SRC * DEST */
  32292. static readonly ALPHA_SUBTRACT: number;
  32293. /** Defines that alpha blending to SRC * DEST */
  32294. static readonly ALPHA_MULTIPLY: number;
  32295. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  32296. static readonly ALPHA_MAXIMIZED: number;
  32297. /** Defines that alpha blending to SRC + DEST */
  32298. static readonly ALPHA_ONEONE: number;
  32299. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  32300. static readonly ALPHA_PREMULTIPLIED: number;
  32301. /**
  32302. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  32303. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  32304. */
  32305. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  32306. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  32307. static readonly ALPHA_INTERPOLATE: number;
  32308. /**
  32309. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  32310. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  32311. */
  32312. static readonly ALPHA_SCREENMODE: number;
  32313. /** Defines that the ressource is not delayed*/
  32314. static readonly DELAYLOADSTATE_NONE: number;
  32315. /** Defines that the ressource was successfully delay loaded */
  32316. static readonly DELAYLOADSTATE_LOADED: number;
  32317. /** Defines that the ressource is currently delay loading */
  32318. static readonly DELAYLOADSTATE_LOADING: number;
  32319. /** Defines that the ressource is delayed and has not started loading */
  32320. static readonly DELAYLOADSTATE_NOTLOADED: number;
  32321. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  32322. static readonly NEVER: number;
  32323. /** 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 */
  32324. static readonly ALWAYS: number;
  32325. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  32326. static readonly LESS: number;
  32327. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  32328. static readonly EQUAL: number;
  32329. /** 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 */
  32330. static readonly LEQUAL: number;
  32331. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  32332. static readonly GREATER: number;
  32333. /** 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 */
  32334. static readonly GEQUAL: number;
  32335. /** 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 */
  32336. static readonly NOTEQUAL: number;
  32337. /** Passed to stencilOperation to specify that stencil value must be kept */
  32338. static readonly KEEP: number;
  32339. /** Passed to stencilOperation to specify that stencil value must be replaced */
  32340. static readonly REPLACE: number;
  32341. /** Passed to stencilOperation to specify that stencil value must be incremented */
  32342. static readonly INCR: number;
  32343. /** Passed to stencilOperation to specify that stencil value must be decremented */
  32344. static readonly DECR: number;
  32345. /** Passed to stencilOperation to specify that stencil value must be inverted */
  32346. static readonly INVERT: number;
  32347. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  32348. static readonly INCR_WRAP: number;
  32349. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  32350. static readonly DECR_WRAP: number;
  32351. /** Texture is not repeating outside of 0..1 UVs */
  32352. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  32353. /** Texture is repeating outside of 0..1 UVs */
  32354. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  32355. /** Texture is repeating and mirrored */
  32356. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  32357. /** ALPHA */
  32358. static readonly TEXTUREFORMAT_ALPHA: number;
  32359. /** LUMINANCE */
  32360. static readonly TEXTUREFORMAT_LUMINANCE: number;
  32361. /** LUMINANCE_ALPHA */
  32362. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  32363. /** RGB */
  32364. static readonly TEXTUREFORMAT_RGB: number;
  32365. /** RGBA */
  32366. static readonly TEXTUREFORMAT_RGBA: number;
  32367. /** RED */
  32368. static readonly TEXTUREFORMAT_RED: number;
  32369. /** RED (2nd reference) */
  32370. static readonly TEXTUREFORMAT_R: number;
  32371. /** RG */
  32372. static readonly TEXTUREFORMAT_RG: number;
  32373. /** RED_INTEGER */
  32374. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  32375. /** RED_INTEGER (2nd reference) */
  32376. static readonly TEXTUREFORMAT_R_INTEGER: number;
  32377. /** RG_INTEGER */
  32378. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  32379. /** RGB_INTEGER */
  32380. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  32381. /** RGBA_INTEGER */
  32382. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  32383. /** UNSIGNED_BYTE */
  32384. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  32385. /** UNSIGNED_BYTE (2nd reference) */
  32386. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  32387. /** FLOAT */
  32388. static readonly TEXTURETYPE_FLOAT: number;
  32389. /** HALF_FLOAT */
  32390. static readonly TEXTURETYPE_HALF_FLOAT: number;
  32391. /** BYTE */
  32392. static readonly TEXTURETYPE_BYTE: number;
  32393. /** SHORT */
  32394. static readonly TEXTURETYPE_SHORT: number;
  32395. /** UNSIGNED_SHORT */
  32396. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  32397. /** INT */
  32398. static readonly TEXTURETYPE_INT: number;
  32399. /** UNSIGNED_INT */
  32400. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  32401. /** UNSIGNED_SHORT_4_4_4_4 */
  32402. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  32403. /** UNSIGNED_SHORT_5_5_5_1 */
  32404. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  32405. /** UNSIGNED_SHORT_5_6_5 */
  32406. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  32407. /** UNSIGNED_INT_2_10_10_10_REV */
  32408. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  32409. /** UNSIGNED_INT_24_8 */
  32410. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  32411. /** UNSIGNED_INT_10F_11F_11F_REV */
  32412. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  32413. /** UNSIGNED_INT_5_9_9_9_REV */
  32414. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  32415. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  32416. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  32417. /** nearest is mag = nearest and min = nearest and mip = linear */
  32418. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  32419. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32420. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  32421. /** Trilinear is mag = linear and min = linear and mip = linear */
  32422. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  32423. /** nearest is mag = nearest and min = nearest and mip = linear */
  32424. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  32425. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32426. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  32427. /** Trilinear is mag = linear and min = linear and mip = linear */
  32428. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  32429. /** mag = nearest and min = nearest and mip = nearest */
  32430. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  32431. /** mag = nearest and min = linear and mip = nearest */
  32432. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  32433. /** mag = nearest and min = linear and mip = linear */
  32434. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  32435. /** mag = nearest and min = linear and mip = none */
  32436. static readonly TEXTURE_NEAREST_LINEAR: number;
  32437. /** mag = nearest and min = nearest and mip = none */
  32438. static readonly TEXTURE_NEAREST_NEAREST: number;
  32439. /** mag = linear and min = nearest and mip = nearest */
  32440. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  32441. /** mag = linear and min = nearest and mip = linear */
  32442. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  32443. /** mag = linear and min = linear and mip = none */
  32444. static readonly TEXTURE_LINEAR_LINEAR: number;
  32445. /** mag = linear and min = nearest and mip = none */
  32446. static readonly TEXTURE_LINEAR_NEAREST: number;
  32447. /** Explicit coordinates mode */
  32448. static readonly TEXTURE_EXPLICIT_MODE: number;
  32449. /** Spherical coordinates mode */
  32450. static readonly TEXTURE_SPHERICAL_MODE: number;
  32451. /** Planar coordinates mode */
  32452. static readonly TEXTURE_PLANAR_MODE: number;
  32453. /** Cubic coordinates mode */
  32454. static readonly TEXTURE_CUBIC_MODE: number;
  32455. /** Projection coordinates mode */
  32456. static readonly TEXTURE_PROJECTION_MODE: number;
  32457. /** Skybox coordinates mode */
  32458. static readonly TEXTURE_SKYBOX_MODE: number;
  32459. /** Inverse Cubic coordinates mode */
  32460. static readonly TEXTURE_INVCUBIC_MODE: number;
  32461. /** Equirectangular coordinates mode */
  32462. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  32463. /** Equirectangular Fixed coordinates mode */
  32464. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  32465. /** Equirectangular Fixed Mirrored coordinates mode */
  32466. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  32467. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  32468. static readonly SCALEMODE_FLOOR: number;
  32469. /** Defines that texture rescaling will look for the nearest power of 2 size */
  32470. static readonly SCALEMODE_NEAREST: number;
  32471. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  32472. static readonly SCALEMODE_CEILING: number;
  32473. /**
  32474. * Returns the current npm package of the sdk
  32475. */
  32476. static readonly NpmPackage: string;
  32477. /**
  32478. * Returns the current version of the framework
  32479. */
  32480. static readonly Version: string;
  32481. /** Gets the list of created engines */
  32482. static readonly Instances: Engine[];
  32483. /**
  32484. * Gets the latest created engine
  32485. */
  32486. static readonly LastCreatedEngine: Nullable<Engine>;
  32487. /**
  32488. * Gets the latest created scene
  32489. */
  32490. static readonly LastCreatedScene: Nullable<Scene>;
  32491. /**
  32492. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  32493. * @param flag defines which part of the materials must be marked as dirty
  32494. * @param predicate defines a predicate used to filter which materials should be affected
  32495. */
  32496. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  32497. /**
  32498. * Method called to create the default loading screen.
  32499. * This can be overriden in your own app.
  32500. * @param canvas The rendering canvas element
  32501. * @returns The loading screen
  32502. */
  32503. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  32504. /**
  32505. * Method called to create the default rescale post process on each engine.
  32506. */
  32507. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  32508. /**
  32509. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  32510. **/
  32511. enableOfflineSupport: boolean;
  32512. /**
  32513. * 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)
  32514. **/
  32515. disableManifestCheck: boolean;
  32516. /**
  32517. * Gets the list of created scenes
  32518. */
  32519. scenes: Scene[];
  32520. /**
  32521. * Event raised when a new scene is created
  32522. */
  32523. onNewSceneAddedObservable: Observable<Scene>;
  32524. /**
  32525. * Gets the list of created postprocesses
  32526. */
  32527. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  32528. /**
  32529. * Gets a boolean indicating if the pointer is currently locked
  32530. */
  32531. isPointerLock: boolean;
  32532. /**
  32533. * Observable event triggered each time the rendering canvas is resized
  32534. */
  32535. onResizeObservable: Observable<Engine>;
  32536. /**
  32537. * Observable event triggered each time the canvas loses focus
  32538. */
  32539. onCanvasBlurObservable: Observable<Engine>;
  32540. /**
  32541. * Observable event triggered each time the canvas gains focus
  32542. */
  32543. onCanvasFocusObservable: Observable<Engine>;
  32544. /**
  32545. * Observable event triggered each time the canvas receives pointerout event
  32546. */
  32547. onCanvasPointerOutObservable: Observable<PointerEvent>;
  32548. /**
  32549. * Observable raised when the engine begins a new frame
  32550. */
  32551. onBeginFrameObservable: Observable<Engine>;
  32552. /**
  32553. * If set, will be used to request the next animation frame for the render loop
  32554. */
  32555. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  32556. /**
  32557. * Observable raised when the engine ends the current frame
  32558. */
  32559. onEndFrameObservable: Observable<Engine>;
  32560. /**
  32561. * Observable raised when the engine is about to compile a shader
  32562. */
  32563. onBeforeShaderCompilationObservable: Observable<Engine>;
  32564. /**
  32565. * Observable raised when the engine has jsut compiled a shader
  32566. */
  32567. onAfterShaderCompilationObservable: Observable<Engine>;
  32568. /**
  32569. * Gets the audio engine
  32570. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  32571. * @ignorenaming
  32572. */
  32573. static audioEngine: IAudioEngine;
  32574. /**
  32575. * Default AudioEngine factory responsible of creating the Audio Engine.
  32576. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  32577. */
  32578. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  32579. /**
  32580. * Default offline support factory responsible of creating a tool used to store data locally.
  32581. * By default, this will create a Database object if the workload has been embedded.
  32582. */
  32583. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  32584. private _loadingScreen;
  32585. private _pointerLockRequested;
  32586. private _dummyFramebuffer;
  32587. private _rescalePostProcess;
  32588. /** @hidden */
  32589. protected _alphaMode: number;
  32590. /** @hidden */
  32591. protected _alphaEquation: number;
  32592. private _deterministicLockstep;
  32593. private _lockstepMaxSteps;
  32594. protected readonly _supportsHardwareTextureRescaling: boolean;
  32595. private _fps;
  32596. private _deltaTime;
  32597. /** @hidden */
  32598. _drawCalls: PerfCounter;
  32599. /**
  32600. * Turn this value on if you want to pause FPS computation when in background
  32601. */
  32602. disablePerformanceMonitorInBackground: boolean;
  32603. private _performanceMonitor;
  32604. /**
  32605. * Gets the performance monitor attached to this engine
  32606. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  32607. */
  32608. readonly performanceMonitor: PerformanceMonitor;
  32609. private _onFocus;
  32610. private _onBlur;
  32611. private _onCanvasPointerOut;
  32612. private _onCanvasBlur;
  32613. private _onCanvasFocus;
  32614. private _onFullscreenChange;
  32615. private _onPointerLockChange;
  32616. /**
  32617. * Gets the HTML element used to attach event listeners
  32618. * @returns a HTML element
  32619. */
  32620. getInputElement(): Nullable<HTMLElement>;
  32621. /**
  32622. * Creates a new engine
  32623. * @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
  32624. * @param antialias defines enable antialiasing (default: false)
  32625. * @param options defines further options to be sent to the getContext() function
  32626. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  32627. */
  32628. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  32629. /**
  32630. * Gets current aspect ratio
  32631. * @param viewportOwner defines the camera to use to get the aspect ratio
  32632. * @param useScreen defines if screen size must be used (or the current render target if any)
  32633. * @returns a number defining the aspect ratio
  32634. */
  32635. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  32636. /**
  32637. * Gets current screen aspect ratio
  32638. * @returns a number defining the aspect ratio
  32639. */
  32640. getScreenAspectRatio(): number;
  32641. /**
  32642. * Gets host document
  32643. * @returns the host document object
  32644. */
  32645. getHostDocument(): Document;
  32646. /**
  32647. * Gets the client rect of the HTML canvas attached with the current webGL context
  32648. * @returns a client rectanglee
  32649. */
  32650. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  32651. /**
  32652. * Gets the client rect of the HTML element used for events
  32653. * @returns a client rectanglee
  32654. */
  32655. getInputElementClientRect(): Nullable<ClientRect>;
  32656. /**
  32657. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  32658. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32659. * @returns true if engine is in deterministic lock step mode
  32660. */
  32661. isDeterministicLockStep(): boolean;
  32662. /**
  32663. * Gets the max steps when engine is running in deterministic lock step
  32664. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32665. * @returns the max steps
  32666. */
  32667. getLockstepMaxSteps(): number;
  32668. /**
  32669. * Force the mipmap generation for the given render target texture
  32670. * @param texture defines the render target texture to use
  32671. */
  32672. generateMipMapsForCubemap(texture: InternalTexture): void;
  32673. /** States */
  32674. /**
  32675. * Set various states to the webGL context
  32676. * @param culling defines backface culling state
  32677. * @param zOffset defines the value to apply to zOffset (0 by default)
  32678. * @param force defines if states must be applied even if cache is up to date
  32679. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  32680. */
  32681. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  32682. /**
  32683. * Set the z offset to apply to current rendering
  32684. * @param value defines the offset to apply
  32685. */
  32686. setZOffset(value: number): void;
  32687. /**
  32688. * Gets the current value of the zOffset
  32689. * @returns the current zOffset state
  32690. */
  32691. getZOffset(): number;
  32692. /**
  32693. * Enable or disable depth buffering
  32694. * @param enable defines the state to set
  32695. */
  32696. setDepthBuffer(enable: boolean): void;
  32697. /**
  32698. * Gets a boolean indicating if depth writing is enabled
  32699. * @returns the current depth writing state
  32700. */
  32701. getDepthWrite(): boolean;
  32702. /**
  32703. * Enable or disable depth writing
  32704. * @param enable defines the state to set
  32705. */
  32706. setDepthWrite(enable: boolean): void;
  32707. /**
  32708. * Enable or disable color writing
  32709. * @param enable defines the state to set
  32710. */
  32711. setColorWrite(enable: boolean): void;
  32712. /**
  32713. * Gets a boolean indicating if color writing is enabled
  32714. * @returns the current color writing state
  32715. */
  32716. getColorWrite(): boolean;
  32717. /**
  32718. * Sets alpha constants used by some alpha blending modes
  32719. * @param r defines the red component
  32720. * @param g defines the green component
  32721. * @param b defines the blue component
  32722. * @param a defines the alpha component
  32723. */
  32724. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  32725. /**
  32726. * Sets the current alpha mode
  32727. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  32728. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  32729. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32730. */
  32731. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  32732. /**
  32733. * Gets the current alpha mode
  32734. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32735. * @returns the current alpha mode
  32736. */
  32737. getAlphaMode(): number;
  32738. /**
  32739. * Sets the current alpha equation
  32740. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  32741. */
  32742. setAlphaEquation(equation: number): void;
  32743. /**
  32744. * Gets the current alpha equation.
  32745. * @returns the current alpha equation
  32746. */
  32747. getAlphaEquation(): number;
  32748. /**
  32749. * Gets a boolean indicating if stencil buffer is enabled
  32750. * @returns the current stencil buffer state
  32751. */
  32752. getStencilBuffer(): boolean;
  32753. /**
  32754. * Enable or disable the stencil buffer
  32755. * @param enable defines if the stencil buffer must be enabled or disabled
  32756. */
  32757. setStencilBuffer(enable: boolean): void;
  32758. /**
  32759. * Gets the current stencil mask
  32760. * @returns a number defining the new stencil mask to use
  32761. */
  32762. getStencilMask(): number;
  32763. /**
  32764. * Sets the current stencil mask
  32765. * @param mask defines the new stencil mask to use
  32766. */
  32767. setStencilMask(mask: number): void;
  32768. /**
  32769. * Gets the current stencil function
  32770. * @returns a number defining the stencil function to use
  32771. */
  32772. getStencilFunction(): number;
  32773. /**
  32774. * Gets the current stencil reference value
  32775. * @returns a number defining the stencil reference value to use
  32776. */
  32777. getStencilFunctionReference(): number;
  32778. /**
  32779. * Gets the current stencil mask
  32780. * @returns a number defining the stencil mask to use
  32781. */
  32782. getStencilFunctionMask(): number;
  32783. /**
  32784. * Sets the current stencil function
  32785. * @param stencilFunc defines the new stencil function to use
  32786. */
  32787. setStencilFunction(stencilFunc: number): void;
  32788. /**
  32789. * Sets the current stencil reference
  32790. * @param reference defines the new stencil reference to use
  32791. */
  32792. setStencilFunctionReference(reference: number): void;
  32793. /**
  32794. * Sets the current stencil mask
  32795. * @param mask defines the new stencil mask to use
  32796. */
  32797. setStencilFunctionMask(mask: number): void;
  32798. /**
  32799. * Gets the current stencil operation when stencil fails
  32800. * @returns a number defining stencil operation to use when stencil fails
  32801. */
  32802. getStencilOperationFail(): number;
  32803. /**
  32804. * Gets the current stencil operation when depth fails
  32805. * @returns a number defining stencil operation to use when depth fails
  32806. */
  32807. getStencilOperationDepthFail(): number;
  32808. /**
  32809. * Gets the current stencil operation when stencil passes
  32810. * @returns a number defining stencil operation to use when stencil passes
  32811. */
  32812. getStencilOperationPass(): number;
  32813. /**
  32814. * Sets the stencil operation to use when stencil fails
  32815. * @param operation defines the stencil operation to use when stencil fails
  32816. */
  32817. setStencilOperationFail(operation: number): void;
  32818. /**
  32819. * Sets the stencil operation to use when depth fails
  32820. * @param operation defines the stencil operation to use when depth fails
  32821. */
  32822. setStencilOperationDepthFail(operation: number): void;
  32823. /**
  32824. * Sets the stencil operation to use when stencil passes
  32825. * @param operation defines the stencil operation to use when stencil passes
  32826. */
  32827. setStencilOperationPass(operation: number): void;
  32828. /**
  32829. * Sets a boolean indicating if the dithering state is enabled or disabled
  32830. * @param value defines the dithering state
  32831. */
  32832. setDitheringState(value: boolean): void;
  32833. /**
  32834. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  32835. * @param value defines the rasterizer state
  32836. */
  32837. setRasterizerState(value: boolean): void;
  32838. /**
  32839. * Gets the current depth function
  32840. * @returns a number defining the depth function
  32841. */
  32842. getDepthFunction(): Nullable<number>;
  32843. /**
  32844. * Sets the current depth function
  32845. * @param depthFunc defines the function to use
  32846. */
  32847. setDepthFunction(depthFunc: number): void;
  32848. /**
  32849. * Sets the current depth function to GREATER
  32850. */
  32851. setDepthFunctionToGreater(): void;
  32852. /**
  32853. * Sets the current depth function to GEQUAL
  32854. */
  32855. setDepthFunctionToGreaterOrEqual(): void;
  32856. /**
  32857. * Sets the current depth function to LESS
  32858. */
  32859. setDepthFunctionToLess(): void;
  32860. /**
  32861. * Sets the current depth function to LEQUAL
  32862. */
  32863. setDepthFunctionToLessOrEqual(): void;
  32864. private _cachedStencilBuffer;
  32865. private _cachedStencilFunction;
  32866. private _cachedStencilMask;
  32867. private _cachedStencilOperationPass;
  32868. private _cachedStencilOperationFail;
  32869. private _cachedStencilOperationDepthFail;
  32870. private _cachedStencilReference;
  32871. /**
  32872. * Caches the the state of the stencil buffer
  32873. */
  32874. cacheStencilState(): void;
  32875. /**
  32876. * Restores the state of the stencil buffer
  32877. */
  32878. restoreStencilState(): void;
  32879. /**
  32880. * Directly set the WebGL Viewport
  32881. * @param x defines the x coordinate of the viewport (in screen space)
  32882. * @param y defines the y coordinate of the viewport (in screen space)
  32883. * @param width defines the width of the viewport (in screen space)
  32884. * @param height defines the height of the viewport (in screen space)
  32885. * @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
  32886. */
  32887. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  32888. /**
  32889. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  32890. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32891. * @param y defines the y-coordinate of the corner of the clear rectangle
  32892. * @param width defines the width of the clear rectangle
  32893. * @param height defines the height of the clear rectangle
  32894. * @param clearColor defines the clear color
  32895. */
  32896. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  32897. /**
  32898. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  32899. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32900. * @param y defines the y-coordinate of the corner of the clear rectangle
  32901. * @param width defines the width of the clear rectangle
  32902. * @param height defines the height of the clear rectangle
  32903. */
  32904. enableScissor(x: number, y: number, width: number, height: number): void;
  32905. /**
  32906. * Disable previously set scissor test rectangle
  32907. */
  32908. disableScissor(): void;
  32909. protected _reportDrawCall(): void;
  32910. /**
  32911. * Initializes a webVR display and starts listening to display change events
  32912. * The onVRDisplayChangedObservable will be notified upon these changes
  32913. * @returns The onVRDisplayChangedObservable
  32914. */
  32915. initWebVR(): Observable<IDisplayChangedEventArgs>;
  32916. /** @hidden */
  32917. _prepareVRComponent(): void;
  32918. /** @hidden */
  32919. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  32920. /** @hidden */
  32921. _submitVRFrame(): void;
  32922. /**
  32923. * Call this function to leave webVR mode
  32924. * Will do nothing if webVR is not supported or if there is no webVR device
  32925. * @see http://doc.babylonjs.com/how_to/webvr_camera
  32926. */
  32927. disableVR(): void;
  32928. /**
  32929. * Gets a boolean indicating that the system is in VR mode and is presenting
  32930. * @returns true if VR mode is engaged
  32931. */
  32932. isVRPresenting(): boolean;
  32933. /** @hidden */
  32934. _requestVRFrame(): void;
  32935. /** @hidden */
  32936. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32937. /**
  32938. * Gets the source code of the vertex shader associated with a specific webGL program
  32939. * @param program defines the program to use
  32940. * @returns a string containing the source code of the vertex shader associated with the program
  32941. */
  32942. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32943. /**
  32944. * Gets the source code of the fragment shader associated with a specific webGL program
  32945. * @param program defines the program to use
  32946. * @returns a string containing the source code of the fragment shader associated with the program
  32947. */
  32948. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32949. /**
  32950. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32951. * @param x defines the x coordinate of the rectangle where pixels must be read
  32952. * @param y defines the y coordinate of the rectangle where pixels must be read
  32953. * @param width defines the width of the rectangle where pixels must be read
  32954. * @param height defines the height of the rectangle where pixels must be read
  32955. * @returns a Uint8Array containing RGBA colors
  32956. */
  32957. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32958. /**
  32959. * Sets a depth stencil texture from a render target to the according uniform.
  32960. * @param channel The texture channel
  32961. * @param uniform The uniform to set
  32962. * @param texture The render target texture containing the depth stencil texture to apply
  32963. */
  32964. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32965. /**
  32966. * Sets a texture to the webGL context from a postprocess
  32967. * @param channel defines the channel to use
  32968. * @param postProcess defines the source postprocess
  32969. */
  32970. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32971. /**
  32972. * Binds the output of the passed in post process to the texture channel specified
  32973. * @param channel The channel the texture should be bound to
  32974. * @param postProcess The post process which's output should be bound
  32975. */
  32976. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32977. /** @hidden */
  32978. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32979. protected _rebuildBuffers(): void;
  32980. /** @hidden */
  32981. _renderFrame(): void;
  32982. _renderLoop(): void;
  32983. /** @hidden */
  32984. _renderViews(): boolean;
  32985. /**
  32986. * Toggle full screen mode
  32987. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32988. */
  32989. switchFullscreen(requestPointerLock: boolean): void;
  32990. /**
  32991. * Enters full screen mode
  32992. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32993. */
  32994. enterFullscreen(requestPointerLock: boolean): void;
  32995. /**
  32996. * Exits full screen mode
  32997. */
  32998. exitFullscreen(): void;
  32999. /**
  33000. * Enters Pointerlock mode
  33001. */
  33002. enterPointerlock(): void;
  33003. /**
  33004. * Exits Pointerlock mode
  33005. */
  33006. exitPointerlock(): void;
  33007. /**
  33008. * Begin a new frame
  33009. */
  33010. beginFrame(): void;
  33011. /**
  33012. * Enf the current frame
  33013. */
  33014. endFrame(): void;
  33015. resize(): void;
  33016. /**
  33017. * Set the compressed texture format to use, based on the formats you have, and the formats
  33018. * supported by the hardware / browser.
  33019. *
  33020. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  33021. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  33022. * to API arguments needed to compressed textures. This puts the burden on the container
  33023. * generator to house the arcane code for determining these for current & future formats.
  33024. *
  33025. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  33026. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  33027. *
  33028. * Note: The result of this call is not taken into account when a texture is base64.
  33029. *
  33030. * @param formatsAvailable defines the list of those format families you have created
  33031. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  33032. *
  33033. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  33034. * @returns The extension selected.
  33035. */
  33036. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  33037. /**
  33038. * Force a specific size of the canvas
  33039. * @param width defines the new canvas' width
  33040. * @param height defines the new canvas' height
  33041. */
  33042. setSize(width: number, height: number): void;
  33043. /**
  33044. * Updates a dynamic vertex buffer.
  33045. * @param vertexBuffer the vertex buffer to update
  33046. * @param data the data used to update the vertex buffer
  33047. * @param byteOffset the byte offset of the data
  33048. * @param byteLength the byte length of the data
  33049. */
  33050. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  33051. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  33052. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  33053. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  33054. _releaseTexture(texture: InternalTexture): void;
  33055. /**
  33056. * @hidden
  33057. * Rescales a texture
  33058. * @param source input texutre
  33059. * @param destination destination texture
  33060. * @param scene scene to use to render the resize
  33061. * @param internalFormat format to use when resizing
  33062. * @param onComplete callback to be called when resize has completed
  33063. */
  33064. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  33065. /**
  33066. * Gets the current framerate
  33067. * @returns a number representing the framerate
  33068. */
  33069. getFps(): number;
  33070. /**
  33071. * Gets the time spent between current and previous frame
  33072. * @returns a number representing the delta time in ms
  33073. */
  33074. getDeltaTime(): number;
  33075. private _measureFps;
  33076. /** @hidden */
  33077. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  33078. /**
  33079. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  33080. * @param renderTarget The render target to set the frame buffer for
  33081. */
  33082. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  33083. /**
  33084. * Update a dynamic index buffer
  33085. * @param indexBuffer defines the target index buffer
  33086. * @param indices defines the data to update
  33087. * @param offset defines the offset in the target index buffer where update should start
  33088. */
  33089. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  33090. /**
  33091. * Updates the sample count of a render target texture
  33092. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  33093. * @param texture defines the texture to update
  33094. * @param samples defines the sample count to set
  33095. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  33096. */
  33097. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  33098. /**
  33099. * Updates a depth texture Comparison Mode and Function.
  33100. * If the comparison Function is equal to 0, the mode will be set to none.
  33101. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  33102. * @param texture The texture to set the comparison function for
  33103. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  33104. */
  33105. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  33106. /**
  33107. * Creates a webGL buffer to use with instanciation
  33108. * @param capacity defines the size of the buffer
  33109. * @returns the webGL buffer
  33110. */
  33111. createInstancesBuffer(capacity: number): DataBuffer;
  33112. /**
  33113. * Delete a webGL buffer used with instanciation
  33114. * @param buffer defines the webGL buffer to delete
  33115. */
  33116. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  33117. /** @hidden */
  33118. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  33119. dispose(): void;
  33120. private _disableTouchAction;
  33121. /**
  33122. * Display the loading screen
  33123. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33124. */
  33125. displayLoadingUI(): void;
  33126. /**
  33127. * Hide the loading screen
  33128. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33129. */
  33130. hideLoadingUI(): void;
  33131. /**
  33132. * Gets the current loading screen object
  33133. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33134. */
  33135. /**
  33136. * Sets the current loading screen object
  33137. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33138. */
  33139. loadingScreen: ILoadingScreen;
  33140. /**
  33141. * Sets the current loading screen text
  33142. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33143. */
  33144. loadingUIText: string;
  33145. /**
  33146. * Sets the current loading screen background color
  33147. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33148. */
  33149. loadingUIBackgroundColor: string;
  33150. /** Pointerlock and fullscreen */
  33151. /**
  33152. * Ask the browser to promote the current element to pointerlock mode
  33153. * @param element defines the DOM element to promote
  33154. */
  33155. static _RequestPointerlock(element: HTMLElement): void;
  33156. /**
  33157. * Asks the browser to exit pointerlock mode
  33158. */
  33159. static _ExitPointerlock(): void;
  33160. /**
  33161. * Ask the browser to promote the current element to fullscreen rendering mode
  33162. * @param element defines the DOM element to promote
  33163. */
  33164. static _RequestFullscreen(element: HTMLElement): void;
  33165. /**
  33166. * Asks the browser to exit fullscreen mode
  33167. */
  33168. static _ExitFullscreen(): void;
  33169. }
  33170. }
  33171. declare module "babylonjs/Engines/engineStore" {
  33172. import { Nullable } from "babylonjs/types";
  33173. import { Engine } from "babylonjs/Engines/engine";
  33174. import { Scene } from "babylonjs/scene";
  33175. /**
  33176. * The engine store class is responsible to hold all the instances of Engine and Scene created
  33177. * during the life time of the application.
  33178. */
  33179. export class EngineStore {
  33180. /** Gets the list of created engines */
  33181. static Instances: import("babylonjs/Engines/engine").Engine[];
  33182. /** @hidden */
  33183. static _LastCreatedScene: Nullable<Scene>;
  33184. /**
  33185. * Gets the latest created engine
  33186. */
  33187. static readonly LastCreatedEngine: Nullable<Engine>;
  33188. /**
  33189. * Gets the latest created scene
  33190. */
  33191. static readonly LastCreatedScene: Nullable<Scene>;
  33192. /**
  33193. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  33194. * @ignorenaming
  33195. */
  33196. static UseFallbackTexture: boolean;
  33197. /**
  33198. * Texture content used if a texture cannot loaded
  33199. * @ignorenaming
  33200. */
  33201. static FallbackTexture: string;
  33202. }
  33203. }
  33204. declare module "babylonjs/Misc/promise" {
  33205. /**
  33206. * Helper class that provides a small promise polyfill
  33207. */
  33208. export class PromisePolyfill {
  33209. /**
  33210. * Static function used to check if the polyfill is required
  33211. * If this is the case then the function will inject the polyfill to window.Promise
  33212. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  33213. */
  33214. static Apply(force?: boolean): void;
  33215. }
  33216. }
  33217. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  33218. /**
  33219. * Interface for screenshot methods with describe argument called `size` as object with options
  33220. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  33221. */
  33222. export interface IScreenshotSize {
  33223. /**
  33224. * number in pixels for canvas height
  33225. */
  33226. height?: number;
  33227. /**
  33228. * multiplier allowing render at a higher or lower resolution
  33229. * If value is defined then height and width will be ignored and taken from camera
  33230. */
  33231. precision?: number;
  33232. /**
  33233. * number in pixels for canvas width
  33234. */
  33235. width?: number;
  33236. }
  33237. }
  33238. declare module "babylonjs/Misc/tools" {
  33239. import { Nullable, float } from "babylonjs/types";
  33240. import { DomManagement } from "babylonjs/Misc/domManagement";
  33241. import { WebRequest } from "babylonjs/Misc/webRequest";
  33242. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  33243. import { ReadFileError } from "babylonjs/Misc/fileTools";
  33244. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  33245. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  33246. import { Camera } from "babylonjs/Cameras/camera";
  33247. import { Engine } from "babylonjs/Engines/engine";
  33248. interface IColor4Like {
  33249. r: float;
  33250. g: float;
  33251. b: float;
  33252. a: float;
  33253. }
  33254. /**
  33255. * Class containing a set of static utilities functions
  33256. */
  33257. export class Tools {
  33258. /**
  33259. * Gets or sets the base URL to use to load assets
  33260. */
  33261. static BaseUrl: string;
  33262. /**
  33263. * Enable/Disable Custom HTTP Request Headers globally.
  33264. * default = false
  33265. * @see CustomRequestHeaders
  33266. */
  33267. static UseCustomRequestHeaders: boolean;
  33268. /**
  33269. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  33270. * i.e. when loading files, where the server/service expects an Authorization header
  33271. */
  33272. static CustomRequestHeaders: {
  33273. [key: string]: string;
  33274. };
  33275. /**
  33276. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  33277. */
  33278. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  33279. /**
  33280. * Default behaviour for cors in the application.
  33281. * It can be a string if the expected behavior is identical in the entire app.
  33282. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  33283. */
  33284. static CorsBehavior: string | ((url: string | string[]) => string);
  33285. /**
  33286. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  33287. * @ignorenaming
  33288. */
  33289. static UseFallbackTexture: boolean;
  33290. /**
  33291. * Use this object to register external classes like custom textures or material
  33292. * to allow the laoders to instantiate them
  33293. */
  33294. static RegisteredExternalClasses: {
  33295. [key: string]: Object;
  33296. };
  33297. /**
  33298. * Texture content used if a texture cannot loaded
  33299. * @ignorenaming
  33300. */
  33301. static fallbackTexture: string;
  33302. /**
  33303. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  33304. * @param u defines the coordinate on X axis
  33305. * @param v defines the coordinate on Y axis
  33306. * @param width defines the width of the source data
  33307. * @param height defines the height of the source data
  33308. * @param pixels defines the source byte array
  33309. * @param color defines the output color
  33310. */
  33311. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  33312. /**
  33313. * Interpolates between a and b via alpha
  33314. * @param a The lower value (returned when alpha = 0)
  33315. * @param b The upper value (returned when alpha = 1)
  33316. * @param alpha The interpolation-factor
  33317. * @return The mixed value
  33318. */
  33319. static Mix(a: number, b: number, alpha: number): number;
  33320. /**
  33321. * Tries to instantiate a new object from a given class name
  33322. * @param className defines the class name to instantiate
  33323. * @returns the new object or null if the system was not able to do the instantiation
  33324. */
  33325. static Instantiate(className: string): any;
  33326. /**
  33327. * Provides a slice function that will work even on IE
  33328. * @param data defines the array to slice
  33329. * @param start defines the start of the data (optional)
  33330. * @param end defines the end of the data (optional)
  33331. * @returns the new sliced array
  33332. */
  33333. static Slice<T>(data: T, start?: number, end?: number): T;
  33334. /**
  33335. * Polyfill for setImmediate
  33336. * @param action defines the action to execute after the current execution block
  33337. */
  33338. static SetImmediate(action: () => void): void;
  33339. /**
  33340. * Function indicating if a number is an exponent of 2
  33341. * @param value defines the value to test
  33342. * @returns true if the value is an exponent of 2
  33343. */
  33344. static IsExponentOfTwo(value: number): boolean;
  33345. private static _tmpFloatArray;
  33346. /**
  33347. * Returns the nearest 32-bit single precision float representation of a Number
  33348. * @param value A Number. If the parameter is of a different type, it will get converted
  33349. * to a number or to NaN if it cannot be converted
  33350. * @returns number
  33351. */
  33352. static FloatRound(value: number): number;
  33353. /**
  33354. * Extracts the filename from a path
  33355. * @param path defines the path to use
  33356. * @returns the filename
  33357. */
  33358. static GetFilename(path: string): string;
  33359. /**
  33360. * Extracts the "folder" part of a path (everything before the filename).
  33361. * @param uri The URI to extract the info from
  33362. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  33363. * @returns The "folder" part of the path
  33364. */
  33365. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  33366. /**
  33367. * Extracts text content from a DOM element hierarchy
  33368. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  33369. */
  33370. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  33371. /**
  33372. * Convert an angle in radians to degrees
  33373. * @param angle defines the angle to convert
  33374. * @returns the angle in degrees
  33375. */
  33376. static ToDegrees(angle: number): number;
  33377. /**
  33378. * Convert an angle in degrees to radians
  33379. * @param angle defines the angle to convert
  33380. * @returns the angle in radians
  33381. */
  33382. static ToRadians(angle: number): number;
  33383. /**
  33384. * Returns an array if obj is not an array
  33385. * @param obj defines the object to evaluate as an array
  33386. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  33387. * @returns either obj directly if obj is an array or a new array containing obj
  33388. */
  33389. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  33390. /**
  33391. * Gets the pointer prefix to use
  33392. * @returns "pointer" if touch is enabled. Else returns "mouse"
  33393. */
  33394. static GetPointerPrefix(): string;
  33395. /**
  33396. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  33397. * @param url define the url we are trying
  33398. * @param element define the dom element where to configure the cors policy
  33399. */
  33400. static SetCorsBehavior(url: string | string[], element: {
  33401. crossOrigin: string | null;
  33402. }): void;
  33403. /**
  33404. * Removes unwanted characters from an url
  33405. * @param url defines the url to clean
  33406. * @returns the cleaned url
  33407. */
  33408. static CleanUrl(url: string): string;
  33409. /**
  33410. * Gets or sets a function used to pre-process url before using them to load assets
  33411. */
  33412. static PreprocessUrl: (url: string) => string;
  33413. /**
  33414. * Loads an image as an HTMLImageElement.
  33415. * @param input url string, ArrayBuffer, or Blob to load
  33416. * @param onLoad callback called when the image successfully loads
  33417. * @param onError callback called when the image fails to load
  33418. * @param offlineProvider offline provider for caching
  33419. * @param mimeType optional mime type
  33420. * @returns the HTMLImageElement of the loaded image
  33421. */
  33422. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  33423. /**
  33424. * Loads a file from a url
  33425. * @param url url string, ArrayBuffer, or Blob to load
  33426. * @param onSuccess callback called when the file successfully loads
  33427. * @param onProgress callback called while file is loading (if the server supports this mode)
  33428. * @param offlineProvider defines the offline provider for caching
  33429. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  33430. * @param onError callback called when the file fails to load
  33431. * @returns a file request object
  33432. */
  33433. 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;
  33434. /**
  33435. * Loads a file from a url
  33436. * @param url the file url to load
  33437. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  33438. */
  33439. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  33440. /**
  33441. * Load a script (identified by an url). When the url returns, the
  33442. * content of this file is added into a new script element, attached to the DOM (body element)
  33443. * @param scriptUrl defines the url of the script to laod
  33444. * @param onSuccess defines the callback called when the script is loaded
  33445. * @param onError defines the callback to call if an error occurs
  33446. * @param scriptId defines the id of the script element
  33447. */
  33448. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  33449. /**
  33450. * Load an asynchronous script (identified by an url). When the url returns, the
  33451. * content of this file is added into a new script element, attached to the DOM (body element)
  33452. * @param scriptUrl defines the url of the script to laod
  33453. * @param scriptId defines the id of the script element
  33454. * @returns a promise request object
  33455. */
  33456. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  33457. /**
  33458. * Loads a file from a blob
  33459. * @param fileToLoad defines the blob to use
  33460. * @param callback defines the callback to call when data is loaded
  33461. * @param progressCallback defines the callback to call during loading process
  33462. * @returns a file request object
  33463. */
  33464. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  33465. /**
  33466. * Reads a file from a File object
  33467. * @param file defines the file to load
  33468. * @param onSuccess defines the callback to call when data is loaded
  33469. * @param onProgress defines the callback to call during loading process
  33470. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  33471. * @param onError defines the callback to call when an error occurs
  33472. * @returns a file request object
  33473. */
  33474. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  33475. /**
  33476. * Creates a data url from a given string content
  33477. * @param content defines the content to convert
  33478. * @returns the new data url link
  33479. */
  33480. static FileAsURL(content: string): string;
  33481. /**
  33482. * Format the given number to a specific decimal format
  33483. * @param value defines the number to format
  33484. * @param decimals defines the number of decimals to use
  33485. * @returns the formatted string
  33486. */
  33487. static Format(value: number, decimals?: number): string;
  33488. /**
  33489. * Tries to copy an object by duplicating every property
  33490. * @param source defines the source object
  33491. * @param destination defines the target object
  33492. * @param doNotCopyList defines a list of properties to avoid
  33493. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  33494. */
  33495. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  33496. /**
  33497. * Gets a boolean indicating if the given object has no own property
  33498. * @param obj defines the object to test
  33499. * @returns true if object has no own property
  33500. */
  33501. static IsEmpty(obj: any): boolean;
  33502. /**
  33503. * Function used to register events at window level
  33504. * @param windowElement defines the Window object to use
  33505. * @param events defines the events to register
  33506. */
  33507. static RegisterTopRootEvents(windowElement: Window, events: {
  33508. name: string;
  33509. handler: Nullable<(e: FocusEvent) => any>;
  33510. }[]): void;
  33511. /**
  33512. * Function used to unregister events from window level
  33513. * @param windowElement defines the Window object to use
  33514. * @param events defines the events to unregister
  33515. */
  33516. static UnregisterTopRootEvents(windowElement: Window, events: {
  33517. name: string;
  33518. handler: Nullable<(e: FocusEvent) => any>;
  33519. }[]): void;
  33520. /**
  33521. * @ignore
  33522. */
  33523. static _ScreenshotCanvas: HTMLCanvasElement;
  33524. /**
  33525. * Dumps the current bound framebuffer
  33526. * @param width defines the rendering width
  33527. * @param height defines the rendering height
  33528. * @param engine defines the hosting engine
  33529. * @param successCallback defines the callback triggered once the data are available
  33530. * @param mimeType defines the mime type of the result
  33531. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  33532. */
  33533. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33534. /**
  33535. * Converts the canvas data to blob.
  33536. * This acts as a polyfill for browsers not supporting the to blob function.
  33537. * @param canvas Defines the canvas to extract the data from
  33538. * @param successCallback Defines the callback triggered once the data are available
  33539. * @param mimeType Defines the mime type of the result
  33540. */
  33541. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  33542. /**
  33543. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  33544. * @param successCallback defines the callback triggered once the data are available
  33545. * @param mimeType defines the mime type of the result
  33546. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  33547. */
  33548. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33549. /**
  33550. * Downloads a blob in the browser
  33551. * @param blob defines the blob to download
  33552. * @param fileName defines the name of the downloaded file
  33553. */
  33554. static Download(blob: Blob, fileName: string): void;
  33555. /**
  33556. * Captures a screenshot of the current rendering
  33557. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33558. * @param engine defines the rendering engine
  33559. * @param camera defines the source camera
  33560. * @param size This parameter can be set to a single number or to an object with the
  33561. * following (optional) properties: precision, width, height. If a single number is passed,
  33562. * it will be used for both width and height. If an object is passed, the screenshot size
  33563. * will be derived from the parameters. The precision property is a multiplier allowing
  33564. * rendering at a higher or lower resolution
  33565. * @param successCallback defines the callback receives a single parameter which contains the
  33566. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33567. * src parameter of an <img> to display it
  33568. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33569. * Check your browser for supported MIME types
  33570. */
  33571. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  33572. /**
  33573. * Captures a screenshot of the current rendering
  33574. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33575. * @param engine defines the rendering engine
  33576. * @param camera defines the source camera
  33577. * @param size This parameter can be set to a single number or to an object with the
  33578. * following (optional) properties: precision, width, height. If a single number is passed,
  33579. * it will be used for both width and height. If an object is passed, the screenshot size
  33580. * will be derived from the parameters. The precision property is a multiplier allowing
  33581. * rendering at a higher or lower resolution
  33582. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33583. * Check your browser for supported MIME types
  33584. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33585. * to the src parameter of an <img> to display it
  33586. */
  33587. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  33588. /**
  33589. * Generates an image screenshot from the specified camera.
  33590. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33591. * @param engine The engine to use for rendering
  33592. * @param camera The camera to use for rendering
  33593. * @param size This parameter can be set to a single number or to an object with the
  33594. * following (optional) properties: precision, width, height. If a single number is passed,
  33595. * it will be used for both width and height. If an object is passed, the screenshot size
  33596. * will be derived from the parameters. The precision property is a multiplier allowing
  33597. * rendering at a higher or lower resolution
  33598. * @param successCallback The callback receives a single parameter which contains the
  33599. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33600. * src parameter of an <img> to display it
  33601. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33602. * Check your browser for supported MIME types
  33603. * @param samples Texture samples (default: 1)
  33604. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33605. * @param fileName A name for for the downloaded file.
  33606. */
  33607. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  33608. /**
  33609. * Generates an image screenshot from the specified camera.
  33610. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33611. * @param engine The engine to use for rendering
  33612. * @param camera The camera to use for rendering
  33613. * @param size This parameter can be set to a single number or to an object with the
  33614. * following (optional) properties: precision, width, height. If a single number is passed,
  33615. * it will be used for both width and height. If an object is passed, the screenshot size
  33616. * will be derived from the parameters. The precision property is a multiplier allowing
  33617. * rendering at a higher or lower resolution
  33618. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33619. * Check your browser for supported MIME types
  33620. * @param samples Texture samples (default: 1)
  33621. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33622. * @param fileName A name for for the downloaded file.
  33623. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33624. * to the src parameter of an <img> to display it
  33625. */
  33626. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  33627. /**
  33628. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  33629. * Be aware Math.random() could cause collisions, but:
  33630. * "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"
  33631. * @returns a pseudo random id
  33632. */
  33633. static RandomId(): string;
  33634. /**
  33635. * Test if the given uri is a base64 string
  33636. * @param uri The uri to test
  33637. * @return True if the uri is a base64 string or false otherwise
  33638. */
  33639. static IsBase64(uri: string): boolean;
  33640. /**
  33641. * Decode the given base64 uri.
  33642. * @param uri The uri to decode
  33643. * @return The decoded base64 data.
  33644. */
  33645. static DecodeBase64(uri: string): ArrayBuffer;
  33646. /**
  33647. * Gets the absolute url.
  33648. * @param url the input url
  33649. * @return the absolute url
  33650. */
  33651. static GetAbsoluteUrl(url: string): string;
  33652. /**
  33653. * No log
  33654. */
  33655. static readonly NoneLogLevel: number;
  33656. /**
  33657. * Only message logs
  33658. */
  33659. static readonly MessageLogLevel: number;
  33660. /**
  33661. * Only warning logs
  33662. */
  33663. static readonly WarningLogLevel: number;
  33664. /**
  33665. * Only error logs
  33666. */
  33667. static readonly ErrorLogLevel: number;
  33668. /**
  33669. * All logs
  33670. */
  33671. static readonly AllLogLevel: number;
  33672. /**
  33673. * Gets a value indicating the number of loading errors
  33674. * @ignorenaming
  33675. */
  33676. static readonly errorsCount: number;
  33677. /**
  33678. * Callback called when a new log is added
  33679. */
  33680. static OnNewCacheEntry: (entry: string) => void;
  33681. /**
  33682. * Log a message to the console
  33683. * @param message defines the message to log
  33684. */
  33685. static Log(message: string): void;
  33686. /**
  33687. * Write a warning message to the console
  33688. * @param message defines the message to log
  33689. */
  33690. static Warn(message: string): void;
  33691. /**
  33692. * Write an error message to the console
  33693. * @param message defines the message to log
  33694. */
  33695. static Error(message: string): void;
  33696. /**
  33697. * Gets current log cache (list of logs)
  33698. */
  33699. static readonly LogCache: string;
  33700. /**
  33701. * Clears the log cache
  33702. */
  33703. static ClearLogCache(): void;
  33704. /**
  33705. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  33706. */
  33707. static LogLevels: number;
  33708. /**
  33709. * Checks if the window object exists
  33710. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  33711. */
  33712. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  33713. /**
  33714. * No performance log
  33715. */
  33716. static readonly PerformanceNoneLogLevel: number;
  33717. /**
  33718. * Use user marks to log performance
  33719. */
  33720. static readonly PerformanceUserMarkLogLevel: number;
  33721. /**
  33722. * Log performance to the console
  33723. */
  33724. static readonly PerformanceConsoleLogLevel: number;
  33725. private static _performance;
  33726. /**
  33727. * Sets the current performance log level
  33728. */
  33729. static PerformanceLogLevel: number;
  33730. private static _StartPerformanceCounterDisabled;
  33731. private static _EndPerformanceCounterDisabled;
  33732. private static _StartUserMark;
  33733. private static _EndUserMark;
  33734. private static _StartPerformanceConsole;
  33735. private static _EndPerformanceConsole;
  33736. /**
  33737. * Starts a performance counter
  33738. */
  33739. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33740. /**
  33741. * Ends a specific performance coutner
  33742. */
  33743. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33744. /**
  33745. * Gets either window.performance.now() if supported or Date.now() else
  33746. */
  33747. static readonly Now: number;
  33748. /**
  33749. * This method will return the name of the class used to create the instance of the given object.
  33750. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  33751. * @param object the object to get the class name from
  33752. * @param isType defines if the object is actually a type
  33753. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33754. */
  33755. static GetClassName(object: any, isType?: boolean): string;
  33756. /**
  33757. * Gets the first element of an array satisfying a given predicate
  33758. * @param array defines the array to browse
  33759. * @param predicate defines the predicate to use
  33760. * @returns null if not found or the element
  33761. */
  33762. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33763. /**
  33764. * This method will return the name of the full name of the class, including its owning module (if any).
  33765. * 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).
  33766. * @param object the object to get the class name from
  33767. * @param isType defines if the object is actually a type
  33768. * @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.
  33769. * @ignorenaming
  33770. */
  33771. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33772. /**
  33773. * Returns a promise that resolves after the given amount of time.
  33774. * @param delay Number of milliseconds to delay
  33775. * @returns Promise that resolves after the given amount of time
  33776. */
  33777. static DelayAsync(delay: number): Promise<void>;
  33778. }
  33779. /**
  33780. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33781. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33782. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33783. * @param name The name of the class, case should be preserved
  33784. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33785. */
  33786. export function className(name: string, module?: string): (target: Object) => void;
  33787. /**
  33788. * An implementation of a loop for asynchronous functions.
  33789. */
  33790. export class AsyncLoop {
  33791. /**
  33792. * Defines the number of iterations for the loop
  33793. */
  33794. iterations: number;
  33795. /**
  33796. * Defines the current index of the loop.
  33797. */
  33798. index: number;
  33799. private _done;
  33800. private _fn;
  33801. private _successCallback;
  33802. /**
  33803. * Constructor.
  33804. * @param iterations the number of iterations.
  33805. * @param func the function to run each iteration
  33806. * @param successCallback the callback that will be called upon succesful execution
  33807. * @param offset starting offset.
  33808. */
  33809. constructor(
  33810. /**
  33811. * Defines the number of iterations for the loop
  33812. */
  33813. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33814. /**
  33815. * Execute the next iteration. Must be called after the last iteration was finished.
  33816. */
  33817. executeNext(): void;
  33818. /**
  33819. * Break the loop and run the success callback.
  33820. */
  33821. breakLoop(): void;
  33822. /**
  33823. * Create and run an async loop.
  33824. * @param iterations the number of iterations.
  33825. * @param fn the function to run each iteration
  33826. * @param successCallback the callback that will be called upon succesful execution
  33827. * @param offset starting offset.
  33828. * @returns the created async loop object
  33829. */
  33830. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33831. /**
  33832. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33833. * @param iterations total number of iterations
  33834. * @param syncedIterations number of synchronous iterations in each async iteration.
  33835. * @param fn the function to call each iteration.
  33836. * @param callback a success call back that will be called when iterating stops.
  33837. * @param breakFunction a break condition (optional)
  33838. * @param timeout timeout settings for the setTimeout function. default - 0.
  33839. * @returns the created async loop object
  33840. */
  33841. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33842. }
  33843. }
  33844. declare module "babylonjs/Misc/stringDictionary" {
  33845. import { Nullable } from "babylonjs/types";
  33846. /**
  33847. * This class implement a typical dictionary using a string as key and the generic type T as value.
  33848. * The underlying implementation relies on an associative array to ensure the best performances.
  33849. * The value can be anything including 'null' but except 'undefined'
  33850. */
  33851. export class StringDictionary<T> {
  33852. /**
  33853. * This will clear this dictionary and copy the content from the 'source' one.
  33854. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  33855. * @param source the dictionary to take the content from and copy to this dictionary
  33856. */
  33857. copyFrom(source: StringDictionary<T>): void;
  33858. /**
  33859. * Get a value based from its key
  33860. * @param key the given key to get the matching value from
  33861. * @return the value if found, otherwise undefined is returned
  33862. */
  33863. get(key: string): T | undefined;
  33864. /**
  33865. * Get a value from its key or add it if it doesn't exist.
  33866. * This method will ensure you that a given key/data will be present in the dictionary.
  33867. * @param key the given key to get the matching value from
  33868. * @param factory the factory that will create the value if the key is not present in the dictionary.
  33869. * The factory will only be invoked if there's no data for the given key.
  33870. * @return the value corresponding to the key.
  33871. */
  33872. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  33873. /**
  33874. * Get a value from its key if present in the dictionary otherwise add it
  33875. * @param key the key to get the value from
  33876. * @param val if there's no such key/value pair in the dictionary add it with this value
  33877. * @return the value corresponding to the key
  33878. */
  33879. getOrAdd(key: string, val: T): T;
  33880. /**
  33881. * Check if there's a given key in the dictionary
  33882. * @param key the key to check for
  33883. * @return true if the key is present, false otherwise
  33884. */
  33885. contains(key: string): boolean;
  33886. /**
  33887. * Add a new key and its corresponding value
  33888. * @param key the key to add
  33889. * @param value the value corresponding to the key
  33890. * @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
  33891. */
  33892. add(key: string, value: T): boolean;
  33893. /**
  33894. * Update a specific value associated to a key
  33895. * @param key defines the key to use
  33896. * @param value defines the value to store
  33897. * @returns true if the value was updated (or false if the key was not found)
  33898. */
  33899. set(key: string, value: T): boolean;
  33900. /**
  33901. * Get the element of the given key and remove it from the dictionary
  33902. * @param key defines the key to search
  33903. * @returns the value associated with the key or null if not found
  33904. */
  33905. getAndRemove(key: string): Nullable<T>;
  33906. /**
  33907. * Remove a key/value from the dictionary.
  33908. * @param key the key to remove
  33909. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  33910. */
  33911. remove(key: string): boolean;
  33912. /**
  33913. * Clear the whole content of the dictionary
  33914. */
  33915. clear(): void;
  33916. /**
  33917. * Gets the current count
  33918. */
  33919. readonly count: number;
  33920. /**
  33921. * Execute a callback on each key/val of the dictionary.
  33922. * Note that you can remove any element in this dictionary in the callback implementation
  33923. * @param callback the callback to execute on a given key/value pair
  33924. */
  33925. forEach(callback: (key: string, val: T) => void): void;
  33926. /**
  33927. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  33928. * If the callback returns null or undefined the method will iterate to the next key/value pair
  33929. * Note that you can remove any element in this dictionary in the callback implementation
  33930. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  33931. * @returns the first item
  33932. */
  33933. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  33934. private _count;
  33935. private _data;
  33936. }
  33937. }
  33938. declare module "babylonjs/Collisions/collisionCoordinator" {
  33939. import { Nullable } from "babylonjs/types";
  33940. import { Scene } from "babylonjs/scene";
  33941. import { Vector3 } from "babylonjs/Maths/math.vector";
  33942. import { Collider } from "babylonjs/Collisions/collider";
  33943. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33944. /** @hidden */
  33945. export interface ICollisionCoordinator {
  33946. createCollider(): Collider;
  33947. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33948. init(scene: Scene): void;
  33949. }
  33950. /** @hidden */
  33951. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33952. private _scene;
  33953. private _scaledPosition;
  33954. private _scaledVelocity;
  33955. private _finalPosition;
  33956. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33957. createCollider(): Collider;
  33958. init(scene: Scene): void;
  33959. private _collideWithWorld;
  33960. }
  33961. }
  33962. declare module "babylonjs/Inputs/scene.inputManager" {
  33963. import { Nullable } from "babylonjs/types";
  33964. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33965. import { Vector2 } from "babylonjs/Maths/math.vector";
  33966. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33967. import { Scene } from "babylonjs/scene";
  33968. /**
  33969. * Class used to manage all inputs for the scene.
  33970. */
  33971. export class InputManager {
  33972. /** The distance in pixel that you have to move to prevent some events */
  33973. static DragMovementThreshold: number;
  33974. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33975. static LongPressDelay: number;
  33976. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33977. static DoubleClickDelay: number;
  33978. /** If you need to check double click without raising a single click at first click, enable this flag */
  33979. static ExclusiveDoubleClickMode: boolean;
  33980. private _wheelEventName;
  33981. private _onPointerMove;
  33982. private _onPointerDown;
  33983. private _onPointerUp;
  33984. private _initClickEvent;
  33985. private _initActionManager;
  33986. private _delayedSimpleClick;
  33987. private _delayedSimpleClickTimeout;
  33988. private _previousDelayedSimpleClickTimeout;
  33989. private _meshPickProceed;
  33990. private _previousButtonPressed;
  33991. private _currentPickResult;
  33992. private _previousPickResult;
  33993. private _totalPointersPressed;
  33994. private _doubleClickOccured;
  33995. private _pointerOverMesh;
  33996. private _pickedDownMesh;
  33997. private _pickedUpMesh;
  33998. private _pointerX;
  33999. private _pointerY;
  34000. private _unTranslatedPointerX;
  34001. private _unTranslatedPointerY;
  34002. private _startingPointerPosition;
  34003. private _previousStartingPointerPosition;
  34004. private _startingPointerTime;
  34005. private _previousStartingPointerTime;
  34006. private _pointerCaptures;
  34007. private _onKeyDown;
  34008. private _onKeyUp;
  34009. private _onCanvasFocusObserver;
  34010. private _onCanvasBlurObserver;
  34011. private _scene;
  34012. /**
  34013. * Creates a new InputManager
  34014. * @param scene defines the hosting scene
  34015. */
  34016. constructor(scene: Scene);
  34017. /**
  34018. * Gets the mesh that is currently under the pointer
  34019. */
  34020. readonly meshUnderPointer: Nullable<AbstractMesh>;
  34021. /**
  34022. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  34023. */
  34024. readonly unTranslatedPointer: Vector2;
  34025. /**
  34026. * Gets or sets the current on-screen X position of the pointer
  34027. */
  34028. pointerX: number;
  34029. /**
  34030. * Gets or sets the current on-screen Y position of the pointer
  34031. */
  34032. pointerY: number;
  34033. private _updatePointerPosition;
  34034. private _processPointerMove;
  34035. private _setRayOnPointerInfo;
  34036. private _checkPrePointerObservable;
  34037. /**
  34038. * Use this method to simulate a pointer move on a mesh
  34039. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34040. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34041. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34042. */
  34043. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  34044. /**
  34045. * Use this method to simulate a pointer down on a mesh
  34046. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34047. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34048. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34049. */
  34050. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  34051. private _processPointerDown;
  34052. /** @hidden */
  34053. _isPointerSwiping(): boolean;
  34054. /**
  34055. * Use this method to simulate a pointer up on a mesh
  34056. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34057. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34058. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34059. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  34060. */
  34061. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  34062. private _processPointerUp;
  34063. /**
  34064. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  34065. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  34066. * @returns true if the pointer was captured
  34067. */
  34068. isPointerCaptured(pointerId?: number): boolean;
  34069. /**
  34070. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  34071. * @param attachUp defines if you want to attach events to pointerup
  34072. * @param attachDown defines if you want to attach events to pointerdown
  34073. * @param attachMove defines if you want to attach events to pointermove
  34074. */
  34075. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  34076. /**
  34077. * Detaches all event handlers
  34078. */
  34079. detachControl(): void;
  34080. /**
  34081. * Force the value of meshUnderPointer
  34082. * @param mesh defines the mesh to use
  34083. */
  34084. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  34085. /**
  34086. * Gets the mesh under the pointer
  34087. * @returns a Mesh or null if no mesh is under the pointer
  34088. */
  34089. getPointerOverMesh(): Nullable<AbstractMesh>;
  34090. }
  34091. }
  34092. declare module "babylonjs/Misc/uniqueIdGenerator" {
  34093. /**
  34094. * Helper class used to generate session unique ID
  34095. */
  34096. export class UniqueIdGenerator {
  34097. private static _UniqueIdCounter;
  34098. /**
  34099. * Gets an unique (relatively to the current scene) Id
  34100. */
  34101. static readonly UniqueId: number;
  34102. }
  34103. }
  34104. declare module "babylonjs/Animations/animationGroup" {
  34105. import { Animatable } from "babylonjs/Animations/animatable";
  34106. import { Animation } from "babylonjs/Animations/animation";
  34107. import { Scene, IDisposable } from "babylonjs/scene";
  34108. import { Observable } from "babylonjs/Misc/observable";
  34109. import { Nullable } from "babylonjs/types";
  34110. import "babylonjs/Animations/animatable";
  34111. /**
  34112. * This class defines the direct association between an animation and a target
  34113. */
  34114. export class TargetedAnimation {
  34115. /**
  34116. * Animation to perform
  34117. */
  34118. animation: Animation;
  34119. /**
  34120. * Target to animate
  34121. */
  34122. target: any;
  34123. /**
  34124. * Serialize the object
  34125. * @returns the JSON object representing the current entity
  34126. */
  34127. serialize(): any;
  34128. }
  34129. /**
  34130. * Use this class to create coordinated animations on multiple targets
  34131. */
  34132. export class AnimationGroup implements IDisposable {
  34133. /** The name of the animation group */
  34134. name: string;
  34135. private _scene;
  34136. private _targetedAnimations;
  34137. private _animatables;
  34138. private _from;
  34139. private _to;
  34140. private _isStarted;
  34141. private _isPaused;
  34142. private _speedRatio;
  34143. private _loopAnimation;
  34144. /**
  34145. * Gets or sets the unique id of the node
  34146. */
  34147. uniqueId: number;
  34148. /**
  34149. * This observable will notify when one animation have ended
  34150. */
  34151. onAnimationEndObservable: Observable<TargetedAnimation>;
  34152. /**
  34153. * Observer raised when one animation loops
  34154. */
  34155. onAnimationLoopObservable: Observable<TargetedAnimation>;
  34156. /**
  34157. * Observer raised when all animations have looped
  34158. */
  34159. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  34160. /**
  34161. * This observable will notify when all animations have ended.
  34162. */
  34163. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  34164. /**
  34165. * This observable will notify when all animations have paused.
  34166. */
  34167. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  34168. /**
  34169. * This observable will notify when all animations are playing.
  34170. */
  34171. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  34172. /**
  34173. * Gets the first frame
  34174. */
  34175. readonly from: number;
  34176. /**
  34177. * Gets the last frame
  34178. */
  34179. readonly to: number;
  34180. /**
  34181. * Define if the animations are started
  34182. */
  34183. readonly isStarted: boolean;
  34184. /**
  34185. * Gets a value indicating that the current group is playing
  34186. */
  34187. readonly isPlaying: boolean;
  34188. /**
  34189. * Gets or sets the speed ratio to use for all animations
  34190. */
  34191. /**
  34192. * Gets or sets the speed ratio to use for all animations
  34193. */
  34194. speedRatio: number;
  34195. /**
  34196. * Gets or sets if all animations should loop or not
  34197. */
  34198. loopAnimation: boolean;
  34199. /**
  34200. * Gets the targeted animations for this animation group
  34201. */
  34202. readonly targetedAnimations: Array<TargetedAnimation>;
  34203. /**
  34204. * returning the list of animatables controlled by this animation group.
  34205. */
  34206. readonly animatables: Array<Animatable>;
  34207. /**
  34208. * Instantiates a new Animation Group.
  34209. * This helps managing several animations at once.
  34210. * @see http://doc.babylonjs.com/how_to/group
  34211. * @param name Defines the name of the group
  34212. * @param scene Defines the scene the group belongs to
  34213. */
  34214. constructor(
  34215. /** The name of the animation group */
  34216. name: string, scene?: Nullable<Scene>);
  34217. /**
  34218. * Add an animation (with its target) in the group
  34219. * @param animation defines the animation we want to add
  34220. * @param target defines the target of the animation
  34221. * @returns the TargetedAnimation object
  34222. */
  34223. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  34224. /**
  34225. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  34226. * It can add constant keys at begin or end
  34227. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  34228. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  34229. * @returns the animation group
  34230. */
  34231. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  34232. private _animationLoopCount;
  34233. private _animationLoopFlags;
  34234. private _processLoop;
  34235. /**
  34236. * Start all animations on given targets
  34237. * @param loop defines if animations must loop
  34238. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  34239. * @param from defines the from key (optional)
  34240. * @param to defines the to key (optional)
  34241. * @returns the current animation group
  34242. */
  34243. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  34244. /**
  34245. * Pause all animations
  34246. * @returns the animation group
  34247. */
  34248. pause(): AnimationGroup;
  34249. /**
  34250. * Play all animations to initial state
  34251. * This function will start() the animations if they were not started or will restart() them if they were paused
  34252. * @param loop defines if animations must loop
  34253. * @returns the animation group
  34254. */
  34255. play(loop?: boolean): AnimationGroup;
  34256. /**
  34257. * Reset all animations to initial state
  34258. * @returns the animation group
  34259. */
  34260. reset(): AnimationGroup;
  34261. /**
  34262. * Restart animations from key 0
  34263. * @returns the animation group
  34264. */
  34265. restart(): AnimationGroup;
  34266. /**
  34267. * Stop all animations
  34268. * @returns the animation group
  34269. */
  34270. stop(): AnimationGroup;
  34271. /**
  34272. * Set animation weight for all animatables
  34273. * @param weight defines the weight to use
  34274. * @return the animationGroup
  34275. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  34276. */
  34277. setWeightForAllAnimatables(weight: number): AnimationGroup;
  34278. /**
  34279. * Synchronize and normalize all animatables with a source animatable
  34280. * @param root defines the root animatable to synchronize with
  34281. * @return the animationGroup
  34282. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  34283. */
  34284. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  34285. /**
  34286. * Goes to a specific frame in this animation group
  34287. * @param frame the frame number to go to
  34288. * @return the animationGroup
  34289. */
  34290. goToFrame(frame: number): AnimationGroup;
  34291. /**
  34292. * Dispose all associated resources
  34293. */
  34294. dispose(): void;
  34295. private _checkAnimationGroupEnded;
  34296. /**
  34297. * Clone the current animation group and returns a copy
  34298. * @param newName defines the name of the new group
  34299. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  34300. * @returns the new aniamtion group
  34301. */
  34302. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  34303. /**
  34304. * Serializes the animationGroup to an object
  34305. * @returns Serialized object
  34306. */
  34307. serialize(): any;
  34308. /**
  34309. * Returns a new AnimationGroup object parsed from the source provided.
  34310. * @param parsedAnimationGroup defines the source
  34311. * @param scene defines the scene that will receive the animationGroup
  34312. * @returns a new AnimationGroup
  34313. */
  34314. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  34315. /**
  34316. * Returns the string "AnimationGroup"
  34317. * @returns "AnimationGroup"
  34318. */
  34319. getClassName(): string;
  34320. /**
  34321. * Creates a detailled string about the object
  34322. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  34323. * @returns a string representing the object
  34324. */
  34325. toString(fullDetails?: boolean): string;
  34326. }
  34327. }
  34328. declare module "babylonjs/scene" {
  34329. import { Nullable } from "babylonjs/types";
  34330. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34331. import { Observable } from "babylonjs/Misc/observable";
  34332. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  34333. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  34334. import { Geometry } from "babylonjs/Meshes/geometry";
  34335. import { TransformNode } from "babylonjs/Meshes/transformNode";
  34336. import { SubMesh } from "babylonjs/Meshes/subMesh";
  34337. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34338. import { Mesh } from "babylonjs/Meshes/mesh";
  34339. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  34340. import { Bone } from "babylonjs/Bones/bone";
  34341. import { Skeleton } from "babylonjs/Bones/skeleton";
  34342. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  34343. import { Camera } from "babylonjs/Cameras/camera";
  34344. import { AbstractScene } from "babylonjs/abstractScene";
  34345. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34346. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34347. import { Material } from "babylonjs/Materials/material";
  34348. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34349. import { Effect } from "babylonjs/Materials/effect";
  34350. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  34351. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  34352. import { Light } from "babylonjs/Lights/light";
  34353. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  34354. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  34355. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  34356. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  34357. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34358. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  34359. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  34360. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  34361. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  34362. import { Engine } from "babylonjs/Engines/engine";
  34363. import { Node } from "babylonjs/node";
  34364. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  34365. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34366. import { WebRequest } from "babylonjs/Misc/webRequest";
  34367. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  34368. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  34369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  34370. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  34371. import { Plane } from "babylonjs/Maths/math.plane";
  34372. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  34373. import { Ray } from "babylonjs/Culling/ray";
  34374. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  34375. import { Animation } from "babylonjs/Animations/animation";
  34376. import { Animatable } from "babylonjs/Animations/animatable";
  34377. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  34378. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34379. import { Collider } from "babylonjs/Collisions/collider";
  34380. /**
  34381. * Define an interface for all classes that will hold resources
  34382. */
  34383. export interface IDisposable {
  34384. /**
  34385. * Releases all held resources
  34386. */
  34387. dispose(): void;
  34388. }
  34389. /** Interface defining initialization parameters for Scene class */
  34390. export interface SceneOptions {
  34391. /**
  34392. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  34393. * It will improve performance when the number of geometries becomes important.
  34394. */
  34395. useGeometryUniqueIdsMap?: boolean;
  34396. /**
  34397. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  34398. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34399. */
  34400. useMaterialMeshMap?: boolean;
  34401. /**
  34402. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  34403. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34404. */
  34405. useClonedMeshhMap?: boolean;
  34406. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  34407. virtual?: boolean;
  34408. }
  34409. /**
  34410. * Represents a scene to be rendered by the engine.
  34411. * @see http://doc.babylonjs.com/features/scene
  34412. */
  34413. export class Scene extends AbstractScene implements IAnimatable {
  34414. /** The fog is deactivated */
  34415. static readonly FOGMODE_NONE: number;
  34416. /** The fog density is following an exponential function */
  34417. static readonly FOGMODE_EXP: number;
  34418. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  34419. static readonly FOGMODE_EXP2: number;
  34420. /** The fog density is following a linear function. */
  34421. static readonly FOGMODE_LINEAR: number;
  34422. /**
  34423. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  34424. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34425. */
  34426. static MinDeltaTime: number;
  34427. /**
  34428. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  34429. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34430. */
  34431. static MaxDeltaTime: number;
  34432. /**
  34433. * Factory used to create the default material.
  34434. * @param name The name of the material to create
  34435. * @param scene The scene to create the material for
  34436. * @returns The default material
  34437. */
  34438. static DefaultMaterialFactory(scene: Scene): Material;
  34439. /**
  34440. * Factory used to create the a collision coordinator.
  34441. * @returns The collision coordinator
  34442. */
  34443. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  34444. /** @hidden */
  34445. _inputManager: InputManager;
  34446. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  34447. cameraToUseForPointers: Nullable<Camera>;
  34448. /** @hidden */
  34449. readonly _isScene: boolean;
  34450. /**
  34451. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  34452. */
  34453. autoClear: boolean;
  34454. /**
  34455. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  34456. */
  34457. autoClearDepthAndStencil: boolean;
  34458. /**
  34459. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  34460. */
  34461. clearColor: Color4;
  34462. /**
  34463. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  34464. */
  34465. ambientColor: Color3;
  34466. /**
  34467. * This is use to store the default BRDF lookup for PBR materials in your scene.
  34468. * It should only be one of the following (if not the default embedded one):
  34469. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  34470. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  34471. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  34472. * The material properties need to be setup according to the type of texture in use.
  34473. */
  34474. environmentBRDFTexture: BaseTexture;
  34475. /** @hidden */
  34476. protected _environmentTexture: Nullable<BaseTexture>;
  34477. /**
  34478. * Texture used in all pbr material as the reflection texture.
  34479. * As in the majority of the scene they are the same (exception for multi room and so on),
  34480. * this is easier to reference from here than from all the materials.
  34481. */
  34482. /**
  34483. * Texture used in all pbr material as the reflection texture.
  34484. * As in the majority of the scene they are the same (exception for multi room and so on),
  34485. * this is easier to set here than in all the materials.
  34486. */
  34487. environmentTexture: Nullable<BaseTexture>;
  34488. /** @hidden */
  34489. protected _environmentIntensity: number;
  34490. /**
  34491. * Intensity of the environment in all pbr material.
  34492. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34493. * As in the majority of the scene they are the same (exception for multi room and so on),
  34494. * this is easier to reference from here than from all the materials.
  34495. */
  34496. /**
  34497. * Intensity of the environment in all pbr material.
  34498. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34499. * As in the majority of the scene they are the same (exception for multi room and so on),
  34500. * this is easier to set here than in all the materials.
  34501. */
  34502. environmentIntensity: number;
  34503. /** @hidden */
  34504. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  34505. /**
  34506. * Default image processing configuration used either in the rendering
  34507. * Forward main pass or through the imageProcessingPostProcess if present.
  34508. * As in the majority of the scene they are the same (exception for multi camera),
  34509. * this is easier to reference from here than from all the materials and post process.
  34510. *
  34511. * No setter as we it is a shared configuration, you can set the values instead.
  34512. */
  34513. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  34514. private _forceWireframe;
  34515. /**
  34516. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  34517. */
  34518. forceWireframe: boolean;
  34519. private _forcePointsCloud;
  34520. /**
  34521. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  34522. */
  34523. forcePointsCloud: boolean;
  34524. /**
  34525. * Gets or sets the active clipplane 1
  34526. */
  34527. clipPlane: Nullable<Plane>;
  34528. /**
  34529. * Gets or sets the active clipplane 2
  34530. */
  34531. clipPlane2: Nullable<Plane>;
  34532. /**
  34533. * Gets or sets the active clipplane 3
  34534. */
  34535. clipPlane3: Nullable<Plane>;
  34536. /**
  34537. * Gets or sets the active clipplane 4
  34538. */
  34539. clipPlane4: Nullable<Plane>;
  34540. /**
  34541. * Gets or sets a boolean indicating if animations are enabled
  34542. */
  34543. animationsEnabled: boolean;
  34544. private _animationPropertiesOverride;
  34545. /**
  34546. * Gets or sets the animation properties override
  34547. */
  34548. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  34549. /**
  34550. * Gets or sets a boolean indicating if a constant deltatime has to be used
  34551. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  34552. */
  34553. useConstantAnimationDeltaTime: boolean;
  34554. /**
  34555. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  34556. * Please note that it requires to run a ray cast through the scene on every frame
  34557. */
  34558. constantlyUpdateMeshUnderPointer: boolean;
  34559. /**
  34560. * Defines the HTML cursor to use when hovering over interactive elements
  34561. */
  34562. hoverCursor: string;
  34563. /**
  34564. * Defines the HTML default cursor to use (empty by default)
  34565. */
  34566. defaultCursor: string;
  34567. /**
  34568. * Defines wether cursors are handled by the scene.
  34569. */
  34570. doNotHandleCursors: boolean;
  34571. /**
  34572. * This is used to call preventDefault() on pointer down
  34573. * in order to block unwanted artifacts like system double clicks
  34574. */
  34575. preventDefaultOnPointerDown: boolean;
  34576. /**
  34577. * This is used to call preventDefault() on pointer up
  34578. * in order to block unwanted artifacts like system double clicks
  34579. */
  34580. preventDefaultOnPointerUp: boolean;
  34581. /**
  34582. * Gets or sets user defined metadata
  34583. */
  34584. metadata: any;
  34585. /**
  34586. * For internal use only. Please do not use.
  34587. */
  34588. reservedDataStore: any;
  34589. /**
  34590. * Gets the name of the plugin used to load this scene (null by default)
  34591. */
  34592. loadingPluginName: string;
  34593. /**
  34594. * Use this array to add regular expressions used to disable offline support for specific urls
  34595. */
  34596. disableOfflineSupportExceptionRules: RegExp[];
  34597. /**
  34598. * An event triggered when the scene is disposed.
  34599. */
  34600. onDisposeObservable: Observable<Scene>;
  34601. private _onDisposeObserver;
  34602. /** Sets a function to be executed when this scene is disposed. */
  34603. onDispose: () => void;
  34604. /**
  34605. * An event triggered before rendering the scene (right after animations and physics)
  34606. */
  34607. onBeforeRenderObservable: Observable<Scene>;
  34608. private _onBeforeRenderObserver;
  34609. /** Sets a function to be executed before rendering this scene */
  34610. beforeRender: Nullable<() => void>;
  34611. /**
  34612. * An event triggered after rendering the scene
  34613. */
  34614. onAfterRenderObservable: Observable<Scene>;
  34615. /**
  34616. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  34617. */
  34618. onAfterRenderCameraObservable: Observable<Camera>;
  34619. private _onAfterRenderObserver;
  34620. /** Sets a function to be executed after rendering this scene */
  34621. afterRender: Nullable<() => void>;
  34622. /**
  34623. * An event triggered before animating the scene
  34624. */
  34625. onBeforeAnimationsObservable: Observable<Scene>;
  34626. /**
  34627. * An event triggered after animations processing
  34628. */
  34629. onAfterAnimationsObservable: Observable<Scene>;
  34630. /**
  34631. * An event triggered before draw calls are ready to be sent
  34632. */
  34633. onBeforeDrawPhaseObservable: Observable<Scene>;
  34634. /**
  34635. * An event triggered after draw calls have been sent
  34636. */
  34637. onAfterDrawPhaseObservable: Observable<Scene>;
  34638. /**
  34639. * An event triggered when the scene is ready
  34640. */
  34641. onReadyObservable: Observable<Scene>;
  34642. /**
  34643. * An event triggered before rendering a camera
  34644. */
  34645. onBeforeCameraRenderObservable: Observable<Camera>;
  34646. private _onBeforeCameraRenderObserver;
  34647. /** Sets a function to be executed before rendering a camera*/
  34648. beforeCameraRender: () => void;
  34649. /**
  34650. * An event triggered after rendering a camera
  34651. */
  34652. onAfterCameraRenderObservable: Observable<Camera>;
  34653. private _onAfterCameraRenderObserver;
  34654. /** Sets a function to be executed after rendering a camera*/
  34655. afterCameraRender: () => void;
  34656. /**
  34657. * An event triggered when active meshes evaluation is about to start
  34658. */
  34659. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  34660. /**
  34661. * An event triggered when active meshes evaluation is done
  34662. */
  34663. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  34664. /**
  34665. * An event triggered when particles rendering is about to start
  34666. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34667. */
  34668. onBeforeParticlesRenderingObservable: Observable<Scene>;
  34669. /**
  34670. * An event triggered when particles rendering is done
  34671. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34672. */
  34673. onAfterParticlesRenderingObservable: Observable<Scene>;
  34674. /**
  34675. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  34676. */
  34677. onDataLoadedObservable: Observable<Scene>;
  34678. /**
  34679. * An event triggered when a camera is created
  34680. */
  34681. onNewCameraAddedObservable: Observable<Camera>;
  34682. /**
  34683. * An event triggered when a camera is removed
  34684. */
  34685. onCameraRemovedObservable: Observable<Camera>;
  34686. /**
  34687. * An event triggered when a light is created
  34688. */
  34689. onNewLightAddedObservable: Observable<Light>;
  34690. /**
  34691. * An event triggered when a light is removed
  34692. */
  34693. onLightRemovedObservable: Observable<Light>;
  34694. /**
  34695. * An event triggered when a geometry is created
  34696. */
  34697. onNewGeometryAddedObservable: Observable<Geometry>;
  34698. /**
  34699. * An event triggered when a geometry is removed
  34700. */
  34701. onGeometryRemovedObservable: Observable<Geometry>;
  34702. /**
  34703. * An event triggered when a transform node is created
  34704. */
  34705. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  34706. /**
  34707. * An event triggered when a transform node is removed
  34708. */
  34709. onTransformNodeRemovedObservable: Observable<TransformNode>;
  34710. /**
  34711. * An event triggered when a mesh is created
  34712. */
  34713. onNewMeshAddedObservable: Observable<AbstractMesh>;
  34714. /**
  34715. * An event triggered when a mesh is removed
  34716. */
  34717. onMeshRemovedObservable: Observable<AbstractMesh>;
  34718. /**
  34719. * An event triggered when a skeleton is created
  34720. */
  34721. onNewSkeletonAddedObservable: Observable<Skeleton>;
  34722. /**
  34723. * An event triggered when a skeleton is removed
  34724. */
  34725. onSkeletonRemovedObservable: Observable<Skeleton>;
  34726. /**
  34727. * An event triggered when a material is created
  34728. */
  34729. onNewMaterialAddedObservable: Observable<Material>;
  34730. /**
  34731. * An event triggered when a material is removed
  34732. */
  34733. onMaterialRemovedObservable: Observable<Material>;
  34734. /**
  34735. * An event triggered when a texture is created
  34736. */
  34737. onNewTextureAddedObservable: Observable<BaseTexture>;
  34738. /**
  34739. * An event triggered when a texture is removed
  34740. */
  34741. onTextureRemovedObservable: Observable<BaseTexture>;
  34742. /**
  34743. * An event triggered when render targets are about to be rendered
  34744. * Can happen multiple times per frame.
  34745. */
  34746. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  34747. /**
  34748. * An event triggered when render targets were rendered.
  34749. * Can happen multiple times per frame.
  34750. */
  34751. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  34752. /**
  34753. * An event triggered before calculating deterministic simulation step
  34754. */
  34755. onBeforeStepObservable: Observable<Scene>;
  34756. /**
  34757. * An event triggered after calculating deterministic simulation step
  34758. */
  34759. onAfterStepObservable: Observable<Scene>;
  34760. /**
  34761. * An event triggered when the activeCamera property is updated
  34762. */
  34763. onActiveCameraChanged: Observable<Scene>;
  34764. /**
  34765. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  34766. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34767. * 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)
  34768. */
  34769. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34770. /**
  34771. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  34772. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34773. * 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)
  34774. */
  34775. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34776. /**
  34777. * This Observable will when a mesh has been imported into the scene.
  34778. */
  34779. onMeshImportedObservable: Observable<AbstractMesh>;
  34780. /**
  34781. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  34782. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  34783. */
  34784. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  34785. /** @hidden */
  34786. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  34787. /**
  34788. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  34789. */
  34790. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  34791. /**
  34792. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  34793. */
  34794. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  34795. /**
  34796. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  34797. */
  34798. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  34799. /** Callback called when a pointer move is detected */
  34800. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34801. /** Callback called when a pointer down is detected */
  34802. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34803. /** Callback called when a pointer up is detected */
  34804. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  34805. /** Callback called when a pointer pick is detected */
  34806. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  34807. /**
  34808. * 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).
  34809. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  34810. */
  34811. onPrePointerObservable: Observable<PointerInfoPre>;
  34812. /**
  34813. * Observable event triggered each time an input event is received from the rendering canvas
  34814. */
  34815. onPointerObservable: Observable<PointerInfo>;
  34816. /**
  34817. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  34818. */
  34819. readonly unTranslatedPointer: Vector2;
  34820. /**
  34821. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  34822. */
  34823. static DragMovementThreshold: number;
  34824. /**
  34825. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  34826. */
  34827. static LongPressDelay: number;
  34828. /**
  34829. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  34830. */
  34831. static DoubleClickDelay: number;
  34832. /** If you need to check double click without raising a single click at first click, enable this flag */
  34833. static ExclusiveDoubleClickMode: boolean;
  34834. /** @hidden */
  34835. _mirroredCameraPosition: Nullable<Vector3>;
  34836. /**
  34837. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  34838. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  34839. */
  34840. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  34841. /**
  34842. * Observable event triggered each time an keyboard event is received from the hosting window
  34843. */
  34844. onKeyboardObservable: Observable<KeyboardInfo>;
  34845. private _useRightHandedSystem;
  34846. /**
  34847. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  34848. */
  34849. useRightHandedSystem: boolean;
  34850. private _timeAccumulator;
  34851. private _currentStepId;
  34852. private _currentInternalStep;
  34853. /**
  34854. * Sets the step Id used by deterministic lock step
  34855. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34856. * @param newStepId defines the step Id
  34857. */
  34858. setStepId(newStepId: number): void;
  34859. /**
  34860. * Gets the step Id used by deterministic lock step
  34861. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34862. * @returns the step Id
  34863. */
  34864. getStepId(): number;
  34865. /**
  34866. * Gets the internal step used by deterministic lock step
  34867. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34868. * @returns the internal step
  34869. */
  34870. getInternalStep(): number;
  34871. private _fogEnabled;
  34872. /**
  34873. * Gets or sets a boolean indicating if fog is enabled on this scene
  34874. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34875. * (Default is true)
  34876. */
  34877. fogEnabled: boolean;
  34878. private _fogMode;
  34879. /**
  34880. * Gets or sets the fog mode to use
  34881. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34882. * | mode | value |
  34883. * | --- | --- |
  34884. * | FOGMODE_NONE | 0 |
  34885. * | FOGMODE_EXP | 1 |
  34886. * | FOGMODE_EXP2 | 2 |
  34887. * | FOGMODE_LINEAR | 3 |
  34888. */
  34889. fogMode: number;
  34890. /**
  34891. * Gets or sets the fog color to use
  34892. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34893. * (Default is Color3(0.2, 0.2, 0.3))
  34894. */
  34895. fogColor: Color3;
  34896. /**
  34897. * Gets or sets the fog density to use
  34898. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34899. * (Default is 0.1)
  34900. */
  34901. fogDensity: number;
  34902. /**
  34903. * Gets or sets the fog start distance to use
  34904. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34905. * (Default is 0)
  34906. */
  34907. fogStart: number;
  34908. /**
  34909. * Gets or sets the fog end distance to use
  34910. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34911. * (Default is 1000)
  34912. */
  34913. fogEnd: number;
  34914. private _shadowsEnabled;
  34915. /**
  34916. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34917. */
  34918. shadowsEnabled: boolean;
  34919. private _lightsEnabled;
  34920. /**
  34921. * Gets or sets a boolean indicating if lights are enabled on this scene
  34922. */
  34923. lightsEnabled: boolean;
  34924. /** All of the active cameras added to this scene. */
  34925. activeCameras: Camera[];
  34926. /** @hidden */
  34927. _activeCamera: Nullable<Camera>;
  34928. /** Gets or sets the current active camera */
  34929. activeCamera: Nullable<Camera>;
  34930. private _defaultMaterial;
  34931. /** The default material used on meshes when no material is affected */
  34932. /** The default material used on meshes when no material is affected */
  34933. defaultMaterial: Material;
  34934. private _texturesEnabled;
  34935. /**
  34936. * Gets or sets a boolean indicating if textures are enabled on this scene
  34937. */
  34938. texturesEnabled: boolean;
  34939. /**
  34940. * Gets or sets a boolean indicating if particles are enabled on this scene
  34941. */
  34942. particlesEnabled: boolean;
  34943. /**
  34944. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34945. */
  34946. spritesEnabled: boolean;
  34947. private _skeletonsEnabled;
  34948. /**
  34949. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34950. */
  34951. skeletonsEnabled: boolean;
  34952. /**
  34953. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34954. */
  34955. lensFlaresEnabled: boolean;
  34956. /**
  34957. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34958. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34959. */
  34960. collisionsEnabled: boolean;
  34961. private _collisionCoordinator;
  34962. /** @hidden */
  34963. readonly collisionCoordinator: ICollisionCoordinator;
  34964. /**
  34965. * Defines the gravity applied to this scene (used only for collisions)
  34966. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34967. */
  34968. gravity: Vector3;
  34969. /**
  34970. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34971. */
  34972. postProcessesEnabled: boolean;
  34973. /**
  34974. * The list of postprocesses added to the scene
  34975. */
  34976. postProcesses: PostProcess[];
  34977. /**
  34978. * Gets the current postprocess manager
  34979. */
  34980. postProcessManager: PostProcessManager;
  34981. /**
  34982. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34983. */
  34984. renderTargetsEnabled: boolean;
  34985. /**
  34986. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34987. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34988. */
  34989. dumpNextRenderTargets: boolean;
  34990. /**
  34991. * The list of user defined render targets added to the scene
  34992. */
  34993. customRenderTargets: RenderTargetTexture[];
  34994. /**
  34995. * Defines if texture loading must be delayed
  34996. * If true, textures will only be loaded when they need to be rendered
  34997. */
  34998. useDelayedTextureLoading: boolean;
  34999. /**
  35000. * Gets the list of meshes imported to the scene through SceneLoader
  35001. */
  35002. importedMeshesFiles: String[];
  35003. /**
  35004. * Gets or sets a boolean indicating if probes are enabled on this scene
  35005. */
  35006. probesEnabled: boolean;
  35007. /**
  35008. * Gets or sets the current offline provider to use to store scene data
  35009. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  35010. */
  35011. offlineProvider: IOfflineProvider;
  35012. /**
  35013. * Gets or sets the action manager associated with the scene
  35014. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  35015. */
  35016. actionManager: AbstractActionManager;
  35017. private _meshesForIntersections;
  35018. /**
  35019. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  35020. */
  35021. proceduralTexturesEnabled: boolean;
  35022. private _engine;
  35023. private _totalVertices;
  35024. /** @hidden */
  35025. _activeIndices: PerfCounter;
  35026. /** @hidden */
  35027. _activeParticles: PerfCounter;
  35028. /** @hidden */
  35029. _activeBones: PerfCounter;
  35030. private _animationRatio;
  35031. /** @hidden */
  35032. _animationTimeLast: number;
  35033. /** @hidden */
  35034. _animationTime: number;
  35035. /**
  35036. * Gets or sets a general scale for animation speed
  35037. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  35038. */
  35039. animationTimeScale: number;
  35040. /** @hidden */
  35041. _cachedMaterial: Nullable<Material>;
  35042. /** @hidden */
  35043. _cachedEffect: Nullable<Effect>;
  35044. /** @hidden */
  35045. _cachedVisibility: Nullable<number>;
  35046. private _renderId;
  35047. private _frameId;
  35048. private _executeWhenReadyTimeoutId;
  35049. private _intermediateRendering;
  35050. private _viewUpdateFlag;
  35051. private _projectionUpdateFlag;
  35052. /** @hidden */
  35053. _toBeDisposed: Nullable<IDisposable>[];
  35054. private _activeRequests;
  35055. /** @hidden */
  35056. _pendingData: any[];
  35057. private _isDisposed;
  35058. /**
  35059. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  35060. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  35061. */
  35062. dispatchAllSubMeshesOfActiveMeshes: boolean;
  35063. private _activeMeshes;
  35064. private _processedMaterials;
  35065. private _renderTargets;
  35066. /** @hidden */
  35067. _activeParticleSystems: SmartArray<IParticleSystem>;
  35068. private _activeSkeletons;
  35069. private _softwareSkinnedMeshes;
  35070. private _renderingManager;
  35071. /** @hidden */
  35072. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  35073. private _transformMatrix;
  35074. private _sceneUbo;
  35075. /** @hidden */
  35076. _viewMatrix: Matrix;
  35077. private _projectionMatrix;
  35078. /** @hidden */
  35079. _forcedViewPosition: Nullable<Vector3>;
  35080. /** @hidden */
  35081. _frustumPlanes: Plane[];
  35082. /**
  35083. * Gets the list of frustum planes (built from the active camera)
  35084. */
  35085. readonly frustumPlanes: Plane[];
  35086. /**
  35087. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  35088. * This is useful if there are more lights that the maximum simulteanous authorized
  35089. */
  35090. requireLightSorting: boolean;
  35091. /** @hidden */
  35092. readonly useMaterialMeshMap: boolean;
  35093. /** @hidden */
  35094. readonly useClonedMeshhMap: boolean;
  35095. private _externalData;
  35096. private _uid;
  35097. /**
  35098. * @hidden
  35099. * Backing store of defined scene components.
  35100. */
  35101. _components: ISceneComponent[];
  35102. /**
  35103. * @hidden
  35104. * Backing store of defined scene components.
  35105. */
  35106. _serializableComponents: ISceneSerializableComponent[];
  35107. /**
  35108. * List of components to register on the next registration step.
  35109. */
  35110. private _transientComponents;
  35111. /**
  35112. * Registers the transient components if needed.
  35113. */
  35114. private _registerTransientComponents;
  35115. /**
  35116. * @hidden
  35117. * Add a component to the scene.
  35118. * Note that the ccomponent could be registered on th next frame if this is called after
  35119. * the register component stage.
  35120. * @param component Defines the component to add to the scene
  35121. */
  35122. _addComponent(component: ISceneComponent): void;
  35123. /**
  35124. * @hidden
  35125. * Gets a component from the scene.
  35126. * @param name defines the name of the component to retrieve
  35127. * @returns the component or null if not present
  35128. */
  35129. _getComponent(name: string): Nullable<ISceneComponent>;
  35130. /**
  35131. * @hidden
  35132. * Defines the actions happening before camera updates.
  35133. */
  35134. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  35135. /**
  35136. * @hidden
  35137. * Defines the actions happening before clear the canvas.
  35138. */
  35139. _beforeClearStage: Stage<SimpleStageAction>;
  35140. /**
  35141. * @hidden
  35142. * Defines the actions when collecting render targets for the frame.
  35143. */
  35144. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  35145. /**
  35146. * @hidden
  35147. * Defines the actions happening for one camera in the frame.
  35148. */
  35149. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  35150. /**
  35151. * @hidden
  35152. * Defines the actions happening during the per mesh ready checks.
  35153. */
  35154. _isReadyForMeshStage: Stage<MeshStageAction>;
  35155. /**
  35156. * @hidden
  35157. * Defines the actions happening before evaluate active mesh checks.
  35158. */
  35159. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  35160. /**
  35161. * @hidden
  35162. * Defines the actions happening during the evaluate sub mesh checks.
  35163. */
  35164. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  35165. /**
  35166. * @hidden
  35167. * Defines the actions happening during the active mesh stage.
  35168. */
  35169. _activeMeshStage: Stage<ActiveMeshStageAction>;
  35170. /**
  35171. * @hidden
  35172. * Defines the actions happening during the per camera render target step.
  35173. */
  35174. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  35175. /**
  35176. * @hidden
  35177. * Defines the actions happening just before the active camera is drawing.
  35178. */
  35179. _beforeCameraDrawStage: Stage<CameraStageAction>;
  35180. /**
  35181. * @hidden
  35182. * Defines the actions happening just before a render target is drawing.
  35183. */
  35184. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  35185. /**
  35186. * @hidden
  35187. * Defines the actions happening just before a rendering group is drawing.
  35188. */
  35189. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  35190. /**
  35191. * @hidden
  35192. * Defines the actions happening just before a mesh is drawing.
  35193. */
  35194. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  35195. /**
  35196. * @hidden
  35197. * Defines the actions happening just after a mesh has been drawn.
  35198. */
  35199. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  35200. /**
  35201. * @hidden
  35202. * Defines the actions happening just after a rendering group has been drawn.
  35203. */
  35204. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  35205. /**
  35206. * @hidden
  35207. * Defines the actions happening just after the active camera has been drawn.
  35208. */
  35209. _afterCameraDrawStage: Stage<CameraStageAction>;
  35210. /**
  35211. * @hidden
  35212. * Defines the actions happening just after a render target has been drawn.
  35213. */
  35214. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  35215. /**
  35216. * @hidden
  35217. * Defines the actions happening just after rendering all cameras and computing intersections.
  35218. */
  35219. _afterRenderStage: Stage<SimpleStageAction>;
  35220. /**
  35221. * @hidden
  35222. * Defines the actions happening when a pointer move event happens.
  35223. */
  35224. _pointerMoveStage: Stage<PointerMoveStageAction>;
  35225. /**
  35226. * @hidden
  35227. * Defines the actions happening when a pointer down event happens.
  35228. */
  35229. _pointerDownStage: Stage<PointerUpDownStageAction>;
  35230. /**
  35231. * @hidden
  35232. * Defines the actions happening when a pointer up event happens.
  35233. */
  35234. _pointerUpStage: Stage<PointerUpDownStageAction>;
  35235. /**
  35236. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  35237. */
  35238. private geometriesByUniqueId;
  35239. /**
  35240. * Creates a new Scene
  35241. * @param engine defines the engine to use to render this scene
  35242. * @param options defines the scene options
  35243. */
  35244. constructor(engine: Engine, options?: SceneOptions);
  35245. /**
  35246. * Gets a string idenfifying the name of the class
  35247. * @returns "Scene" string
  35248. */
  35249. getClassName(): string;
  35250. private _defaultMeshCandidates;
  35251. /**
  35252. * @hidden
  35253. */
  35254. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  35255. private _defaultSubMeshCandidates;
  35256. /**
  35257. * @hidden
  35258. */
  35259. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  35260. /**
  35261. * Sets the default candidate providers for the scene.
  35262. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  35263. * and getCollidingSubMeshCandidates to their default function
  35264. */
  35265. setDefaultCandidateProviders(): void;
  35266. /**
  35267. * Gets the mesh that is currently under the pointer
  35268. */
  35269. readonly meshUnderPointer: Nullable<AbstractMesh>;
  35270. /**
  35271. * Gets or sets the current on-screen X position of the pointer
  35272. */
  35273. pointerX: number;
  35274. /**
  35275. * Gets or sets the current on-screen Y position of the pointer
  35276. */
  35277. pointerY: number;
  35278. /**
  35279. * Gets the cached material (ie. the latest rendered one)
  35280. * @returns the cached material
  35281. */
  35282. getCachedMaterial(): Nullable<Material>;
  35283. /**
  35284. * Gets the cached effect (ie. the latest rendered one)
  35285. * @returns the cached effect
  35286. */
  35287. getCachedEffect(): Nullable<Effect>;
  35288. /**
  35289. * Gets the cached visibility state (ie. the latest rendered one)
  35290. * @returns the cached visibility state
  35291. */
  35292. getCachedVisibility(): Nullable<number>;
  35293. /**
  35294. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  35295. * @param material defines the current material
  35296. * @param effect defines the current effect
  35297. * @param visibility defines the current visibility state
  35298. * @returns true if one parameter is not cached
  35299. */
  35300. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  35301. /**
  35302. * Gets the engine associated with the scene
  35303. * @returns an Engine
  35304. */
  35305. getEngine(): Engine;
  35306. /**
  35307. * Gets the total number of vertices rendered per frame
  35308. * @returns the total number of vertices rendered per frame
  35309. */
  35310. getTotalVertices(): number;
  35311. /**
  35312. * Gets the performance counter for total vertices
  35313. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35314. */
  35315. readonly totalVerticesPerfCounter: PerfCounter;
  35316. /**
  35317. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  35318. * @returns the total number of active indices rendered per frame
  35319. */
  35320. getActiveIndices(): number;
  35321. /**
  35322. * Gets the performance counter for active indices
  35323. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35324. */
  35325. readonly totalActiveIndicesPerfCounter: PerfCounter;
  35326. /**
  35327. * Gets the total number of active particles rendered per frame
  35328. * @returns the total number of active particles rendered per frame
  35329. */
  35330. getActiveParticles(): number;
  35331. /**
  35332. * Gets the performance counter for active particles
  35333. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35334. */
  35335. readonly activeParticlesPerfCounter: PerfCounter;
  35336. /**
  35337. * Gets the total number of active bones rendered per frame
  35338. * @returns the total number of active bones rendered per frame
  35339. */
  35340. getActiveBones(): number;
  35341. /**
  35342. * Gets the performance counter for active bones
  35343. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35344. */
  35345. readonly activeBonesPerfCounter: PerfCounter;
  35346. /**
  35347. * Gets the array of active meshes
  35348. * @returns an array of AbstractMesh
  35349. */
  35350. getActiveMeshes(): SmartArray<AbstractMesh>;
  35351. /**
  35352. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  35353. * @returns a number
  35354. */
  35355. getAnimationRatio(): number;
  35356. /**
  35357. * Gets an unique Id for the current render phase
  35358. * @returns a number
  35359. */
  35360. getRenderId(): number;
  35361. /**
  35362. * Gets an unique Id for the current frame
  35363. * @returns a number
  35364. */
  35365. getFrameId(): number;
  35366. /** Call this function if you want to manually increment the render Id*/
  35367. incrementRenderId(): void;
  35368. private _createUbo;
  35369. /**
  35370. * Use this method to simulate a pointer move on a mesh
  35371. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35372. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35373. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35374. * @returns the current scene
  35375. */
  35376. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35377. /**
  35378. * Use this method to simulate a pointer down on a mesh
  35379. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35380. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35381. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35382. * @returns the current scene
  35383. */
  35384. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35385. /**
  35386. * Use this method to simulate a pointer up on a mesh
  35387. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35388. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35389. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35390. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  35391. * @returns the current scene
  35392. */
  35393. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  35394. /**
  35395. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  35396. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  35397. * @returns true if the pointer was captured
  35398. */
  35399. isPointerCaptured(pointerId?: number): boolean;
  35400. /**
  35401. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  35402. * @param attachUp defines if you want to attach events to pointerup
  35403. * @param attachDown defines if you want to attach events to pointerdown
  35404. * @param attachMove defines if you want to attach events to pointermove
  35405. */
  35406. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  35407. /** Detaches all event handlers*/
  35408. detachControl(): void;
  35409. /**
  35410. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  35411. * Delay loaded resources are not taking in account
  35412. * @return true if all required resources are ready
  35413. */
  35414. isReady(): boolean;
  35415. /** Resets all cached information relative to material (including effect and visibility) */
  35416. resetCachedMaterial(): void;
  35417. /**
  35418. * Registers a function to be called before every frame render
  35419. * @param func defines the function to register
  35420. */
  35421. registerBeforeRender(func: () => void): void;
  35422. /**
  35423. * Unregisters a function called before every frame render
  35424. * @param func defines the function to unregister
  35425. */
  35426. unregisterBeforeRender(func: () => void): void;
  35427. /**
  35428. * Registers a function to be called after every frame render
  35429. * @param func defines the function to register
  35430. */
  35431. registerAfterRender(func: () => void): void;
  35432. /**
  35433. * Unregisters a function called after every frame render
  35434. * @param func defines the function to unregister
  35435. */
  35436. unregisterAfterRender(func: () => void): void;
  35437. private _executeOnceBeforeRender;
  35438. /**
  35439. * The provided function will run before render once and will be disposed afterwards.
  35440. * A timeout delay can be provided so that the function will be executed in N ms.
  35441. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  35442. * @param func The function to be executed.
  35443. * @param timeout optional delay in ms
  35444. */
  35445. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  35446. /** @hidden */
  35447. _addPendingData(data: any): void;
  35448. /** @hidden */
  35449. _removePendingData(data: any): void;
  35450. /**
  35451. * Returns the number of items waiting to be loaded
  35452. * @returns the number of items waiting to be loaded
  35453. */
  35454. getWaitingItemsCount(): number;
  35455. /**
  35456. * Returns a boolean indicating if the scene is still loading data
  35457. */
  35458. readonly isLoading: boolean;
  35459. /**
  35460. * Registers a function to be executed when the scene is ready
  35461. * @param {Function} func - the function to be executed
  35462. */
  35463. executeWhenReady(func: () => void): void;
  35464. /**
  35465. * Returns a promise that resolves when the scene is ready
  35466. * @returns A promise that resolves when the scene is ready
  35467. */
  35468. whenReadyAsync(): Promise<void>;
  35469. /** @hidden */
  35470. _checkIsReady(): void;
  35471. /**
  35472. * Gets all animatable attached to the scene
  35473. */
  35474. readonly animatables: Animatable[];
  35475. /**
  35476. * Resets the last animation time frame.
  35477. * Useful to override when animations start running when loading a scene for the first time.
  35478. */
  35479. resetLastAnimationTimeFrame(): void;
  35480. /**
  35481. * Gets the current view matrix
  35482. * @returns a Matrix
  35483. */
  35484. getViewMatrix(): Matrix;
  35485. /**
  35486. * Gets the current projection matrix
  35487. * @returns a Matrix
  35488. */
  35489. getProjectionMatrix(): Matrix;
  35490. /**
  35491. * Gets the current transform matrix
  35492. * @returns a Matrix made of View * Projection
  35493. */
  35494. getTransformMatrix(): Matrix;
  35495. /**
  35496. * Sets the current transform matrix
  35497. * @param viewL defines the View matrix to use
  35498. * @param projectionL defines the Projection matrix to use
  35499. * @param viewR defines the right View matrix to use (if provided)
  35500. * @param projectionR defines the right Projection matrix to use (if provided)
  35501. */
  35502. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  35503. /**
  35504. * Gets the uniform buffer used to store scene data
  35505. * @returns a UniformBuffer
  35506. */
  35507. getSceneUniformBuffer(): UniformBuffer;
  35508. /**
  35509. * Gets an unique (relatively to the current scene) Id
  35510. * @returns an unique number for the scene
  35511. */
  35512. getUniqueId(): number;
  35513. /**
  35514. * Add a mesh to the list of scene's meshes
  35515. * @param newMesh defines the mesh to add
  35516. * @param recursive if all child meshes should also be added to the scene
  35517. */
  35518. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  35519. /**
  35520. * Remove a mesh for the list of scene's meshes
  35521. * @param toRemove defines the mesh to remove
  35522. * @param recursive if all child meshes should also be removed from the scene
  35523. * @returns the index where the mesh was in the mesh list
  35524. */
  35525. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  35526. /**
  35527. * Add a transform node to the list of scene's transform nodes
  35528. * @param newTransformNode defines the transform node to add
  35529. */
  35530. addTransformNode(newTransformNode: TransformNode): void;
  35531. /**
  35532. * Remove a transform node for the list of scene's transform nodes
  35533. * @param toRemove defines the transform node to remove
  35534. * @returns the index where the transform node was in the transform node list
  35535. */
  35536. removeTransformNode(toRemove: TransformNode): number;
  35537. /**
  35538. * Remove a skeleton for the list of scene's skeletons
  35539. * @param toRemove defines the skeleton to remove
  35540. * @returns the index where the skeleton was in the skeleton list
  35541. */
  35542. removeSkeleton(toRemove: Skeleton): number;
  35543. /**
  35544. * Remove a morph target for the list of scene's morph targets
  35545. * @param toRemove defines the morph target to remove
  35546. * @returns the index where the morph target was in the morph target list
  35547. */
  35548. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  35549. /**
  35550. * Remove a light for the list of scene's lights
  35551. * @param toRemove defines the light to remove
  35552. * @returns the index where the light was in the light list
  35553. */
  35554. removeLight(toRemove: Light): number;
  35555. /**
  35556. * Remove a camera for the list of scene's cameras
  35557. * @param toRemove defines the camera to remove
  35558. * @returns the index where the camera was in the camera list
  35559. */
  35560. removeCamera(toRemove: Camera): number;
  35561. /**
  35562. * Remove a particle system for the list of scene's particle systems
  35563. * @param toRemove defines the particle system to remove
  35564. * @returns the index where the particle system was in the particle system list
  35565. */
  35566. removeParticleSystem(toRemove: IParticleSystem): number;
  35567. /**
  35568. * Remove a animation for the list of scene's animations
  35569. * @param toRemove defines the animation to remove
  35570. * @returns the index where the animation was in the animation list
  35571. */
  35572. removeAnimation(toRemove: Animation): number;
  35573. /**
  35574. * Will stop the animation of the given target
  35575. * @param target - the target
  35576. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  35577. * @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)
  35578. */
  35579. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  35580. /**
  35581. * Removes the given animation group from this scene.
  35582. * @param toRemove The animation group to remove
  35583. * @returns The index of the removed animation group
  35584. */
  35585. removeAnimationGroup(toRemove: AnimationGroup): number;
  35586. /**
  35587. * Removes the given multi-material from this scene.
  35588. * @param toRemove The multi-material to remove
  35589. * @returns The index of the removed multi-material
  35590. */
  35591. removeMultiMaterial(toRemove: MultiMaterial): number;
  35592. /**
  35593. * Removes the given material from this scene.
  35594. * @param toRemove The material to remove
  35595. * @returns The index of the removed material
  35596. */
  35597. removeMaterial(toRemove: Material): number;
  35598. /**
  35599. * Removes the given action manager from this scene.
  35600. * @param toRemove The action manager to remove
  35601. * @returns The index of the removed action manager
  35602. */
  35603. removeActionManager(toRemove: AbstractActionManager): number;
  35604. /**
  35605. * Removes the given texture from this scene.
  35606. * @param toRemove The texture to remove
  35607. * @returns The index of the removed texture
  35608. */
  35609. removeTexture(toRemove: BaseTexture): number;
  35610. /**
  35611. * Adds the given light to this scene
  35612. * @param newLight The light to add
  35613. */
  35614. addLight(newLight: Light): void;
  35615. /**
  35616. * Sorts the list list based on light priorities
  35617. */
  35618. sortLightsByPriority(): void;
  35619. /**
  35620. * Adds the given camera to this scene
  35621. * @param newCamera The camera to add
  35622. */
  35623. addCamera(newCamera: Camera): void;
  35624. /**
  35625. * Adds the given skeleton to this scene
  35626. * @param newSkeleton The skeleton to add
  35627. */
  35628. addSkeleton(newSkeleton: Skeleton): void;
  35629. /**
  35630. * Adds the given particle system to this scene
  35631. * @param newParticleSystem The particle system to add
  35632. */
  35633. addParticleSystem(newParticleSystem: IParticleSystem): void;
  35634. /**
  35635. * Adds the given animation to this scene
  35636. * @param newAnimation The animation to add
  35637. */
  35638. addAnimation(newAnimation: Animation): void;
  35639. /**
  35640. * Adds the given animation group to this scene.
  35641. * @param newAnimationGroup The animation group to add
  35642. */
  35643. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  35644. /**
  35645. * Adds the given multi-material to this scene
  35646. * @param newMultiMaterial The multi-material to add
  35647. */
  35648. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  35649. /**
  35650. * Adds the given material to this scene
  35651. * @param newMaterial The material to add
  35652. */
  35653. addMaterial(newMaterial: Material): void;
  35654. /**
  35655. * Adds the given morph target to this scene
  35656. * @param newMorphTargetManager The morph target to add
  35657. */
  35658. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  35659. /**
  35660. * Adds the given geometry to this scene
  35661. * @param newGeometry The geometry to add
  35662. */
  35663. addGeometry(newGeometry: Geometry): void;
  35664. /**
  35665. * Adds the given action manager to this scene
  35666. * @param newActionManager The action manager to add
  35667. */
  35668. addActionManager(newActionManager: AbstractActionManager): void;
  35669. /**
  35670. * Adds the given texture to this scene.
  35671. * @param newTexture The texture to add
  35672. */
  35673. addTexture(newTexture: BaseTexture): void;
  35674. /**
  35675. * Switch active camera
  35676. * @param newCamera defines the new active camera
  35677. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  35678. */
  35679. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  35680. /**
  35681. * sets the active camera of the scene using its ID
  35682. * @param id defines the camera's ID
  35683. * @return the new active camera or null if none found.
  35684. */
  35685. setActiveCameraByID(id: string): Nullable<Camera>;
  35686. /**
  35687. * sets the active camera of the scene using its name
  35688. * @param name defines the camera's name
  35689. * @returns the new active camera or null if none found.
  35690. */
  35691. setActiveCameraByName(name: string): Nullable<Camera>;
  35692. /**
  35693. * get an animation group using its name
  35694. * @param name defines the material's name
  35695. * @return the animation group or null if none found.
  35696. */
  35697. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  35698. /**
  35699. * Get a material using its unique id
  35700. * @param uniqueId defines the material's unique id
  35701. * @return the material or null if none found.
  35702. */
  35703. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  35704. /**
  35705. * get a material using its id
  35706. * @param id defines the material's ID
  35707. * @return the material or null if none found.
  35708. */
  35709. getMaterialByID(id: string): Nullable<Material>;
  35710. /**
  35711. * Gets a the last added material using a given id
  35712. * @param id defines the material's ID
  35713. * @return the last material with the given id or null if none found.
  35714. */
  35715. getLastMaterialByID(id: string): Nullable<Material>;
  35716. /**
  35717. * Gets a material using its name
  35718. * @param name defines the material's name
  35719. * @return the material or null if none found.
  35720. */
  35721. getMaterialByName(name: string): Nullable<Material>;
  35722. /**
  35723. * Get a texture using its unique id
  35724. * @param uniqueId defines the texture's unique id
  35725. * @return the texture or null if none found.
  35726. */
  35727. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  35728. /**
  35729. * Gets a camera using its id
  35730. * @param id defines the id to look for
  35731. * @returns the camera or null if not found
  35732. */
  35733. getCameraByID(id: string): Nullable<Camera>;
  35734. /**
  35735. * Gets a camera using its unique id
  35736. * @param uniqueId defines the unique id to look for
  35737. * @returns the camera or null if not found
  35738. */
  35739. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  35740. /**
  35741. * Gets a camera using its name
  35742. * @param name defines the camera's name
  35743. * @return the camera or null if none found.
  35744. */
  35745. getCameraByName(name: string): Nullable<Camera>;
  35746. /**
  35747. * Gets a bone using its id
  35748. * @param id defines the bone's id
  35749. * @return the bone or null if not found
  35750. */
  35751. getBoneByID(id: string): Nullable<Bone>;
  35752. /**
  35753. * Gets a bone using its id
  35754. * @param name defines the bone's name
  35755. * @return the bone or null if not found
  35756. */
  35757. getBoneByName(name: string): Nullable<Bone>;
  35758. /**
  35759. * Gets a light node using its name
  35760. * @param name defines the the light's name
  35761. * @return the light or null if none found.
  35762. */
  35763. getLightByName(name: string): Nullable<Light>;
  35764. /**
  35765. * Gets a light node using its id
  35766. * @param id defines the light's id
  35767. * @return the light or null if none found.
  35768. */
  35769. getLightByID(id: string): Nullable<Light>;
  35770. /**
  35771. * Gets a light node using its scene-generated unique ID
  35772. * @param uniqueId defines the light's unique id
  35773. * @return the light or null if none found.
  35774. */
  35775. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  35776. /**
  35777. * Gets a particle system by id
  35778. * @param id defines the particle system id
  35779. * @return the corresponding system or null if none found
  35780. */
  35781. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  35782. /**
  35783. * Gets a geometry using its ID
  35784. * @param id defines the geometry's id
  35785. * @return the geometry or null if none found.
  35786. */
  35787. getGeometryByID(id: string): Nullable<Geometry>;
  35788. private _getGeometryByUniqueID;
  35789. /**
  35790. * Add a new geometry to this scene
  35791. * @param geometry defines the geometry to be added to the scene.
  35792. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  35793. * @return a boolean defining if the geometry was added or not
  35794. */
  35795. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  35796. /**
  35797. * Removes an existing geometry
  35798. * @param geometry defines the geometry to be removed from the scene
  35799. * @return a boolean defining if the geometry was removed or not
  35800. */
  35801. removeGeometry(geometry: Geometry): boolean;
  35802. /**
  35803. * Gets the list of geometries attached to the scene
  35804. * @returns an array of Geometry
  35805. */
  35806. getGeometries(): Geometry[];
  35807. /**
  35808. * Gets the first added mesh found of a given ID
  35809. * @param id defines the id to search for
  35810. * @return the mesh found or null if not found at all
  35811. */
  35812. getMeshByID(id: string): Nullable<AbstractMesh>;
  35813. /**
  35814. * Gets a list of meshes using their id
  35815. * @param id defines the id to search for
  35816. * @returns a list of meshes
  35817. */
  35818. getMeshesByID(id: string): Array<AbstractMesh>;
  35819. /**
  35820. * Gets the first added transform node found of a given ID
  35821. * @param id defines the id to search for
  35822. * @return the found transform node or null if not found at all.
  35823. */
  35824. getTransformNodeByID(id: string): Nullable<TransformNode>;
  35825. /**
  35826. * Gets a transform node with its auto-generated unique id
  35827. * @param uniqueId efines the unique id to search for
  35828. * @return the found transform node or null if not found at all.
  35829. */
  35830. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  35831. /**
  35832. * Gets a list of transform nodes using their id
  35833. * @param id defines the id to search for
  35834. * @returns a list of transform nodes
  35835. */
  35836. getTransformNodesByID(id: string): Array<TransformNode>;
  35837. /**
  35838. * Gets a mesh with its auto-generated unique id
  35839. * @param uniqueId defines the unique id to search for
  35840. * @return the found mesh or null if not found at all.
  35841. */
  35842. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  35843. /**
  35844. * Gets a the last added mesh using a given id
  35845. * @param id defines the id to search for
  35846. * @return the found mesh or null if not found at all.
  35847. */
  35848. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  35849. /**
  35850. * Gets a the last added node (Mesh, Camera, Light) using a given id
  35851. * @param id defines the id to search for
  35852. * @return the found node or null if not found at all
  35853. */
  35854. getLastEntryByID(id: string): Nullable<Node>;
  35855. /**
  35856. * Gets a node (Mesh, Camera, Light) using a given id
  35857. * @param id defines the id to search for
  35858. * @return the found node or null if not found at all
  35859. */
  35860. getNodeByID(id: string): Nullable<Node>;
  35861. /**
  35862. * Gets a node (Mesh, Camera, Light) using a given name
  35863. * @param name defines the name to search for
  35864. * @return the found node or null if not found at all.
  35865. */
  35866. getNodeByName(name: string): Nullable<Node>;
  35867. /**
  35868. * Gets a mesh using a given name
  35869. * @param name defines the name to search for
  35870. * @return the found mesh or null if not found at all.
  35871. */
  35872. getMeshByName(name: string): Nullable<AbstractMesh>;
  35873. /**
  35874. * Gets a transform node using a given name
  35875. * @param name defines the name to search for
  35876. * @return the found transform node or null if not found at all.
  35877. */
  35878. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35879. /**
  35880. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35881. * @param id defines the id to search for
  35882. * @return the found skeleton or null if not found at all.
  35883. */
  35884. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35885. /**
  35886. * Gets a skeleton using a given auto generated unique id
  35887. * @param uniqueId defines the unique id to search for
  35888. * @return the found skeleton or null if not found at all.
  35889. */
  35890. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35891. /**
  35892. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35893. * @param id defines the id to search for
  35894. * @return the found skeleton or null if not found at all.
  35895. */
  35896. getSkeletonById(id: string): Nullable<Skeleton>;
  35897. /**
  35898. * Gets a skeleton using a given name
  35899. * @param name defines the name to search for
  35900. * @return the found skeleton or null if not found at all.
  35901. */
  35902. getSkeletonByName(name: string): Nullable<Skeleton>;
  35903. /**
  35904. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35905. * @param id defines the id to search for
  35906. * @return the found morph target manager or null if not found at all.
  35907. */
  35908. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35909. /**
  35910. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35911. * @param id defines the id to search for
  35912. * @return the found morph target or null if not found at all.
  35913. */
  35914. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35915. /**
  35916. * Gets a boolean indicating if the given mesh is active
  35917. * @param mesh defines the mesh to look for
  35918. * @returns true if the mesh is in the active list
  35919. */
  35920. isActiveMesh(mesh: AbstractMesh): boolean;
  35921. /**
  35922. * Return a unique id as a string which can serve as an identifier for the scene
  35923. */
  35924. readonly uid: string;
  35925. /**
  35926. * Add an externaly attached data from its key.
  35927. * This method call will fail and return false, if such key already exists.
  35928. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35929. * @param key the unique key that identifies the data
  35930. * @param data the data object to associate to the key for this Engine instance
  35931. * @return true if no such key were already present and the data was added successfully, false otherwise
  35932. */
  35933. addExternalData<T>(key: string, data: T): boolean;
  35934. /**
  35935. * Get an externaly attached data from its key
  35936. * @param key the unique key that identifies the data
  35937. * @return the associated data, if present (can be null), or undefined if not present
  35938. */
  35939. getExternalData<T>(key: string): Nullable<T>;
  35940. /**
  35941. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35942. * @param key the unique key that identifies the data
  35943. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35944. * @return the associated data, can be null if the factory returned null.
  35945. */
  35946. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35947. /**
  35948. * Remove an externaly attached data from the Engine instance
  35949. * @param key the unique key that identifies the data
  35950. * @return true if the data was successfully removed, false if it doesn't exist
  35951. */
  35952. removeExternalData(key: string): boolean;
  35953. private _evaluateSubMesh;
  35954. /**
  35955. * Clear the processed materials smart array preventing retention point in material dispose.
  35956. */
  35957. freeProcessedMaterials(): void;
  35958. private _preventFreeActiveMeshesAndRenderingGroups;
  35959. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35960. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35961. * when disposing several meshes in a row or a hierarchy of meshes.
  35962. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35963. */
  35964. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35965. /**
  35966. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35967. */
  35968. freeActiveMeshes(): void;
  35969. /**
  35970. * Clear the info related to rendering groups preventing retention points during dispose.
  35971. */
  35972. freeRenderingGroups(): void;
  35973. /** @hidden */
  35974. _isInIntermediateRendering(): boolean;
  35975. /**
  35976. * Lambda returning the list of potentially active meshes.
  35977. */
  35978. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35979. /**
  35980. * Lambda returning the list of potentially active sub meshes.
  35981. */
  35982. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35983. /**
  35984. * Lambda returning the list of potentially intersecting sub meshes.
  35985. */
  35986. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35987. /**
  35988. * Lambda returning the list of potentially colliding sub meshes.
  35989. */
  35990. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35991. private _activeMeshesFrozen;
  35992. private _skipEvaluateActiveMeshesCompletely;
  35993. /**
  35994. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35995. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  35996. * @returns the current scene
  35997. */
  35998. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  35999. /**
  36000. * Use this function to restart evaluating active meshes on every frame
  36001. * @returns the current scene
  36002. */
  36003. unfreezeActiveMeshes(): Scene;
  36004. private _evaluateActiveMeshes;
  36005. private _activeMesh;
  36006. /**
  36007. * Update the transform matrix to update from the current active camera
  36008. * @param force defines a boolean used to force the update even if cache is up to date
  36009. */
  36010. updateTransformMatrix(force?: boolean): void;
  36011. private _bindFrameBuffer;
  36012. /** @hidden */
  36013. _allowPostProcessClearColor: boolean;
  36014. /** @hidden */
  36015. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  36016. private _processSubCameras;
  36017. private _checkIntersections;
  36018. /** @hidden */
  36019. _advancePhysicsEngineStep(step: number): void;
  36020. /**
  36021. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  36022. */
  36023. getDeterministicFrameTime: () => number;
  36024. /** @hidden */
  36025. _animate(): void;
  36026. /** Execute all animations (for a frame) */
  36027. animate(): void;
  36028. /**
  36029. * Render the scene
  36030. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  36031. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  36032. */
  36033. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  36034. /**
  36035. * Freeze all materials
  36036. * A frozen material will not be updatable but should be faster to render
  36037. */
  36038. freezeMaterials(): void;
  36039. /**
  36040. * Unfreeze all materials
  36041. * A frozen material will not be updatable but should be faster to render
  36042. */
  36043. unfreezeMaterials(): void;
  36044. /**
  36045. * Releases all held ressources
  36046. */
  36047. dispose(): void;
  36048. /**
  36049. * Gets if the scene is already disposed
  36050. */
  36051. readonly isDisposed: boolean;
  36052. /**
  36053. * Call this function to reduce memory footprint of the scene.
  36054. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  36055. */
  36056. clearCachedVertexData(): void;
  36057. /**
  36058. * This function will remove the local cached buffer data from texture.
  36059. * It will save memory but will prevent the texture from being rebuilt
  36060. */
  36061. cleanCachedTextureBuffer(): void;
  36062. /**
  36063. * Get the world extend vectors with an optional filter
  36064. *
  36065. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  36066. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  36067. */
  36068. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  36069. min: Vector3;
  36070. max: Vector3;
  36071. };
  36072. /**
  36073. * Creates a ray that can be used to pick in the scene
  36074. * @param x defines the x coordinate of the origin (on-screen)
  36075. * @param y defines the y coordinate of the origin (on-screen)
  36076. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  36077. * @param camera defines the camera to use for the picking
  36078. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  36079. * @returns a Ray
  36080. */
  36081. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  36082. /**
  36083. * Creates a ray that can be used to pick in the scene
  36084. * @param x defines the x coordinate of the origin (on-screen)
  36085. * @param y defines the y coordinate of the origin (on-screen)
  36086. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  36087. * @param result defines the ray where to store the picking ray
  36088. * @param camera defines the camera to use for the picking
  36089. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  36090. * @returns the current scene
  36091. */
  36092. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  36093. /**
  36094. * Creates a ray that can be used to pick in the scene
  36095. * @param x defines the x coordinate of the origin (on-screen)
  36096. * @param y defines the y coordinate of the origin (on-screen)
  36097. * @param camera defines the camera to use for the picking
  36098. * @returns a Ray
  36099. */
  36100. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  36101. /**
  36102. * Creates a ray that can be used to pick in the scene
  36103. * @param x defines the x coordinate of the origin (on-screen)
  36104. * @param y defines the y coordinate of the origin (on-screen)
  36105. * @param result defines the ray where to store the picking ray
  36106. * @param camera defines the camera to use for the picking
  36107. * @returns the current scene
  36108. */
  36109. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  36110. /** Launch a ray to try to pick a mesh in the scene
  36111. * @param x position on screen
  36112. * @param y position on screen
  36113. * @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
  36114. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  36115. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  36116. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36117. * @returns a PickingInfo
  36118. */
  36119. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  36120. /** Use the given ray to pick a mesh in the scene
  36121. * @param ray The ray to use to pick meshes
  36122. * @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
  36123. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  36124. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36125. * @returns a PickingInfo
  36126. */
  36127. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  36128. /**
  36129. * Launch a ray to try to pick a mesh in the scene
  36130. * @param x X position on screen
  36131. * @param y Y position on screen
  36132. * @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
  36133. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  36134. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36135. * @returns an array of PickingInfo
  36136. */
  36137. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  36138. /**
  36139. * Launch a ray to try to pick a mesh in the scene
  36140. * @param ray Ray to use
  36141. * @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
  36142. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36143. * @returns an array of PickingInfo
  36144. */
  36145. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  36146. /**
  36147. * Force the value of meshUnderPointer
  36148. * @param mesh defines the mesh to use
  36149. */
  36150. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  36151. /**
  36152. * Gets the mesh under the pointer
  36153. * @returns a Mesh or null if no mesh is under the pointer
  36154. */
  36155. getPointerOverMesh(): Nullable<AbstractMesh>;
  36156. /** @hidden */
  36157. _rebuildGeometries(): void;
  36158. /** @hidden */
  36159. _rebuildTextures(): void;
  36160. private _getByTags;
  36161. /**
  36162. * Get a list of meshes by tags
  36163. * @param tagsQuery defines the tags query to use
  36164. * @param forEach defines a predicate used to filter results
  36165. * @returns an array of Mesh
  36166. */
  36167. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  36168. /**
  36169. * Get a list of cameras by tags
  36170. * @param tagsQuery defines the tags query to use
  36171. * @param forEach defines a predicate used to filter results
  36172. * @returns an array of Camera
  36173. */
  36174. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  36175. /**
  36176. * Get a list of lights by tags
  36177. * @param tagsQuery defines the tags query to use
  36178. * @param forEach defines a predicate used to filter results
  36179. * @returns an array of Light
  36180. */
  36181. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  36182. /**
  36183. * Get a list of materials by tags
  36184. * @param tagsQuery defines the tags query to use
  36185. * @param forEach defines a predicate used to filter results
  36186. * @returns an array of Material
  36187. */
  36188. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  36189. /**
  36190. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  36191. * This allowed control for front to back rendering or reversly depending of the special needs.
  36192. *
  36193. * @param renderingGroupId The rendering group id corresponding to its index
  36194. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  36195. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  36196. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  36197. */
  36198. 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;
  36199. /**
  36200. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  36201. *
  36202. * @param renderingGroupId The rendering group id corresponding to its index
  36203. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  36204. * @param depth Automatically clears depth between groups if true and autoClear is true.
  36205. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  36206. */
  36207. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  36208. /**
  36209. * Gets the current auto clear configuration for one rendering group of the rendering
  36210. * manager.
  36211. * @param index the rendering group index to get the information for
  36212. * @returns The auto clear setup for the requested rendering group
  36213. */
  36214. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  36215. private _blockMaterialDirtyMechanism;
  36216. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  36217. blockMaterialDirtyMechanism: boolean;
  36218. /**
  36219. * Will flag all materials as dirty to trigger new shader compilation
  36220. * @param flag defines the flag used to specify which material part must be marked as dirty
  36221. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  36222. */
  36223. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  36224. /** @hidden */
  36225. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  36226. /** @hidden */
  36227. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  36228. /** @hidden */
  36229. _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  36230. /** @hidden */
  36231. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  36232. /** @hidden */
  36233. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  36234. /** @hidden */
  36235. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  36236. }
  36237. }
  36238. declare module "babylonjs/assetContainer" {
  36239. import { AbstractScene } from "babylonjs/abstractScene";
  36240. import { Scene } from "babylonjs/scene";
  36241. import { Mesh } from "babylonjs/Meshes/mesh";
  36242. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36243. import { Skeleton } from "babylonjs/Bones/skeleton";
  36244. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  36245. /**
  36246. * Set of assets to keep when moving a scene into an asset container.
  36247. */
  36248. export class KeepAssets extends AbstractScene {
  36249. }
  36250. /**
  36251. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  36252. */
  36253. export class InstantiatedEntries {
  36254. /**
  36255. * List of new root nodes (eg. nodes with no parent)
  36256. */
  36257. rootNodes: TransformNode[];
  36258. /**
  36259. * List of new skeletons
  36260. */
  36261. skeletons: Skeleton[];
  36262. /**
  36263. * List of new animation groups
  36264. */
  36265. animationGroups: AnimationGroup[];
  36266. }
  36267. /**
  36268. * Container with a set of assets that can be added or removed from a scene.
  36269. */
  36270. export class AssetContainer extends AbstractScene {
  36271. /**
  36272. * The scene the AssetContainer belongs to.
  36273. */
  36274. scene: Scene;
  36275. /**
  36276. * Instantiates an AssetContainer.
  36277. * @param scene The scene the AssetContainer belongs to.
  36278. */
  36279. constructor(scene: Scene);
  36280. /**
  36281. * Instantiate or clone all meshes and add the new ones to the scene.
  36282. * Skeletons and animation groups will all be cloned
  36283. * @param nameFunction defines an optional function used to get new names for clones
  36284. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  36285. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  36286. */
  36287. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  36288. /**
  36289. * Adds all the assets from the container to the scene.
  36290. */
  36291. addAllToScene(): void;
  36292. /**
  36293. * Removes all the assets in the container from the scene
  36294. */
  36295. removeAllFromScene(): void;
  36296. /**
  36297. * Disposes all the assets in the container
  36298. */
  36299. dispose(): void;
  36300. private _moveAssets;
  36301. /**
  36302. * Removes all the assets contained in the scene and adds them to the container.
  36303. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  36304. */
  36305. moveAllFromScene(keepAssets?: KeepAssets): void;
  36306. /**
  36307. * 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.
  36308. * @returns the root mesh
  36309. */
  36310. createRootMesh(): Mesh;
  36311. }
  36312. }
  36313. declare module "babylonjs/abstractScene" {
  36314. import { Scene } from "babylonjs/scene";
  36315. import { Nullable } from "babylonjs/types";
  36316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36317. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36318. import { Geometry } from "babylonjs/Meshes/geometry";
  36319. import { Skeleton } from "babylonjs/Bones/skeleton";
  36320. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  36321. import { AssetContainer } from "babylonjs/assetContainer";
  36322. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  36323. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  36324. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36325. import { Material } from "babylonjs/Materials/material";
  36326. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  36327. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  36328. import { Camera } from "babylonjs/Cameras/camera";
  36329. import { Light } from "babylonjs/Lights/light";
  36330. import { Node } from "babylonjs/node";
  36331. import { Animation } from "babylonjs/Animations/animation";
  36332. /**
  36333. * Defines how the parser contract is defined.
  36334. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  36335. */
  36336. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  36337. /**
  36338. * Defines how the individual parser contract is defined.
  36339. * These parser can parse an individual asset
  36340. */
  36341. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  36342. /**
  36343. * Base class of the scene acting as a container for the different elements composing a scene.
  36344. * This class is dynamically extended by the different components of the scene increasing
  36345. * flexibility and reducing coupling
  36346. */
  36347. export abstract class AbstractScene {
  36348. /**
  36349. * Stores the list of available parsers in the application.
  36350. */
  36351. private static _BabylonFileParsers;
  36352. /**
  36353. * Stores the list of available individual parsers in the application.
  36354. */
  36355. private static _IndividualBabylonFileParsers;
  36356. /**
  36357. * Adds a parser in the list of available ones
  36358. * @param name Defines the name of the parser
  36359. * @param parser Defines the parser to add
  36360. */
  36361. static AddParser(name: string, parser: BabylonFileParser): void;
  36362. /**
  36363. * Gets a general parser from the list of avaialble ones
  36364. * @param name Defines the name of the parser
  36365. * @returns the requested parser or null
  36366. */
  36367. static GetParser(name: string): Nullable<BabylonFileParser>;
  36368. /**
  36369. * Adds n individual parser in the list of available ones
  36370. * @param name Defines the name of the parser
  36371. * @param parser Defines the parser to add
  36372. */
  36373. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  36374. /**
  36375. * Gets an individual parser from the list of avaialble ones
  36376. * @param name Defines the name of the parser
  36377. * @returns the requested parser or null
  36378. */
  36379. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  36380. /**
  36381. * Parser json data and populate both a scene and its associated container object
  36382. * @param jsonData Defines the data to parse
  36383. * @param scene Defines the scene to parse the data for
  36384. * @param container Defines the container attached to the parsing sequence
  36385. * @param rootUrl Defines the root url of the data
  36386. */
  36387. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  36388. /**
  36389. * Gets the list of root nodes (ie. nodes with no parent)
  36390. */
  36391. rootNodes: Node[];
  36392. /** All of the cameras added to this scene
  36393. * @see http://doc.babylonjs.com/babylon101/cameras
  36394. */
  36395. cameras: Camera[];
  36396. /**
  36397. * All of the lights added to this scene
  36398. * @see http://doc.babylonjs.com/babylon101/lights
  36399. */
  36400. lights: Light[];
  36401. /**
  36402. * All of the (abstract) meshes added to this scene
  36403. */
  36404. meshes: AbstractMesh[];
  36405. /**
  36406. * The list of skeletons added to the scene
  36407. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  36408. */
  36409. skeletons: Skeleton[];
  36410. /**
  36411. * All of the particle systems added to this scene
  36412. * @see http://doc.babylonjs.com/babylon101/particles
  36413. */
  36414. particleSystems: IParticleSystem[];
  36415. /**
  36416. * Gets a list of Animations associated with the scene
  36417. */
  36418. animations: Animation[];
  36419. /**
  36420. * All of the animation groups added to this scene
  36421. * @see http://doc.babylonjs.com/how_to/group
  36422. */
  36423. animationGroups: AnimationGroup[];
  36424. /**
  36425. * All of the multi-materials added to this scene
  36426. * @see http://doc.babylonjs.com/how_to/multi_materials
  36427. */
  36428. multiMaterials: MultiMaterial[];
  36429. /**
  36430. * All of the materials added to this scene
  36431. * In the context of a Scene, it is not supposed to be modified manually.
  36432. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  36433. * Note also that the order of the Material within the array is not significant and might change.
  36434. * @see http://doc.babylonjs.com/babylon101/materials
  36435. */
  36436. materials: Material[];
  36437. /**
  36438. * The list of morph target managers added to the scene
  36439. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  36440. */
  36441. morphTargetManagers: MorphTargetManager[];
  36442. /**
  36443. * The list of geometries used in the scene.
  36444. */
  36445. geometries: Geometry[];
  36446. /**
  36447. * All of the tranform nodes added to this scene
  36448. * In the context of a Scene, it is not supposed to be modified manually.
  36449. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  36450. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  36451. * @see http://doc.babylonjs.com/how_to/transformnode
  36452. */
  36453. transformNodes: TransformNode[];
  36454. /**
  36455. * ActionManagers available on the scene.
  36456. */
  36457. actionManagers: AbstractActionManager[];
  36458. /**
  36459. * Textures to keep.
  36460. */
  36461. textures: BaseTexture[];
  36462. /**
  36463. * Environment texture for the scene
  36464. */
  36465. environmentTexture: Nullable<BaseTexture>;
  36466. }
  36467. }
  36468. declare module "babylonjs/Audio/sound" {
  36469. import { Observable } from "babylonjs/Misc/observable";
  36470. import { Vector3 } from "babylonjs/Maths/math.vector";
  36471. import { Nullable } from "babylonjs/types";
  36472. import { Scene } from "babylonjs/scene";
  36473. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36474. /**
  36475. * Interface used to define options for Sound class
  36476. */
  36477. export interface ISoundOptions {
  36478. /**
  36479. * Does the sound autoplay once loaded.
  36480. */
  36481. autoplay?: boolean;
  36482. /**
  36483. * Does the sound loop after it finishes playing once.
  36484. */
  36485. loop?: boolean;
  36486. /**
  36487. * Sound's volume
  36488. */
  36489. volume?: number;
  36490. /**
  36491. * Is it a spatial sound?
  36492. */
  36493. spatialSound?: boolean;
  36494. /**
  36495. * Maximum distance to hear that sound
  36496. */
  36497. maxDistance?: number;
  36498. /**
  36499. * Uses user defined attenuation function
  36500. */
  36501. useCustomAttenuation?: boolean;
  36502. /**
  36503. * Define the roll off factor of spatial sounds.
  36504. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36505. */
  36506. rolloffFactor?: number;
  36507. /**
  36508. * Define the reference distance the sound should be heard perfectly.
  36509. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36510. */
  36511. refDistance?: number;
  36512. /**
  36513. * Define the distance attenuation model the sound will follow.
  36514. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36515. */
  36516. distanceModel?: string;
  36517. /**
  36518. * Defines the playback speed (1 by default)
  36519. */
  36520. playbackRate?: number;
  36521. /**
  36522. * Defines if the sound is from a streaming source
  36523. */
  36524. streaming?: boolean;
  36525. /**
  36526. * Defines an optional length (in seconds) inside the sound file
  36527. */
  36528. length?: number;
  36529. /**
  36530. * Defines an optional offset (in seconds) inside the sound file
  36531. */
  36532. offset?: number;
  36533. /**
  36534. * If true, URLs will not be required to state the audio file codec to use.
  36535. */
  36536. skipCodecCheck?: boolean;
  36537. }
  36538. /**
  36539. * Defines a sound that can be played in the application.
  36540. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  36541. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36542. */
  36543. export class Sound {
  36544. /**
  36545. * The name of the sound in the scene.
  36546. */
  36547. name: string;
  36548. /**
  36549. * Does the sound autoplay once loaded.
  36550. */
  36551. autoplay: boolean;
  36552. /**
  36553. * Does the sound loop after it finishes playing once.
  36554. */
  36555. loop: boolean;
  36556. /**
  36557. * Does the sound use a custom attenuation curve to simulate the falloff
  36558. * happening when the source gets further away from the camera.
  36559. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36560. */
  36561. useCustomAttenuation: boolean;
  36562. /**
  36563. * The sound track id this sound belongs to.
  36564. */
  36565. soundTrackId: number;
  36566. /**
  36567. * Is this sound currently played.
  36568. */
  36569. isPlaying: boolean;
  36570. /**
  36571. * Is this sound currently paused.
  36572. */
  36573. isPaused: boolean;
  36574. /**
  36575. * Does this sound enables spatial sound.
  36576. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36577. */
  36578. spatialSound: boolean;
  36579. /**
  36580. * Define the reference distance the sound should be heard perfectly.
  36581. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36582. */
  36583. refDistance: number;
  36584. /**
  36585. * Define the roll off factor of spatial sounds.
  36586. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36587. */
  36588. rolloffFactor: number;
  36589. /**
  36590. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  36591. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36592. */
  36593. maxDistance: number;
  36594. /**
  36595. * Define the distance attenuation model the sound will follow.
  36596. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36597. */
  36598. distanceModel: string;
  36599. /**
  36600. * @hidden
  36601. * Back Compat
  36602. **/
  36603. onended: () => any;
  36604. /**
  36605. * Observable event when the current playing sound finishes.
  36606. */
  36607. onEndedObservable: Observable<Sound>;
  36608. private _panningModel;
  36609. private _playbackRate;
  36610. private _streaming;
  36611. private _startTime;
  36612. private _startOffset;
  36613. private _position;
  36614. /** @hidden */
  36615. _positionInEmitterSpace: boolean;
  36616. private _localDirection;
  36617. private _volume;
  36618. private _isReadyToPlay;
  36619. private _isDirectional;
  36620. private _readyToPlayCallback;
  36621. private _audioBuffer;
  36622. private _soundSource;
  36623. private _streamingSource;
  36624. private _soundPanner;
  36625. private _soundGain;
  36626. private _inputAudioNode;
  36627. private _outputAudioNode;
  36628. private _coneInnerAngle;
  36629. private _coneOuterAngle;
  36630. private _coneOuterGain;
  36631. private _scene;
  36632. private _connectedTransformNode;
  36633. private _customAttenuationFunction;
  36634. private _registerFunc;
  36635. private _isOutputConnected;
  36636. private _htmlAudioElement;
  36637. private _urlType;
  36638. private _length?;
  36639. private _offset?;
  36640. /** @hidden */
  36641. static _SceneComponentInitialization: (scene: Scene) => void;
  36642. /**
  36643. * Create a sound and attach it to a scene
  36644. * @param name Name of your sound
  36645. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  36646. * @param scene defines the scene the sound belongs to
  36647. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  36648. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  36649. */
  36650. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  36651. /**
  36652. * Release the sound and its associated resources
  36653. */
  36654. dispose(): void;
  36655. /**
  36656. * Gets if the sounds is ready to be played or not.
  36657. * @returns true if ready, otherwise false
  36658. */
  36659. isReady(): boolean;
  36660. private _soundLoaded;
  36661. /**
  36662. * Sets the data of the sound from an audiobuffer
  36663. * @param audioBuffer The audioBuffer containing the data
  36664. */
  36665. setAudioBuffer(audioBuffer: AudioBuffer): void;
  36666. /**
  36667. * Updates the current sounds options such as maxdistance, loop...
  36668. * @param options A JSON object containing values named as the object properties
  36669. */
  36670. updateOptions(options: ISoundOptions): void;
  36671. private _createSpatialParameters;
  36672. private _updateSpatialParameters;
  36673. /**
  36674. * Switch the panning model to HRTF:
  36675. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36676. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36677. */
  36678. switchPanningModelToHRTF(): void;
  36679. /**
  36680. * Switch the panning model to Equal Power:
  36681. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36682. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36683. */
  36684. switchPanningModelToEqualPower(): void;
  36685. private _switchPanningModel;
  36686. /**
  36687. * Connect this sound to a sound track audio node like gain...
  36688. * @param soundTrackAudioNode the sound track audio node to connect to
  36689. */
  36690. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  36691. /**
  36692. * Transform this sound into a directional source
  36693. * @param coneInnerAngle Size of the inner cone in degree
  36694. * @param coneOuterAngle Size of the outer cone in degree
  36695. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  36696. */
  36697. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  36698. /**
  36699. * Gets or sets the inner angle for the directional cone.
  36700. */
  36701. /**
  36702. * Gets or sets the inner angle for the directional cone.
  36703. */
  36704. directionalConeInnerAngle: number;
  36705. /**
  36706. * Gets or sets the outer angle for the directional cone.
  36707. */
  36708. /**
  36709. * Gets or sets the outer angle for the directional cone.
  36710. */
  36711. directionalConeOuterAngle: number;
  36712. /**
  36713. * Sets the position of the emitter if spatial sound is enabled
  36714. * @param newPosition Defines the new posisiton
  36715. */
  36716. setPosition(newPosition: Vector3): void;
  36717. /**
  36718. * Sets the local direction of the emitter if spatial sound is enabled
  36719. * @param newLocalDirection Defines the new local direction
  36720. */
  36721. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  36722. private _updateDirection;
  36723. /** @hidden */
  36724. updateDistanceFromListener(): void;
  36725. /**
  36726. * Sets a new custom attenuation function for the sound.
  36727. * @param callback Defines the function used for the attenuation
  36728. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36729. */
  36730. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  36731. /**
  36732. * Play the sound
  36733. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  36734. * @param offset (optional) Start the sound at a specific time in seconds
  36735. * @param length (optional) Sound duration (in seconds)
  36736. */
  36737. play(time?: number, offset?: number, length?: number): void;
  36738. private _onended;
  36739. /**
  36740. * Stop the sound
  36741. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  36742. */
  36743. stop(time?: number): void;
  36744. /**
  36745. * Put the sound in pause
  36746. */
  36747. pause(): void;
  36748. /**
  36749. * Sets a dedicated volume for this sounds
  36750. * @param newVolume Define the new volume of the sound
  36751. * @param time Define time for gradual change to new volume
  36752. */
  36753. setVolume(newVolume: number, time?: number): void;
  36754. /**
  36755. * Set the sound play back rate
  36756. * @param newPlaybackRate Define the playback rate the sound should be played at
  36757. */
  36758. setPlaybackRate(newPlaybackRate: number): void;
  36759. /**
  36760. * Gets the volume of the sound.
  36761. * @returns the volume of the sound
  36762. */
  36763. getVolume(): number;
  36764. /**
  36765. * Attach the sound to a dedicated mesh
  36766. * @param transformNode The transform node to connect the sound with
  36767. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36768. */
  36769. attachToMesh(transformNode: TransformNode): void;
  36770. /**
  36771. * Detach the sound from the previously attached mesh
  36772. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36773. */
  36774. detachFromMesh(): void;
  36775. private _onRegisterAfterWorldMatrixUpdate;
  36776. /**
  36777. * Clone the current sound in the scene.
  36778. * @returns the new sound clone
  36779. */
  36780. clone(): Nullable<Sound>;
  36781. /**
  36782. * Gets the current underlying audio buffer containing the data
  36783. * @returns the audio buffer
  36784. */
  36785. getAudioBuffer(): Nullable<AudioBuffer>;
  36786. /**
  36787. * Serializes the Sound in a JSON representation
  36788. * @returns the JSON representation of the sound
  36789. */
  36790. serialize(): any;
  36791. /**
  36792. * Parse a JSON representation of a sound to innstantiate in a given scene
  36793. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  36794. * @param scene Define the scene the new parsed sound should be created in
  36795. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  36796. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  36797. * @returns the newly parsed sound
  36798. */
  36799. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  36800. }
  36801. }
  36802. declare module "babylonjs/Actions/directAudioActions" {
  36803. import { Action } from "babylonjs/Actions/action";
  36804. import { Condition } from "babylonjs/Actions/condition";
  36805. import { Sound } from "babylonjs/Audio/sound";
  36806. /**
  36807. * This defines an action helpful to play a defined sound on a triggered action.
  36808. */
  36809. export class PlaySoundAction extends Action {
  36810. private _sound;
  36811. /**
  36812. * Instantiate the action
  36813. * @param triggerOptions defines the trigger options
  36814. * @param sound defines the sound to play
  36815. * @param condition defines the trigger related conditions
  36816. */
  36817. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36818. /** @hidden */
  36819. _prepare(): void;
  36820. /**
  36821. * Execute the action and play the sound.
  36822. */
  36823. execute(): void;
  36824. /**
  36825. * Serializes the actions and its related information.
  36826. * @param parent defines the object to serialize in
  36827. * @returns the serialized object
  36828. */
  36829. serialize(parent: any): any;
  36830. }
  36831. /**
  36832. * This defines an action helpful to stop a defined sound on a triggered action.
  36833. */
  36834. export class StopSoundAction extends Action {
  36835. private _sound;
  36836. /**
  36837. * Instantiate the action
  36838. * @param triggerOptions defines the trigger options
  36839. * @param sound defines the sound to stop
  36840. * @param condition defines the trigger related conditions
  36841. */
  36842. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36843. /** @hidden */
  36844. _prepare(): void;
  36845. /**
  36846. * Execute the action and stop the sound.
  36847. */
  36848. execute(): void;
  36849. /**
  36850. * Serializes the actions and its related information.
  36851. * @param parent defines the object to serialize in
  36852. * @returns the serialized object
  36853. */
  36854. serialize(parent: any): any;
  36855. }
  36856. }
  36857. declare module "babylonjs/Actions/interpolateValueAction" {
  36858. import { Action } from "babylonjs/Actions/action";
  36859. import { Condition } from "babylonjs/Actions/condition";
  36860. import { Observable } from "babylonjs/Misc/observable";
  36861. /**
  36862. * This defines an action responsible to change the value of a property
  36863. * by interpolating between its current value and the newly set one once triggered.
  36864. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  36865. */
  36866. export class InterpolateValueAction extends Action {
  36867. /**
  36868. * Defines the path of the property where the value should be interpolated
  36869. */
  36870. propertyPath: string;
  36871. /**
  36872. * Defines the target value at the end of the interpolation.
  36873. */
  36874. value: any;
  36875. /**
  36876. * Defines the time it will take for the property to interpolate to the value.
  36877. */
  36878. duration: number;
  36879. /**
  36880. * Defines if the other scene animations should be stopped when the action has been triggered
  36881. */
  36882. stopOtherAnimations?: boolean;
  36883. /**
  36884. * Defines a callback raised once the interpolation animation has been done.
  36885. */
  36886. onInterpolationDone?: () => void;
  36887. /**
  36888. * Observable triggered once the interpolation animation has been done.
  36889. */
  36890. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  36891. private _target;
  36892. private _effectiveTarget;
  36893. private _property;
  36894. /**
  36895. * Instantiate the action
  36896. * @param triggerOptions defines the trigger options
  36897. * @param target defines the object containing the value to interpolate
  36898. * @param propertyPath defines the path to the property in the target object
  36899. * @param value defines the target value at the end of the interpolation
  36900. * @param duration deines the time it will take for the property to interpolate to the value.
  36901. * @param condition defines the trigger related conditions
  36902. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36903. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36904. */
  36905. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36906. /** @hidden */
  36907. _prepare(): void;
  36908. /**
  36909. * Execute the action starts the value interpolation.
  36910. */
  36911. execute(): void;
  36912. /**
  36913. * Serializes the actions and its related information.
  36914. * @param parent defines the object to serialize in
  36915. * @returns the serialized object
  36916. */
  36917. serialize(parent: any): any;
  36918. }
  36919. }
  36920. declare module "babylonjs/Actions/index" {
  36921. export * from "babylonjs/Actions/abstractActionManager";
  36922. export * from "babylonjs/Actions/action";
  36923. export * from "babylonjs/Actions/actionEvent";
  36924. export * from "babylonjs/Actions/actionManager";
  36925. export * from "babylonjs/Actions/condition";
  36926. export * from "babylonjs/Actions/directActions";
  36927. export * from "babylonjs/Actions/directAudioActions";
  36928. export * from "babylonjs/Actions/interpolateValueAction";
  36929. }
  36930. declare module "babylonjs/Animations/index" {
  36931. export * from "babylonjs/Animations/animatable";
  36932. export * from "babylonjs/Animations/animation";
  36933. export * from "babylonjs/Animations/animationGroup";
  36934. export * from "babylonjs/Animations/animationPropertiesOverride";
  36935. export * from "babylonjs/Animations/easing";
  36936. export * from "babylonjs/Animations/runtimeAnimation";
  36937. export * from "babylonjs/Animations/animationEvent";
  36938. export * from "babylonjs/Animations/animationGroup";
  36939. export * from "babylonjs/Animations/animationKey";
  36940. export * from "babylonjs/Animations/animationRange";
  36941. export * from "babylonjs/Animations/animatable.interface";
  36942. }
  36943. declare module "babylonjs/Audio/soundTrack" {
  36944. import { Sound } from "babylonjs/Audio/sound";
  36945. import { Analyser } from "babylonjs/Audio/analyser";
  36946. import { Scene } from "babylonjs/scene";
  36947. /**
  36948. * Options allowed during the creation of a sound track.
  36949. */
  36950. export interface ISoundTrackOptions {
  36951. /**
  36952. * The volume the sound track should take during creation
  36953. */
  36954. volume?: number;
  36955. /**
  36956. * Define if the sound track is the main sound track of the scene
  36957. */
  36958. mainTrack?: boolean;
  36959. }
  36960. /**
  36961. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36962. * It will be also used in a future release to apply effects on a specific track.
  36963. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36964. */
  36965. export class SoundTrack {
  36966. /**
  36967. * The unique identifier of the sound track in the scene.
  36968. */
  36969. id: number;
  36970. /**
  36971. * The list of sounds included in the sound track.
  36972. */
  36973. soundCollection: Array<Sound>;
  36974. private _outputAudioNode;
  36975. private _scene;
  36976. private _connectedAnalyser;
  36977. private _options;
  36978. private _isInitialized;
  36979. /**
  36980. * Creates a new sound track.
  36981. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36982. * @param scene Define the scene the sound track belongs to
  36983. * @param options
  36984. */
  36985. constructor(scene: Scene, options?: ISoundTrackOptions);
  36986. private _initializeSoundTrackAudioGraph;
  36987. /**
  36988. * Release the sound track and its associated resources
  36989. */
  36990. dispose(): void;
  36991. /**
  36992. * Adds a sound to this sound track
  36993. * @param sound define the cound to add
  36994. * @ignoreNaming
  36995. */
  36996. AddSound(sound: Sound): void;
  36997. /**
  36998. * Removes a sound to this sound track
  36999. * @param sound define the cound to remove
  37000. * @ignoreNaming
  37001. */
  37002. RemoveSound(sound: Sound): void;
  37003. /**
  37004. * Set a global volume for the full sound track.
  37005. * @param newVolume Define the new volume of the sound track
  37006. */
  37007. setVolume(newVolume: number): void;
  37008. /**
  37009. * Switch the panning model to HRTF:
  37010. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  37011. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  37012. */
  37013. switchPanningModelToHRTF(): void;
  37014. /**
  37015. * Switch the panning model to Equal Power:
  37016. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  37017. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  37018. */
  37019. switchPanningModelToEqualPower(): void;
  37020. /**
  37021. * Connect the sound track to an audio analyser allowing some amazing
  37022. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  37023. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  37024. * @param analyser The analyser to connect to the engine
  37025. */
  37026. connectToAnalyser(analyser: Analyser): void;
  37027. }
  37028. }
  37029. declare module "babylonjs/Audio/audioSceneComponent" {
  37030. import { Sound } from "babylonjs/Audio/sound";
  37031. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  37032. import { Nullable } from "babylonjs/types";
  37033. import { Vector3 } from "babylonjs/Maths/math.vector";
  37034. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  37035. import { Scene } from "babylonjs/scene";
  37036. import { AbstractScene } from "babylonjs/abstractScene";
  37037. import "babylonjs/Audio/audioEngine";
  37038. module "babylonjs/abstractScene" {
  37039. interface AbstractScene {
  37040. /**
  37041. * The list of sounds used in the scene.
  37042. */
  37043. sounds: Nullable<Array<Sound>>;
  37044. }
  37045. }
  37046. module "babylonjs/scene" {
  37047. interface Scene {
  37048. /**
  37049. * @hidden
  37050. * Backing field
  37051. */
  37052. _mainSoundTrack: SoundTrack;
  37053. /**
  37054. * The main sound track played by the scene.
  37055. * It cotains your primary collection of sounds.
  37056. */
  37057. mainSoundTrack: SoundTrack;
  37058. /**
  37059. * The list of sound tracks added to the scene
  37060. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37061. */
  37062. soundTracks: Nullable<Array<SoundTrack>>;
  37063. /**
  37064. * Gets a sound using a given name
  37065. * @param name defines the name to search for
  37066. * @return the found sound or null if not found at all.
  37067. */
  37068. getSoundByName(name: string): Nullable<Sound>;
  37069. /**
  37070. * Gets or sets if audio support is enabled
  37071. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37072. */
  37073. audioEnabled: boolean;
  37074. /**
  37075. * Gets or sets if audio will be output to headphones
  37076. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37077. */
  37078. headphone: boolean;
  37079. /**
  37080. * Gets or sets custom audio listener position provider
  37081. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37082. */
  37083. audioListenerPositionProvider: Nullable<() => Vector3>;
  37084. /**
  37085. * Gets or sets a refresh rate when using 3D audio positioning
  37086. */
  37087. audioPositioningRefreshRate: number;
  37088. }
  37089. }
  37090. /**
  37091. * Defines the sound scene component responsible to manage any sounds
  37092. * in a given scene.
  37093. */
  37094. export class AudioSceneComponent implements ISceneSerializableComponent {
  37095. /**
  37096. * The component name helpfull to identify the component in the list of scene components.
  37097. */
  37098. readonly name: string;
  37099. /**
  37100. * The scene the component belongs to.
  37101. */
  37102. scene: Scene;
  37103. private _audioEnabled;
  37104. /**
  37105. * Gets whether audio is enabled or not.
  37106. * Please use related enable/disable method to switch state.
  37107. */
  37108. readonly audioEnabled: boolean;
  37109. private _headphone;
  37110. /**
  37111. * Gets whether audio is outputing to headphone or not.
  37112. * Please use the according Switch methods to change output.
  37113. */
  37114. readonly headphone: boolean;
  37115. /**
  37116. * Gets or sets a refresh rate when using 3D audio positioning
  37117. */
  37118. audioPositioningRefreshRate: number;
  37119. private _audioListenerPositionProvider;
  37120. /**
  37121. * Gets the current audio listener position provider
  37122. */
  37123. /**
  37124. * Sets a custom listener position for all sounds in the scene
  37125. * By default, this is the position of the first active camera
  37126. */
  37127. audioListenerPositionProvider: Nullable<() => Vector3>;
  37128. /**
  37129. * Creates a new instance of the component for the given scene
  37130. * @param scene Defines the scene to register the component in
  37131. */
  37132. constructor(scene: Scene);
  37133. /**
  37134. * Registers the component in a given scene
  37135. */
  37136. register(): void;
  37137. /**
  37138. * Rebuilds the elements related to this component in case of
  37139. * context lost for instance.
  37140. */
  37141. rebuild(): void;
  37142. /**
  37143. * Serializes the component data to the specified json object
  37144. * @param serializationObject The object to serialize to
  37145. */
  37146. serialize(serializationObject: any): void;
  37147. /**
  37148. * Adds all the elements from the container to the scene
  37149. * @param container the container holding the elements
  37150. */
  37151. addFromContainer(container: AbstractScene): void;
  37152. /**
  37153. * Removes all the elements in the container from the scene
  37154. * @param container contains the elements to remove
  37155. * @param dispose if the removed element should be disposed (default: false)
  37156. */
  37157. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  37158. /**
  37159. * Disposes the component and the associated ressources.
  37160. */
  37161. dispose(): void;
  37162. /**
  37163. * Disables audio in the associated scene.
  37164. */
  37165. disableAudio(): void;
  37166. /**
  37167. * Enables audio in the associated scene.
  37168. */
  37169. enableAudio(): void;
  37170. /**
  37171. * Switch audio to headphone output.
  37172. */
  37173. switchAudioModeForHeadphones(): void;
  37174. /**
  37175. * Switch audio to normal speakers.
  37176. */
  37177. switchAudioModeForNormalSpeakers(): void;
  37178. private _cachedCameraDirection;
  37179. private _cachedCameraPosition;
  37180. private _lastCheck;
  37181. private _afterRender;
  37182. }
  37183. }
  37184. declare module "babylonjs/Audio/weightedsound" {
  37185. import { Sound } from "babylonjs/Audio/sound";
  37186. /**
  37187. * Wraps one or more Sound objects and selects one with random weight for playback.
  37188. */
  37189. export class WeightedSound {
  37190. /** When true a Sound will be selected and played when the current playing Sound completes. */
  37191. loop: boolean;
  37192. private _coneInnerAngle;
  37193. private _coneOuterAngle;
  37194. private _volume;
  37195. /** A Sound is currently playing. */
  37196. isPlaying: boolean;
  37197. /** A Sound is currently paused. */
  37198. isPaused: boolean;
  37199. private _sounds;
  37200. private _weights;
  37201. private _currentIndex?;
  37202. /**
  37203. * Creates a new WeightedSound from the list of sounds given.
  37204. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  37205. * @param sounds Array of Sounds that will be selected from.
  37206. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  37207. */
  37208. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  37209. /**
  37210. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  37211. */
  37212. /**
  37213. * The size of cone in degress for a directional sound in which there will be no attenuation.
  37214. */
  37215. directionalConeInnerAngle: number;
  37216. /**
  37217. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  37218. * Listener angles between innerAngle and outerAngle will falloff linearly.
  37219. */
  37220. /**
  37221. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  37222. * Listener angles between innerAngle and outerAngle will falloff linearly.
  37223. */
  37224. directionalConeOuterAngle: number;
  37225. /**
  37226. * Playback volume.
  37227. */
  37228. /**
  37229. * Playback volume.
  37230. */
  37231. volume: number;
  37232. private _onended;
  37233. /**
  37234. * Suspend playback
  37235. */
  37236. pause(): void;
  37237. /**
  37238. * Stop playback
  37239. */
  37240. stop(): void;
  37241. /**
  37242. * Start playback.
  37243. * @param startOffset Position the clip head at a specific time in seconds.
  37244. */
  37245. play(startOffset?: number): void;
  37246. }
  37247. }
  37248. declare module "babylonjs/Audio/index" {
  37249. export * from "babylonjs/Audio/analyser";
  37250. export * from "babylonjs/Audio/audioEngine";
  37251. export * from "babylonjs/Audio/audioSceneComponent";
  37252. export * from "babylonjs/Audio/sound";
  37253. export * from "babylonjs/Audio/soundTrack";
  37254. export * from "babylonjs/Audio/weightedsound";
  37255. }
  37256. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  37257. import { Behavior } from "babylonjs/Behaviors/behavior";
  37258. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37259. import { BackEase } from "babylonjs/Animations/easing";
  37260. /**
  37261. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  37262. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37263. */
  37264. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  37265. /**
  37266. * Gets the name of the behavior.
  37267. */
  37268. readonly name: string;
  37269. /**
  37270. * The easing function used by animations
  37271. */
  37272. static EasingFunction: BackEase;
  37273. /**
  37274. * The easing mode used by animations
  37275. */
  37276. static EasingMode: number;
  37277. /**
  37278. * The duration of the animation, in milliseconds
  37279. */
  37280. transitionDuration: number;
  37281. /**
  37282. * Length of the distance animated by the transition when lower radius is reached
  37283. */
  37284. lowerRadiusTransitionRange: number;
  37285. /**
  37286. * Length of the distance animated by the transition when upper radius is reached
  37287. */
  37288. upperRadiusTransitionRange: number;
  37289. private _autoTransitionRange;
  37290. /**
  37291. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  37292. */
  37293. /**
  37294. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  37295. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  37296. */
  37297. autoTransitionRange: boolean;
  37298. private _attachedCamera;
  37299. private _onAfterCheckInputsObserver;
  37300. private _onMeshTargetChangedObserver;
  37301. /**
  37302. * Initializes the behavior.
  37303. */
  37304. init(): void;
  37305. /**
  37306. * Attaches the behavior to its arc rotate camera.
  37307. * @param camera Defines the camera to attach the behavior to
  37308. */
  37309. attach(camera: ArcRotateCamera): void;
  37310. /**
  37311. * Detaches the behavior from its current arc rotate camera.
  37312. */
  37313. detach(): void;
  37314. private _radiusIsAnimating;
  37315. private _radiusBounceTransition;
  37316. private _animatables;
  37317. private _cachedWheelPrecision;
  37318. /**
  37319. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  37320. * @param radiusLimit The limit to check against.
  37321. * @return Bool to indicate if at limit.
  37322. */
  37323. private _isRadiusAtLimit;
  37324. /**
  37325. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  37326. * @param radiusDelta The delta by which to animate to. Can be negative.
  37327. */
  37328. private _applyBoundRadiusAnimation;
  37329. /**
  37330. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  37331. */
  37332. protected _clearAnimationLocks(): void;
  37333. /**
  37334. * Stops and removes all animations that have been applied to the camera
  37335. */
  37336. stopAllAnimations(): void;
  37337. }
  37338. }
  37339. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  37340. import { Behavior } from "babylonjs/Behaviors/behavior";
  37341. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37342. import { ExponentialEase } from "babylonjs/Animations/easing";
  37343. import { Nullable } from "babylonjs/types";
  37344. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37345. import { Vector3 } from "babylonjs/Maths/math.vector";
  37346. /**
  37347. * 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.
  37348. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37349. */
  37350. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  37351. /**
  37352. * Gets the name of the behavior.
  37353. */
  37354. readonly name: string;
  37355. private _mode;
  37356. private _radiusScale;
  37357. private _positionScale;
  37358. private _defaultElevation;
  37359. private _elevationReturnTime;
  37360. private _elevationReturnWaitTime;
  37361. private _zoomStopsAnimation;
  37362. private _framingTime;
  37363. /**
  37364. * The easing function used by animations
  37365. */
  37366. static EasingFunction: ExponentialEase;
  37367. /**
  37368. * The easing mode used by animations
  37369. */
  37370. static EasingMode: number;
  37371. /**
  37372. * Sets the current mode used by the behavior
  37373. */
  37374. /**
  37375. * Gets current mode used by the behavior.
  37376. */
  37377. mode: number;
  37378. /**
  37379. * Sets the scale applied to the radius (1 by default)
  37380. */
  37381. /**
  37382. * Gets the scale applied to the radius
  37383. */
  37384. radiusScale: number;
  37385. /**
  37386. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37387. */
  37388. /**
  37389. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37390. */
  37391. positionScale: number;
  37392. /**
  37393. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37394. * behaviour is triggered, in radians.
  37395. */
  37396. /**
  37397. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37398. * behaviour is triggered, in radians.
  37399. */
  37400. defaultElevation: number;
  37401. /**
  37402. * Sets the time (in milliseconds) taken to return to the default beta position.
  37403. * Negative value indicates camera should not return to default.
  37404. */
  37405. /**
  37406. * Gets the time (in milliseconds) taken to return to the default beta position.
  37407. * Negative value indicates camera should not return to default.
  37408. */
  37409. elevationReturnTime: number;
  37410. /**
  37411. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37412. */
  37413. /**
  37414. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37415. */
  37416. elevationReturnWaitTime: number;
  37417. /**
  37418. * Sets the flag that indicates if user zooming should stop animation.
  37419. */
  37420. /**
  37421. * Gets the flag that indicates if user zooming should stop animation.
  37422. */
  37423. zoomStopsAnimation: boolean;
  37424. /**
  37425. * Sets the transition time when framing the mesh, in milliseconds
  37426. */
  37427. /**
  37428. * Gets the transition time when framing the mesh, in milliseconds
  37429. */
  37430. framingTime: number;
  37431. /**
  37432. * Define if the behavior should automatically change the configured
  37433. * camera limits and sensibilities.
  37434. */
  37435. autoCorrectCameraLimitsAndSensibility: boolean;
  37436. private _onPrePointerObservableObserver;
  37437. private _onAfterCheckInputsObserver;
  37438. private _onMeshTargetChangedObserver;
  37439. private _attachedCamera;
  37440. private _isPointerDown;
  37441. private _lastInteractionTime;
  37442. /**
  37443. * Initializes the behavior.
  37444. */
  37445. init(): void;
  37446. /**
  37447. * Attaches the behavior to its arc rotate camera.
  37448. * @param camera Defines the camera to attach the behavior to
  37449. */
  37450. attach(camera: ArcRotateCamera): void;
  37451. /**
  37452. * Detaches the behavior from its current arc rotate camera.
  37453. */
  37454. detach(): void;
  37455. private _animatables;
  37456. private _betaIsAnimating;
  37457. private _betaTransition;
  37458. private _radiusTransition;
  37459. private _vectorTransition;
  37460. /**
  37461. * Targets the given mesh and updates zoom level accordingly.
  37462. * @param mesh The mesh to target.
  37463. * @param radius Optional. If a cached radius position already exists, overrides default.
  37464. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37465. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37466. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37467. */
  37468. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37469. /**
  37470. * Targets the given mesh with its children and updates zoom level accordingly.
  37471. * @param mesh The mesh to target.
  37472. * @param radius Optional. If a cached radius position already exists, overrides default.
  37473. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37474. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37475. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37476. */
  37477. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37478. /**
  37479. * Targets the given meshes with their children and updates zoom level accordingly.
  37480. * @param meshes The mesh to target.
  37481. * @param radius Optional. If a cached radius position already exists, overrides default.
  37482. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37483. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37484. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37485. */
  37486. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37487. /**
  37488. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  37489. * @param minimumWorld Determines the smaller position of the bounding box extend
  37490. * @param maximumWorld Determines the bigger position of the bounding box extend
  37491. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37492. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37493. */
  37494. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37495. /**
  37496. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  37497. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  37498. * frustum width.
  37499. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  37500. * to fully enclose the mesh in the viewing frustum.
  37501. */
  37502. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  37503. /**
  37504. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  37505. * is automatically returned to its default position (expected to be above ground plane).
  37506. */
  37507. private _maintainCameraAboveGround;
  37508. /**
  37509. * Returns the frustum slope based on the canvas ratio and camera FOV
  37510. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  37511. */
  37512. private _getFrustumSlope;
  37513. /**
  37514. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  37515. */
  37516. private _clearAnimationLocks;
  37517. /**
  37518. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37519. */
  37520. private _applyUserInteraction;
  37521. /**
  37522. * Stops and removes all animations that have been applied to the camera
  37523. */
  37524. stopAllAnimations(): void;
  37525. /**
  37526. * Gets a value indicating if the user is moving the camera
  37527. */
  37528. readonly isUserIsMoving: boolean;
  37529. /**
  37530. * The camera can move all the way towards the mesh.
  37531. */
  37532. static IgnoreBoundsSizeMode: number;
  37533. /**
  37534. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  37535. */
  37536. static FitFrustumSidesMode: number;
  37537. }
  37538. }
  37539. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  37540. import { Nullable } from "babylonjs/types";
  37541. import { Camera } from "babylonjs/Cameras/camera";
  37542. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37543. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37544. /**
  37545. * Base class for Camera Pointer Inputs.
  37546. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  37547. * for example usage.
  37548. */
  37549. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  37550. /**
  37551. * Defines the camera the input is attached to.
  37552. */
  37553. abstract camera: Camera;
  37554. /**
  37555. * Whether keyboard modifier keys are pressed at time of last mouse event.
  37556. */
  37557. protected _altKey: boolean;
  37558. protected _ctrlKey: boolean;
  37559. protected _metaKey: boolean;
  37560. protected _shiftKey: boolean;
  37561. /**
  37562. * Which mouse buttons were pressed at time of last mouse event.
  37563. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  37564. */
  37565. protected _buttonsPressed: number;
  37566. /**
  37567. * Defines the buttons associated with the input to handle camera move.
  37568. */
  37569. buttons: number[];
  37570. /**
  37571. * Attach the input controls to a specific dom element to get the input from.
  37572. * @param element Defines the element the controls should be listened from
  37573. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37574. */
  37575. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37576. /**
  37577. * Detach the current controls from the specified dom element.
  37578. * @param element Defines the element to stop listening the inputs from
  37579. */
  37580. detachControl(element: Nullable<HTMLElement>): void;
  37581. /**
  37582. * Gets the class name of the current input.
  37583. * @returns the class name
  37584. */
  37585. getClassName(): string;
  37586. /**
  37587. * Get the friendly name associated with the input class.
  37588. * @returns the input friendly name
  37589. */
  37590. getSimpleName(): string;
  37591. /**
  37592. * Called on pointer POINTERDOUBLETAP event.
  37593. * Override this method to provide functionality on POINTERDOUBLETAP event.
  37594. */
  37595. protected onDoubleTap(type: string): void;
  37596. /**
  37597. * Called on pointer POINTERMOVE event if only a single touch is active.
  37598. * Override this method to provide functionality.
  37599. */
  37600. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37601. /**
  37602. * Called on pointer POINTERMOVE event if multiple touches are active.
  37603. * Override this method to provide functionality.
  37604. */
  37605. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37606. /**
  37607. * Called on JS contextmenu event.
  37608. * Override this method to provide functionality.
  37609. */
  37610. protected onContextMenu(evt: PointerEvent): void;
  37611. /**
  37612. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37613. * press.
  37614. * Override this method to provide functionality.
  37615. */
  37616. protected onButtonDown(evt: PointerEvent): void;
  37617. /**
  37618. * Called each time a new POINTERUP event occurs. Ie, for each button
  37619. * release.
  37620. * Override this method to provide functionality.
  37621. */
  37622. protected onButtonUp(evt: PointerEvent): void;
  37623. /**
  37624. * Called when window becomes inactive.
  37625. * Override this method to provide functionality.
  37626. */
  37627. protected onLostFocus(): void;
  37628. private _pointerInput;
  37629. private _observer;
  37630. private _onLostFocus;
  37631. private pointA;
  37632. private pointB;
  37633. }
  37634. }
  37635. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  37636. import { Nullable } from "babylonjs/types";
  37637. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37638. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  37639. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37640. /**
  37641. * Manage the pointers inputs to control an arc rotate camera.
  37642. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37643. */
  37644. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  37645. /**
  37646. * Defines the camera the input is attached to.
  37647. */
  37648. camera: ArcRotateCamera;
  37649. /**
  37650. * Gets the class name of the current input.
  37651. * @returns the class name
  37652. */
  37653. getClassName(): string;
  37654. /**
  37655. * Defines the buttons associated with the input to handle camera move.
  37656. */
  37657. buttons: number[];
  37658. /**
  37659. * Defines the pointer angular sensibility along the X axis or how fast is
  37660. * the camera rotating.
  37661. */
  37662. angularSensibilityX: number;
  37663. /**
  37664. * Defines the pointer angular sensibility along the Y axis or how fast is
  37665. * the camera rotating.
  37666. */
  37667. angularSensibilityY: number;
  37668. /**
  37669. * Defines the pointer pinch precision or how fast is the camera zooming.
  37670. */
  37671. pinchPrecision: number;
  37672. /**
  37673. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  37674. * from 0.
  37675. * It defines the percentage of current camera.radius to use as delta when
  37676. * pinch zoom is used.
  37677. */
  37678. pinchDeltaPercentage: number;
  37679. /**
  37680. * Defines the pointer panning sensibility or how fast is the camera moving.
  37681. */
  37682. panningSensibility: number;
  37683. /**
  37684. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  37685. */
  37686. multiTouchPanning: boolean;
  37687. /**
  37688. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  37689. * zoom (pinch) through multitouch.
  37690. */
  37691. multiTouchPanAndZoom: boolean;
  37692. /**
  37693. * Revers pinch action direction.
  37694. */
  37695. pinchInwards: boolean;
  37696. private _isPanClick;
  37697. private _twoFingerActivityCount;
  37698. private _isPinching;
  37699. /**
  37700. * Called on pointer POINTERMOVE event if only a single touch is active.
  37701. */
  37702. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37703. /**
  37704. * Called on pointer POINTERDOUBLETAP event.
  37705. */
  37706. protected onDoubleTap(type: string): void;
  37707. /**
  37708. * Called on pointer POINTERMOVE event if multiple touches are active.
  37709. */
  37710. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37711. /**
  37712. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37713. * press.
  37714. */
  37715. protected onButtonDown(evt: PointerEvent): void;
  37716. /**
  37717. * Called each time a new POINTERUP event occurs. Ie, for each button
  37718. * release.
  37719. */
  37720. protected onButtonUp(evt: PointerEvent): void;
  37721. /**
  37722. * Called when window becomes inactive.
  37723. */
  37724. protected onLostFocus(): void;
  37725. }
  37726. }
  37727. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  37728. import { Nullable } from "babylonjs/types";
  37729. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37730. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37731. /**
  37732. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  37733. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37734. */
  37735. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  37736. /**
  37737. * Defines the camera the input is attached to.
  37738. */
  37739. camera: ArcRotateCamera;
  37740. /**
  37741. * Defines the list of key codes associated with the up action (increase alpha)
  37742. */
  37743. keysUp: number[];
  37744. /**
  37745. * Defines the list of key codes associated with the down action (decrease alpha)
  37746. */
  37747. keysDown: number[];
  37748. /**
  37749. * Defines the list of key codes associated with the left action (increase beta)
  37750. */
  37751. keysLeft: number[];
  37752. /**
  37753. * Defines the list of key codes associated with the right action (decrease beta)
  37754. */
  37755. keysRight: number[];
  37756. /**
  37757. * Defines the list of key codes associated with the reset action.
  37758. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  37759. */
  37760. keysReset: number[];
  37761. /**
  37762. * Defines the panning sensibility of the inputs.
  37763. * (How fast is the camera paning)
  37764. */
  37765. panningSensibility: number;
  37766. /**
  37767. * Defines the zooming sensibility of the inputs.
  37768. * (How fast is the camera zooming)
  37769. */
  37770. zoomingSensibility: number;
  37771. /**
  37772. * Defines wether maintaining the alt key down switch the movement mode from
  37773. * orientation to zoom.
  37774. */
  37775. useAltToZoom: boolean;
  37776. /**
  37777. * Rotation speed of the camera
  37778. */
  37779. angularSpeed: number;
  37780. private _keys;
  37781. private _ctrlPressed;
  37782. private _altPressed;
  37783. private _onCanvasBlurObserver;
  37784. private _onKeyboardObserver;
  37785. private _engine;
  37786. private _scene;
  37787. /**
  37788. * Attach the input controls to a specific dom element to get the input from.
  37789. * @param element Defines the element the controls should be listened from
  37790. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37791. */
  37792. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37793. /**
  37794. * Detach the current controls from the specified dom element.
  37795. * @param element Defines the element to stop listening the inputs from
  37796. */
  37797. detachControl(element: Nullable<HTMLElement>): void;
  37798. /**
  37799. * Update the current camera state depending on the inputs that have been used this frame.
  37800. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  37801. */
  37802. checkInputs(): void;
  37803. /**
  37804. * Gets the class name of the current intput.
  37805. * @returns the class name
  37806. */
  37807. getClassName(): string;
  37808. /**
  37809. * Get the friendly name associated with the input class.
  37810. * @returns the input friendly name
  37811. */
  37812. getSimpleName(): string;
  37813. }
  37814. }
  37815. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  37816. import { Nullable } from "babylonjs/types";
  37817. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37818. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37819. /**
  37820. * Manage the mouse wheel inputs to control an arc rotate camera.
  37821. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37822. */
  37823. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  37824. /**
  37825. * Defines the camera the input is attached to.
  37826. */
  37827. camera: ArcRotateCamera;
  37828. /**
  37829. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37830. */
  37831. wheelPrecision: number;
  37832. /**
  37833. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  37834. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  37835. */
  37836. wheelDeltaPercentage: number;
  37837. private _wheel;
  37838. private _observer;
  37839. private computeDeltaFromMouseWheelLegacyEvent;
  37840. /**
  37841. * Attach the input controls to a specific dom element to get the input from.
  37842. * @param element Defines the element the controls should be listened from
  37843. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37844. */
  37845. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37846. /**
  37847. * Detach the current controls from the specified dom element.
  37848. * @param element Defines the element to stop listening the inputs from
  37849. */
  37850. detachControl(element: Nullable<HTMLElement>): void;
  37851. /**
  37852. * Gets the class name of the current intput.
  37853. * @returns the class name
  37854. */
  37855. getClassName(): string;
  37856. /**
  37857. * Get the friendly name associated with the input class.
  37858. * @returns the input friendly name
  37859. */
  37860. getSimpleName(): string;
  37861. }
  37862. }
  37863. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  37864. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37865. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  37866. /**
  37867. * Default Inputs manager for the ArcRotateCamera.
  37868. * It groups all the default supported inputs for ease of use.
  37869. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37870. */
  37871. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  37872. /**
  37873. * Instantiates a new ArcRotateCameraInputsManager.
  37874. * @param camera Defines the camera the inputs belong to
  37875. */
  37876. constructor(camera: ArcRotateCamera);
  37877. /**
  37878. * Add mouse wheel input support to the input manager.
  37879. * @returns the current input manager
  37880. */
  37881. addMouseWheel(): ArcRotateCameraInputsManager;
  37882. /**
  37883. * Add pointers input support to the input manager.
  37884. * @returns the current input manager
  37885. */
  37886. addPointers(): ArcRotateCameraInputsManager;
  37887. /**
  37888. * Add keyboard input support to the input manager.
  37889. * @returns the current input manager
  37890. */
  37891. addKeyboard(): ArcRotateCameraInputsManager;
  37892. }
  37893. }
  37894. declare module "babylonjs/Cameras/arcRotateCamera" {
  37895. import { Observable } from "babylonjs/Misc/observable";
  37896. import { Nullable } from "babylonjs/types";
  37897. import { Scene } from "babylonjs/scene";
  37898. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  37899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37900. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37901. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37902. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  37903. import { Camera } from "babylonjs/Cameras/camera";
  37904. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  37905. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  37906. import { Collider } from "babylonjs/Collisions/collider";
  37907. /**
  37908. * This represents an orbital type of camera.
  37909. *
  37910. * 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.
  37911. * 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.
  37912. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  37913. */
  37914. export class ArcRotateCamera extends TargetCamera {
  37915. /**
  37916. * Defines the rotation angle of the camera along the longitudinal axis.
  37917. */
  37918. alpha: number;
  37919. /**
  37920. * Defines the rotation angle of the camera along the latitudinal axis.
  37921. */
  37922. beta: number;
  37923. /**
  37924. * Defines the radius of the camera from it s target point.
  37925. */
  37926. radius: number;
  37927. protected _target: Vector3;
  37928. protected _targetHost: Nullable<AbstractMesh>;
  37929. /**
  37930. * Defines the target point of the camera.
  37931. * The camera looks towards it form the radius distance.
  37932. */
  37933. target: Vector3;
  37934. /**
  37935. * Define the current local position of the camera in the scene
  37936. */
  37937. position: Vector3;
  37938. protected _upVector: Vector3;
  37939. protected _upToYMatrix: Matrix;
  37940. protected _YToUpMatrix: Matrix;
  37941. /**
  37942. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37943. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37944. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37945. */
  37946. upVector: Vector3;
  37947. /**
  37948. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37949. */
  37950. setMatUp(): void;
  37951. /**
  37952. * Current inertia value on the longitudinal axis.
  37953. * The bigger this number the longer it will take for the camera to stop.
  37954. */
  37955. inertialAlphaOffset: number;
  37956. /**
  37957. * Current inertia value on the latitudinal axis.
  37958. * The bigger this number the longer it will take for the camera to stop.
  37959. */
  37960. inertialBetaOffset: number;
  37961. /**
  37962. * Current inertia value on the radius axis.
  37963. * The bigger this number the longer it will take for the camera to stop.
  37964. */
  37965. inertialRadiusOffset: number;
  37966. /**
  37967. * Minimum allowed angle on the longitudinal axis.
  37968. * This can help limiting how the Camera is able to move in the scene.
  37969. */
  37970. lowerAlphaLimit: Nullable<number>;
  37971. /**
  37972. * Maximum allowed angle on the longitudinal axis.
  37973. * This can help limiting how the Camera is able to move in the scene.
  37974. */
  37975. upperAlphaLimit: Nullable<number>;
  37976. /**
  37977. * Minimum allowed angle on the latitudinal axis.
  37978. * This can help limiting how the Camera is able to move in the scene.
  37979. */
  37980. lowerBetaLimit: number;
  37981. /**
  37982. * Maximum allowed angle on the latitudinal axis.
  37983. * This can help limiting how the Camera is able to move in the scene.
  37984. */
  37985. upperBetaLimit: number;
  37986. /**
  37987. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37988. * This can help limiting how the Camera is able to move in the scene.
  37989. */
  37990. lowerRadiusLimit: Nullable<number>;
  37991. /**
  37992. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37993. * This can help limiting how the Camera is able to move in the scene.
  37994. */
  37995. upperRadiusLimit: Nullable<number>;
  37996. /**
  37997. * Defines the current inertia value used during panning of the camera along the X axis.
  37998. */
  37999. inertialPanningX: number;
  38000. /**
  38001. * Defines the current inertia value used during panning of the camera along the Y axis.
  38002. */
  38003. inertialPanningY: number;
  38004. /**
  38005. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  38006. * Basically if your fingers moves away from more than this distance you will be considered
  38007. * in pinch mode.
  38008. */
  38009. pinchToPanMaxDistance: number;
  38010. /**
  38011. * Defines the maximum distance the camera can pan.
  38012. * This could help keeping the cammera always in your scene.
  38013. */
  38014. panningDistanceLimit: Nullable<number>;
  38015. /**
  38016. * Defines the target of the camera before paning.
  38017. */
  38018. panningOriginTarget: Vector3;
  38019. /**
  38020. * Defines the value of the inertia used during panning.
  38021. * 0 would mean stop inertia and one would mean no decelleration at all.
  38022. */
  38023. panningInertia: number;
  38024. /**
  38025. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  38026. */
  38027. angularSensibilityX: number;
  38028. /**
  38029. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  38030. */
  38031. angularSensibilityY: number;
  38032. /**
  38033. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  38034. */
  38035. pinchPrecision: number;
  38036. /**
  38037. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  38038. * It will be used instead of pinchDeltaPrecision if different from 0.
  38039. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  38040. */
  38041. pinchDeltaPercentage: number;
  38042. /**
  38043. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  38044. */
  38045. panningSensibility: number;
  38046. /**
  38047. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  38048. */
  38049. keysUp: number[];
  38050. /**
  38051. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  38052. */
  38053. keysDown: number[];
  38054. /**
  38055. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  38056. */
  38057. keysLeft: number[];
  38058. /**
  38059. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  38060. */
  38061. keysRight: number[];
  38062. /**
  38063. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  38064. */
  38065. wheelPrecision: number;
  38066. /**
  38067. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  38068. * It will be used instead of pinchDeltaPrecision if different from 0.
  38069. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  38070. */
  38071. wheelDeltaPercentage: number;
  38072. /**
  38073. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  38074. */
  38075. zoomOnFactor: number;
  38076. /**
  38077. * Defines a screen offset for the camera position.
  38078. */
  38079. targetScreenOffset: Vector2;
  38080. /**
  38081. * Allows the camera to be completely reversed.
  38082. * If false the camera can not arrive upside down.
  38083. */
  38084. allowUpsideDown: boolean;
  38085. /**
  38086. * Define if double tap/click is used to restore the previously saved state of the camera.
  38087. */
  38088. useInputToRestoreState: boolean;
  38089. /** @hidden */
  38090. _viewMatrix: Matrix;
  38091. /** @hidden */
  38092. _useCtrlForPanning: boolean;
  38093. /** @hidden */
  38094. _panningMouseButton: number;
  38095. /**
  38096. * Defines the input associated to the camera.
  38097. */
  38098. inputs: ArcRotateCameraInputsManager;
  38099. /** @hidden */
  38100. _reset: () => void;
  38101. /**
  38102. * Defines the allowed panning axis.
  38103. */
  38104. panningAxis: Vector3;
  38105. protected _localDirection: Vector3;
  38106. protected _transformedDirection: Vector3;
  38107. private _bouncingBehavior;
  38108. /**
  38109. * Gets the bouncing behavior of the camera if it has been enabled.
  38110. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  38111. */
  38112. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  38113. /**
  38114. * Defines if the bouncing behavior of the camera is enabled on the camera.
  38115. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  38116. */
  38117. useBouncingBehavior: boolean;
  38118. private _framingBehavior;
  38119. /**
  38120. * Gets the framing behavior of the camera if it has been enabled.
  38121. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  38122. */
  38123. readonly framingBehavior: Nullable<FramingBehavior>;
  38124. /**
  38125. * Defines if the framing behavior of the camera is enabled on the camera.
  38126. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  38127. */
  38128. useFramingBehavior: boolean;
  38129. private _autoRotationBehavior;
  38130. /**
  38131. * Gets the auto rotation behavior of the camera if it has been enabled.
  38132. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38133. */
  38134. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  38135. /**
  38136. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  38137. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38138. */
  38139. useAutoRotationBehavior: boolean;
  38140. /**
  38141. * Observable triggered when the mesh target has been changed on the camera.
  38142. */
  38143. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  38144. /**
  38145. * Event raised when the camera is colliding with a mesh.
  38146. */
  38147. onCollide: (collidedMesh: AbstractMesh) => void;
  38148. /**
  38149. * Defines whether the camera should check collision with the objects oh the scene.
  38150. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  38151. */
  38152. checkCollisions: boolean;
  38153. /**
  38154. * Defines the collision radius of the camera.
  38155. * This simulates a sphere around the camera.
  38156. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38157. */
  38158. collisionRadius: Vector3;
  38159. protected _collider: Collider;
  38160. protected _previousPosition: Vector3;
  38161. protected _collisionVelocity: Vector3;
  38162. protected _newPosition: Vector3;
  38163. protected _previousAlpha: number;
  38164. protected _previousBeta: number;
  38165. protected _previousRadius: number;
  38166. protected _collisionTriggered: boolean;
  38167. protected _targetBoundingCenter: Nullable<Vector3>;
  38168. private _computationVector;
  38169. /**
  38170. * Instantiates a new ArcRotateCamera in a given scene
  38171. * @param name Defines the name of the camera
  38172. * @param alpha Defines the camera rotation along the logitudinal axis
  38173. * @param beta Defines the camera rotation along the latitudinal axis
  38174. * @param radius Defines the camera distance from its target
  38175. * @param target Defines the camera target
  38176. * @param scene Defines the scene the camera belongs to
  38177. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  38178. */
  38179. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  38180. /** @hidden */
  38181. _initCache(): void;
  38182. /** @hidden */
  38183. _updateCache(ignoreParentClass?: boolean): void;
  38184. protected _getTargetPosition(): Vector3;
  38185. private _storedAlpha;
  38186. private _storedBeta;
  38187. private _storedRadius;
  38188. private _storedTarget;
  38189. private _storedTargetScreenOffset;
  38190. /**
  38191. * Stores the current state of the camera (alpha, beta, radius and target)
  38192. * @returns the camera itself
  38193. */
  38194. storeState(): Camera;
  38195. /**
  38196. * @hidden
  38197. * Restored camera state. You must call storeState() first
  38198. */
  38199. _restoreStateValues(): boolean;
  38200. /** @hidden */
  38201. _isSynchronizedViewMatrix(): boolean;
  38202. /**
  38203. * Attached controls to the current camera.
  38204. * @param element Defines the element the controls should be listened from
  38205. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38206. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  38207. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  38208. */
  38209. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  38210. /**
  38211. * Detach the current controls from the camera.
  38212. * The camera will stop reacting to inputs.
  38213. * @param element Defines the element to stop listening the inputs from
  38214. */
  38215. detachControl(element: HTMLElement): void;
  38216. /** @hidden */
  38217. _checkInputs(): void;
  38218. protected _checkLimits(): void;
  38219. /**
  38220. * Rebuilds angles (alpha, beta) and radius from the give position and target
  38221. */
  38222. rebuildAnglesAndRadius(): void;
  38223. /**
  38224. * Use a position to define the current camera related information like alpha, beta and radius
  38225. * @param position Defines the position to set the camera at
  38226. */
  38227. setPosition(position: Vector3): void;
  38228. /**
  38229. * Defines the target the camera should look at.
  38230. * This will automatically adapt alpha beta and radius to fit within the new target.
  38231. * @param target Defines the new target as a Vector or a mesh
  38232. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  38233. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  38234. */
  38235. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  38236. /** @hidden */
  38237. _getViewMatrix(): Matrix;
  38238. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  38239. /**
  38240. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  38241. * @param meshes Defines the mesh to zoom on
  38242. * @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)
  38243. */
  38244. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  38245. /**
  38246. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  38247. * The target will be changed but the radius
  38248. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  38249. * @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)
  38250. */
  38251. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  38252. min: Vector3;
  38253. max: Vector3;
  38254. distance: number;
  38255. }, doNotUpdateMaxZ?: boolean): void;
  38256. /**
  38257. * @override
  38258. * Override Camera.createRigCamera
  38259. */
  38260. createRigCamera(name: string, cameraIndex: number): Camera;
  38261. /**
  38262. * @hidden
  38263. * @override
  38264. * Override Camera._updateRigCameras
  38265. */
  38266. _updateRigCameras(): void;
  38267. /**
  38268. * Destroy the camera and release the current resources hold by it.
  38269. */
  38270. dispose(): void;
  38271. /**
  38272. * Gets the current object class name.
  38273. * @return the class name
  38274. */
  38275. getClassName(): string;
  38276. }
  38277. }
  38278. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  38279. import { Behavior } from "babylonjs/Behaviors/behavior";
  38280. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38281. /**
  38282. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  38283. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38284. */
  38285. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  38286. /**
  38287. * Gets the name of the behavior.
  38288. */
  38289. readonly name: string;
  38290. private _zoomStopsAnimation;
  38291. private _idleRotationSpeed;
  38292. private _idleRotationWaitTime;
  38293. private _idleRotationSpinupTime;
  38294. /**
  38295. * Sets the flag that indicates if user zooming should stop animation.
  38296. */
  38297. /**
  38298. * Gets the flag that indicates if user zooming should stop animation.
  38299. */
  38300. zoomStopsAnimation: boolean;
  38301. /**
  38302. * Sets the default speed at which the camera rotates around the model.
  38303. */
  38304. /**
  38305. * Gets the default speed at which the camera rotates around the model.
  38306. */
  38307. idleRotationSpeed: number;
  38308. /**
  38309. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  38310. */
  38311. /**
  38312. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  38313. */
  38314. idleRotationWaitTime: number;
  38315. /**
  38316. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  38317. */
  38318. /**
  38319. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  38320. */
  38321. idleRotationSpinupTime: number;
  38322. /**
  38323. * Gets a value indicating if the camera is currently rotating because of this behavior
  38324. */
  38325. readonly rotationInProgress: boolean;
  38326. private _onPrePointerObservableObserver;
  38327. private _onAfterCheckInputsObserver;
  38328. private _attachedCamera;
  38329. private _isPointerDown;
  38330. private _lastFrameTime;
  38331. private _lastInteractionTime;
  38332. private _cameraRotationSpeed;
  38333. /**
  38334. * Initializes the behavior.
  38335. */
  38336. init(): void;
  38337. /**
  38338. * Attaches the behavior to its arc rotate camera.
  38339. * @param camera Defines the camera to attach the behavior to
  38340. */
  38341. attach(camera: ArcRotateCamera): void;
  38342. /**
  38343. * Detaches the behavior from its current arc rotate camera.
  38344. */
  38345. detach(): void;
  38346. /**
  38347. * Returns true if user is scrolling.
  38348. * @return true if user is scrolling.
  38349. */
  38350. private _userIsZooming;
  38351. private _lastFrameRadius;
  38352. private _shouldAnimationStopForInteraction;
  38353. /**
  38354. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  38355. */
  38356. private _applyUserInteraction;
  38357. private _userIsMoving;
  38358. }
  38359. }
  38360. declare module "babylonjs/Behaviors/Cameras/index" {
  38361. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  38362. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  38363. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  38364. }
  38365. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  38366. import { Mesh } from "babylonjs/Meshes/mesh";
  38367. import { TransformNode } from "babylonjs/Meshes/transformNode";
  38368. import { Behavior } from "babylonjs/Behaviors/behavior";
  38369. /**
  38370. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  38371. */
  38372. export class AttachToBoxBehavior implements Behavior<Mesh> {
  38373. private ui;
  38374. /**
  38375. * The name of the behavior
  38376. */
  38377. name: string;
  38378. /**
  38379. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  38380. */
  38381. distanceAwayFromFace: number;
  38382. /**
  38383. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  38384. */
  38385. distanceAwayFromBottomOfFace: number;
  38386. private _faceVectors;
  38387. private _target;
  38388. private _scene;
  38389. private _onRenderObserver;
  38390. private _tmpMatrix;
  38391. private _tmpVector;
  38392. /**
  38393. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  38394. * @param ui The transform node that should be attched to the mesh
  38395. */
  38396. constructor(ui: TransformNode);
  38397. /**
  38398. * Initializes the behavior
  38399. */
  38400. init(): void;
  38401. private _closestFace;
  38402. private _zeroVector;
  38403. private _lookAtTmpMatrix;
  38404. private _lookAtToRef;
  38405. /**
  38406. * Attaches the AttachToBoxBehavior to the passed in mesh
  38407. * @param target The mesh that the specified node will be attached to
  38408. */
  38409. attach(target: Mesh): void;
  38410. /**
  38411. * Detaches the behavior from the mesh
  38412. */
  38413. detach(): void;
  38414. }
  38415. }
  38416. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  38417. import { Behavior } from "babylonjs/Behaviors/behavior";
  38418. import { Mesh } from "babylonjs/Meshes/mesh";
  38419. /**
  38420. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  38421. */
  38422. export class FadeInOutBehavior implements Behavior<Mesh> {
  38423. /**
  38424. * Time in milliseconds to delay before fading in (Default: 0)
  38425. */
  38426. delay: number;
  38427. /**
  38428. * Time in milliseconds for the mesh to fade in (Default: 300)
  38429. */
  38430. fadeInTime: number;
  38431. private _millisecondsPerFrame;
  38432. private _hovered;
  38433. private _hoverValue;
  38434. private _ownerNode;
  38435. /**
  38436. * Instatiates the FadeInOutBehavior
  38437. */
  38438. constructor();
  38439. /**
  38440. * The name of the behavior
  38441. */
  38442. readonly name: string;
  38443. /**
  38444. * Initializes the behavior
  38445. */
  38446. init(): void;
  38447. /**
  38448. * Attaches the fade behavior on the passed in mesh
  38449. * @param ownerNode The mesh that will be faded in/out once attached
  38450. */
  38451. attach(ownerNode: Mesh): void;
  38452. /**
  38453. * Detaches the behavior from the mesh
  38454. */
  38455. detach(): void;
  38456. /**
  38457. * Triggers the mesh to begin fading in or out
  38458. * @param value if the object should fade in or out (true to fade in)
  38459. */
  38460. fadeIn(value: boolean): void;
  38461. private _update;
  38462. private _setAllVisibility;
  38463. }
  38464. }
  38465. declare module "babylonjs/Misc/pivotTools" {
  38466. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38467. /**
  38468. * Class containing a set of static utilities functions for managing Pivots
  38469. * @hidden
  38470. */
  38471. export class PivotTools {
  38472. private static _PivotCached;
  38473. private static _OldPivotPoint;
  38474. private static _PivotTranslation;
  38475. private static _PivotTmpVector;
  38476. /** @hidden */
  38477. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  38478. /** @hidden */
  38479. static _RestorePivotPoint(mesh: AbstractMesh): void;
  38480. }
  38481. }
  38482. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  38483. import { Scene } from "babylonjs/scene";
  38484. import { Vector4 } from "babylonjs/Maths/math.vector";
  38485. import { Mesh } from "babylonjs/Meshes/mesh";
  38486. import { Nullable } from "babylonjs/types";
  38487. import { Plane } from "babylonjs/Maths/math.plane";
  38488. /**
  38489. * Class containing static functions to help procedurally build meshes
  38490. */
  38491. export class PlaneBuilder {
  38492. /**
  38493. * Creates a plane mesh
  38494. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  38495. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  38496. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  38497. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  38498. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  38499. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  38500. * @param name defines the name of the mesh
  38501. * @param options defines the options used to create the mesh
  38502. * @param scene defines the hosting scene
  38503. * @returns the plane mesh
  38504. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  38505. */
  38506. static CreatePlane(name: string, options: {
  38507. size?: number;
  38508. width?: number;
  38509. height?: number;
  38510. sideOrientation?: number;
  38511. frontUVs?: Vector4;
  38512. backUVs?: Vector4;
  38513. updatable?: boolean;
  38514. sourcePlane?: Plane;
  38515. }, scene?: Nullable<Scene>): Mesh;
  38516. }
  38517. }
  38518. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  38519. import { Behavior } from "babylonjs/Behaviors/behavior";
  38520. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38521. import { Observable } from "babylonjs/Misc/observable";
  38522. import { Vector3 } from "babylonjs/Maths/math.vector";
  38523. import { Ray } from "babylonjs/Culling/ray";
  38524. import "babylonjs/Meshes/Builders/planeBuilder";
  38525. /**
  38526. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  38527. */
  38528. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  38529. private static _AnyMouseID;
  38530. /**
  38531. * Abstract mesh the behavior is set on
  38532. */
  38533. attachedNode: AbstractMesh;
  38534. private _dragPlane;
  38535. private _scene;
  38536. private _pointerObserver;
  38537. private _beforeRenderObserver;
  38538. private static _planeScene;
  38539. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  38540. /**
  38541. * 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)
  38542. */
  38543. maxDragAngle: number;
  38544. /**
  38545. * @hidden
  38546. */
  38547. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  38548. /**
  38549. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38550. */
  38551. currentDraggingPointerID: number;
  38552. /**
  38553. * The last position where the pointer hit the drag plane in world space
  38554. */
  38555. lastDragPosition: Vector3;
  38556. /**
  38557. * If the behavior is currently in a dragging state
  38558. */
  38559. dragging: boolean;
  38560. /**
  38561. * 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)
  38562. */
  38563. dragDeltaRatio: number;
  38564. /**
  38565. * If the drag plane orientation should be updated during the dragging (Default: true)
  38566. */
  38567. updateDragPlane: boolean;
  38568. private _debugMode;
  38569. private _moving;
  38570. /**
  38571. * Fires each time the attached mesh is dragged with the pointer
  38572. * * delta between last drag position and current drag position in world space
  38573. * * dragDistance along the drag axis
  38574. * * dragPlaneNormal normal of the current drag plane used during the drag
  38575. * * dragPlanePoint in world space where the drag intersects the drag plane
  38576. */
  38577. onDragObservable: Observable<{
  38578. delta: Vector3;
  38579. dragPlanePoint: Vector3;
  38580. dragPlaneNormal: Vector3;
  38581. dragDistance: number;
  38582. pointerId: number;
  38583. }>;
  38584. /**
  38585. * Fires each time a drag begins (eg. mouse down on mesh)
  38586. */
  38587. onDragStartObservable: Observable<{
  38588. dragPlanePoint: Vector3;
  38589. pointerId: number;
  38590. }>;
  38591. /**
  38592. * Fires each time a drag ends (eg. mouse release after drag)
  38593. */
  38594. onDragEndObservable: Observable<{
  38595. dragPlanePoint: Vector3;
  38596. pointerId: number;
  38597. }>;
  38598. /**
  38599. * If the attached mesh should be moved when dragged
  38600. */
  38601. moveAttached: boolean;
  38602. /**
  38603. * If the drag behavior will react to drag events (Default: true)
  38604. */
  38605. enabled: boolean;
  38606. /**
  38607. * If pointer events should start and release the drag (Default: true)
  38608. */
  38609. startAndReleaseDragOnPointerEvents: boolean;
  38610. /**
  38611. * If camera controls should be detached during the drag
  38612. */
  38613. detachCameraControls: boolean;
  38614. /**
  38615. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  38616. */
  38617. useObjectOrienationForDragging: boolean;
  38618. private _options;
  38619. /**
  38620. * Creates a pointer drag behavior that can be attached to a mesh
  38621. * @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)
  38622. */
  38623. constructor(options?: {
  38624. dragAxis?: Vector3;
  38625. dragPlaneNormal?: Vector3;
  38626. });
  38627. /**
  38628. * Predicate to determine if it is valid to move the object to a new position when it is moved
  38629. */
  38630. validateDrag: (targetPosition: Vector3) => boolean;
  38631. /**
  38632. * The name of the behavior
  38633. */
  38634. readonly name: string;
  38635. /**
  38636. * Initializes the behavior
  38637. */
  38638. init(): void;
  38639. private _tmpVector;
  38640. private _alternatePickedPoint;
  38641. private _worldDragAxis;
  38642. private _targetPosition;
  38643. private _attachedElement;
  38644. /**
  38645. * Attaches the drag behavior the passed in mesh
  38646. * @param ownerNode The mesh that will be dragged around once attached
  38647. * @param predicate Predicate to use for pick filtering
  38648. */
  38649. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  38650. /**
  38651. * Force relase the drag action by code.
  38652. */
  38653. releaseDrag(): void;
  38654. private _startDragRay;
  38655. private _lastPointerRay;
  38656. /**
  38657. * Simulates the start of a pointer drag event on the behavior
  38658. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  38659. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  38660. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  38661. */
  38662. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  38663. private _startDrag;
  38664. private _dragDelta;
  38665. private _moveDrag;
  38666. private _pickWithRayOnDragPlane;
  38667. private _pointA;
  38668. private _pointB;
  38669. private _pointC;
  38670. private _lineA;
  38671. private _lineB;
  38672. private _localAxis;
  38673. private _lookAt;
  38674. private _updateDragPlanePosition;
  38675. /**
  38676. * Detaches the behavior from the mesh
  38677. */
  38678. detach(): void;
  38679. }
  38680. }
  38681. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  38682. import { Mesh } from "babylonjs/Meshes/mesh";
  38683. import { Behavior } from "babylonjs/Behaviors/behavior";
  38684. /**
  38685. * A behavior that when attached to a mesh will allow the mesh to be scaled
  38686. */
  38687. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  38688. private _dragBehaviorA;
  38689. private _dragBehaviorB;
  38690. private _startDistance;
  38691. private _initialScale;
  38692. private _targetScale;
  38693. private _ownerNode;
  38694. private _sceneRenderObserver;
  38695. /**
  38696. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  38697. */
  38698. constructor();
  38699. /**
  38700. * The name of the behavior
  38701. */
  38702. readonly name: string;
  38703. /**
  38704. * Initializes the behavior
  38705. */
  38706. init(): void;
  38707. private _getCurrentDistance;
  38708. /**
  38709. * Attaches the scale behavior the passed in mesh
  38710. * @param ownerNode The mesh that will be scaled around once attached
  38711. */
  38712. attach(ownerNode: Mesh): void;
  38713. /**
  38714. * Detaches the behavior from the mesh
  38715. */
  38716. detach(): void;
  38717. }
  38718. }
  38719. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  38720. import { Behavior } from "babylonjs/Behaviors/behavior";
  38721. import { Mesh } from "babylonjs/Meshes/mesh";
  38722. import { Observable } from "babylonjs/Misc/observable";
  38723. /**
  38724. * 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
  38725. */
  38726. export class SixDofDragBehavior implements Behavior<Mesh> {
  38727. private static _virtualScene;
  38728. private _ownerNode;
  38729. private _sceneRenderObserver;
  38730. private _scene;
  38731. private _targetPosition;
  38732. private _virtualOriginMesh;
  38733. private _virtualDragMesh;
  38734. private _pointerObserver;
  38735. private _moving;
  38736. private _startingOrientation;
  38737. /**
  38738. * 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)
  38739. */
  38740. private zDragFactor;
  38741. /**
  38742. * If the object should rotate to face the drag origin
  38743. */
  38744. rotateDraggedObject: boolean;
  38745. /**
  38746. * If the behavior is currently in a dragging state
  38747. */
  38748. dragging: boolean;
  38749. /**
  38750. * 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)
  38751. */
  38752. dragDeltaRatio: number;
  38753. /**
  38754. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38755. */
  38756. currentDraggingPointerID: number;
  38757. /**
  38758. * If camera controls should be detached during the drag
  38759. */
  38760. detachCameraControls: boolean;
  38761. /**
  38762. * Fires each time a drag starts
  38763. */
  38764. onDragStartObservable: Observable<{}>;
  38765. /**
  38766. * Fires each time a drag ends (eg. mouse release after drag)
  38767. */
  38768. onDragEndObservable: Observable<{}>;
  38769. /**
  38770. * 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
  38771. */
  38772. constructor();
  38773. /**
  38774. * The name of the behavior
  38775. */
  38776. readonly name: string;
  38777. /**
  38778. * Initializes the behavior
  38779. */
  38780. init(): void;
  38781. /**
  38782. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  38783. */
  38784. private readonly _pointerCamera;
  38785. /**
  38786. * Attaches the scale behavior the passed in mesh
  38787. * @param ownerNode The mesh that will be scaled around once attached
  38788. */
  38789. attach(ownerNode: Mesh): void;
  38790. /**
  38791. * Detaches the behavior from the mesh
  38792. */
  38793. detach(): void;
  38794. }
  38795. }
  38796. declare module "babylonjs/Behaviors/Meshes/index" {
  38797. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  38798. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  38799. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  38800. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  38801. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  38802. }
  38803. declare module "babylonjs/Behaviors/index" {
  38804. export * from "babylonjs/Behaviors/behavior";
  38805. export * from "babylonjs/Behaviors/Cameras/index";
  38806. export * from "babylonjs/Behaviors/Meshes/index";
  38807. }
  38808. declare module "babylonjs/Bones/boneIKController" {
  38809. import { Bone } from "babylonjs/Bones/bone";
  38810. import { Vector3 } from "babylonjs/Maths/math.vector";
  38811. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38812. import { Nullable } from "babylonjs/types";
  38813. /**
  38814. * Class used to apply inverse kinematics to bones
  38815. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  38816. */
  38817. export class BoneIKController {
  38818. private static _tmpVecs;
  38819. private static _tmpQuat;
  38820. private static _tmpMats;
  38821. /**
  38822. * Gets or sets the target mesh
  38823. */
  38824. targetMesh: AbstractMesh;
  38825. /** Gets or sets the mesh used as pole */
  38826. poleTargetMesh: AbstractMesh;
  38827. /**
  38828. * Gets or sets the bone used as pole
  38829. */
  38830. poleTargetBone: Nullable<Bone>;
  38831. /**
  38832. * Gets or sets the target position
  38833. */
  38834. targetPosition: Vector3;
  38835. /**
  38836. * Gets or sets the pole target position
  38837. */
  38838. poleTargetPosition: Vector3;
  38839. /**
  38840. * Gets or sets the pole target local offset
  38841. */
  38842. poleTargetLocalOffset: Vector3;
  38843. /**
  38844. * Gets or sets the pole angle
  38845. */
  38846. poleAngle: number;
  38847. /**
  38848. * Gets or sets the mesh associated with the controller
  38849. */
  38850. mesh: AbstractMesh;
  38851. /**
  38852. * 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)
  38853. */
  38854. slerpAmount: number;
  38855. private _bone1Quat;
  38856. private _bone1Mat;
  38857. private _bone2Ang;
  38858. private _bone1;
  38859. private _bone2;
  38860. private _bone1Length;
  38861. private _bone2Length;
  38862. private _maxAngle;
  38863. private _maxReach;
  38864. private _rightHandedSystem;
  38865. private _bendAxis;
  38866. private _slerping;
  38867. private _adjustRoll;
  38868. /**
  38869. * Gets or sets maximum allowed angle
  38870. */
  38871. maxAngle: number;
  38872. /**
  38873. * Creates a new BoneIKController
  38874. * @param mesh defines the mesh to control
  38875. * @param bone defines the bone to control
  38876. * @param options defines options to set up the controller
  38877. */
  38878. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  38879. targetMesh?: AbstractMesh;
  38880. poleTargetMesh?: AbstractMesh;
  38881. poleTargetBone?: Bone;
  38882. poleTargetLocalOffset?: Vector3;
  38883. poleAngle?: number;
  38884. bendAxis?: Vector3;
  38885. maxAngle?: number;
  38886. slerpAmount?: number;
  38887. });
  38888. private _setMaxAngle;
  38889. /**
  38890. * Force the controller to update the bones
  38891. */
  38892. update(): void;
  38893. }
  38894. }
  38895. declare module "babylonjs/Bones/boneLookController" {
  38896. import { Vector3 } from "babylonjs/Maths/math.vector";
  38897. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38898. import { Bone } from "babylonjs/Bones/bone";
  38899. import { Space } from "babylonjs/Maths/math.axis";
  38900. /**
  38901. * Class used to make a bone look toward a point in space
  38902. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  38903. */
  38904. export class BoneLookController {
  38905. private static _tmpVecs;
  38906. private static _tmpQuat;
  38907. private static _tmpMats;
  38908. /**
  38909. * The target Vector3 that the bone will look at
  38910. */
  38911. target: Vector3;
  38912. /**
  38913. * The mesh that the bone is attached to
  38914. */
  38915. mesh: AbstractMesh;
  38916. /**
  38917. * The bone that will be looking to the target
  38918. */
  38919. bone: Bone;
  38920. /**
  38921. * The up axis of the coordinate system that is used when the bone is rotated
  38922. */
  38923. upAxis: Vector3;
  38924. /**
  38925. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38926. */
  38927. upAxisSpace: Space;
  38928. /**
  38929. * Used to make an adjustment to the yaw of the bone
  38930. */
  38931. adjustYaw: number;
  38932. /**
  38933. * Used to make an adjustment to the pitch of the bone
  38934. */
  38935. adjustPitch: number;
  38936. /**
  38937. * Used to make an adjustment to the roll of the bone
  38938. */
  38939. adjustRoll: number;
  38940. /**
  38941. * 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)
  38942. */
  38943. slerpAmount: number;
  38944. private _minYaw;
  38945. private _maxYaw;
  38946. private _minPitch;
  38947. private _maxPitch;
  38948. private _minYawSin;
  38949. private _minYawCos;
  38950. private _maxYawSin;
  38951. private _maxYawCos;
  38952. private _midYawConstraint;
  38953. private _minPitchTan;
  38954. private _maxPitchTan;
  38955. private _boneQuat;
  38956. private _slerping;
  38957. private _transformYawPitch;
  38958. private _transformYawPitchInv;
  38959. private _firstFrameSkipped;
  38960. private _yawRange;
  38961. private _fowardAxis;
  38962. /**
  38963. * Gets or sets the minimum yaw angle that the bone can look to
  38964. */
  38965. minYaw: number;
  38966. /**
  38967. * Gets or sets the maximum yaw angle that the bone can look to
  38968. */
  38969. maxYaw: number;
  38970. /**
  38971. * Gets or sets the minimum pitch angle that the bone can look to
  38972. */
  38973. minPitch: number;
  38974. /**
  38975. * Gets or sets the maximum pitch angle that the bone can look to
  38976. */
  38977. maxPitch: number;
  38978. /**
  38979. * Create a BoneLookController
  38980. * @param mesh the mesh that the bone belongs to
  38981. * @param bone the bone that will be looking to the target
  38982. * @param target the target Vector3 to look at
  38983. * @param options optional settings:
  38984. * * maxYaw: the maximum angle the bone will yaw to
  38985. * * minYaw: the minimum angle the bone will yaw to
  38986. * * maxPitch: the maximum angle the bone will pitch to
  38987. * * minPitch: the minimum angle the bone will yaw to
  38988. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38989. * * upAxis: the up axis of the coordinate system
  38990. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38991. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38992. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38993. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38994. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38995. * * adjustRoll: used to make an adjustment to the roll of the bone
  38996. **/
  38997. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38998. maxYaw?: number;
  38999. minYaw?: number;
  39000. maxPitch?: number;
  39001. minPitch?: number;
  39002. slerpAmount?: number;
  39003. upAxis?: Vector3;
  39004. upAxisSpace?: Space;
  39005. yawAxis?: Vector3;
  39006. pitchAxis?: Vector3;
  39007. adjustYaw?: number;
  39008. adjustPitch?: number;
  39009. adjustRoll?: number;
  39010. });
  39011. /**
  39012. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  39013. */
  39014. update(): void;
  39015. private _getAngleDiff;
  39016. private _getAngleBetween;
  39017. private _isAngleBetween;
  39018. }
  39019. }
  39020. declare module "babylonjs/Bones/index" {
  39021. export * from "babylonjs/Bones/bone";
  39022. export * from "babylonjs/Bones/boneIKController";
  39023. export * from "babylonjs/Bones/boneLookController";
  39024. export * from "babylonjs/Bones/skeleton";
  39025. }
  39026. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  39027. import { Nullable } from "babylonjs/types";
  39028. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  39029. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39030. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39031. /**
  39032. * Manage the gamepad inputs to control an arc rotate camera.
  39033. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39034. */
  39035. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  39036. /**
  39037. * Defines the camera the input is attached to.
  39038. */
  39039. camera: ArcRotateCamera;
  39040. /**
  39041. * Defines the gamepad the input is gathering event from.
  39042. */
  39043. gamepad: Nullable<Gamepad>;
  39044. /**
  39045. * Defines the gamepad rotation sensiblity.
  39046. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39047. */
  39048. gamepadRotationSensibility: number;
  39049. /**
  39050. * Defines the gamepad move sensiblity.
  39051. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39052. */
  39053. gamepadMoveSensibility: number;
  39054. private _yAxisScale;
  39055. /**
  39056. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  39057. */
  39058. invertYAxis: boolean;
  39059. private _onGamepadConnectedObserver;
  39060. private _onGamepadDisconnectedObserver;
  39061. /**
  39062. * Attach the input controls to a specific dom element to get the input from.
  39063. * @param element Defines the element the controls should be listened from
  39064. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39065. */
  39066. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39067. /**
  39068. * Detach the current controls from the specified dom element.
  39069. * @param element Defines the element to stop listening the inputs from
  39070. */
  39071. detachControl(element: Nullable<HTMLElement>): void;
  39072. /**
  39073. * Update the current camera state depending on the inputs that have been used this frame.
  39074. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39075. */
  39076. checkInputs(): void;
  39077. /**
  39078. * Gets the class name of the current intput.
  39079. * @returns the class name
  39080. */
  39081. getClassName(): string;
  39082. /**
  39083. * Get the friendly name associated with the input class.
  39084. * @returns the input friendly name
  39085. */
  39086. getSimpleName(): string;
  39087. }
  39088. }
  39089. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  39090. import { Nullable } from "babylonjs/types";
  39091. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  39092. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39093. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  39094. interface ArcRotateCameraInputsManager {
  39095. /**
  39096. * Add orientation input support to the input manager.
  39097. * @returns the current input manager
  39098. */
  39099. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  39100. }
  39101. }
  39102. /**
  39103. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  39104. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39105. */
  39106. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  39107. /**
  39108. * Defines the camera the input is attached to.
  39109. */
  39110. camera: ArcRotateCamera;
  39111. /**
  39112. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  39113. */
  39114. alphaCorrection: number;
  39115. /**
  39116. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  39117. */
  39118. gammaCorrection: number;
  39119. private _alpha;
  39120. private _gamma;
  39121. private _dirty;
  39122. private _deviceOrientationHandler;
  39123. /**
  39124. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  39125. */
  39126. constructor();
  39127. /**
  39128. * Attach the input controls to a specific dom element to get the input from.
  39129. * @param element Defines the element the controls should be listened from
  39130. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39131. */
  39132. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39133. /** @hidden */
  39134. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  39135. /**
  39136. * Update the current camera state depending on the inputs that have been used this frame.
  39137. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39138. */
  39139. checkInputs(): void;
  39140. /**
  39141. * Detach the current controls from the specified dom element.
  39142. * @param element Defines the element to stop listening the inputs from
  39143. */
  39144. detachControl(element: Nullable<HTMLElement>): void;
  39145. /**
  39146. * Gets the class name of the current intput.
  39147. * @returns the class name
  39148. */
  39149. getClassName(): string;
  39150. /**
  39151. * Get the friendly name associated with the input class.
  39152. * @returns the input friendly name
  39153. */
  39154. getSimpleName(): string;
  39155. }
  39156. }
  39157. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  39158. import { Nullable } from "babylonjs/types";
  39159. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39160. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39161. /**
  39162. * Listen to mouse events to control the camera.
  39163. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39164. */
  39165. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  39166. /**
  39167. * Defines the camera the input is attached to.
  39168. */
  39169. camera: FlyCamera;
  39170. /**
  39171. * Defines if touch is enabled. (Default is true.)
  39172. */
  39173. touchEnabled: boolean;
  39174. /**
  39175. * Defines the buttons associated with the input to handle camera rotation.
  39176. */
  39177. buttons: number[];
  39178. /**
  39179. * Assign buttons for Yaw control.
  39180. */
  39181. buttonsYaw: number[];
  39182. /**
  39183. * Assign buttons for Pitch control.
  39184. */
  39185. buttonsPitch: number[];
  39186. /**
  39187. * Assign buttons for Roll control.
  39188. */
  39189. buttonsRoll: number[];
  39190. /**
  39191. * Detect if any button is being pressed while mouse is moved.
  39192. * -1 = Mouse locked.
  39193. * 0 = Left button.
  39194. * 1 = Middle Button.
  39195. * 2 = Right Button.
  39196. */
  39197. activeButton: number;
  39198. /**
  39199. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  39200. * Higher values reduce its sensitivity.
  39201. */
  39202. angularSensibility: number;
  39203. private _mousemoveCallback;
  39204. private _observer;
  39205. private _rollObserver;
  39206. private previousPosition;
  39207. private noPreventDefault;
  39208. private element;
  39209. /**
  39210. * Listen to mouse events to control the camera.
  39211. * @param touchEnabled Define if touch is enabled. (Default is true.)
  39212. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39213. */
  39214. constructor(touchEnabled?: boolean);
  39215. /**
  39216. * Attach the mouse control to the HTML DOM element.
  39217. * @param element Defines the element that listens to the input events.
  39218. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  39219. */
  39220. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39221. /**
  39222. * Detach the current controls from the specified dom element.
  39223. * @param element Defines the element to stop listening the inputs from
  39224. */
  39225. detachControl(element: Nullable<HTMLElement>): void;
  39226. /**
  39227. * Gets the class name of the current input.
  39228. * @returns the class name.
  39229. */
  39230. getClassName(): string;
  39231. /**
  39232. * Get the friendly name associated with the input class.
  39233. * @returns the input's friendly name.
  39234. */
  39235. getSimpleName(): string;
  39236. private _pointerInput;
  39237. private _onMouseMove;
  39238. /**
  39239. * Rotate camera by mouse offset.
  39240. */
  39241. private rotateCamera;
  39242. }
  39243. }
  39244. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  39245. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39246. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39247. /**
  39248. * Default Inputs manager for the FlyCamera.
  39249. * It groups all the default supported inputs for ease of use.
  39250. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39251. */
  39252. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  39253. /**
  39254. * Instantiates a new FlyCameraInputsManager.
  39255. * @param camera Defines the camera the inputs belong to.
  39256. */
  39257. constructor(camera: FlyCamera);
  39258. /**
  39259. * Add keyboard input support to the input manager.
  39260. * @returns the new FlyCameraKeyboardMoveInput().
  39261. */
  39262. addKeyboard(): FlyCameraInputsManager;
  39263. /**
  39264. * Add mouse input support to the input manager.
  39265. * @param touchEnabled Enable touch screen support.
  39266. * @returns the new FlyCameraMouseInput().
  39267. */
  39268. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  39269. }
  39270. }
  39271. declare module "babylonjs/Cameras/flyCamera" {
  39272. import { Scene } from "babylonjs/scene";
  39273. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  39274. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39275. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39276. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  39277. /**
  39278. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39279. * such as in a 3D Space Shooter or a Flight Simulator.
  39280. */
  39281. export class FlyCamera extends TargetCamera {
  39282. /**
  39283. * Define the collision ellipsoid of the camera.
  39284. * This is helpful for simulating a camera body, like a player's body.
  39285. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  39286. */
  39287. ellipsoid: Vector3;
  39288. /**
  39289. * Define an offset for the position of the ellipsoid around the camera.
  39290. * This can be helpful if the camera is attached away from the player's body center,
  39291. * such as at its head.
  39292. */
  39293. ellipsoidOffset: Vector3;
  39294. /**
  39295. * Enable or disable collisions of the camera with the rest of the scene objects.
  39296. */
  39297. checkCollisions: boolean;
  39298. /**
  39299. * Enable or disable gravity on the camera.
  39300. */
  39301. applyGravity: boolean;
  39302. /**
  39303. * Define the current direction the camera is moving to.
  39304. */
  39305. cameraDirection: Vector3;
  39306. /**
  39307. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  39308. * This overrides and empties cameraRotation.
  39309. */
  39310. rotationQuaternion: Quaternion;
  39311. /**
  39312. * Track Roll to maintain the wanted Rolling when looking around.
  39313. */
  39314. _trackRoll: number;
  39315. /**
  39316. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  39317. */
  39318. rollCorrect: number;
  39319. /**
  39320. * Mimic a banked turn, Rolling the camera when Yawing.
  39321. * It's recommended to use rollCorrect = 10 for faster banking correction.
  39322. */
  39323. bankedTurn: boolean;
  39324. /**
  39325. * Limit in radians for how much Roll banking will add. (Default: 90°)
  39326. */
  39327. bankedTurnLimit: number;
  39328. /**
  39329. * Value of 0 disables the banked Roll.
  39330. * Value of 1 is equal to the Yaw angle in radians.
  39331. */
  39332. bankedTurnMultiplier: number;
  39333. /**
  39334. * The inputs manager loads all the input sources, such as keyboard and mouse.
  39335. */
  39336. inputs: FlyCameraInputsManager;
  39337. /**
  39338. * Gets the input sensibility for mouse input.
  39339. * Higher values reduce sensitivity.
  39340. */
  39341. /**
  39342. * Sets the input sensibility for a mouse input.
  39343. * Higher values reduce sensitivity.
  39344. */
  39345. angularSensibility: number;
  39346. /**
  39347. * Get the keys for camera movement forward.
  39348. */
  39349. /**
  39350. * Set the keys for camera movement forward.
  39351. */
  39352. keysForward: number[];
  39353. /**
  39354. * Get the keys for camera movement backward.
  39355. */
  39356. keysBackward: number[];
  39357. /**
  39358. * Get the keys for camera movement up.
  39359. */
  39360. /**
  39361. * Set the keys for camera movement up.
  39362. */
  39363. keysUp: number[];
  39364. /**
  39365. * Get the keys for camera movement down.
  39366. */
  39367. /**
  39368. * Set the keys for camera movement down.
  39369. */
  39370. keysDown: number[];
  39371. /**
  39372. * Get the keys for camera movement left.
  39373. */
  39374. /**
  39375. * Set the keys for camera movement left.
  39376. */
  39377. keysLeft: number[];
  39378. /**
  39379. * Set the keys for camera movement right.
  39380. */
  39381. /**
  39382. * Set the keys for camera movement right.
  39383. */
  39384. keysRight: number[];
  39385. /**
  39386. * Event raised when the camera collides with a mesh in the scene.
  39387. */
  39388. onCollide: (collidedMesh: AbstractMesh) => void;
  39389. private _collider;
  39390. private _needMoveForGravity;
  39391. private _oldPosition;
  39392. private _diffPosition;
  39393. private _newPosition;
  39394. /** @hidden */
  39395. _localDirection: Vector3;
  39396. /** @hidden */
  39397. _transformedDirection: Vector3;
  39398. /**
  39399. * Instantiates a FlyCamera.
  39400. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39401. * such as in a 3D Space Shooter or a Flight Simulator.
  39402. * @param name Define the name of the camera in the scene.
  39403. * @param position Define the starting position of the camera in the scene.
  39404. * @param scene Define the scene the camera belongs to.
  39405. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  39406. */
  39407. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  39408. /**
  39409. * Attach a control to the HTML DOM element.
  39410. * @param element Defines the element that listens to the input events.
  39411. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  39412. */
  39413. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39414. /**
  39415. * Detach a control from the HTML DOM element.
  39416. * The camera will stop reacting to that input.
  39417. * @param element Defines the element that listens to the input events.
  39418. */
  39419. detachControl(element: HTMLElement): void;
  39420. private _collisionMask;
  39421. /**
  39422. * Get the mask that the camera ignores in collision events.
  39423. */
  39424. /**
  39425. * Set the mask that the camera ignores in collision events.
  39426. */
  39427. collisionMask: number;
  39428. /** @hidden */
  39429. _collideWithWorld(displacement: Vector3): void;
  39430. /** @hidden */
  39431. private _onCollisionPositionChange;
  39432. /** @hidden */
  39433. _checkInputs(): void;
  39434. /** @hidden */
  39435. _decideIfNeedsToMove(): boolean;
  39436. /** @hidden */
  39437. _updatePosition(): void;
  39438. /**
  39439. * Restore the Roll to its target value at the rate specified.
  39440. * @param rate - Higher means slower restoring.
  39441. * @hidden
  39442. */
  39443. restoreRoll(rate: number): void;
  39444. /**
  39445. * Destroy the camera and release the current resources held by it.
  39446. */
  39447. dispose(): void;
  39448. /**
  39449. * Get the current object class name.
  39450. * @returns the class name.
  39451. */
  39452. getClassName(): string;
  39453. }
  39454. }
  39455. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  39456. import { Nullable } from "babylonjs/types";
  39457. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39458. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39459. /**
  39460. * Listen to keyboard events to control the camera.
  39461. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39462. */
  39463. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  39464. /**
  39465. * Defines the camera the input is attached to.
  39466. */
  39467. camera: FlyCamera;
  39468. /**
  39469. * The list of keyboard keys used to control the forward move of the camera.
  39470. */
  39471. keysForward: number[];
  39472. /**
  39473. * The list of keyboard keys used to control the backward move of the camera.
  39474. */
  39475. keysBackward: number[];
  39476. /**
  39477. * The list of keyboard keys used to control the forward move of the camera.
  39478. */
  39479. keysUp: number[];
  39480. /**
  39481. * The list of keyboard keys used to control the backward move of the camera.
  39482. */
  39483. keysDown: number[];
  39484. /**
  39485. * The list of keyboard keys used to control the right strafe move of the camera.
  39486. */
  39487. keysRight: number[];
  39488. /**
  39489. * The list of keyboard keys used to control the left strafe move of the camera.
  39490. */
  39491. keysLeft: number[];
  39492. private _keys;
  39493. private _onCanvasBlurObserver;
  39494. private _onKeyboardObserver;
  39495. private _engine;
  39496. private _scene;
  39497. /**
  39498. * Attach the input controls to a specific dom element to get the input from.
  39499. * @param element Defines the element the controls should be listened from
  39500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39501. */
  39502. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39503. /**
  39504. * Detach the current controls from the specified dom element.
  39505. * @param element Defines the element to stop listening the inputs from
  39506. */
  39507. detachControl(element: Nullable<HTMLElement>): void;
  39508. /**
  39509. * Gets the class name of the current intput.
  39510. * @returns the class name
  39511. */
  39512. getClassName(): string;
  39513. /** @hidden */
  39514. _onLostFocus(e: FocusEvent): void;
  39515. /**
  39516. * Get the friendly name associated with the input class.
  39517. * @returns the input friendly name
  39518. */
  39519. getSimpleName(): string;
  39520. /**
  39521. * Update the current camera state depending on the inputs that have been used this frame.
  39522. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39523. */
  39524. checkInputs(): void;
  39525. }
  39526. }
  39527. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  39528. import { Nullable } from "babylonjs/types";
  39529. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39530. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39531. /**
  39532. * Manage the mouse wheel inputs to control a follow camera.
  39533. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39534. */
  39535. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  39536. /**
  39537. * Defines the camera the input is attached to.
  39538. */
  39539. camera: FollowCamera;
  39540. /**
  39541. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  39542. */
  39543. axisControlRadius: boolean;
  39544. /**
  39545. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  39546. */
  39547. axisControlHeight: boolean;
  39548. /**
  39549. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  39550. */
  39551. axisControlRotation: boolean;
  39552. /**
  39553. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  39554. * relation to mouseWheel events.
  39555. */
  39556. wheelPrecision: number;
  39557. /**
  39558. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  39559. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  39560. */
  39561. wheelDeltaPercentage: number;
  39562. private _wheel;
  39563. private _observer;
  39564. /**
  39565. * Attach the input controls to a specific dom element to get the input from.
  39566. * @param element Defines the element the controls should be listened from
  39567. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39568. */
  39569. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39570. /**
  39571. * Detach the current controls from the specified dom element.
  39572. * @param element Defines the element to stop listening the inputs from
  39573. */
  39574. detachControl(element: Nullable<HTMLElement>): void;
  39575. /**
  39576. * Gets the class name of the current intput.
  39577. * @returns the class name
  39578. */
  39579. getClassName(): string;
  39580. /**
  39581. * Get the friendly name associated with the input class.
  39582. * @returns the input friendly name
  39583. */
  39584. getSimpleName(): string;
  39585. }
  39586. }
  39587. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  39588. import { Nullable } from "babylonjs/types";
  39589. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39590. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  39591. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  39592. /**
  39593. * Manage the pointers inputs to control an follow camera.
  39594. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39595. */
  39596. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  39597. /**
  39598. * Defines the camera the input is attached to.
  39599. */
  39600. camera: FollowCamera;
  39601. /**
  39602. * Gets the class name of the current input.
  39603. * @returns the class name
  39604. */
  39605. getClassName(): string;
  39606. /**
  39607. * Defines the pointer angular sensibility along the X axis or how fast is
  39608. * the camera rotating.
  39609. * A negative number will reverse the axis direction.
  39610. */
  39611. angularSensibilityX: number;
  39612. /**
  39613. * Defines the pointer angular sensibility along the Y axis or how fast is
  39614. * the camera rotating.
  39615. * A negative number will reverse the axis direction.
  39616. */
  39617. angularSensibilityY: number;
  39618. /**
  39619. * Defines the pointer pinch precision or how fast is the camera zooming.
  39620. * A negative number will reverse the axis direction.
  39621. */
  39622. pinchPrecision: number;
  39623. /**
  39624. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  39625. * from 0.
  39626. * It defines the percentage of current camera.radius to use as delta when
  39627. * pinch zoom is used.
  39628. */
  39629. pinchDeltaPercentage: number;
  39630. /**
  39631. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  39632. */
  39633. axisXControlRadius: boolean;
  39634. /**
  39635. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  39636. */
  39637. axisXControlHeight: boolean;
  39638. /**
  39639. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  39640. */
  39641. axisXControlRotation: boolean;
  39642. /**
  39643. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  39644. */
  39645. axisYControlRadius: boolean;
  39646. /**
  39647. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  39648. */
  39649. axisYControlHeight: boolean;
  39650. /**
  39651. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  39652. */
  39653. axisYControlRotation: boolean;
  39654. /**
  39655. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  39656. */
  39657. axisPinchControlRadius: boolean;
  39658. /**
  39659. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  39660. */
  39661. axisPinchControlHeight: boolean;
  39662. /**
  39663. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  39664. */
  39665. axisPinchControlRotation: boolean;
  39666. /**
  39667. * Log error messages if basic misconfiguration has occurred.
  39668. */
  39669. warningEnable: boolean;
  39670. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  39671. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  39672. private _warningCounter;
  39673. private _warning;
  39674. }
  39675. }
  39676. declare module "babylonjs/Cameras/followCameraInputsManager" {
  39677. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39678. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39679. /**
  39680. * Default Inputs manager for the FollowCamera.
  39681. * It groups all the default supported inputs for ease of use.
  39682. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39683. */
  39684. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  39685. /**
  39686. * Instantiates a new FollowCameraInputsManager.
  39687. * @param camera Defines the camera the inputs belong to
  39688. */
  39689. constructor(camera: FollowCamera);
  39690. /**
  39691. * Add keyboard input support to the input manager.
  39692. * @returns the current input manager
  39693. */
  39694. addKeyboard(): FollowCameraInputsManager;
  39695. /**
  39696. * Add mouse wheel input support to the input manager.
  39697. * @returns the current input manager
  39698. */
  39699. addMouseWheel(): FollowCameraInputsManager;
  39700. /**
  39701. * Add pointers input support to the input manager.
  39702. * @returns the current input manager
  39703. */
  39704. addPointers(): FollowCameraInputsManager;
  39705. /**
  39706. * Add orientation input support to the input manager.
  39707. * @returns the current input manager
  39708. */
  39709. addVRDeviceOrientation(): FollowCameraInputsManager;
  39710. }
  39711. }
  39712. declare module "babylonjs/Cameras/followCamera" {
  39713. import { Nullable } from "babylonjs/types";
  39714. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39715. import { Scene } from "babylonjs/scene";
  39716. import { Vector3 } from "babylonjs/Maths/math.vector";
  39717. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39718. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  39719. /**
  39720. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  39721. * an arc rotate version arcFollowCamera are available.
  39722. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39723. */
  39724. export class FollowCamera extends TargetCamera {
  39725. /**
  39726. * Distance the follow camera should follow an object at
  39727. */
  39728. radius: number;
  39729. /**
  39730. * Minimum allowed distance of the camera to the axis of rotation
  39731. * (The camera can not get closer).
  39732. * This can help limiting how the Camera is able to move in the scene.
  39733. */
  39734. lowerRadiusLimit: Nullable<number>;
  39735. /**
  39736. * Maximum allowed distance of the camera to the axis of rotation
  39737. * (The camera can not get further).
  39738. * This can help limiting how the Camera is able to move in the scene.
  39739. */
  39740. upperRadiusLimit: Nullable<number>;
  39741. /**
  39742. * Define a rotation offset between the camera and the object it follows
  39743. */
  39744. rotationOffset: number;
  39745. /**
  39746. * Minimum allowed angle to camera position relative to target object.
  39747. * This can help limiting how the Camera is able to move in the scene.
  39748. */
  39749. lowerRotationOffsetLimit: Nullable<number>;
  39750. /**
  39751. * Maximum allowed angle to camera position relative to target object.
  39752. * This can help limiting how the Camera is able to move in the scene.
  39753. */
  39754. upperRotationOffsetLimit: Nullable<number>;
  39755. /**
  39756. * Define a height offset between the camera and the object it follows.
  39757. * It can help following an object from the top (like a car chaing a plane)
  39758. */
  39759. heightOffset: number;
  39760. /**
  39761. * Minimum allowed height of camera position relative to target object.
  39762. * This can help limiting how the Camera is able to move in the scene.
  39763. */
  39764. lowerHeightOffsetLimit: Nullable<number>;
  39765. /**
  39766. * Maximum allowed height of camera position relative to target object.
  39767. * This can help limiting how the Camera is able to move in the scene.
  39768. */
  39769. upperHeightOffsetLimit: Nullable<number>;
  39770. /**
  39771. * Define how fast the camera can accelerate to follow it s target.
  39772. */
  39773. cameraAcceleration: number;
  39774. /**
  39775. * Define the speed limit of the camera following an object.
  39776. */
  39777. maxCameraSpeed: number;
  39778. /**
  39779. * Define the target of the camera.
  39780. */
  39781. lockedTarget: Nullable<AbstractMesh>;
  39782. /**
  39783. * Defines the input associated with the camera.
  39784. */
  39785. inputs: FollowCameraInputsManager;
  39786. /**
  39787. * Instantiates the follow camera.
  39788. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39789. * @param name Define the name of the camera in the scene
  39790. * @param position Define the position of the camera
  39791. * @param scene Define the scene the camera belong to
  39792. * @param lockedTarget Define the target of the camera
  39793. */
  39794. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  39795. private _follow;
  39796. /**
  39797. * Attached controls to the current camera.
  39798. * @param element Defines the element the controls should be listened from
  39799. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39800. */
  39801. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39802. /**
  39803. * Detach the current controls from the camera.
  39804. * The camera will stop reacting to inputs.
  39805. * @param element Defines the element to stop listening the inputs from
  39806. */
  39807. detachControl(element: HTMLElement): void;
  39808. /** @hidden */
  39809. _checkInputs(): void;
  39810. private _checkLimits;
  39811. /**
  39812. * Gets the camera class name.
  39813. * @returns the class name
  39814. */
  39815. getClassName(): string;
  39816. }
  39817. /**
  39818. * Arc Rotate version of the follow camera.
  39819. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  39820. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39821. */
  39822. export class ArcFollowCamera extends TargetCamera {
  39823. /** The longitudinal angle of the camera */
  39824. alpha: number;
  39825. /** The latitudinal angle of the camera */
  39826. beta: number;
  39827. /** The radius of the camera from its target */
  39828. radius: number;
  39829. /** Define the camera target (the messh it should follow) */
  39830. target: Nullable<AbstractMesh>;
  39831. private _cartesianCoordinates;
  39832. /**
  39833. * Instantiates a new ArcFollowCamera
  39834. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39835. * @param name Define the name of the camera
  39836. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  39837. * @param beta Define the rotation angle of the camera around the elevation axis
  39838. * @param radius Define the radius of the camera from its target point
  39839. * @param target Define the target of the camera
  39840. * @param scene Define the scene the camera belongs to
  39841. */
  39842. constructor(name: string,
  39843. /** The longitudinal angle of the camera */
  39844. alpha: number,
  39845. /** The latitudinal angle of the camera */
  39846. beta: number,
  39847. /** The radius of the camera from its target */
  39848. radius: number,
  39849. /** Define the camera target (the messh it should follow) */
  39850. target: Nullable<AbstractMesh>, scene: Scene);
  39851. private _follow;
  39852. /** @hidden */
  39853. _checkInputs(): void;
  39854. /**
  39855. * Returns the class name of the object.
  39856. * It is mostly used internally for serialization purposes.
  39857. */
  39858. getClassName(): string;
  39859. }
  39860. }
  39861. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  39862. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39863. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39864. import { Nullable } from "babylonjs/types";
  39865. /**
  39866. * Manage the keyboard inputs to control the movement of a follow camera.
  39867. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39868. */
  39869. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  39870. /**
  39871. * Defines the camera the input is attached to.
  39872. */
  39873. camera: FollowCamera;
  39874. /**
  39875. * Defines the list of key codes associated with the up action (increase heightOffset)
  39876. */
  39877. keysHeightOffsetIncr: number[];
  39878. /**
  39879. * Defines the list of key codes associated with the down action (decrease heightOffset)
  39880. */
  39881. keysHeightOffsetDecr: number[];
  39882. /**
  39883. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  39884. */
  39885. keysHeightOffsetModifierAlt: boolean;
  39886. /**
  39887. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  39888. */
  39889. keysHeightOffsetModifierCtrl: boolean;
  39890. /**
  39891. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  39892. */
  39893. keysHeightOffsetModifierShift: boolean;
  39894. /**
  39895. * Defines the list of key codes associated with the left action (increase rotationOffset)
  39896. */
  39897. keysRotationOffsetIncr: number[];
  39898. /**
  39899. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  39900. */
  39901. keysRotationOffsetDecr: number[];
  39902. /**
  39903. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  39904. */
  39905. keysRotationOffsetModifierAlt: boolean;
  39906. /**
  39907. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  39908. */
  39909. keysRotationOffsetModifierCtrl: boolean;
  39910. /**
  39911. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  39912. */
  39913. keysRotationOffsetModifierShift: boolean;
  39914. /**
  39915. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  39916. */
  39917. keysRadiusIncr: number[];
  39918. /**
  39919. * Defines the list of key codes associated with the zoom-out action (increase radius)
  39920. */
  39921. keysRadiusDecr: number[];
  39922. /**
  39923. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  39924. */
  39925. keysRadiusModifierAlt: boolean;
  39926. /**
  39927. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  39928. */
  39929. keysRadiusModifierCtrl: boolean;
  39930. /**
  39931. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39932. */
  39933. keysRadiusModifierShift: boolean;
  39934. /**
  39935. * Defines the rate of change of heightOffset.
  39936. */
  39937. heightSensibility: number;
  39938. /**
  39939. * Defines the rate of change of rotationOffset.
  39940. */
  39941. rotationSensibility: number;
  39942. /**
  39943. * Defines the rate of change of radius.
  39944. */
  39945. radiusSensibility: number;
  39946. private _keys;
  39947. private _ctrlPressed;
  39948. private _altPressed;
  39949. private _shiftPressed;
  39950. private _onCanvasBlurObserver;
  39951. private _onKeyboardObserver;
  39952. private _engine;
  39953. private _scene;
  39954. /**
  39955. * Attach the input controls to a specific dom element to get the input from.
  39956. * @param element Defines the element the controls should be listened from
  39957. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39958. */
  39959. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39960. /**
  39961. * Detach the current controls from the specified dom element.
  39962. * @param element Defines the element to stop listening the inputs from
  39963. */
  39964. detachControl(element: Nullable<HTMLElement>): void;
  39965. /**
  39966. * Update the current camera state depending on the inputs that have been used this frame.
  39967. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39968. */
  39969. checkInputs(): void;
  39970. /**
  39971. * Gets the class name of the current input.
  39972. * @returns the class name
  39973. */
  39974. getClassName(): string;
  39975. /**
  39976. * Get the friendly name associated with the input class.
  39977. * @returns the input friendly name
  39978. */
  39979. getSimpleName(): string;
  39980. /**
  39981. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39982. * allow modification of the heightOffset value.
  39983. */
  39984. private _modifierHeightOffset;
  39985. /**
  39986. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39987. * allow modification of the rotationOffset value.
  39988. */
  39989. private _modifierRotationOffset;
  39990. /**
  39991. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39992. * allow modification of the radius value.
  39993. */
  39994. private _modifierRadius;
  39995. }
  39996. }
  39997. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39998. import { Nullable } from "babylonjs/types";
  39999. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  40000. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40001. import { Observable } from "babylonjs/Misc/observable";
  40002. module "babylonjs/Cameras/freeCameraInputsManager" {
  40003. interface FreeCameraInputsManager {
  40004. /**
  40005. * @hidden
  40006. */
  40007. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  40008. /**
  40009. * Add orientation input support to the input manager.
  40010. * @returns the current input manager
  40011. */
  40012. addDeviceOrientation(): FreeCameraInputsManager;
  40013. }
  40014. }
  40015. /**
  40016. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  40017. * Screen rotation is taken into account.
  40018. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40019. */
  40020. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  40021. private _camera;
  40022. private _screenOrientationAngle;
  40023. private _constantTranform;
  40024. private _screenQuaternion;
  40025. private _alpha;
  40026. private _beta;
  40027. private _gamma;
  40028. /**
  40029. * Can be used to detect if a device orientation sensor is availible on a device
  40030. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  40031. * @returns a promise that will resolve on orientation change
  40032. */
  40033. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  40034. /**
  40035. * @hidden
  40036. */
  40037. _onDeviceOrientationChangedObservable: Observable<void>;
  40038. /**
  40039. * Instantiates a new input
  40040. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40041. */
  40042. constructor();
  40043. /**
  40044. * Define the camera controlled by the input.
  40045. */
  40046. camera: FreeCamera;
  40047. /**
  40048. * Attach the input controls to a specific dom element to get the input from.
  40049. * @param element Defines the element the controls should be listened from
  40050. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40051. */
  40052. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40053. private _orientationChanged;
  40054. private _deviceOrientation;
  40055. /**
  40056. * Detach the current controls from the specified dom element.
  40057. * @param element Defines the element to stop listening the inputs from
  40058. */
  40059. detachControl(element: Nullable<HTMLElement>): void;
  40060. /**
  40061. * Update the current camera state depending on the inputs that have been used this frame.
  40062. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40063. */
  40064. checkInputs(): void;
  40065. /**
  40066. * Gets the class name of the current intput.
  40067. * @returns the class name
  40068. */
  40069. getClassName(): string;
  40070. /**
  40071. * Get the friendly name associated with the input class.
  40072. * @returns the input friendly name
  40073. */
  40074. getSimpleName(): string;
  40075. }
  40076. }
  40077. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  40078. import { Nullable } from "babylonjs/types";
  40079. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  40080. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40081. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40082. /**
  40083. * Manage the gamepad inputs to control a free camera.
  40084. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40085. */
  40086. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  40087. /**
  40088. * Define the camera the input is attached to.
  40089. */
  40090. camera: FreeCamera;
  40091. /**
  40092. * Define the Gamepad controlling the input
  40093. */
  40094. gamepad: Nullable<Gamepad>;
  40095. /**
  40096. * Defines the gamepad rotation sensiblity.
  40097. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40098. */
  40099. gamepadAngularSensibility: number;
  40100. /**
  40101. * Defines the gamepad move sensiblity.
  40102. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40103. */
  40104. gamepadMoveSensibility: number;
  40105. private _yAxisScale;
  40106. /**
  40107. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  40108. */
  40109. invertYAxis: boolean;
  40110. private _onGamepadConnectedObserver;
  40111. private _onGamepadDisconnectedObserver;
  40112. private _cameraTransform;
  40113. private _deltaTransform;
  40114. private _vector3;
  40115. private _vector2;
  40116. /**
  40117. * Attach the input controls to a specific dom element to get the input from.
  40118. * @param element Defines the element the controls should be listened from
  40119. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40120. */
  40121. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40122. /**
  40123. * Detach the current controls from the specified dom element.
  40124. * @param element Defines the element to stop listening the inputs from
  40125. */
  40126. detachControl(element: Nullable<HTMLElement>): void;
  40127. /**
  40128. * Update the current camera state depending on the inputs that have been used this frame.
  40129. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40130. */
  40131. checkInputs(): void;
  40132. /**
  40133. * Gets the class name of the current intput.
  40134. * @returns the class name
  40135. */
  40136. getClassName(): string;
  40137. /**
  40138. * Get the friendly name associated with the input class.
  40139. * @returns the input friendly name
  40140. */
  40141. getSimpleName(): string;
  40142. }
  40143. }
  40144. declare module "babylonjs/Misc/virtualJoystick" {
  40145. import { Nullable } from "babylonjs/types";
  40146. import { Vector3 } from "babylonjs/Maths/math.vector";
  40147. /**
  40148. * Defines the potential axis of a Joystick
  40149. */
  40150. export enum JoystickAxis {
  40151. /** X axis */
  40152. X = 0,
  40153. /** Y axis */
  40154. Y = 1,
  40155. /** Z axis */
  40156. Z = 2
  40157. }
  40158. /**
  40159. * Class used to define virtual joystick (used in touch mode)
  40160. */
  40161. export class VirtualJoystick {
  40162. /**
  40163. * Gets or sets a boolean indicating that left and right values must be inverted
  40164. */
  40165. reverseLeftRight: boolean;
  40166. /**
  40167. * Gets or sets a boolean indicating that up and down values must be inverted
  40168. */
  40169. reverseUpDown: boolean;
  40170. /**
  40171. * Gets the offset value for the position (ie. the change of the position value)
  40172. */
  40173. deltaPosition: Vector3;
  40174. /**
  40175. * Gets a boolean indicating if the virtual joystick was pressed
  40176. */
  40177. pressed: boolean;
  40178. /**
  40179. * Canvas the virtual joystick will render onto, default z-index of this is 5
  40180. */
  40181. static Canvas: Nullable<HTMLCanvasElement>;
  40182. private static _globalJoystickIndex;
  40183. private static vjCanvasContext;
  40184. private static vjCanvasWidth;
  40185. private static vjCanvasHeight;
  40186. private static halfWidth;
  40187. private _action;
  40188. private _axisTargetedByLeftAndRight;
  40189. private _axisTargetedByUpAndDown;
  40190. private _joystickSensibility;
  40191. private _inversedSensibility;
  40192. private _joystickPointerID;
  40193. private _joystickColor;
  40194. private _joystickPointerPos;
  40195. private _joystickPreviousPointerPos;
  40196. private _joystickPointerStartPos;
  40197. private _deltaJoystickVector;
  40198. private _leftJoystick;
  40199. private _touches;
  40200. private _onPointerDownHandlerRef;
  40201. private _onPointerMoveHandlerRef;
  40202. private _onPointerUpHandlerRef;
  40203. private _onResize;
  40204. /**
  40205. * Creates a new virtual joystick
  40206. * @param leftJoystick defines that the joystick is for left hand (false by default)
  40207. */
  40208. constructor(leftJoystick?: boolean);
  40209. /**
  40210. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  40211. * @param newJoystickSensibility defines the new sensibility
  40212. */
  40213. setJoystickSensibility(newJoystickSensibility: number): void;
  40214. private _onPointerDown;
  40215. private _onPointerMove;
  40216. private _onPointerUp;
  40217. /**
  40218. * Change the color of the virtual joystick
  40219. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  40220. */
  40221. setJoystickColor(newColor: string): void;
  40222. /**
  40223. * Defines a callback to call when the joystick is touched
  40224. * @param action defines the callback
  40225. */
  40226. setActionOnTouch(action: () => any): void;
  40227. /**
  40228. * Defines which axis you'd like to control for left & right
  40229. * @param axis defines the axis to use
  40230. */
  40231. setAxisForLeftRight(axis: JoystickAxis): void;
  40232. /**
  40233. * Defines which axis you'd like to control for up & down
  40234. * @param axis defines the axis to use
  40235. */
  40236. setAxisForUpDown(axis: JoystickAxis): void;
  40237. private _drawVirtualJoystick;
  40238. /**
  40239. * Release internal HTML canvas
  40240. */
  40241. releaseCanvas(): void;
  40242. }
  40243. }
  40244. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  40245. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  40246. import { Nullable } from "babylonjs/types";
  40247. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  40248. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40249. module "babylonjs/Cameras/freeCameraInputsManager" {
  40250. interface FreeCameraInputsManager {
  40251. /**
  40252. * Add virtual joystick input support to the input manager.
  40253. * @returns the current input manager
  40254. */
  40255. addVirtualJoystick(): FreeCameraInputsManager;
  40256. }
  40257. }
  40258. /**
  40259. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  40260. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40261. */
  40262. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  40263. /**
  40264. * Defines the camera the input is attached to.
  40265. */
  40266. camera: FreeCamera;
  40267. private _leftjoystick;
  40268. private _rightjoystick;
  40269. /**
  40270. * Gets the left stick of the virtual joystick.
  40271. * @returns The virtual Joystick
  40272. */
  40273. getLeftJoystick(): VirtualJoystick;
  40274. /**
  40275. * Gets the right stick of the virtual joystick.
  40276. * @returns The virtual Joystick
  40277. */
  40278. getRightJoystick(): VirtualJoystick;
  40279. /**
  40280. * Update the current camera state depending on the inputs that have been used this frame.
  40281. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40282. */
  40283. checkInputs(): void;
  40284. /**
  40285. * Attach the input controls to a specific dom element to get the input from.
  40286. * @param element Defines the element the controls should be listened from
  40287. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40288. */
  40289. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40290. /**
  40291. * Detach the current controls from the specified dom element.
  40292. * @param element Defines the element to stop listening the inputs from
  40293. */
  40294. detachControl(element: Nullable<HTMLElement>): void;
  40295. /**
  40296. * Gets the class name of the current intput.
  40297. * @returns the class name
  40298. */
  40299. getClassName(): string;
  40300. /**
  40301. * Get the friendly name associated with the input class.
  40302. * @returns the input friendly name
  40303. */
  40304. getSimpleName(): string;
  40305. }
  40306. }
  40307. declare module "babylonjs/Cameras/Inputs/index" {
  40308. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  40309. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  40310. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  40311. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  40312. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  40313. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  40314. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  40315. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  40316. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  40317. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  40318. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40319. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  40320. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  40321. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  40322. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  40323. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  40324. }
  40325. declare module "babylonjs/Cameras/touchCamera" {
  40326. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40327. import { Scene } from "babylonjs/scene";
  40328. import { Vector3 } from "babylonjs/Maths/math.vector";
  40329. /**
  40330. * This represents a FPS type of camera controlled by touch.
  40331. * This is like a universal camera minus the Gamepad controls.
  40332. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40333. */
  40334. export class TouchCamera extends FreeCamera {
  40335. /**
  40336. * Defines the touch sensibility for rotation.
  40337. * The higher the faster.
  40338. */
  40339. touchAngularSensibility: number;
  40340. /**
  40341. * Defines the touch sensibility for move.
  40342. * The higher the faster.
  40343. */
  40344. touchMoveSensibility: number;
  40345. /**
  40346. * Instantiates a new touch camera.
  40347. * This represents a FPS type of camera controlled by touch.
  40348. * This is like a universal camera minus the Gamepad controls.
  40349. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40350. * @param name Define the name of the camera in the scene
  40351. * @param position Define the start position of the camera in the scene
  40352. * @param scene Define the scene the camera belongs to
  40353. */
  40354. constructor(name: string, position: Vector3, scene: Scene);
  40355. /**
  40356. * Gets the current object class name.
  40357. * @return the class name
  40358. */
  40359. getClassName(): string;
  40360. /** @hidden */
  40361. _setupInputs(): void;
  40362. }
  40363. }
  40364. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  40365. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40366. import { Scene } from "babylonjs/scene";
  40367. import { Vector3 } from "babylonjs/Maths/math.vector";
  40368. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40369. import { Axis } from "babylonjs/Maths/math.axis";
  40370. /**
  40371. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  40372. * being tilted forward or back and left or right.
  40373. */
  40374. export class DeviceOrientationCamera extends FreeCamera {
  40375. private _initialQuaternion;
  40376. private _quaternionCache;
  40377. private _tmpDragQuaternion;
  40378. private _disablePointerInputWhenUsingDeviceOrientation;
  40379. /**
  40380. * Creates a new device orientation camera
  40381. * @param name The name of the camera
  40382. * @param position The start position camera
  40383. * @param scene The scene the camera belongs to
  40384. */
  40385. constructor(name: string, position: Vector3, scene: Scene);
  40386. /**
  40387. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  40388. */
  40389. disablePointerInputWhenUsingDeviceOrientation: boolean;
  40390. private _dragFactor;
  40391. /**
  40392. * Enabled turning on the y axis when the orientation sensor is active
  40393. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  40394. */
  40395. enableHorizontalDragging(dragFactor?: number): void;
  40396. /**
  40397. * Gets the current instance class name ("DeviceOrientationCamera").
  40398. * This helps avoiding instanceof at run time.
  40399. * @returns the class name
  40400. */
  40401. getClassName(): string;
  40402. /**
  40403. * @hidden
  40404. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  40405. */
  40406. _checkInputs(): void;
  40407. /**
  40408. * Reset the camera to its default orientation on the specified axis only.
  40409. * @param axis The axis to reset
  40410. */
  40411. resetToCurrentRotation(axis?: Axis): void;
  40412. }
  40413. }
  40414. declare module "babylonjs/Gamepads/xboxGamepad" {
  40415. import { Observable } from "babylonjs/Misc/observable";
  40416. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40417. /**
  40418. * Defines supported buttons for XBox360 compatible gamepads
  40419. */
  40420. export enum Xbox360Button {
  40421. /** A */
  40422. A = 0,
  40423. /** B */
  40424. B = 1,
  40425. /** X */
  40426. X = 2,
  40427. /** Y */
  40428. Y = 3,
  40429. /** Start */
  40430. Start = 4,
  40431. /** Back */
  40432. Back = 5,
  40433. /** Left button */
  40434. LB = 6,
  40435. /** Right button */
  40436. RB = 7,
  40437. /** Left stick */
  40438. LeftStick = 8,
  40439. /** Right stick */
  40440. RightStick = 9
  40441. }
  40442. /** Defines values for XBox360 DPad */
  40443. export enum Xbox360Dpad {
  40444. /** Up */
  40445. Up = 0,
  40446. /** Down */
  40447. Down = 1,
  40448. /** Left */
  40449. Left = 2,
  40450. /** Right */
  40451. Right = 3
  40452. }
  40453. /**
  40454. * Defines a XBox360 gamepad
  40455. */
  40456. export class Xbox360Pad extends Gamepad {
  40457. private _leftTrigger;
  40458. private _rightTrigger;
  40459. private _onlefttriggerchanged;
  40460. private _onrighttriggerchanged;
  40461. private _onbuttondown;
  40462. private _onbuttonup;
  40463. private _ondpaddown;
  40464. private _ondpadup;
  40465. /** Observable raised when a button is pressed */
  40466. onButtonDownObservable: Observable<Xbox360Button>;
  40467. /** Observable raised when a button is released */
  40468. onButtonUpObservable: Observable<Xbox360Button>;
  40469. /** Observable raised when a pad is pressed */
  40470. onPadDownObservable: Observable<Xbox360Dpad>;
  40471. /** Observable raised when a pad is released */
  40472. onPadUpObservable: Observable<Xbox360Dpad>;
  40473. private _buttonA;
  40474. private _buttonB;
  40475. private _buttonX;
  40476. private _buttonY;
  40477. private _buttonBack;
  40478. private _buttonStart;
  40479. private _buttonLB;
  40480. private _buttonRB;
  40481. private _buttonLeftStick;
  40482. private _buttonRightStick;
  40483. private _dPadUp;
  40484. private _dPadDown;
  40485. private _dPadLeft;
  40486. private _dPadRight;
  40487. private _isXboxOnePad;
  40488. /**
  40489. * Creates a new XBox360 gamepad object
  40490. * @param id defines the id of this gamepad
  40491. * @param index defines its index
  40492. * @param gamepad defines the internal HTML gamepad object
  40493. * @param xboxOne defines if it is a XBox One gamepad
  40494. */
  40495. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  40496. /**
  40497. * Defines the callback to call when left trigger is pressed
  40498. * @param callback defines the callback to use
  40499. */
  40500. onlefttriggerchanged(callback: (value: number) => void): void;
  40501. /**
  40502. * Defines the callback to call when right trigger is pressed
  40503. * @param callback defines the callback to use
  40504. */
  40505. onrighttriggerchanged(callback: (value: number) => void): void;
  40506. /**
  40507. * Gets the left trigger value
  40508. */
  40509. /**
  40510. * Sets the left trigger value
  40511. */
  40512. leftTrigger: number;
  40513. /**
  40514. * Gets the right trigger value
  40515. */
  40516. /**
  40517. * Sets the right trigger value
  40518. */
  40519. rightTrigger: number;
  40520. /**
  40521. * Defines the callback to call when a button is pressed
  40522. * @param callback defines the callback to use
  40523. */
  40524. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  40525. /**
  40526. * Defines the callback to call when a button is released
  40527. * @param callback defines the callback to use
  40528. */
  40529. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  40530. /**
  40531. * Defines the callback to call when a pad is pressed
  40532. * @param callback defines the callback to use
  40533. */
  40534. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  40535. /**
  40536. * Defines the callback to call when a pad is released
  40537. * @param callback defines the callback to use
  40538. */
  40539. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  40540. private _setButtonValue;
  40541. private _setDPadValue;
  40542. /**
  40543. * Gets the value of the `A` button
  40544. */
  40545. /**
  40546. * Sets the value of the `A` button
  40547. */
  40548. buttonA: number;
  40549. /**
  40550. * Gets the value of the `B` button
  40551. */
  40552. /**
  40553. * Sets the value of the `B` button
  40554. */
  40555. buttonB: number;
  40556. /**
  40557. * Gets the value of the `X` button
  40558. */
  40559. /**
  40560. * Sets the value of the `X` button
  40561. */
  40562. buttonX: number;
  40563. /**
  40564. * Gets the value of the `Y` button
  40565. */
  40566. /**
  40567. * Sets the value of the `Y` button
  40568. */
  40569. buttonY: number;
  40570. /**
  40571. * Gets the value of the `Start` button
  40572. */
  40573. /**
  40574. * Sets the value of the `Start` button
  40575. */
  40576. buttonStart: number;
  40577. /**
  40578. * Gets the value of the `Back` button
  40579. */
  40580. /**
  40581. * Sets the value of the `Back` button
  40582. */
  40583. buttonBack: number;
  40584. /**
  40585. * Gets the value of the `Left` button
  40586. */
  40587. /**
  40588. * Sets the value of the `Left` button
  40589. */
  40590. buttonLB: number;
  40591. /**
  40592. * Gets the value of the `Right` button
  40593. */
  40594. /**
  40595. * Sets the value of the `Right` button
  40596. */
  40597. buttonRB: number;
  40598. /**
  40599. * Gets the value of the Left joystick
  40600. */
  40601. /**
  40602. * Sets the value of the Left joystick
  40603. */
  40604. buttonLeftStick: number;
  40605. /**
  40606. * Gets the value of the Right joystick
  40607. */
  40608. /**
  40609. * Sets the value of the Right joystick
  40610. */
  40611. buttonRightStick: number;
  40612. /**
  40613. * Gets the value of D-pad up
  40614. */
  40615. /**
  40616. * Sets the value of D-pad up
  40617. */
  40618. dPadUp: number;
  40619. /**
  40620. * Gets the value of D-pad down
  40621. */
  40622. /**
  40623. * Sets the value of D-pad down
  40624. */
  40625. dPadDown: number;
  40626. /**
  40627. * Gets the value of D-pad left
  40628. */
  40629. /**
  40630. * Sets the value of D-pad left
  40631. */
  40632. dPadLeft: number;
  40633. /**
  40634. * Gets the value of D-pad right
  40635. */
  40636. /**
  40637. * Sets the value of D-pad right
  40638. */
  40639. dPadRight: number;
  40640. /**
  40641. * Force the gamepad to synchronize with device values
  40642. */
  40643. update(): void;
  40644. /**
  40645. * Disposes the gamepad
  40646. */
  40647. dispose(): void;
  40648. }
  40649. }
  40650. declare module "babylonjs/Gamepads/dualShockGamepad" {
  40651. import { Observable } from "babylonjs/Misc/observable";
  40652. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40653. /**
  40654. * Defines supported buttons for DualShock compatible gamepads
  40655. */
  40656. export enum DualShockButton {
  40657. /** Cross */
  40658. Cross = 0,
  40659. /** Circle */
  40660. Circle = 1,
  40661. /** Square */
  40662. Square = 2,
  40663. /** Triangle */
  40664. Triangle = 3,
  40665. /** Options */
  40666. Options = 4,
  40667. /** Share */
  40668. Share = 5,
  40669. /** L1 */
  40670. L1 = 6,
  40671. /** R1 */
  40672. R1 = 7,
  40673. /** Left stick */
  40674. LeftStick = 8,
  40675. /** Right stick */
  40676. RightStick = 9
  40677. }
  40678. /** Defines values for DualShock DPad */
  40679. export enum DualShockDpad {
  40680. /** Up */
  40681. Up = 0,
  40682. /** Down */
  40683. Down = 1,
  40684. /** Left */
  40685. Left = 2,
  40686. /** Right */
  40687. Right = 3
  40688. }
  40689. /**
  40690. * Defines a DualShock gamepad
  40691. */
  40692. export class DualShockPad extends Gamepad {
  40693. private _leftTrigger;
  40694. private _rightTrigger;
  40695. private _onlefttriggerchanged;
  40696. private _onrighttriggerchanged;
  40697. private _onbuttondown;
  40698. private _onbuttonup;
  40699. private _ondpaddown;
  40700. private _ondpadup;
  40701. /** Observable raised when a button is pressed */
  40702. onButtonDownObservable: Observable<DualShockButton>;
  40703. /** Observable raised when a button is released */
  40704. onButtonUpObservable: Observable<DualShockButton>;
  40705. /** Observable raised when a pad is pressed */
  40706. onPadDownObservable: Observable<DualShockDpad>;
  40707. /** Observable raised when a pad is released */
  40708. onPadUpObservable: Observable<DualShockDpad>;
  40709. private _buttonCross;
  40710. private _buttonCircle;
  40711. private _buttonSquare;
  40712. private _buttonTriangle;
  40713. private _buttonShare;
  40714. private _buttonOptions;
  40715. private _buttonL1;
  40716. private _buttonR1;
  40717. private _buttonLeftStick;
  40718. private _buttonRightStick;
  40719. private _dPadUp;
  40720. private _dPadDown;
  40721. private _dPadLeft;
  40722. private _dPadRight;
  40723. /**
  40724. * Creates a new DualShock gamepad object
  40725. * @param id defines the id of this gamepad
  40726. * @param index defines its index
  40727. * @param gamepad defines the internal HTML gamepad object
  40728. */
  40729. constructor(id: string, index: number, gamepad: any);
  40730. /**
  40731. * Defines the callback to call when left trigger is pressed
  40732. * @param callback defines the callback to use
  40733. */
  40734. onlefttriggerchanged(callback: (value: number) => void): void;
  40735. /**
  40736. * Defines the callback to call when right trigger is pressed
  40737. * @param callback defines the callback to use
  40738. */
  40739. onrighttriggerchanged(callback: (value: number) => void): void;
  40740. /**
  40741. * Gets the left trigger value
  40742. */
  40743. /**
  40744. * Sets the left trigger value
  40745. */
  40746. leftTrigger: number;
  40747. /**
  40748. * Gets the right trigger value
  40749. */
  40750. /**
  40751. * Sets the right trigger value
  40752. */
  40753. rightTrigger: number;
  40754. /**
  40755. * Defines the callback to call when a button is pressed
  40756. * @param callback defines the callback to use
  40757. */
  40758. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  40759. /**
  40760. * Defines the callback to call when a button is released
  40761. * @param callback defines the callback to use
  40762. */
  40763. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  40764. /**
  40765. * Defines the callback to call when a pad is pressed
  40766. * @param callback defines the callback to use
  40767. */
  40768. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  40769. /**
  40770. * Defines the callback to call when a pad is released
  40771. * @param callback defines the callback to use
  40772. */
  40773. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  40774. private _setButtonValue;
  40775. private _setDPadValue;
  40776. /**
  40777. * Gets the value of the `Cross` button
  40778. */
  40779. /**
  40780. * Sets the value of the `Cross` button
  40781. */
  40782. buttonCross: number;
  40783. /**
  40784. * Gets the value of the `Circle` button
  40785. */
  40786. /**
  40787. * Sets the value of the `Circle` button
  40788. */
  40789. buttonCircle: number;
  40790. /**
  40791. * Gets the value of the `Square` button
  40792. */
  40793. /**
  40794. * Sets the value of the `Square` button
  40795. */
  40796. buttonSquare: number;
  40797. /**
  40798. * Gets the value of the `Triangle` button
  40799. */
  40800. /**
  40801. * Sets the value of the `Triangle` button
  40802. */
  40803. buttonTriangle: number;
  40804. /**
  40805. * Gets the value of the `Options` button
  40806. */
  40807. /**
  40808. * Sets the value of the `Options` button
  40809. */
  40810. buttonOptions: number;
  40811. /**
  40812. * Gets the value of the `Share` button
  40813. */
  40814. /**
  40815. * Sets the value of the `Share` button
  40816. */
  40817. buttonShare: number;
  40818. /**
  40819. * Gets the value of the `L1` button
  40820. */
  40821. /**
  40822. * Sets the value of the `L1` button
  40823. */
  40824. buttonL1: number;
  40825. /**
  40826. * Gets the value of the `R1` button
  40827. */
  40828. /**
  40829. * Sets the value of the `R1` button
  40830. */
  40831. buttonR1: number;
  40832. /**
  40833. * Gets the value of the Left joystick
  40834. */
  40835. /**
  40836. * Sets the value of the Left joystick
  40837. */
  40838. buttonLeftStick: number;
  40839. /**
  40840. * Gets the value of the Right joystick
  40841. */
  40842. /**
  40843. * Sets the value of the Right joystick
  40844. */
  40845. buttonRightStick: number;
  40846. /**
  40847. * Gets the value of D-pad up
  40848. */
  40849. /**
  40850. * Sets the value of D-pad up
  40851. */
  40852. dPadUp: number;
  40853. /**
  40854. * Gets the value of D-pad down
  40855. */
  40856. /**
  40857. * Sets the value of D-pad down
  40858. */
  40859. dPadDown: number;
  40860. /**
  40861. * Gets the value of D-pad left
  40862. */
  40863. /**
  40864. * Sets the value of D-pad left
  40865. */
  40866. dPadLeft: number;
  40867. /**
  40868. * Gets the value of D-pad right
  40869. */
  40870. /**
  40871. * Sets the value of D-pad right
  40872. */
  40873. dPadRight: number;
  40874. /**
  40875. * Force the gamepad to synchronize with device values
  40876. */
  40877. update(): void;
  40878. /**
  40879. * Disposes the gamepad
  40880. */
  40881. dispose(): void;
  40882. }
  40883. }
  40884. declare module "babylonjs/Gamepads/gamepadManager" {
  40885. import { Observable } from "babylonjs/Misc/observable";
  40886. import { Nullable } from "babylonjs/types";
  40887. import { Scene } from "babylonjs/scene";
  40888. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40889. /**
  40890. * Manager for handling gamepads
  40891. */
  40892. export class GamepadManager {
  40893. private _scene?;
  40894. private _babylonGamepads;
  40895. private _oneGamepadConnected;
  40896. /** @hidden */
  40897. _isMonitoring: boolean;
  40898. private _gamepadEventSupported;
  40899. private _gamepadSupport;
  40900. /**
  40901. * observable to be triggered when the gamepad controller has been connected
  40902. */
  40903. onGamepadConnectedObservable: Observable<Gamepad>;
  40904. /**
  40905. * observable to be triggered when the gamepad controller has been disconnected
  40906. */
  40907. onGamepadDisconnectedObservable: Observable<Gamepad>;
  40908. private _onGamepadConnectedEvent;
  40909. private _onGamepadDisconnectedEvent;
  40910. /**
  40911. * Initializes the gamepad manager
  40912. * @param _scene BabylonJS scene
  40913. */
  40914. constructor(_scene?: Scene | undefined);
  40915. /**
  40916. * The gamepads in the game pad manager
  40917. */
  40918. readonly gamepads: Gamepad[];
  40919. /**
  40920. * Get the gamepad controllers based on type
  40921. * @param type The type of gamepad controller
  40922. * @returns Nullable gamepad
  40923. */
  40924. getGamepadByType(type?: number): Nullable<Gamepad>;
  40925. /**
  40926. * Disposes the gamepad manager
  40927. */
  40928. dispose(): void;
  40929. private _addNewGamepad;
  40930. private _startMonitoringGamepads;
  40931. private _stopMonitoringGamepads;
  40932. /** @hidden */
  40933. _checkGamepadsStatus(): void;
  40934. private _updateGamepadObjects;
  40935. }
  40936. }
  40937. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40938. import { Nullable } from "babylonjs/types";
  40939. import { Scene } from "babylonjs/scene";
  40940. import { ISceneComponent } from "babylonjs/sceneComponent";
  40941. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40942. module "babylonjs/scene" {
  40943. interface Scene {
  40944. /** @hidden */
  40945. _gamepadManager: Nullable<GamepadManager>;
  40946. /**
  40947. * Gets the gamepad manager associated with the scene
  40948. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40949. */
  40950. gamepadManager: GamepadManager;
  40951. }
  40952. }
  40953. module "babylonjs/Cameras/freeCameraInputsManager" {
  40954. /**
  40955. * Interface representing a free camera inputs manager
  40956. */
  40957. interface FreeCameraInputsManager {
  40958. /**
  40959. * Adds gamepad input support to the FreeCameraInputsManager.
  40960. * @returns the FreeCameraInputsManager
  40961. */
  40962. addGamepad(): FreeCameraInputsManager;
  40963. }
  40964. }
  40965. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40966. /**
  40967. * Interface representing an arc rotate camera inputs manager
  40968. */
  40969. interface ArcRotateCameraInputsManager {
  40970. /**
  40971. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40972. * @returns the camera inputs manager
  40973. */
  40974. addGamepad(): ArcRotateCameraInputsManager;
  40975. }
  40976. }
  40977. /**
  40978. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40979. */
  40980. export class GamepadSystemSceneComponent implements ISceneComponent {
  40981. /**
  40982. * The component name helpfull to identify the component in the list of scene components.
  40983. */
  40984. readonly name: string;
  40985. /**
  40986. * The scene the component belongs to.
  40987. */
  40988. scene: Scene;
  40989. /**
  40990. * Creates a new instance of the component for the given scene
  40991. * @param scene Defines the scene to register the component in
  40992. */
  40993. constructor(scene: Scene);
  40994. /**
  40995. * Registers the component in a given scene
  40996. */
  40997. register(): void;
  40998. /**
  40999. * Rebuilds the elements related to this component in case of
  41000. * context lost for instance.
  41001. */
  41002. rebuild(): void;
  41003. /**
  41004. * Disposes the component and the associated ressources
  41005. */
  41006. dispose(): void;
  41007. private _beforeCameraUpdate;
  41008. }
  41009. }
  41010. declare module "babylonjs/Cameras/universalCamera" {
  41011. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  41012. import { Scene } from "babylonjs/scene";
  41013. import { Vector3 } from "babylonjs/Maths/math.vector";
  41014. import "babylonjs/Gamepads/gamepadSceneComponent";
  41015. /**
  41016. * 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,
  41017. * which still works and will still be found in many Playgrounds.
  41018. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41019. */
  41020. export class UniversalCamera extends TouchCamera {
  41021. /**
  41022. * Defines the gamepad rotation sensiblity.
  41023. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  41024. */
  41025. gamepadAngularSensibility: number;
  41026. /**
  41027. * Defines the gamepad move sensiblity.
  41028. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  41029. */
  41030. gamepadMoveSensibility: number;
  41031. /**
  41032. * 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,
  41033. * which still works and will still be found in many Playgrounds.
  41034. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41035. * @param name Define the name of the camera in the scene
  41036. * @param position Define the start position of the camera in the scene
  41037. * @param scene Define the scene the camera belongs to
  41038. */
  41039. constructor(name: string, position: Vector3, scene: Scene);
  41040. /**
  41041. * Gets the current object class name.
  41042. * @return the class name
  41043. */
  41044. getClassName(): string;
  41045. }
  41046. }
  41047. declare module "babylonjs/Cameras/gamepadCamera" {
  41048. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41049. import { Scene } from "babylonjs/scene";
  41050. import { Vector3 } from "babylonjs/Maths/math.vector";
  41051. /**
  41052. * This represents a FPS type of camera. This is only here for back compat purpose.
  41053. * Please use the UniversalCamera instead as both are identical.
  41054. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41055. */
  41056. export class GamepadCamera extends UniversalCamera {
  41057. /**
  41058. * Instantiates a new Gamepad Camera
  41059. * This represents a FPS type of camera. This is only here for back compat purpose.
  41060. * Please use the UniversalCamera instead as both are identical.
  41061. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41062. * @param name Define the name of the camera in the scene
  41063. * @param position Define the start position of the camera in the scene
  41064. * @param scene Define the scene the camera belongs to
  41065. */
  41066. constructor(name: string, position: Vector3, scene: Scene);
  41067. /**
  41068. * Gets the current object class name.
  41069. * @return the class name
  41070. */
  41071. getClassName(): string;
  41072. }
  41073. }
  41074. declare module "babylonjs/Shaders/pass.fragment" {
  41075. /** @hidden */
  41076. export var passPixelShader: {
  41077. name: string;
  41078. shader: string;
  41079. };
  41080. }
  41081. declare module "babylonjs/Shaders/passCube.fragment" {
  41082. /** @hidden */
  41083. export var passCubePixelShader: {
  41084. name: string;
  41085. shader: string;
  41086. };
  41087. }
  41088. declare module "babylonjs/PostProcesses/passPostProcess" {
  41089. import { Nullable } from "babylonjs/types";
  41090. import { Camera } from "babylonjs/Cameras/camera";
  41091. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41092. import { Engine } from "babylonjs/Engines/engine";
  41093. import "babylonjs/Shaders/pass.fragment";
  41094. import "babylonjs/Shaders/passCube.fragment";
  41095. /**
  41096. * PassPostProcess which produces an output the same as it's input
  41097. */
  41098. export class PassPostProcess extends PostProcess {
  41099. /**
  41100. * Creates the PassPostProcess
  41101. * @param name The name of the effect.
  41102. * @param options The required width/height ratio to downsize to before computing the render pass.
  41103. * @param camera The camera to apply the render pass to.
  41104. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41105. * @param engine The engine which the post process will be applied. (default: current engine)
  41106. * @param reusable If the post process can be reused on the same frame. (default: false)
  41107. * @param textureType The type of texture to be used when performing the post processing.
  41108. * @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)
  41109. */
  41110. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  41111. }
  41112. /**
  41113. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  41114. */
  41115. export class PassCubePostProcess extends PostProcess {
  41116. private _face;
  41117. /**
  41118. * Gets or sets the cube face to display.
  41119. * * 0 is +X
  41120. * * 1 is -X
  41121. * * 2 is +Y
  41122. * * 3 is -Y
  41123. * * 4 is +Z
  41124. * * 5 is -Z
  41125. */
  41126. face: number;
  41127. /**
  41128. * Creates the PassCubePostProcess
  41129. * @param name The name of the effect.
  41130. * @param options The required width/height ratio to downsize to before computing the render pass.
  41131. * @param camera The camera to apply the render pass to.
  41132. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41133. * @param engine The engine which the post process will be applied. (default: current engine)
  41134. * @param reusable If the post process can be reused on the same frame. (default: false)
  41135. * @param textureType The type of texture to be used when performing the post processing.
  41136. * @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)
  41137. */
  41138. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  41139. }
  41140. }
  41141. declare module "babylonjs/Shaders/anaglyph.fragment" {
  41142. /** @hidden */
  41143. export var anaglyphPixelShader: {
  41144. name: string;
  41145. shader: string;
  41146. };
  41147. }
  41148. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  41149. import { Engine } from "babylonjs/Engines/engine";
  41150. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41151. import { Camera } from "babylonjs/Cameras/camera";
  41152. import "babylonjs/Shaders/anaglyph.fragment";
  41153. /**
  41154. * Postprocess used to generate anaglyphic rendering
  41155. */
  41156. export class AnaglyphPostProcess extends PostProcess {
  41157. private _passedProcess;
  41158. /**
  41159. * Creates a new AnaglyphPostProcess
  41160. * @param name defines postprocess name
  41161. * @param options defines creation options or target ratio scale
  41162. * @param rigCameras defines cameras using this postprocess
  41163. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  41164. * @param engine defines hosting engine
  41165. * @param reusable defines if the postprocess will be reused multiple times per frame
  41166. */
  41167. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  41168. }
  41169. }
  41170. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  41171. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  41172. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41173. import { Scene } from "babylonjs/scene";
  41174. import { Vector3 } from "babylonjs/Maths/math.vector";
  41175. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41176. /**
  41177. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  41178. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41179. */
  41180. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  41181. /**
  41182. * Creates a new AnaglyphArcRotateCamera
  41183. * @param name defines camera name
  41184. * @param alpha defines alpha angle (in radians)
  41185. * @param beta defines beta angle (in radians)
  41186. * @param radius defines radius
  41187. * @param target defines camera target
  41188. * @param interaxialDistance defines distance between each color axis
  41189. * @param scene defines the hosting scene
  41190. */
  41191. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  41192. /**
  41193. * Gets camera class name
  41194. * @returns AnaglyphArcRotateCamera
  41195. */
  41196. getClassName(): string;
  41197. }
  41198. }
  41199. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  41200. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41201. import { Scene } from "babylonjs/scene";
  41202. import { Vector3 } from "babylonjs/Maths/math.vector";
  41203. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41204. /**
  41205. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  41206. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41207. */
  41208. export class AnaglyphFreeCamera extends FreeCamera {
  41209. /**
  41210. * Creates a new AnaglyphFreeCamera
  41211. * @param name defines camera name
  41212. * @param position defines initial position
  41213. * @param interaxialDistance defines distance between each color axis
  41214. * @param scene defines the hosting scene
  41215. */
  41216. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41217. /**
  41218. * Gets camera class name
  41219. * @returns AnaglyphFreeCamera
  41220. */
  41221. getClassName(): string;
  41222. }
  41223. }
  41224. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  41225. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41226. import { Scene } from "babylonjs/scene";
  41227. import { Vector3 } from "babylonjs/Maths/math.vector";
  41228. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41229. /**
  41230. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  41231. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41232. */
  41233. export class AnaglyphGamepadCamera extends GamepadCamera {
  41234. /**
  41235. * Creates a new AnaglyphGamepadCamera
  41236. * @param name defines camera name
  41237. * @param position defines initial position
  41238. * @param interaxialDistance defines distance between each color axis
  41239. * @param scene defines the hosting scene
  41240. */
  41241. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41242. /**
  41243. * Gets camera class name
  41244. * @returns AnaglyphGamepadCamera
  41245. */
  41246. getClassName(): string;
  41247. }
  41248. }
  41249. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  41250. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41251. import { Scene } from "babylonjs/scene";
  41252. import { Vector3 } from "babylonjs/Maths/math.vector";
  41253. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41254. /**
  41255. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  41256. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41257. */
  41258. export class AnaglyphUniversalCamera extends UniversalCamera {
  41259. /**
  41260. * Creates a new AnaglyphUniversalCamera
  41261. * @param name defines camera name
  41262. * @param position defines initial position
  41263. * @param interaxialDistance defines distance between each color axis
  41264. * @param scene defines the hosting scene
  41265. */
  41266. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41267. /**
  41268. * Gets camera class name
  41269. * @returns AnaglyphUniversalCamera
  41270. */
  41271. getClassName(): string;
  41272. }
  41273. }
  41274. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  41275. /** @hidden */
  41276. export var stereoscopicInterlacePixelShader: {
  41277. name: string;
  41278. shader: string;
  41279. };
  41280. }
  41281. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  41282. import { Camera } from "babylonjs/Cameras/camera";
  41283. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41284. import { Engine } from "babylonjs/Engines/engine";
  41285. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  41286. /**
  41287. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  41288. */
  41289. export class StereoscopicInterlacePostProcess extends PostProcess {
  41290. private _stepSize;
  41291. private _passedProcess;
  41292. /**
  41293. * Initializes a StereoscopicInterlacePostProcess
  41294. * @param name The name of the effect.
  41295. * @param rigCameras The rig cameras to be appled to the post process
  41296. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  41297. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41298. * @param engine The engine which the post process will be applied. (default: current engine)
  41299. * @param reusable If the post process can be reused on the same frame. (default: false)
  41300. */
  41301. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  41302. }
  41303. }
  41304. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  41305. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  41306. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41307. import { Scene } from "babylonjs/scene";
  41308. import { Vector3 } from "babylonjs/Maths/math.vector";
  41309. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41310. /**
  41311. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  41312. * @see http://doc.babylonjs.com/features/cameras
  41313. */
  41314. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  41315. /**
  41316. * Creates a new StereoscopicArcRotateCamera
  41317. * @param name defines camera name
  41318. * @param alpha defines alpha angle (in radians)
  41319. * @param beta defines beta angle (in radians)
  41320. * @param radius defines radius
  41321. * @param target defines camera target
  41322. * @param interaxialDistance defines distance between each color axis
  41323. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41324. * @param scene defines the hosting scene
  41325. */
  41326. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41327. /**
  41328. * Gets camera class name
  41329. * @returns StereoscopicArcRotateCamera
  41330. */
  41331. getClassName(): string;
  41332. }
  41333. }
  41334. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  41335. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41336. import { Scene } from "babylonjs/scene";
  41337. import { Vector3 } from "babylonjs/Maths/math.vector";
  41338. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41339. /**
  41340. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  41341. * @see http://doc.babylonjs.com/features/cameras
  41342. */
  41343. export class StereoscopicFreeCamera extends FreeCamera {
  41344. /**
  41345. * Creates a new StereoscopicFreeCamera
  41346. * @param name defines camera name
  41347. * @param position defines initial position
  41348. * @param interaxialDistance defines distance between each color axis
  41349. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41350. * @param scene defines the hosting scene
  41351. */
  41352. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41353. /**
  41354. * Gets camera class name
  41355. * @returns StereoscopicFreeCamera
  41356. */
  41357. getClassName(): string;
  41358. }
  41359. }
  41360. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  41361. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41362. import { Scene } from "babylonjs/scene";
  41363. import { Vector3 } from "babylonjs/Maths/math.vector";
  41364. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41365. /**
  41366. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  41367. * @see http://doc.babylonjs.com/features/cameras
  41368. */
  41369. export class StereoscopicGamepadCamera extends GamepadCamera {
  41370. /**
  41371. * Creates a new StereoscopicGamepadCamera
  41372. * @param name defines camera name
  41373. * @param position defines initial position
  41374. * @param interaxialDistance defines distance between each color axis
  41375. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41376. * @param scene defines the hosting scene
  41377. */
  41378. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41379. /**
  41380. * Gets camera class name
  41381. * @returns StereoscopicGamepadCamera
  41382. */
  41383. getClassName(): string;
  41384. }
  41385. }
  41386. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  41387. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41388. import { Scene } from "babylonjs/scene";
  41389. import { Vector3 } from "babylonjs/Maths/math.vector";
  41390. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41391. /**
  41392. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  41393. * @see http://doc.babylonjs.com/features/cameras
  41394. */
  41395. export class StereoscopicUniversalCamera extends UniversalCamera {
  41396. /**
  41397. * Creates a new StereoscopicUniversalCamera
  41398. * @param name defines camera name
  41399. * @param position defines initial position
  41400. * @param interaxialDistance defines distance between each color axis
  41401. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41402. * @param scene defines the hosting scene
  41403. */
  41404. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41405. /**
  41406. * Gets camera class name
  41407. * @returns StereoscopicUniversalCamera
  41408. */
  41409. getClassName(): string;
  41410. }
  41411. }
  41412. declare module "babylonjs/Cameras/Stereoscopic/index" {
  41413. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  41414. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  41415. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  41416. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  41417. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  41418. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  41419. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  41420. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  41421. }
  41422. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  41423. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41424. import { Scene } from "babylonjs/scene";
  41425. import { Vector3 } from "babylonjs/Maths/math.vector";
  41426. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  41427. /**
  41428. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  41429. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41430. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41431. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41432. */
  41433. export class VirtualJoysticksCamera extends FreeCamera {
  41434. /**
  41435. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  41436. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41437. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41438. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41439. * @param name Define the name of the camera in the scene
  41440. * @param position Define the start position of the camera in the scene
  41441. * @param scene Define the scene the camera belongs to
  41442. */
  41443. constructor(name: string, position: Vector3, scene: Scene);
  41444. /**
  41445. * Gets the current object class name.
  41446. * @return the class name
  41447. */
  41448. getClassName(): string;
  41449. }
  41450. }
  41451. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  41452. import { Matrix } from "babylonjs/Maths/math.vector";
  41453. /**
  41454. * This represents all the required metrics to create a VR camera.
  41455. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  41456. */
  41457. export class VRCameraMetrics {
  41458. /**
  41459. * Define the horizontal resolution off the screen.
  41460. */
  41461. hResolution: number;
  41462. /**
  41463. * Define the vertical resolution off the screen.
  41464. */
  41465. vResolution: number;
  41466. /**
  41467. * Define the horizontal screen size.
  41468. */
  41469. hScreenSize: number;
  41470. /**
  41471. * Define the vertical screen size.
  41472. */
  41473. vScreenSize: number;
  41474. /**
  41475. * Define the vertical screen center position.
  41476. */
  41477. vScreenCenter: number;
  41478. /**
  41479. * Define the distance of the eyes to the screen.
  41480. */
  41481. eyeToScreenDistance: number;
  41482. /**
  41483. * Define the distance between both lenses
  41484. */
  41485. lensSeparationDistance: number;
  41486. /**
  41487. * Define the distance between both viewer's eyes.
  41488. */
  41489. interpupillaryDistance: number;
  41490. /**
  41491. * Define the distortion factor of the VR postprocess.
  41492. * Please, touch with care.
  41493. */
  41494. distortionK: number[];
  41495. /**
  41496. * Define the chromatic aberration correction factors for the VR post process.
  41497. */
  41498. chromaAbCorrection: number[];
  41499. /**
  41500. * Define the scale factor of the post process.
  41501. * The smaller the better but the slower.
  41502. */
  41503. postProcessScaleFactor: number;
  41504. /**
  41505. * Define an offset for the lens center.
  41506. */
  41507. lensCenterOffset: number;
  41508. /**
  41509. * Define if the current vr camera should compensate the distortion of the lense or not.
  41510. */
  41511. compensateDistortion: boolean;
  41512. /**
  41513. * Defines if multiview should be enabled when rendering (Default: false)
  41514. */
  41515. multiviewEnabled: boolean;
  41516. /**
  41517. * Gets the rendering aspect ratio based on the provided resolutions.
  41518. */
  41519. readonly aspectRatio: number;
  41520. /**
  41521. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  41522. */
  41523. readonly aspectRatioFov: number;
  41524. /**
  41525. * @hidden
  41526. */
  41527. readonly leftHMatrix: Matrix;
  41528. /**
  41529. * @hidden
  41530. */
  41531. readonly rightHMatrix: Matrix;
  41532. /**
  41533. * @hidden
  41534. */
  41535. readonly leftPreViewMatrix: Matrix;
  41536. /**
  41537. * @hidden
  41538. */
  41539. readonly rightPreViewMatrix: Matrix;
  41540. /**
  41541. * Get the default VRMetrics based on the most generic setup.
  41542. * @returns the default vr metrics
  41543. */
  41544. static GetDefault(): VRCameraMetrics;
  41545. }
  41546. }
  41547. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  41548. /** @hidden */
  41549. export var vrDistortionCorrectionPixelShader: {
  41550. name: string;
  41551. shader: string;
  41552. };
  41553. }
  41554. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  41555. import { Camera } from "babylonjs/Cameras/camera";
  41556. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41557. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41558. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  41559. /**
  41560. * VRDistortionCorrectionPostProcess used for mobile VR
  41561. */
  41562. export class VRDistortionCorrectionPostProcess extends PostProcess {
  41563. private _isRightEye;
  41564. private _distortionFactors;
  41565. private _postProcessScaleFactor;
  41566. private _lensCenterOffset;
  41567. private _scaleIn;
  41568. private _scaleFactor;
  41569. private _lensCenter;
  41570. /**
  41571. * Initializes the VRDistortionCorrectionPostProcess
  41572. * @param name The name of the effect.
  41573. * @param camera The camera to apply the render pass to.
  41574. * @param isRightEye If this is for the right eye distortion
  41575. * @param vrMetrics All the required metrics for the VR camera
  41576. */
  41577. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  41578. }
  41579. }
  41580. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  41581. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  41582. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41583. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41584. import { Scene } from "babylonjs/scene";
  41585. import { Vector3 } from "babylonjs/Maths/math.vector";
  41586. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  41587. import "babylonjs/Cameras/RigModes/vrRigMode";
  41588. /**
  41589. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  41590. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41591. */
  41592. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  41593. /**
  41594. * Creates a new VRDeviceOrientationArcRotateCamera
  41595. * @param name defines camera name
  41596. * @param alpha defines the camera rotation along the logitudinal axis
  41597. * @param beta defines the camera rotation along the latitudinal axis
  41598. * @param radius defines the camera distance from its target
  41599. * @param target defines the camera target
  41600. * @param scene defines the scene the camera belongs to
  41601. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41602. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41603. */
  41604. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41605. /**
  41606. * Gets camera class name
  41607. * @returns VRDeviceOrientationArcRotateCamera
  41608. */
  41609. getClassName(): string;
  41610. }
  41611. }
  41612. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  41613. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  41614. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41615. import { Scene } from "babylonjs/scene";
  41616. import { Vector3 } from "babylonjs/Maths/math.vector";
  41617. import "babylonjs/Cameras/RigModes/vrRigMode";
  41618. /**
  41619. * Camera used to simulate VR rendering (based on FreeCamera)
  41620. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41621. */
  41622. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  41623. /**
  41624. * Creates a new VRDeviceOrientationFreeCamera
  41625. * @param name defines camera name
  41626. * @param position defines the start position of the camera
  41627. * @param scene defines the scene the camera belongs to
  41628. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41629. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41630. */
  41631. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41632. /**
  41633. * Gets camera class name
  41634. * @returns VRDeviceOrientationFreeCamera
  41635. */
  41636. getClassName(): string;
  41637. }
  41638. }
  41639. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  41640. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  41641. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41642. import { Scene } from "babylonjs/scene";
  41643. import { Vector3 } from "babylonjs/Maths/math.vector";
  41644. import "babylonjs/Gamepads/gamepadSceneComponent";
  41645. /**
  41646. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  41647. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41648. */
  41649. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  41650. /**
  41651. * Creates a new VRDeviceOrientationGamepadCamera
  41652. * @param name defines camera name
  41653. * @param position defines the start position of the camera
  41654. * @param scene defines the scene the camera belongs to
  41655. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41656. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41657. */
  41658. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41659. /**
  41660. * Gets camera class name
  41661. * @returns VRDeviceOrientationGamepadCamera
  41662. */
  41663. getClassName(): string;
  41664. }
  41665. }
  41666. declare module "babylonjs/Materials/pushMaterial" {
  41667. import { Nullable } from "babylonjs/types";
  41668. import { Scene } from "babylonjs/scene";
  41669. import { Matrix } from "babylonjs/Maths/math.vector";
  41670. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41671. import { Mesh } from "babylonjs/Meshes/mesh";
  41672. import { Material } from "babylonjs/Materials/material";
  41673. import { Effect } from "babylonjs/Materials/effect";
  41674. /**
  41675. * Base class of materials working in push mode in babylon JS
  41676. * @hidden
  41677. */
  41678. export class PushMaterial extends Material {
  41679. protected _activeEffect: Effect;
  41680. protected _normalMatrix: Matrix;
  41681. /**
  41682. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  41683. * This means that the material can keep using a previous shader while a new one is being compiled.
  41684. * This is mostly used when shader parallel compilation is supported (true by default)
  41685. */
  41686. allowShaderHotSwapping: boolean;
  41687. constructor(name: string, scene: Scene);
  41688. getEffect(): Effect;
  41689. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  41690. /**
  41691. * Binds the given world matrix to the active effect
  41692. *
  41693. * @param world the matrix to bind
  41694. */
  41695. bindOnlyWorldMatrix(world: Matrix): void;
  41696. /**
  41697. * Binds the given normal matrix to the active effect
  41698. *
  41699. * @param normalMatrix the matrix to bind
  41700. */
  41701. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  41702. bind(world: Matrix, mesh?: Mesh): void;
  41703. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  41704. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  41705. }
  41706. }
  41707. declare module "babylonjs/Materials/materialFlags" {
  41708. /**
  41709. * This groups all the flags used to control the materials channel.
  41710. */
  41711. export class MaterialFlags {
  41712. private static _DiffuseTextureEnabled;
  41713. /**
  41714. * Are diffuse textures enabled in the application.
  41715. */
  41716. static DiffuseTextureEnabled: boolean;
  41717. private static _AmbientTextureEnabled;
  41718. /**
  41719. * Are ambient textures enabled in the application.
  41720. */
  41721. static AmbientTextureEnabled: boolean;
  41722. private static _OpacityTextureEnabled;
  41723. /**
  41724. * Are opacity textures enabled in the application.
  41725. */
  41726. static OpacityTextureEnabled: boolean;
  41727. private static _ReflectionTextureEnabled;
  41728. /**
  41729. * Are reflection textures enabled in the application.
  41730. */
  41731. static ReflectionTextureEnabled: boolean;
  41732. private static _EmissiveTextureEnabled;
  41733. /**
  41734. * Are emissive textures enabled in the application.
  41735. */
  41736. static EmissiveTextureEnabled: boolean;
  41737. private static _SpecularTextureEnabled;
  41738. /**
  41739. * Are specular textures enabled in the application.
  41740. */
  41741. static SpecularTextureEnabled: boolean;
  41742. private static _BumpTextureEnabled;
  41743. /**
  41744. * Are bump textures enabled in the application.
  41745. */
  41746. static BumpTextureEnabled: boolean;
  41747. private static _LightmapTextureEnabled;
  41748. /**
  41749. * Are lightmap textures enabled in the application.
  41750. */
  41751. static LightmapTextureEnabled: boolean;
  41752. private static _RefractionTextureEnabled;
  41753. /**
  41754. * Are refraction textures enabled in the application.
  41755. */
  41756. static RefractionTextureEnabled: boolean;
  41757. private static _ColorGradingTextureEnabled;
  41758. /**
  41759. * Are color grading textures enabled in the application.
  41760. */
  41761. static ColorGradingTextureEnabled: boolean;
  41762. private static _FresnelEnabled;
  41763. /**
  41764. * Are fresnels enabled in the application.
  41765. */
  41766. static FresnelEnabled: boolean;
  41767. private static _ClearCoatTextureEnabled;
  41768. /**
  41769. * Are clear coat textures enabled in the application.
  41770. */
  41771. static ClearCoatTextureEnabled: boolean;
  41772. private static _ClearCoatBumpTextureEnabled;
  41773. /**
  41774. * Are clear coat bump textures enabled in the application.
  41775. */
  41776. static ClearCoatBumpTextureEnabled: boolean;
  41777. private static _ClearCoatTintTextureEnabled;
  41778. /**
  41779. * Are clear coat tint textures enabled in the application.
  41780. */
  41781. static ClearCoatTintTextureEnabled: boolean;
  41782. private static _SheenTextureEnabled;
  41783. /**
  41784. * Are sheen textures enabled in the application.
  41785. */
  41786. static SheenTextureEnabled: boolean;
  41787. private static _AnisotropicTextureEnabled;
  41788. /**
  41789. * Are anisotropic textures enabled in the application.
  41790. */
  41791. static AnisotropicTextureEnabled: boolean;
  41792. private static _ThicknessTextureEnabled;
  41793. /**
  41794. * Are thickness textures enabled in the application.
  41795. */
  41796. static ThicknessTextureEnabled: boolean;
  41797. }
  41798. }
  41799. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  41800. /** @hidden */
  41801. export var defaultFragmentDeclaration: {
  41802. name: string;
  41803. shader: string;
  41804. };
  41805. }
  41806. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  41807. /** @hidden */
  41808. export var defaultUboDeclaration: {
  41809. name: string;
  41810. shader: string;
  41811. };
  41812. }
  41813. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  41814. /** @hidden */
  41815. export var lightFragmentDeclaration: {
  41816. name: string;
  41817. shader: string;
  41818. };
  41819. }
  41820. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  41821. /** @hidden */
  41822. export var lightUboDeclaration: {
  41823. name: string;
  41824. shader: string;
  41825. };
  41826. }
  41827. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  41828. /** @hidden */
  41829. export var lightsFragmentFunctions: {
  41830. name: string;
  41831. shader: string;
  41832. };
  41833. }
  41834. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  41835. /** @hidden */
  41836. export var shadowsFragmentFunctions: {
  41837. name: string;
  41838. shader: string;
  41839. };
  41840. }
  41841. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  41842. /** @hidden */
  41843. export var fresnelFunction: {
  41844. name: string;
  41845. shader: string;
  41846. };
  41847. }
  41848. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  41849. /** @hidden */
  41850. export var reflectionFunction: {
  41851. name: string;
  41852. shader: string;
  41853. };
  41854. }
  41855. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  41856. /** @hidden */
  41857. export var bumpFragmentFunctions: {
  41858. name: string;
  41859. shader: string;
  41860. };
  41861. }
  41862. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  41863. /** @hidden */
  41864. export var logDepthDeclaration: {
  41865. name: string;
  41866. shader: string;
  41867. };
  41868. }
  41869. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  41870. /** @hidden */
  41871. export var bumpFragment: {
  41872. name: string;
  41873. shader: string;
  41874. };
  41875. }
  41876. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  41877. /** @hidden */
  41878. export var depthPrePass: {
  41879. name: string;
  41880. shader: string;
  41881. };
  41882. }
  41883. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  41884. /** @hidden */
  41885. export var lightFragment: {
  41886. name: string;
  41887. shader: string;
  41888. };
  41889. }
  41890. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  41891. /** @hidden */
  41892. export var logDepthFragment: {
  41893. name: string;
  41894. shader: string;
  41895. };
  41896. }
  41897. declare module "babylonjs/Shaders/default.fragment" {
  41898. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  41899. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41900. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41901. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41902. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41903. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  41904. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  41905. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  41906. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  41907. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41908. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41909. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  41910. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  41911. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41912. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  41913. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  41914. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  41915. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  41916. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  41917. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  41918. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  41919. /** @hidden */
  41920. export var defaultPixelShader: {
  41921. name: string;
  41922. shader: string;
  41923. };
  41924. }
  41925. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  41926. /** @hidden */
  41927. export var defaultVertexDeclaration: {
  41928. name: string;
  41929. shader: string;
  41930. };
  41931. }
  41932. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  41933. /** @hidden */
  41934. export var bumpVertexDeclaration: {
  41935. name: string;
  41936. shader: string;
  41937. };
  41938. }
  41939. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41940. /** @hidden */
  41941. export var bumpVertex: {
  41942. name: string;
  41943. shader: string;
  41944. };
  41945. }
  41946. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41947. /** @hidden */
  41948. export var fogVertex: {
  41949. name: string;
  41950. shader: string;
  41951. };
  41952. }
  41953. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41954. /** @hidden */
  41955. export var shadowsVertex: {
  41956. name: string;
  41957. shader: string;
  41958. };
  41959. }
  41960. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41961. /** @hidden */
  41962. export var pointCloudVertex: {
  41963. name: string;
  41964. shader: string;
  41965. };
  41966. }
  41967. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41968. /** @hidden */
  41969. export var logDepthVertex: {
  41970. name: string;
  41971. shader: string;
  41972. };
  41973. }
  41974. declare module "babylonjs/Shaders/default.vertex" {
  41975. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41976. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41977. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41978. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41979. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41980. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41981. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41982. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41983. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41984. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41985. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41986. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41987. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41988. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41989. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41990. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41991. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41992. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41993. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41994. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41995. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41996. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41997. /** @hidden */
  41998. export var defaultVertexShader: {
  41999. name: string;
  42000. shader: string;
  42001. };
  42002. }
  42003. declare module "babylonjs/Materials/standardMaterial" {
  42004. import { SmartArray } from "babylonjs/Misc/smartArray";
  42005. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  42006. import { Nullable } from "babylonjs/types";
  42007. import { Scene } from "babylonjs/scene";
  42008. import { Matrix } from "babylonjs/Maths/math.vector";
  42009. import { Color3 } from "babylonjs/Maths/math.color";
  42010. import { SubMesh } from "babylonjs/Meshes/subMesh";
  42011. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42012. import { Mesh } from "babylonjs/Meshes/mesh";
  42013. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  42014. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  42015. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  42016. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  42017. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  42018. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42019. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  42020. import "babylonjs/Shaders/default.fragment";
  42021. import "babylonjs/Shaders/default.vertex";
  42022. /** @hidden */
  42023. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  42024. MAINUV1: boolean;
  42025. MAINUV2: boolean;
  42026. DIFFUSE: boolean;
  42027. DIFFUSEDIRECTUV: number;
  42028. AMBIENT: boolean;
  42029. AMBIENTDIRECTUV: number;
  42030. OPACITY: boolean;
  42031. OPACITYDIRECTUV: number;
  42032. OPACITYRGB: boolean;
  42033. REFLECTION: boolean;
  42034. EMISSIVE: boolean;
  42035. EMISSIVEDIRECTUV: number;
  42036. SPECULAR: boolean;
  42037. SPECULARDIRECTUV: number;
  42038. BUMP: boolean;
  42039. BUMPDIRECTUV: number;
  42040. PARALLAX: boolean;
  42041. PARALLAXOCCLUSION: boolean;
  42042. SPECULAROVERALPHA: boolean;
  42043. CLIPPLANE: boolean;
  42044. CLIPPLANE2: boolean;
  42045. CLIPPLANE3: boolean;
  42046. CLIPPLANE4: boolean;
  42047. ALPHATEST: boolean;
  42048. DEPTHPREPASS: boolean;
  42049. ALPHAFROMDIFFUSE: boolean;
  42050. POINTSIZE: boolean;
  42051. FOG: boolean;
  42052. SPECULARTERM: boolean;
  42053. DIFFUSEFRESNEL: boolean;
  42054. OPACITYFRESNEL: boolean;
  42055. REFLECTIONFRESNEL: boolean;
  42056. REFRACTIONFRESNEL: boolean;
  42057. EMISSIVEFRESNEL: boolean;
  42058. FRESNEL: boolean;
  42059. NORMAL: boolean;
  42060. UV1: boolean;
  42061. UV2: boolean;
  42062. VERTEXCOLOR: boolean;
  42063. VERTEXALPHA: boolean;
  42064. NUM_BONE_INFLUENCERS: number;
  42065. BonesPerMesh: number;
  42066. BONETEXTURE: boolean;
  42067. INSTANCES: boolean;
  42068. GLOSSINESS: boolean;
  42069. ROUGHNESS: boolean;
  42070. EMISSIVEASILLUMINATION: boolean;
  42071. LINKEMISSIVEWITHDIFFUSE: boolean;
  42072. REFLECTIONFRESNELFROMSPECULAR: boolean;
  42073. LIGHTMAP: boolean;
  42074. LIGHTMAPDIRECTUV: number;
  42075. OBJECTSPACE_NORMALMAP: boolean;
  42076. USELIGHTMAPASSHADOWMAP: boolean;
  42077. REFLECTIONMAP_3D: boolean;
  42078. REFLECTIONMAP_SPHERICAL: boolean;
  42079. REFLECTIONMAP_PLANAR: boolean;
  42080. REFLECTIONMAP_CUBIC: boolean;
  42081. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  42082. REFLECTIONMAP_PROJECTION: boolean;
  42083. REFLECTIONMAP_SKYBOX: boolean;
  42084. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  42085. REFLECTIONMAP_EXPLICIT: boolean;
  42086. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  42087. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  42088. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  42089. INVERTCUBICMAP: boolean;
  42090. LOGARITHMICDEPTH: boolean;
  42091. REFRACTION: boolean;
  42092. REFRACTIONMAP_3D: boolean;
  42093. REFLECTIONOVERALPHA: boolean;
  42094. TWOSIDEDLIGHTING: boolean;
  42095. SHADOWFLOAT: boolean;
  42096. MORPHTARGETS: boolean;
  42097. MORPHTARGETS_NORMAL: boolean;
  42098. MORPHTARGETS_TANGENT: boolean;
  42099. MORPHTARGETS_UV: boolean;
  42100. NUM_MORPH_INFLUENCERS: number;
  42101. NONUNIFORMSCALING: boolean;
  42102. PREMULTIPLYALPHA: boolean;
  42103. IMAGEPROCESSING: boolean;
  42104. VIGNETTE: boolean;
  42105. VIGNETTEBLENDMODEMULTIPLY: boolean;
  42106. VIGNETTEBLENDMODEOPAQUE: boolean;
  42107. TONEMAPPING: boolean;
  42108. TONEMAPPING_ACES: boolean;
  42109. CONTRAST: boolean;
  42110. COLORCURVES: boolean;
  42111. COLORGRADING: boolean;
  42112. COLORGRADING3D: boolean;
  42113. SAMPLER3DGREENDEPTH: boolean;
  42114. SAMPLER3DBGRMAP: boolean;
  42115. IMAGEPROCESSINGPOSTPROCESS: boolean;
  42116. MULTIVIEW: boolean;
  42117. /**
  42118. * If the reflection texture on this material is in linear color space
  42119. * @hidden
  42120. */
  42121. IS_REFLECTION_LINEAR: boolean;
  42122. /**
  42123. * If the refraction texture on this material is in linear color space
  42124. * @hidden
  42125. */
  42126. IS_REFRACTION_LINEAR: boolean;
  42127. EXPOSURE: boolean;
  42128. constructor();
  42129. setReflectionMode(modeToEnable: string): void;
  42130. }
  42131. /**
  42132. * This is the default material used in Babylon. It is the best trade off between quality
  42133. * and performances.
  42134. * @see http://doc.babylonjs.com/babylon101/materials
  42135. */
  42136. export class StandardMaterial extends PushMaterial {
  42137. private _diffuseTexture;
  42138. /**
  42139. * The basic texture of the material as viewed under a light.
  42140. */
  42141. diffuseTexture: Nullable<BaseTexture>;
  42142. private _ambientTexture;
  42143. /**
  42144. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  42145. */
  42146. ambientTexture: Nullable<BaseTexture>;
  42147. private _opacityTexture;
  42148. /**
  42149. * Define the transparency of the material from a texture.
  42150. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  42151. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  42152. */
  42153. opacityTexture: Nullable<BaseTexture>;
  42154. private _reflectionTexture;
  42155. /**
  42156. * Define the texture used to display the reflection.
  42157. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42158. */
  42159. reflectionTexture: Nullable<BaseTexture>;
  42160. private _emissiveTexture;
  42161. /**
  42162. * Define texture of the material as if self lit.
  42163. * This will be mixed in the final result even in the absence of light.
  42164. */
  42165. emissiveTexture: Nullable<BaseTexture>;
  42166. private _specularTexture;
  42167. /**
  42168. * Define how the color and intensity of the highlight given by the light in the material.
  42169. */
  42170. specularTexture: Nullable<BaseTexture>;
  42171. private _bumpTexture;
  42172. /**
  42173. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  42174. * 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.
  42175. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  42176. */
  42177. bumpTexture: Nullable<BaseTexture>;
  42178. private _lightmapTexture;
  42179. /**
  42180. * Complex lighting can be computationally expensive to compute at runtime.
  42181. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  42182. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  42183. */
  42184. lightmapTexture: Nullable<BaseTexture>;
  42185. private _refractionTexture;
  42186. /**
  42187. * Define the texture used to display the refraction.
  42188. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42189. */
  42190. refractionTexture: Nullable<BaseTexture>;
  42191. /**
  42192. * The color of the material lit by the environmental background lighting.
  42193. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  42194. */
  42195. ambientColor: Color3;
  42196. /**
  42197. * The basic color of the material as viewed under a light.
  42198. */
  42199. diffuseColor: Color3;
  42200. /**
  42201. * Define how the color and intensity of the highlight given by the light in the material.
  42202. */
  42203. specularColor: Color3;
  42204. /**
  42205. * Define the color of the material as if self lit.
  42206. * This will be mixed in the final result even in the absence of light.
  42207. */
  42208. emissiveColor: Color3;
  42209. /**
  42210. * Defines how sharp are the highlights in the material.
  42211. * The bigger the value the sharper giving a more glossy feeling to the result.
  42212. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  42213. */
  42214. specularPower: number;
  42215. private _useAlphaFromDiffuseTexture;
  42216. /**
  42217. * Does the transparency come from the diffuse texture alpha channel.
  42218. */
  42219. useAlphaFromDiffuseTexture: boolean;
  42220. private _useEmissiveAsIllumination;
  42221. /**
  42222. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  42223. */
  42224. useEmissiveAsIllumination: boolean;
  42225. private _linkEmissiveWithDiffuse;
  42226. /**
  42227. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  42228. * the emissive level when the final color is close to one.
  42229. */
  42230. linkEmissiveWithDiffuse: boolean;
  42231. private _useSpecularOverAlpha;
  42232. /**
  42233. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  42234. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  42235. */
  42236. useSpecularOverAlpha: boolean;
  42237. private _useReflectionOverAlpha;
  42238. /**
  42239. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  42240. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  42241. */
  42242. useReflectionOverAlpha: boolean;
  42243. private _disableLighting;
  42244. /**
  42245. * Does lights from the scene impacts this material.
  42246. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  42247. */
  42248. disableLighting: boolean;
  42249. private _useObjectSpaceNormalMap;
  42250. /**
  42251. * Allows using an object space normal map (instead of tangent space).
  42252. */
  42253. useObjectSpaceNormalMap: boolean;
  42254. private _useParallax;
  42255. /**
  42256. * Is parallax enabled or not.
  42257. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  42258. */
  42259. useParallax: boolean;
  42260. private _useParallaxOcclusion;
  42261. /**
  42262. * Is parallax occlusion enabled or not.
  42263. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  42264. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  42265. */
  42266. useParallaxOcclusion: boolean;
  42267. /**
  42268. * 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.
  42269. */
  42270. parallaxScaleBias: number;
  42271. private _roughness;
  42272. /**
  42273. * Helps to define how blurry the reflections should appears in the material.
  42274. */
  42275. roughness: number;
  42276. /**
  42277. * In case of refraction, define the value of the index of refraction.
  42278. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42279. */
  42280. indexOfRefraction: number;
  42281. /**
  42282. * Invert the refraction texture alongside the y axis.
  42283. * It can be useful with procedural textures or probe for instance.
  42284. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42285. */
  42286. invertRefractionY: boolean;
  42287. /**
  42288. * Defines the alpha limits in alpha test mode.
  42289. */
  42290. alphaCutOff: number;
  42291. private _useLightmapAsShadowmap;
  42292. /**
  42293. * In case of light mapping, define whether the map contains light or shadow informations.
  42294. */
  42295. useLightmapAsShadowmap: boolean;
  42296. private _diffuseFresnelParameters;
  42297. /**
  42298. * Define the diffuse fresnel parameters of the material.
  42299. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42300. */
  42301. diffuseFresnelParameters: FresnelParameters;
  42302. private _opacityFresnelParameters;
  42303. /**
  42304. * Define the opacity fresnel parameters of the material.
  42305. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42306. */
  42307. opacityFresnelParameters: FresnelParameters;
  42308. private _reflectionFresnelParameters;
  42309. /**
  42310. * Define the reflection fresnel parameters of the material.
  42311. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42312. */
  42313. reflectionFresnelParameters: FresnelParameters;
  42314. private _refractionFresnelParameters;
  42315. /**
  42316. * Define the refraction fresnel parameters of the material.
  42317. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42318. */
  42319. refractionFresnelParameters: FresnelParameters;
  42320. private _emissiveFresnelParameters;
  42321. /**
  42322. * Define the emissive fresnel parameters of the material.
  42323. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42324. */
  42325. emissiveFresnelParameters: FresnelParameters;
  42326. private _useReflectionFresnelFromSpecular;
  42327. /**
  42328. * If true automatically deducts the fresnels values from the material specularity.
  42329. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42330. */
  42331. useReflectionFresnelFromSpecular: boolean;
  42332. private _useGlossinessFromSpecularMapAlpha;
  42333. /**
  42334. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  42335. */
  42336. useGlossinessFromSpecularMapAlpha: boolean;
  42337. private _maxSimultaneousLights;
  42338. /**
  42339. * Defines the maximum number of lights that can be used in the material
  42340. */
  42341. maxSimultaneousLights: number;
  42342. private _invertNormalMapX;
  42343. /**
  42344. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  42345. */
  42346. invertNormalMapX: boolean;
  42347. private _invertNormalMapY;
  42348. /**
  42349. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  42350. */
  42351. invertNormalMapY: boolean;
  42352. private _twoSidedLighting;
  42353. /**
  42354. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  42355. */
  42356. twoSidedLighting: boolean;
  42357. /**
  42358. * Default configuration related to image processing available in the standard Material.
  42359. */
  42360. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42361. /**
  42362. * Gets the image processing configuration used either in this material.
  42363. */
  42364. /**
  42365. * Sets the Default image processing configuration used either in the this material.
  42366. *
  42367. * If sets to null, the scene one is in use.
  42368. */
  42369. imageProcessingConfiguration: ImageProcessingConfiguration;
  42370. /**
  42371. * Keep track of the image processing observer to allow dispose and replace.
  42372. */
  42373. private _imageProcessingObserver;
  42374. /**
  42375. * Attaches a new image processing configuration to the Standard Material.
  42376. * @param configuration
  42377. */
  42378. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  42379. /**
  42380. * Gets wether the color curves effect is enabled.
  42381. */
  42382. /**
  42383. * Sets wether the color curves effect is enabled.
  42384. */
  42385. cameraColorCurvesEnabled: boolean;
  42386. /**
  42387. * Gets wether the color grading effect is enabled.
  42388. */
  42389. /**
  42390. * Gets wether the color grading effect is enabled.
  42391. */
  42392. cameraColorGradingEnabled: boolean;
  42393. /**
  42394. * Gets wether tonemapping is enabled or not.
  42395. */
  42396. /**
  42397. * Sets wether tonemapping is enabled or not
  42398. */
  42399. cameraToneMappingEnabled: boolean;
  42400. /**
  42401. * The camera exposure used on this material.
  42402. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42403. * This corresponds to a photographic exposure.
  42404. */
  42405. /**
  42406. * The camera exposure used on this material.
  42407. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42408. * This corresponds to a photographic exposure.
  42409. */
  42410. cameraExposure: number;
  42411. /**
  42412. * Gets The camera contrast used on this material.
  42413. */
  42414. /**
  42415. * Sets The camera contrast used on this material.
  42416. */
  42417. cameraContrast: number;
  42418. /**
  42419. * Gets the Color Grading 2D Lookup Texture.
  42420. */
  42421. /**
  42422. * Sets the Color Grading 2D Lookup Texture.
  42423. */
  42424. cameraColorGradingTexture: Nullable<BaseTexture>;
  42425. /**
  42426. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42427. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42428. * 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;
  42429. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42430. */
  42431. /**
  42432. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42433. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42434. * 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;
  42435. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42436. */
  42437. cameraColorCurves: Nullable<ColorCurves>;
  42438. /**
  42439. * Custom callback helping to override the default shader used in the material.
  42440. */
  42441. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  42442. protected _renderTargets: SmartArray<RenderTargetTexture>;
  42443. protected _worldViewProjectionMatrix: Matrix;
  42444. protected _globalAmbientColor: Color3;
  42445. protected _useLogarithmicDepth: boolean;
  42446. protected _rebuildInParallel: boolean;
  42447. /**
  42448. * Instantiates a new standard material.
  42449. * This is the default material used in Babylon. It is the best trade off between quality
  42450. * and performances.
  42451. * @see http://doc.babylonjs.com/babylon101/materials
  42452. * @param name Define the name of the material in the scene
  42453. * @param scene Define the scene the material belong to
  42454. */
  42455. constructor(name: string, scene: Scene);
  42456. /**
  42457. * Gets a boolean indicating that current material needs to register RTT
  42458. */
  42459. readonly hasRenderTargetTextures: boolean;
  42460. /**
  42461. * Gets the current class name of the material e.g. "StandardMaterial"
  42462. * Mainly use in serialization.
  42463. * @returns the class name
  42464. */
  42465. getClassName(): string;
  42466. /**
  42467. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  42468. * You can try switching to logarithmic depth.
  42469. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  42470. */
  42471. useLogarithmicDepth: boolean;
  42472. /**
  42473. * Specifies if the material will require alpha blending
  42474. * @returns a boolean specifying if alpha blending is needed
  42475. */
  42476. needAlphaBlending(): boolean;
  42477. /**
  42478. * Specifies if this material should be rendered in alpha test mode
  42479. * @returns a boolean specifying if an alpha test is needed.
  42480. */
  42481. needAlphaTesting(): boolean;
  42482. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  42483. /**
  42484. * Get the texture used for alpha test purpose.
  42485. * @returns the diffuse texture in case of the standard material.
  42486. */
  42487. getAlphaTestTexture(): Nullable<BaseTexture>;
  42488. /**
  42489. * Get if the submesh is ready to be used and all its information available.
  42490. * Child classes can use it to update shaders
  42491. * @param mesh defines the mesh to check
  42492. * @param subMesh defines which submesh to check
  42493. * @param useInstances specifies that instances should be used
  42494. * @returns a boolean indicating that the submesh is ready or not
  42495. */
  42496. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  42497. /**
  42498. * Builds the material UBO layouts.
  42499. * Used internally during the effect preparation.
  42500. */
  42501. buildUniformLayout(): void;
  42502. /**
  42503. * Unbinds the material from the mesh
  42504. */
  42505. unbind(): void;
  42506. /**
  42507. * Binds the submesh to this material by preparing the effect and shader to draw
  42508. * @param world defines the world transformation matrix
  42509. * @param mesh defines the mesh containing the submesh
  42510. * @param subMesh defines the submesh to bind the material to
  42511. */
  42512. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  42513. /**
  42514. * Get the list of animatables in the material.
  42515. * @returns the list of animatables object used in the material
  42516. */
  42517. getAnimatables(): IAnimatable[];
  42518. /**
  42519. * Gets the active textures from the material
  42520. * @returns an array of textures
  42521. */
  42522. getActiveTextures(): BaseTexture[];
  42523. /**
  42524. * Specifies if the material uses a texture
  42525. * @param texture defines the texture to check against the material
  42526. * @returns a boolean specifying if the material uses the texture
  42527. */
  42528. hasTexture(texture: BaseTexture): boolean;
  42529. /**
  42530. * Disposes the material
  42531. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  42532. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  42533. */
  42534. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  42535. /**
  42536. * Makes a duplicate of the material, and gives it a new name
  42537. * @param name defines the new name for the duplicated material
  42538. * @returns the cloned material
  42539. */
  42540. clone(name: string): StandardMaterial;
  42541. /**
  42542. * Serializes this material in a JSON representation
  42543. * @returns the serialized material object
  42544. */
  42545. serialize(): any;
  42546. /**
  42547. * Creates a standard material from parsed material data
  42548. * @param source defines the JSON representation of the material
  42549. * @param scene defines the hosting scene
  42550. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  42551. * @returns a new standard material
  42552. */
  42553. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  42554. /**
  42555. * Are diffuse textures enabled in the application.
  42556. */
  42557. static DiffuseTextureEnabled: boolean;
  42558. /**
  42559. * Are ambient textures enabled in the application.
  42560. */
  42561. static AmbientTextureEnabled: boolean;
  42562. /**
  42563. * Are opacity textures enabled in the application.
  42564. */
  42565. static OpacityTextureEnabled: boolean;
  42566. /**
  42567. * Are reflection textures enabled in the application.
  42568. */
  42569. static ReflectionTextureEnabled: boolean;
  42570. /**
  42571. * Are emissive textures enabled in the application.
  42572. */
  42573. static EmissiveTextureEnabled: boolean;
  42574. /**
  42575. * Are specular textures enabled in the application.
  42576. */
  42577. static SpecularTextureEnabled: boolean;
  42578. /**
  42579. * Are bump textures enabled in the application.
  42580. */
  42581. static BumpTextureEnabled: boolean;
  42582. /**
  42583. * Are lightmap textures enabled in the application.
  42584. */
  42585. static LightmapTextureEnabled: boolean;
  42586. /**
  42587. * Are refraction textures enabled in the application.
  42588. */
  42589. static RefractionTextureEnabled: boolean;
  42590. /**
  42591. * Are color grading textures enabled in the application.
  42592. */
  42593. static ColorGradingTextureEnabled: boolean;
  42594. /**
  42595. * Are fresnels enabled in the application.
  42596. */
  42597. static FresnelEnabled: boolean;
  42598. }
  42599. }
  42600. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  42601. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  42602. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  42603. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  42604. /** @hidden */
  42605. export var imageProcessingPixelShader: {
  42606. name: string;
  42607. shader: string;
  42608. };
  42609. }
  42610. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  42611. import { Nullable } from "babylonjs/types";
  42612. import { Color4 } from "babylonjs/Maths/math.color";
  42613. import { Camera } from "babylonjs/Cameras/camera";
  42614. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42615. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  42616. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  42617. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  42618. import { Engine } from "babylonjs/Engines/engine";
  42619. import "babylonjs/Shaders/imageProcessing.fragment";
  42620. import "babylonjs/Shaders/postprocess.vertex";
  42621. /**
  42622. * ImageProcessingPostProcess
  42623. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  42624. */
  42625. export class ImageProcessingPostProcess extends PostProcess {
  42626. /**
  42627. * Default configuration related to image processing available in the PBR Material.
  42628. */
  42629. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42630. /**
  42631. * Gets the image processing configuration used either in this material.
  42632. */
  42633. /**
  42634. * Sets the Default image processing configuration used either in the this material.
  42635. *
  42636. * If sets to null, the scene one is in use.
  42637. */
  42638. imageProcessingConfiguration: ImageProcessingConfiguration;
  42639. /**
  42640. * Keep track of the image processing observer to allow dispose and replace.
  42641. */
  42642. private _imageProcessingObserver;
  42643. /**
  42644. * Attaches a new image processing configuration to the PBR Material.
  42645. * @param configuration
  42646. */
  42647. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  42648. /**
  42649. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42650. */
  42651. /**
  42652. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42653. */
  42654. colorCurves: Nullable<ColorCurves>;
  42655. /**
  42656. * Gets wether the color curves effect is enabled.
  42657. */
  42658. /**
  42659. * Sets wether the color curves effect is enabled.
  42660. */
  42661. colorCurvesEnabled: boolean;
  42662. /**
  42663. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42664. */
  42665. /**
  42666. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42667. */
  42668. colorGradingTexture: Nullable<BaseTexture>;
  42669. /**
  42670. * Gets wether the color grading effect is enabled.
  42671. */
  42672. /**
  42673. * Gets wether the color grading effect is enabled.
  42674. */
  42675. colorGradingEnabled: boolean;
  42676. /**
  42677. * Gets exposure used in the effect.
  42678. */
  42679. /**
  42680. * Sets exposure used in the effect.
  42681. */
  42682. exposure: number;
  42683. /**
  42684. * Gets wether tonemapping is enabled or not.
  42685. */
  42686. /**
  42687. * Sets wether tonemapping is enabled or not
  42688. */
  42689. toneMappingEnabled: boolean;
  42690. /**
  42691. * Gets the type of tone mapping effect.
  42692. */
  42693. /**
  42694. * Sets the type of tone mapping effect.
  42695. */
  42696. toneMappingType: number;
  42697. /**
  42698. * Gets contrast used in the effect.
  42699. */
  42700. /**
  42701. * Sets contrast used in the effect.
  42702. */
  42703. contrast: number;
  42704. /**
  42705. * Gets Vignette stretch size.
  42706. */
  42707. /**
  42708. * Sets Vignette stretch size.
  42709. */
  42710. vignetteStretch: number;
  42711. /**
  42712. * Gets Vignette centre X Offset.
  42713. */
  42714. /**
  42715. * Sets Vignette centre X Offset.
  42716. */
  42717. vignetteCentreX: number;
  42718. /**
  42719. * Gets Vignette centre Y Offset.
  42720. */
  42721. /**
  42722. * Sets Vignette centre Y Offset.
  42723. */
  42724. vignetteCentreY: number;
  42725. /**
  42726. * Gets Vignette weight or intensity of the vignette effect.
  42727. */
  42728. /**
  42729. * Sets Vignette weight or intensity of the vignette effect.
  42730. */
  42731. vignetteWeight: number;
  42732. /**
  42733. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42734. * if vignetteEnabled is set to true.
  42735. */
  42736. /**
  42737. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42738. * if vignetteEnabled is set to true.
  42739. */
  42740. vignetteColor: Color4;
  42741. /**
  42742. * Gets Camera field of view used by the Vignette effect.
  42743. */
  42744. /**
  42745. * Sets Camera field of view used by the Vignette effect.
  42746. */
  42747. vignetteCameraFov: number;
  42748. /**
  42749. * Gets the vignette blend mode allowing different kind of effect.
  42750. */
  42751. /**
  42752. * Sets the vignette blend mode allowing different kind of effect.
  42753. */
  42754. vignetteBlendMode: number;
  42755. /**
  42756. * Gets wether the vignette effect is enabled.
  42757. */
  42758. /**
  42759. * Sets wether the vignette effect is enabled.
  42760. */
  42761. vignetteEnabled: boolean;
  42762. private _fromLinearSpace;
  42763. /**
  42764. * Gets wether the input of the processing is in Gamma or Linear Space.
  42765. */
  42766. /**
  42767. * Sets wether the input of the processing is in Gamma or Linear Space.
  42768. */
  42769. fromLinearSpace: boolean;
  42770. /**
  42771. * Defines cache preventing GC.
  42772. */
  42773. private _defines;
  42774. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  42775. /**
  42776. * "ImageProcessingPostProcess"
  42777. * @returns "ImageProcessingPostProcess"
  42778. */
  42779. getClassName(): string;
  42780. protected _updateParameters(): void;
  42781. dispose(camera?: Camera): void;
  42782. }
  42783. }
  42784. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  42785. import { Scene } from "babylonjs/scene";
  42786. import { Color3 } from "babylonjs/Maths/math.color";
  42787. import { Mesh } from "babylonjs/Meshes/mesh";
  42788. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  42789. import { Nullable } from "babylonjs/types";
  42790. /**
  42791. * Class containing static functions to help procedurally build meshes
  42792. */
  42793. export class GroundBuilder {
  42794. /**
  42795. * Creates a ground mesh
  42796. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  42797. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  42798. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  42799. * @param name defines the name of the mesh
  42800. * @param options defines the options used to create the mesh
  42801. * @param scene defines the hosting scene
  42802. * @returns the ground mesh
  42803. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  42804. */
  42805. static CreateGround(name: string, options: {
  42806. width?: number;
  42807. height?: number;
  42808. subdivisions?: number;
  42809. subdivisionsX?: number;
  42810. subdivisionsY?: number;
  42811. updatable?: boolean;
  42812. }, scene: any): Mesh;
  42813. /**
  42814. * Creates a tiled ground mesh
  42815. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  42816. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  42817. * * 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
  42818. * * 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
  42819. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42820. * @param name defines the name of the mesh
  42821. * @param options defines the options used to create the mesh
  42822. * @param scene defines the hosting scene
  42823. * @returns the tiled ground mesh
  42824. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  42825. */
  42826. static CreateTiledGround(name: string, options: {
  42827. xmin: number;
  42828. zmin: number;
  42829. xmax: number;
  42830. zmax: number;
  42831. subdivisions?: {
  42832. w: number;
  42833. h: number;
  42834. };
  42835. precision?: {
  42836. w: number;
  42837. h: number;
  42838. };
  42839. updatable?: boolean;
  42840. }, scene?: Nullable<Scene>): Mesh;
  42841. /**
  42842. * Creates a ground mesh from a height map
  42843. * * The parameter `url` sets the URL of the height map image resource.
  42844. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  42845. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  42846. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  42847. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  42848. * * 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.
  42849. * * 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).
  42850. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42851. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42852. * @param name defines the name of the mesh
  42853. * @param url defines the url to the height map
  42854. * @param options defines the options used to create the mesh
  42855. * @param scene defines the hosting scene
  42856. * @returns the ground mesh
  42857. * @see https://doc.babylonjs.com/babylon101/height_map
  42858. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42859. */
  42860. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42861. width?: number;
  42862. height?: number;
  42863. subdivisions?: number;
  42864. minHeight?: number;
  42865. maxHeight?: number;
  42866. colorFilter?: Color3;
  42867. alphaFilter?: number;
  42868. updatable?: boolean;
  42869. onReady?: (mesh: GroundMesh) => void;
  42870. }, scene?: Nullable<Scene>): GroundMesh;
  42871. }
  42872. }
  42873. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42874. import { Vector4 } from "babylonjs/Maths/math.vector";
  42875. import { Mesh } from "babylonjs/Meshes/mesh";
  42876. /**
  42877. * Class containing static functions to help procedurally build meshes
  42878. */
  42879. export class TorusBuilder {
  42880. /**
  42881. * Creates a torus mesh
  42882. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42883. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42884. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42885. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42886. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42887. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42888. * @param name defines the name of the mesh
  42889. * @param options defines the options used to create the mesh
  42890. * @param scene defines the hosting scene
  42891. * @returns the torus mesh
  42892. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42893. */
  42894. static CreateTorus(name: string, options: {
  42895. diameter?: number;
  42896. thickness?: number;
  42897. tessellation?: number;
  42898. updatable?: boolean;
  42899. sideOrientation?: number;
  42900. frontUVs?: Vector4;
  42901. backUVs?: Vector4;
  42902. }, scene: any): Mesh;
  42903. }
  42904. }
  42905. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42906. import { Vector4 } from "babylonjs/Maths/math.vector";
  42907. import { Color4 } from "babylonjs/Maths/math.color";
  42908. import { Mesh } from "babylonjs/Meshes/mesh";
  42909. /**
  42910. * Class containing static functions to help procedurally build meshes
  42911. */
  42912. export class CylinderBuilder {
  42913. /**
  42914. * Creates a cylinder or a cone mesh
  42915. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42916. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42917. * * 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.
  42918. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42919. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42920. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42921. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42922. * * 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).
  42923. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42924. * * 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).
  42925. * * 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
  42926. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42927. * * 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
  42928. * * 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.
  42929. * * If `enclose` is false, a ring surface is one element.
  42930. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42931. * * 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
  42932. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42933. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42934. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42935. * @param name defines the name of the mesh
  42936. * @param options defines the options used to create the mesh
  42937. * @param scene defines the hosting scene
  42938. * @returns the cylinder mesh
  42939. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42940. */
  42941. static CreateCylinder(name: string, options: {
  42942. height?: number;
  42943. diameterTop?: number;
  42944. diameterBottom?: number;
  42945. diameter?: number;
  42946. tessellation?: number;
  42947. subdivisions?: number;
  42948. arc?: number;
  42949. faceColors?: Color4[];
  42950. faceUV?: Vector4[];
  42951. updatable?: boolean;
  42952. hasRings?: boolean;
  42953. enclose?: boolean;
  42954. cap?: number;
  42955. sideOrientation?: number;
  42956. frontUVs?: Vector4;
  42957. backUVs?: Vector4;
  42958. }, scene: any): Mesh;
  42959. }
  42960. }
  42961. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42962. import { Observable } from "babylonjs/Misc/observable";
  42963. import { Nullable } from "babylonjs/types";
  42964. import { Camera } from "babylonjs/Cameras/camera";
  42965. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42966. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42967. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42968. import { Scene } from "babylonjs/scene";
  42969. import { Vector3 } from "babylonjs/Maths/math.vector";
  42970. import { Color3 } from "babylonjs/Maths/math.color";
  42971. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42972. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42973. import { Mesh } from "babylonjs/Meshes/mesh";
  42974. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42975. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42976. import "babylonjs/Meshes/Builders/groundBuilder";
  42977. import "babylonjs/Meshes/Builders/torusBuilder";
  42978. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42979. import "babylonjs/Gamepads/gamepadSceneComponent";
  42980. import "babylonjs/Animations/animatable";
  42981. /**
  42982. * Options to modify the vr teleportation behavior.
  42983. */
  42984. export interface VRTeleportationOptions {
  42985. /**
  42986. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42987. */
  42988. floorMeshName?: string;
  42989. /**
  42990. * A list of meshes to be used as the teleportation floor. (default: empty)
  42991. */
  42992. floorMeshes?: Mesh[];
  42993. }
  42994. /**
  42995. * Options to modify the vr experience helper's behavior.
  42996. */
  42997. export interface VRExperienceHelperOptions extends WebVROptions {
  42998. /**
  42999. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  43000. */
  43001. createDeviceOrientationCamera?: boolean;
  43002. /**
  43003. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  43004. */
  43005. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  43006. /**
  43007. * Uses the main button on the controller to toggle the laser casted. (default: true)
  43008. */
  43009. laserToggle?: boolean;
  43010. /**
  43011. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  43012. */
  43013. floorMeshes?: Mesh[];
  43014. /**
  43015. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  43016. */
  43017. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  43018. }
  43019. /**
  43020. * Event containing information after VR has been entered
  43021. */
  43022. export class OnAfterEnteringVRObservableEvent {
  43023. /**
  43024. * If entering vr was successful
  43025. */
  43026. success: boolean;
  43027. }
  43028. /**
  43029. * Helps to quickly add VR support to an existing scene.
  43030. * See http://doc.babylonjs.com/how_to/webvr_helper
  43031. */
  43032. export class VRExperienceHelper {
  43033. /** Options to modify the vr experience helper's behavior. */
  43034. webVROptions: VRExperienceHelperOptions;
  43035. private _scene;
  43036. private _position;
  43037. private _btnVR;
  43038. private _btnVRDisplayed;
  43039. private _webVRsupported;
  43040. private _webVRready;
  43041. private _webVRrequesting;
  43042. private _webVRpresenting;
  43043. private _hasEnteredVR;
  43044. private _fullscreenVRpresenting;
  43045. private _inputElement;
  43046. private _webVRCamera;
  43047. private _vrDeviceOrientationCamera;
  43048. private _deviceOrientationCamera;
  43049. private _existingCamera;
  43050. private _onKeyDown;
  43051. private _onVrDisplayPresentChange;
  43052. private _onVRDisplayChanged;
  43053. private _onVRRequestPresentStart;
  43054. private _onVRRequestPresentComplete;
  43055. /**
  43056. * 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)
  43057. */
  43058. enableGazeEvenWhenNoPointerLock: boolean;
  43059. /**
  43060. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  43061. */
  43062. exitVROnDoubleTap: boolean;
  43063. /**
  43064. * Observable raised right before entering VR.
  43065. */
  43066. onEnteringVRObservable: Observable<VRExperienceHelper>;
  43067. /**
  43068. * Observable raised when entering VR has completed.
  43069. */
  43070. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  43071. /**
  43072. * Observable raised when exiting VR.
  43073. */
  43074. onExitingVRObservable: Observable<VRExperienceHelper>;
  43075. /**
  43076. * Observable raised when controller mesh is loaded.
  43077. */
  43078. onControllerMeshLoadedObservable: Observable<WebVRController>;
  43079. /** Return this.onEnteringVRObservable
  43080. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  43081. */
  43082. readonly onEnteringVR: Observable<VRExperienceHelper>;
  43083. /** Return this.onExitingVRObservable
  43084. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  43085. */
  43086. readonly onExitingVR: Observable<VRExperienceHelper>;
  43087. /** Return this.onControllerMeshLoadedObservable
  43088. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  43089. */
  43090. readonly onControllerMeshLoaded: Observable<WebVRController>;
  43091. private _rayLength;
  43092. private _useCustomVRButton;
  43093. private _teleportationRequested;
  43094. private _teleportActive;
  43095. private _floorMeshName;
  43096. private _floorMeshesCollection;
  43097. private _rotationAllowed;
  43098. private _teleportBackwardsVector;
  43099. private _teleportationTarget;
  43100. private _isDefaultTeleportationTarget;
  43101. private _postProcessMove;
  43102. private _teleportationFillColor;
  43103. private _teleportationBorderColor;
  43104. private _rotationAngle;
  43105. private _haloCenter;
  43106. private _cameraGazer;
  43107. private _padSensibilityUp;
  43108. private _padSensibilityDown;
  43109. private _leftController;
  43110. private _rightController;
  43111. /**
  43112. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  43113. */
  43114. onNewMeshSelected: Observable<AbstractMesh>;
  43115. /**
  43116. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  43117. * This observable will provide the mesh and the controller used to select the mesh
  43118. */
  43119. onMeshSelectedWithController: Observable<{
  43120. mesh: AbstractMesh;
  43121. controller: WebVRController;
  43122. }>;
  43123. /**
  43124. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  43125. */
  43126. onNewMeshPicked: Observable<PickingInfo>;
  43127. private _circleEase;
  43128. /**
  43129. * Observable raised before camera teleportation
  43130. */
  43131. onBeforeCameraTeleport: Observable<Vector3>;
  43132. /**
  43133. * Observable raised after camera teleportation
  43134. */
  43135. onAfterCameraTeleport: Observable<Vector3>;
  43136. /**
  43137. * Observable raised when current selected mesh gets unselected
  43138. */
  43139. onSelectedMeshUnselected: Observable<AbstractMesh>;
  43140. private _raySelectionPredicate;
  43141. /**
  43142. * To be optionaly changed by user to define custom ray selection
  43143. */
  43144. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  43145. /**
  43146. * To be optionaly changed by user to define custom selection logic (after ray selection)
  43147. */
  43148. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  43149. /**
  43150. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  43151. */
  43152. teleportationEnabled: boolean;
  43153. private _defaultHeight;
  43154. private _teleportationInitialized;
  43155. private _interactionsEnabled;
  43156. private _interactionsRequested;
  43157. private _displayGaze;
  43158. private _displayLaserPointer;
  43159. /**
  43160. * The mesh used to display where the user is going to teleport.
  43161. */
  43162. /**
  43163. * Sets the mesh to be used to display where the user is going to teleport.
  43164. */
  43165. teleportationTarget: Mesh;
  43166. /**
  43167. * 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
  43168. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  43169. * See http://doc.babylonjs.com/resources/baking_transformations
  43170. */
  43171. gazeTrackerMesh: Mesh;
  43172. /**
  43173. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  43174. */
  43175. updateGazeTrackerScale: boolean;
  43176. /**
  43177. * If the gaze trackers color should be updated when selecting meshes
  43178. */
  43179. updateGazeTrackerColor: boolean;
  43180. /**
  43181. * If the controller laser color should be updated when selecting meshes
  43182. */
  43183. updateControllerLaserColor: boolean;
  43184. /**
  43185. * The gaze tracking mesh corresponding to the left controller
  43186. */
  43187. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  43188. /**
  43189. * The gaze tracking mesh corresponding to the right controller
  43190. */
  43191. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  43192. /**
  43193. * If the ray of the gaze should be displayed.
  43194. */
  43195. /**
  43196. * Sets if the ray of the gaze should be displayed.
  43197. */
  43198. displayGaze: boolean;
  43199. /**
  43200. * If the ray of the LaserPointer should be displayed.
  43201. */
  43202. /**
  43203. * Sets if the ray of the LaserPointer should be displayed.
  43204. */
  43205. displayLaserPointer: boolean;
  43206. /**
  43207. * The deviceOrientationCamera used as the camera when not in VR.
  43208. */
  43209. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  43210. /**
  43211. * Based on the current WebVR support, returns the current VR camera used.
  43212. */
  43213. readonly currentVRCamera: Nullable<Camera>;
  43214. /**
  43215. * The webVRCamera which is used when in VR.
  43216. */
  43217. readonly webVRCamera: WebVRFreeCamera;
  43218. /**
  43219. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  43220. */
  43221. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  43222. /**
  43223. * The html button that is used to trigger entering into VR.
  43224. */
  43225. readonly vrButton: Nullable<HTMLButtonElement>;
  43226. private readonly _teleportationRequestInitiated;
  43227. /**
  43228. * Defines wether or not Pointer lock should be requested when switching to
  43229. * full screen.
  43230. */
  43231. requestPointerLockOnFullScreen: boolean;
  43232. /**
  43233. * Instantiates a VRExperienceHelper.
  43234. * Helps to quickly add VR support to an existing scene.
  43235. * @param scene The scene the VRExperienceHelper belongs to.
  43236. * @param webVROptions Options to modify the vr experience helper's behavior.
  43237. */
  43238. constructor(scene: Scene,
  43239. /** Options to modify the vr experience helper's behavior. */
  43240. webVROptions?: VRExperienceHelperOptions);
  43241. private _onDefaultMeshLoaded;
  43242. private _onResize;
  43243. private _onFullscreenChange;
  43244. /**
  43245. * Gets a value indicating if we are currently in VR mode.
  43246. */
  43247. readonly isInVRMode: boolean;
  43248. private onVrDisplayPresentChange;
  43249. private onVRDisplayChanged;
  43250. private moveButtonToBottomRight;
  43251. private displayVRButton;
  43252. private updateButtonVisibility;
  43253. private _cachedAngularSensibility;
  43254. /**
  43255. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  43256. * Otherwise, will use the fullscreen API.
  43257. */
  43258. enterVR(): void;
  43259. /**
  43260. * Attempt to exit VR, or fullscreen.
  43261. */
  43262. exitVR(): void;
  43263. /**
  43264. * The position of the vr experience helper.
  43265. */
  43266. /**
  43267. * Sets the position of the vr experience helper.
  43268. */
  43269. position: Vector3;
  43270. /**
  43271. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  43272. */
  43273. enableInteractions(): void;
  43274. private readonly _noControllerIsActive;
  43275. private beforeRender;
  43276. private _isTeleportationFloor;
  43277. /**
  43278. * Adds a floor mesh to be used for teleportation.
  43279. * @param floorMesh the mesh to be used for teleportation.
  43280. */
  43281. addFloorMesh(floorMesh: Mesh): void;
  43282. /**
  43283. * Removes a floor mesh from being used for teleportation.
  43284. * @param floorMesh the mesh to be removed.
  43285. */
  43286. removeFloorMesh(floorMesh: Mesh): void;
  43287. /**
  43288. * Enables interactions and teleportation using the VR controllers and gaze.
  43289. * @param vrTeleportationOptions options to modify teleportation behavior.
  43290. */
  43291. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  43292. private _onNewGamepadConnected;
  43293. private _tryEnableInteractionOnController;
  43294. private _onNewGamepadDisconnected;
  43295. private _enableInteractionOnController;
  43296. private _checkTeleportWithRay;
  43297. private _checkRotate;
  43298. private _checkTeleportBackwards;
  43299. private _enableTeleportationOnController;
  43300. private _createTeleportationCircles;
  43301. private _displayTeleportationTarget;
  43302. private _hideTeleportationTarget;
  43303. private _rotateCamera;
  43304. private _moveTeleportationSelectorTo;
  43305. private _workingVector;
  43306. private _workingQuaternion;
  43307. private _workingMatrix;
  43308. /**
  43309. * Teleports the users feet to the desired location
  43310. * @param location The location where the user's feet should be placed
  43311. */
  43312. teleportCamera(location: Vector3): void;
  43313. private _convertNormalToDirectionOfRay;
  43314. private _castRayAndSelectObject;
  43315. private _notifySelectedMeshUnselected;
  43316. /**
  43317. * Sets the color of the laser ray from the vr controllers.
  43318. * @param color new color for the ray.
  43319. */
  43320. changeLaserColor(color: Color3): void;
  43321. /**
  43322. * Sets the color of the ray from the vr headsets gaze.
  43323. * @param color new color for the ray.
  43324. */
  43325. changeGazeColor(color: Color3): void;
  43326. /**
  43327. * Exits VR and disposes of the vr experience helper
  43328. */
  43329. dispose(): void;
  43330. /**
  43331. * Gets the name of the VRExperienceHelper class
  43332. * @returns "VRExperienceHelper"
  43333. */
  43334. getClassName(): string;
  43335. }
  43336. }
  43337. declare module "babylonjs/Cameras/VR/index" {
  43338. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  43339. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  43340. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  43341. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  43342. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  43343. export * from "babylonjs/Cameras/VR/webVRCamera";
  43344. }
  43345. declare module "babylonjs/Cameras/XR/webXRTypes" {
  43346. import { Nullable } from "babylonjs/types";
  43347. import { IDisposable } from "babylonjs/scene";
  43348. /**
  43349. * States of the webXR experience
  43350. */
  43351. export enum WebXRState {
  43352. /**
  43353. * Transitioning to being in XR mode
  43354. */
  43355. ENTERING_XR = 0,
  43356. /**
  43357. * Transitioning to non XR mode
  43358. */
  43359. EXITING_XR = 1,
  43360. /**
  43361. * In XR mode and presenting
  43362. */
  43363. IN_XR = 2,
  43364. /**
  43365. * Not entered XR mode
  43366. */
  43367. NOT_IN_XR = 3
  43368. }
  43369. /**
  43370. * Abstraction of the XR render target
  43371. */
  43372. export interface WebXRRenderTarget extends IDisposable {
  43373. /**
  43374. * xrpresent context of the canvas which can be used to display/mirror xr content
  43375. */
  43376. canvasContext: WebGLRenderingContext;
  43377. /**
  43378. * xr layer for the canvas
  43379. */
  43380. xrLayer: Nullable<XRWebGLLayer>;
  43381. /**
  43382. * Initializes the xr layer for the session
  43383. * @param xrSession xr session
  43384. * @returns a promise that will resolve once the XR Layer has been created
  43385. */
  43386. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  43387. }
  43388. }
  43389. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  43390. import { Nullable } from "babylonjs/types";
  43391. import { Observable } from "babylonjs/Misc/observable";
  43392. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  43393. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43394. /**
  43395. * COnfiguration object for WebXR output canvas
  43396. */
  43397. export class WebXRManagedOutputCanvasOptions {
  43398. /**
  43399. * Options for this XR Layer output
  43400. */
  43401. canvasOptions: XRWebGLLayerOptions;
  43402. /**
  43403. * CSS styling for a newly created canvas (if not provided)
  43404. */
  43405. newCanvasCssStyle?: string;
  43406. /**
  43407. * Get the default values of the configuration object
  43408. * @returns default values of this configuration object
  43409. */
  43410. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  43411. }
  43412. /**
  43413. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  43414. */
  43415. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  43416. private configuration;
  43417. private _engine;
  43418. private _canvas;
  43419. /**
  43420. * xrpresent context of the canvas which can be used to display/mirror xr content
  43421. */
  43422. canvasContext: WebGLRenderingContext;
  43423. /**
  43424. * xr layer for the canvas
  43425. */
  43426. xrLayer: Nullable<XRWebGLLayer>;
  43427. /**
  43428. * Initializes the xr layer for the session
  43429. * @param xrSession xr session
  43430. * @returns a promise that will resolve once the XR Layer has been created
  43431. */
  43432. initializeXRLayerAsync(xrSession: any): any;
  43433. /**
  43434. * Initializes the canvas to be added/removed upon entering/exiting xr
  43435. * @param engine the Babylon engine
  43436. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  43437. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  43438. * @param configuration optional configuration for this canvas output. defaults will be used if not provided
  43439. */
  43440. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>, configuration?: WebXRManagedOutputCanvasOptions);
  43441. /**
  43442. * Disposes of the object
  43443. */
  43444. dispose(): void;
  43445. private _setManagedOutputCanvas;
  43446. private _addCanvas;
  43447. private _removeCanvas;
  43448. }
  43449. }
  43450. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  43451. import { Observable } from "babylonjs/Misc/observable";
  43452. import { Nullable } from "babylonjs/types";
  43453. import { IDisposable, Scene } from "babylonjs/scene";
  43454. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  43455. import { WebXRRenderTarget, WebXRState } from "babylonjs/Cameras/XR/webXRTypes";
  43456. import { WebXRManagedOutputCanvasOptions } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  43457. /**
  43458. * Manages an XRSession to work with Babylon's engine
  43459. * @see https://doc.babylonjs.com/how_to/webxr
  43460. */
  43461. export class WebXRSessionManager implements IDisposable {
  43462. private scene;
  43463. /**
  43464. * Fires every time a new xrFrame arrives which can be used to update the camera
  43465. */
  43466. onXRFrameObservable: Observable<any>;
  43467. /**
  43468. * Fires when the xr session is ended either by the device or manually done
  43469. */
  43470. onXRSessionEnded: Observable<any>;
  43471. /**
  43472. * Underlying xr session
  43473. */
  43474. session: XRSession;
  43475. /**
  43476. * Type of reference space used when creating the session
  43477. */
  43478. referenceSpace: XRReferenceSpace;
  43479. /**
  43480. * Current XR frame
  43481. */
  43482. currentFrame: Nullable<XRFrame>;
  43483. private _xrNavigator;
  43484. private baseLayer;
  43485. private _rttProvider;
  43486. private _sessionEnded;
  43487. /**
  43488. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  43489. * @param scene The scene which the session should be created for
  43490. */
  43491. constructor(scene: Scene);
  43492. /**
  43493. * Initializes the manager
  43494. * After initialization enterXR can be called to start an XR session
  43495. * @returns Promise which resolves after it is initialized
  43496. */
  43497. initializeAsync(): Promise<void>;
  43498. /**
  43499. * Initializes an xr session
  43500. * @param xrSessionMode mode to initialize
  43501. * @param optionalFeatures defines optional values to pass to the session builder
  43502. * @returns a promise which will resolve once the session has been initialized
  43503. */
  43504. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): Promise<XRSession>;
  43505. /**
  43506. * Sets the reference space on the xr session
  43507. * @param referenceSpace space to set
  43508. * @returns a promise that will resolve once the reference space has been set
  43509. */
  43510. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  43511. /**
  43512. * Updates the render state of the session
  43513. * @param state state to set
  43514. * @returns a promise that resolves once the render state has been updated
  43515. */
  43516. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  43517. /**
  43518. * Starts rendering to the xr layer
  43519. * @returns a promise that will resolve once rendering has started
  43520. */
  43521. startRenderingToXRAsync(): Promise<void>;
  43522. /**
  43523. * Gets the correct render target texture to be rendered this frame for this eye
  43524. * @param eye the eye for which to get the render target
  43525. * @returns the render target for the specified eye
  43526. */
  43527. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  43528. /**
  43529. * Stops the xrSession and restores the renderloop
  43530. * @returns Promise which resolves after it exits XR
  43531. */
  43532. exitXRAsync(): Promise<void>;
  43533. /**
  43534. * Checks if a session would be supported for the creation options specified
  43535. * @param sessionMode session mode to check if supported eg. immersive-vr
  43536. * @returns true if supported
  43537. */
  43538. supportsSessionAsync(sessionMode: XRSessionMode): any;
  43539. /**
  43540. * Creates a WebXRRenderTarget object for the XR session
  43541. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  43542. * @param options optional options to provide when creating a new render target
  43543. * @returns a WebXR render target to which the session can render
  43544. */
  43545. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>, options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  43546. /**
  43547. * @hidden
  43548. * Converts the render layer of xrSession to a render target
  43549. * @param session session to create render target for
  43550. * @param scene scene the new render target should be created for
  43551. */
  43552. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  43553. /**
  43554. * Disposes of the session manager
  43555. */
  43556. dispose(): void;
  43557. }
  43558. }
  43559. declare module "babylonjs/Cameras/XR/webXRCamera" {
  43560. import { Scene } from "babylonjs/scene";
  43561. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  43562. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43563. /**
  43564. * WebXR Camera which holds the views for the xrSession
  43565. * @see https://doc.babylonjs.com/how_to/webxr
  43566. */
  43567. export class WebXRCamera extends FreeCamera {
  43568. /**
  43569. * Is the camera in debug mode. Used when using an emulator
  43570. */
  43571. debugMode: boolean;
  43572. /**
  43573. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  43574. * @param name the name of the camera
  43575. * @param scene the scene to add the camera to
  43576. */
  43577. constructor(name: string, scene: Scene);
  43578. private _updateNumberOfRigCameras;
  43579. /** @hidden */
  43580. _updateForDualEyeDebugging(): void;
  43581. /**
  43582. * Updates the cameras position from the current pose information of the XR session
  43583. * @param xrSessionManager the session containing pose information
  43584. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  43585. */
  43586. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  43587. }
  43588. }
  43589. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  43590. import { Observable } from "babylonjs/Misc/observable";
  43591. import { IDisposable, Scene } from "babylonjs/scene";
  43592. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  43593. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43594. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43595. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  43596. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43597. /**
  43598. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  43599. * @see https://doc.babylonjs.com/how_to/webxr
  43600. */
  43601. export class WebXRExperienceHelper implements IDisposable {
  43602. private scene;
  43603. /**
  43604. * 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
  43605. */
  43606. container: AbstractMesh;
  43607. /**
  43608. * Camera used to render xr content
  43609. */
  43610. camera: WebXRCamera;
  43611. /**
  43612. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  43613. */
  43614. state: WebXRState;
  43615. private _setState;
  43616. private static _TmpVector;
  43617. /**
  43618. * Fires when the state of the experience helper has changed
  43619. */
  43620. onStateChangedObservable: Observable<WebXRState>;
  43621. /** Session manager used to keep track of xr session */
  43622. sessionManager: WebXRSessionManager;
  43623. private _nonVRCamera;
  43624. private _originalSceneAutoClear;
  43625. private _supported;
  43626. /**
  43627. * Creates the experience helper
  43628. * @param scene the scene to attach the experience helper to
  43629. * @returns a promise for the experience helper
  43630. */
  43631. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  43632. /**
  43633. * Creates a WebXRExperienceHelper
  43634. * @param scene The scene the helper should be created in
  43635. */
  43636. private constructor();
  43637. /**
  43638. * Exits XR mode and returns the scene to its original state
  43639. * @returns promise that resolves after xr mode has exited
  43640. */
  43641. exitXRAsync(): Promise<void>;
  43642. /**
  43643. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  43644. * @param sessionMode options for the XR session
  43645. * @param referenceSpaceType frame of reference of the XR session
  43646. * @param renderTarget the output canvas that will be used to enter XR mode
  43647. * @returns promise that resolves after xr mode has entered
  43648. */
  43649. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): Promise<WebXRSessionManager>;
  43650. /**
  43651. * Updates the global position of the camera by moving the camera's container
  43652. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  43653. * @param position The desired global position of the camera
  43654. */
  43655. setPositionOfCameraUsingContainer(position: Vector3): void;
  43656. /**
  43657. * Rotates the xr camera by rotating the camera's container around the camera's position
  43658. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  43659. * @param rotation the desired quaternion rotation to apply to the camera
  43660. */
  43661. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  43662. /**
  43663. * Disposes of the experience helper
  43664. */
  43665. dispose(): void;
  43666. }
  43667. }
  43668. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  43669. import { Nullable } from "babylonjs/types";
  43670. import { Observable } from "babylonjs/Misc/observable";
  43671. import { IDisposable, Scene } from "babylonjs/scene";
  43672. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43673. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43674. /**
  43675. * Button which can be used to enter a different mode of XR
  43676. */
  43677. export class WebXREnterExitUIButton {
  43678. /** button element */
  43679. element: HTMLElement;
  43680. /** XR initialization options for the button */
  43681. sessionMode: XRSessionMode;
  43682. /** Reference space type */
  43683. referenceSpaceType: XRReferenceSpaceType;
  43684. /**
  43685. * Creates a WebXREnterExitUIButton
  43686. * @param element button element
  43687. * @param sessionMode XR initialization session mode
  43688. * @param referenceSpaceType the type of reference space to be used
  43689. */
  43690. constructor(
  43691. /** button element */
  43692. element: HTMLElement,
  43693. /** XR initialization options for the button */
  43694. sessionMode: XRSessionMode,
  43695. /** Reference space type */
  43696. referenceSpaceType: XRReferenceSpaceType);
  43697. /**
  43698. * Overwritable function which can be used to update the button's visuals when the state changes
  43699. * @param activeButton the current active button in the UI
  43700. */
  43701. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  43702. }
  43703. /**
  43704. * Options to create the webXR UI
  43705. */
  43706. export class WebXREnterExitUIOptions {
  43707. /**
  43708. * Context to enter xr with
  43709. */
  43710. renderTarget?: Nullable<WebXRRenderTarget>;
  43711. /**
  43712. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  43713. */
  43714. customButtons?: Array<WebXREnterExitUIButton>;
  43715. /**
  43716. * A session mode to use when creating the default button.
  43717. * Default is immersive-vr
  43718. */
  43719. sessionMode?: XRSessionMode;
  43720. /**
  43721. * A reference space type to use when creating the default button.
  43722. * Default is local-floor
  43723. */
  43724. referenceSpaceType?: XRReferenceSpaceType;
  43725. }
  43726. /**
  43727. * UI to allow the user to enter/exit XR mode
  43728. */
  43729. export class WebXREnterExitUI implements IDisposable {
  43730. private scene;
  43731. private _overlay;
  43732. private _buttons;
  43733. private _activeButton;
  43734. /**
  43735. * Fired every time the active button is changed.
  43736. *
  43737. * When xr is entered via a button that launches xr that button will be the callback parameter
  43738. *
  43739. * When exiting xr the callback parameter will be null)
  43740. */
  43741. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  43742. /**
  43743. * Creates UI to allow the user to enter/exit XR mode
  43744. * @param scene the scene to add the ui to
  43745. * @param helper the xr experience helper to enter/exit xr with
  43746. * @param options options to configure the UI
  43747. * @returns the created ui
  43748. */
  43749. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  43750. private constructor();
  43751. private _updateButtons;
  43752. /**
  43753. * Disposes of the object
  43754. */
  43755. dispose(): void;
  43756. }
  43757. }
  43758. declare module "babylonjs/Cameras/XR/webXRController" {
  43759. import { Nullable } from "babylonjs/types";
  43760. import { Observable } from "babylonjs/Misc/observable";
  43761. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43762. import { Ray } from "babylonjs/Culling/ray";
  43763. import { Scene } from "babylonjs/scene";
  43764. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43765. /**
  43766. * Represents an XR input
  43767. */
  43768. export class WebXRController {
  43769. private scene;
  43770. /** The underlying input source for the controller */
  43771. inputSource: XRInputSource;
  43772. private parentContainer;
  43773. /**
  43774. * 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
  43775. */
  43776. grip?: AbstractMesh;
  43777. /**
  43778. * Pointer which can be used to select objects or attach a visible laser to
  43779. */
  43780. pointer: AbstractMesh;
  43781. private _gamepadMode;
  43782. /**
  43783. * If available, this is the gamepad object related to this controller.
  43784. * Using this object it is possible to get click events and trackpad changes of the
  43785. * webxr controller that is currently being used.
  43786. */
  43787. gamepadController?: WebVRController;
  43788. /**
  43789. * Event that fires when the controller is removed/disposed
  43790. */
  43791. onDisposeObservable: Observable<{}>;
  43792. private _tmpMatrix;
  43793. private _tmpQuaternion;
  43794. private _tmpVector;
  43795. /**
  43796. * Creates the controller
  43797. * @see https://doc.babylonjs.com/how_to/webxr
  43798. * @param scene the scene which the controller should be associated to
  43799. * @param inputSource the underlying input source for the controller
  43800. * @param parentContainer parent that the controller meshes should be children of
  43801. */
  43802. constructor(scene: Scene,
  43803. /** The underlying input source for the controller */
  43804. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  43805. /**
  43806. * Updates the controller pose based on the given XRFrame
  43807. * @param xrFrame xr frame to update the pose with
  43808. * @param referenceSpace reference space to use
  43809. */
  43810. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  43811. /**
  43812. * Gets a world space ray coming from the controller
  43813. * @param result the resulting ray
  43814. */
  43815. getWorldPointerRayToRef(result: Ray): void;
  43816. /**
  43817. * Get the scene associated with this controller
  43818. * @returns the scene object
  43819. */
  43820. getScene(): Scene;
  43821. /**
  43822. * Disposes of the object
  43823. */
  43824. dispose(): void;
  43825. }
  43826. }
  43827. declare module "babylonjs/Cameras/XR/webXRInput" {
  43828. import { Observable } from "babylonjs/Misc/observable";
  43829. import { IDisposable } from "babylonjs/scene";
  43830. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43831. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  43832. /**
  43833. * XR input used to track XR inputs such as controllers/rays
  43834. */
  43835. export class WebXRInput implements IDisposable {
  43836. /**
  43837. * Base experience the input listens to
  43838. */
  43839. baseExperience: WebXRExperienceHelper;
  43840. /**
  43841. * XR controllers being tracked
  43842. */
  43843. controllers: Array<WebXRController>;
  43844. private _frameObserver;
  43845. private _stateObserver;
  43846. /**
  43847. * Event when a controller has been connected/added
  43848. */
  43849. onControllerAddedObservable: Observable<WebXRController>;
  43850. /**
  43851. * Event when a controller has been removed/disconnected
  43852. */
  43853. onControllerRemovedObservable: Observable<WebXRController>;
  43854. /**
  43855. * Initializes the WebXRInput
  43856. * @param baseExperience experience helper which the input should be created for
  43857. */
  43858. constructor(
  43859. /**
  43860. * Base experience the input listens to
  43861. */
  43862. baseExperience: WebXRExperienceHelper);
  43863. private _onInputSourcesChange;
  43864. private _addAndRemoveControllers;
  43865. /**
  43866. * Disposes of the object
  43867. */
  43868. dispose(): void;
  43869. }
  43870. }
  43871. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  43872. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43873. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43874. /**
  43875. * Enables teleportation
  43876. */
  43877. export class WebXRControllerTeleportation {
  43878. private _teleportationFillColor;
  43879. private _teleportationBorderColor;
  43880. private _tmpRay;
  43881. private _tmpVector;
  43882. /**
  43883. * Creates a WebXRControllerTeleportation
  43884. * @param input input manager to add teleportation to
  43885. * @param floorMeshes floormeshes which can be teleported to
  43886. */
  43887. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  43888. }
  43889. }
  43890. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  43891. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43892. /**
  43893. * Handles pointer input automatically for the pointer of XR controllers
  43894. */
  43895. export class WebXRControllerPointerSelection {
  43896. private static _idCounter;
  43897. private _tmpRay;
  43898. /**
  43899. * Creates a WebXRControllerPointerSelection
  43900. * @param input input manager to setup pointer selection
  43901. */
  43902. constructor(input: WebXRInput);
  43903. private _convertNormalToDirectionOfRay;
  43904. private _updatePointerDistance;
  43905. }
  43906. }
  43907. declare module "babylonjs/Loading/sceneLoader" {
  43908. import { Observable } from "babylonjs/Misc/observable";
  43909. import { Nullable } from "babylonjs/types";
  43910. import { Scene } from "babylonjs/scene";
  43911. import { Engine } from "babylonjs/Engines/engine";
  43912. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43913. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43914. import { AssetContainer } from "babylonjs/assetContainer";
  43915. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43916. import { Skeleton } from "babylonjs/Bones/skeleton";
  43917. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  43918. import { WebRequest } from "babylonjs/Misc/webRequest";
  43919. /**
  43920. * Class used to represent data loading progression
  43921. */
  43922. export class SceneLoaderProgressEvent {
  43923. /** defines if data length to load can be evaluated */
  43924. readonly lengthComputable: boolean;
  43925. /** defines the loaded data length */
  43926. readonly loaded: number;
  43927. /** defines the data length to load */
  43928. readonly total: number;
  43929. /**
  43930. * Create a new progress event
  43931. * @param lengthComputable defines if data length to load can be evaluated
  43932. * @param loaded defines the loaded data length
  43933. * @param total defines the data length to load
  43934. */
  43935. constructor(
  43936. /** defines if data length to load can be evaluated */
  43937. lengthComputable: boolean,
  43938. /** defines the loaded data length */
  43939. loaded: number,
  43940. /** defines the data length to load */
  43941. total: number);
  43942. /**
  43943. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  43944. * @param event defines the source event
  43945. * @returns a new SceneLoaderProgressEvent
  43946. */
  43947. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  43948. }
  43949. /**
  43950. * Interface used by SceneLoader plugins to define supported file extensions
  43951. */
  43952. export interface ISceneLoaderPluginExtensions {
  43953. /**
  43954. * Defines the list of supported extensions
  43955. */
  43956. [extension: string]: {
  43957. isBinary: boolean;
  43958. };
  43959. }
  43960. /**
  43961. * Interface used by SceneLoader plugin factory
  43962. */
  43963. export interface ISceneLoaderPluginFactory {
  43964. /**
  43965. * Defines the name of the factory
  43966. */
  43967. name: string;
  43968. /**
  43969. * Function called to create a new plugin
  43970. * @return the new plugin
  43971. */
  43972. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43973. /**
  43974. * The callback that returns true if the data can be directly loaded.
  43975. * @param data string containing the file data
  43976. * @returns if the data can be loaded directly
  43977. */
  43978. canDirectLoad?(data: string): boolean;
  43979. }
  43980. /**
  43981. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  43982. */
  43983. export interface ISceneLoaderPluginBase {
  43984. /**
  43985. * The friendly name of this plugin.
  43986. */
  43987. name: string;
  43988. /**
  43989. * The file extensions supported by this plugin.
  43990. */
  43991. extensions: string | ISceneLoaderPluginExtensions;
  43992. /**
  43993. * The callback called when loading from a url.
  43994. * @param scene scene loading this url
  43995. * @param url url to load
  43996. * @param onSuccess callback called when the file successfully loads
  43997. * @param onProgress callback called while file is loading (if the server supports this mode)
  43998. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  43999. * @param onError callback called when the file fails to load
  44000. * @returns a file request object
  44001. */
  44002. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  44003. /**
  44004. * The callback called when loading from a file object.
  44005. * @param scene scene loading this file
  44006. * @param file defines the file to load
  44007. * @param onSuccess defines the callback to call when data is loaded
  44008. * @param onProgress defines the callback to call during loading process
  44009. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  44010. * @param onError defines the callback to call when an error occurs
  44011. * @returns a file request object
  44012. */
  44013. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  44014. /**
  44015. * The callback that returns true if the data can be directly loaded.
  44016. * @param data string containing the file data
  44017. * @returns if the data can be loaded directly
  44018. */
  44019. canDirectLoad?(data: string): boolean;
  44020. /**
  44021. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  44022. * @param scene scene loading this data
  44023. * @param data string containing the data
  44024. * @returns data to pass to the plugin
  44025. */
  44026. directLoad?(scene: Scene, data: string): any;
  44027. /**
  44028. * The callback that allows custom handling of the root url based on the response url.
  44029. * @param rootUrl the original root url
  44030. * @param responseURL the response url if available
  44031. * @returns the new root url
  44032. */
  44033. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  44034. }
  44035. /**
  44036. * Interface used to define a SceneLoader plugin
  44037. */
  44038. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  44039. /**
  44040. * Import meshes into a scene.
  44041. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44042. * @param scene The scene to import into
  44043. * @param data The data to import
  44044. * @param rootUrl The root url for scene and resources
  44045. * @param meshes The meshes array to import into
  44046. * @param particleSystems The particle systems array to import into
  44047. * @param skeletons The skeletons array to import into
  44048. * @param onError The callback when import fails
  44049. * @returns True if successful or false otherwise
  44050. */
  44051. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  44052. /**
  44053. * Load into a scene.
  44054. * @param scene The scene to load into
  44055. * @param data The data to import
  44056. * @param rootUrl The root url for scene and resources
  44057. * @param onError The callback when import fails
  44058. * @returns True if successful or false otherwise
  44059. */
  44060. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  44061. /**
  44062. * Load into an asset container.
  44063. * @param scene The scene to load into
  44064. * @param data The data to import
  44065. * @param rootUrl The root url for scene and resources
  44066. * @param onError The callback when import fails
  44067. * @returns The loaded asset container
  44068. */
  44069. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  44070. }
  44071. /**
  44072. * Interface used to define an async SceneLoader plugin
  44073. */
  44074. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  44075. /**
  44076. * Import meshes into a scene.
  44077. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44078. * @param scene The scene to import into
  44079. * @param data The data to import
  44080. * @param rootUrl The root url for scene and resources
  44081. * @param onProgress The callback when the load progresses
  44082. * @param fileName Defines the name of the file to load
  44083. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  44084. */
  44085. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  44086. meshes: AbstractMesh[];
  44087. particleSystems: IParticleSystem[];
  44088. skeletons: Skeleton[];
  44089. animationGroups: AnimationGroup[];
  44090. }>;
  44091. /**
  44092. * Load into a scene.
  44093. * @param scene The scene to load into
  44094. * @param data The data to import
  44095. * @param rootUrl The root url for scene and resources
  44096. * @param onProgress The callback when the load progresses
  44097. * @param fileName Defines the name of the file to load
  44098. * @returns Nothing
  44099. */
  44100. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  44101. /**
  44102. * Load into an asset container.
  44103. * @param scene The scene to load into
  44104. * @param data The data to import
  44105. * @param rootUrl The root url for scene and resources
  44106. * @param onProgress The callback when the load progresses
  44107. * @param fileName Defines the name of the file to load
  44108. * @returns The loaded asset container
  44109. */
  44110. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  44111. }
  44112. /**
  44113. * Class used to load scene from various file formats using registered plugins
  44114. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  44115. */
  44116. export class SceneLoader {
  44117. /**
  44118. * No logging while loading
  44119. */
  44120. static readonly NO_LOGGING: number;
  44121. /**
  44122. * Minimal logging while loading
  44123. */
  44124. static readonly MINIMAL_LOGGING: number;
  44125. /**
  44126. * Summary logging while loading
  44127. */
  44128. static readonly SUMMARY_LOGGING: number;
  44129. /**
  44130. * Detailled logging while loading
  44131. */
  44132. static readonly DETAILED_LOGGING: number;
  44133. /**
  44134. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  44135. */
  44136. static ForceFullSceneLoadingForIncremental: boolean;
  44137. /**
  44138. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  44139. */
  44140. static ShowLoadingScreen: boolean;
  44141. /**
  44142. * Defines the current logging level (while loading the scene)
  44143. * @ignorenaming
  44144. */
  44145. static loggingLevel: number;
  44146. /**
  44147. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  44148. */
  44149. static CleanBoneMatrixWeights: boolean;
  44150. /**
  44151. * Event raised when a plugin is used to load a scene
  44152. */
  44153. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  44154. private static _registeredPlugins;
  44155. private static _getDefaultPlugin;
  44156. private static _getPluginForExtension;
  44157. private static _getPluginForDirectLoad;
  44158. private static _getPluginForFilename;
  44159. private static _getDirectLoad;
  44160. private static _loadData;
  44161. private static _getFileInfo;
  44162. /**
  44163. * Gets a plugin that can load the given extension
  44164. * @param extension defines the extension to load
  44165. * @returns a plugin or null if none works
  44166. */
  44167. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  44168. /**
  44169. * Gets a boolean indicating that the given extension can be loaded
  44170. * @param extension defines the extension to load
  44171. * @returns true if the extension is supported
  44172. */
  44173. static IsPluginForExtensionAvailable(extension: string): boolean;
  44174. /**
  44175. * Adds a new plugin to the list of registered plugins
  44176. * @param plugin defines the plugin to add
  44177. */
  44178. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  44179. /**
  44180. * Import meshes into a scene
  44181. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44182. * @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)
  44183. * @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)
  44184. * @param scene the instance of BABYLON.Scene to append to
  44185. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  44186. * @param onProgress a callback with a progress event for each file being loaded
  44187. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44188. * @param pluginExtension the extension used to determine the plugin
  44189. * @returns The loaded plugin
  44190. */
  44191. 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>;
  44192. /**
  44193. * Import meshes into a scene
  44194. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44195. * @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)
  44196. * @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)
  44197. * @param scene the instance of BABYLON.Scene to append to
  44198. * @param onProgress a callback with a progress event for each file being loaded
  44199. * @param pluginExtension the extension used to determine the plugin
  44200. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  44201. */
  44202. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  44203. meshes: AbstractMesh[];
  44204. particleSystems: IParticleSystem[];
  44205. skeletons: Skeleton[];
  44206. animationGroups: AnimationGroup[];
  44207. }>;
  44208. /**
  44209. * Load a scene
  44210. * @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)
  44211. * @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)
  44212. * @param engine is the instance of BABYLON.Engine to use to create the scene
  44213. * @param onSuccess a callback with the scene when import succeeds
  44214. * @param onProgress a callback with a progress event for each file being loaded
  44215. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44216. * @param pluginExtension the extension used to determine the plugin
  44217. * @returns The loaded plugin
  44218. */
  44219. 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>;
  44220. /**
  44221. * Load a scene
  44222. * @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)
  44223. * @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)
  44224. * @param engine is the instance of BABYLON.Engine to use to create the scene
  44225. * @param onProgress a callback with a progress event for each file being loaded
  44226. * @param pluginExtension the extension used to determine the plugin
  44227. * @returns The loaded scene
  44228. */
  44229. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  44230. /**
  44231. * Append a scene
  44232. * @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)
  44233. * @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)
  44234. * @param scene is the instance of BABYLON.Scene to append to
  44235. * @param onSuccess a callback with the scene when import succeeds
  44236. * @param onProgress a callback with a progress event for each file being loaded
  44237. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44238. * @param pluginExtension the extension used to determine the plugin
  44239. * @returns The loaded plugin
  44240. */
  44241. 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>;
  44242. /**
  44243. * Append a scene
  44244. * @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)
  44245. * @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)
  44246. * @param scene is the instance of BABYLON.Scene to append to
  44247. * @param onProgress a callback with a progress event for each file being loaded
  44248. * @param pluginExtension the extension used to determine the plugin
  44249. * @returns The given scene
  44250. */
  44251. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  44252. /**
  44253. * Load a scene into an asset container
  44254. * @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)
  44255. * @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)
  44256. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  44257. * @param onSuccess a callback with the scene when import succeeds
  44258. * @param onProgress a callback with a progress event for each file being loaded
  44259. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44260. * @param pluginExtension the extension used to determine the plugin
  44261. * @returns The loaded plugin
  44262. */
  44263. 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>;
  44264. /**
  44265. * Load a scene into an asset container
  44266. * @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)
  44267. * @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)
  44268. * @param scene is the instance of Scene to append to
  44269. * @param onProgress a callback with a progress event for each file being loaded
  44270. * @param pluginExtension the extension used to determine the plugin
  44271. * @returns The loaded asset container
  44272. */
  44273. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  44274. }
  44275. }
  44276. declare module "babylonjs/Gamepads/Controllers/genericController" {
  44277. import { Scene } from "babylonjs/scene";
  44278. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44279. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44280. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44281. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44282. /**
  44283. * Generic Controller
  44284. */
  44285. export class GenericController extends WebVRController {
  44286. /**
  44287. * Base Url for the controller model.
  44288. */
  44289. static readonly MODEL_BASE_URL: string;
  44290. /**
  44291. * File name for the controller model.
  44292. */
  44293. static readonly MODEL_FILENAME: string;
  44294. /**
  44295. * Creates a new GenericController from a gamepad
  44296. * @param vrGamepad the gamepad that the controller should be created from
  44297. */
  44298. constructor(vrGamepad: any);
  44299. /**
  44300. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44301. * @param scene scene in which to add meshes
  44302. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44303. */
  44304. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44305. /**
  44306. * Called once for each button that changed state since the last frame
  44307. * @param buttonIdx Which button index changed
  44308. * @param state New state of the button
  44309. * @param changes Which properties on the state changed since last frame
  44310. */
  44311. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44312. }
  44313. }
  44314. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  44315. import { Observable } from "babylonjs/Misc/observable";
  44316. import { Scene } from "babylonjs/scene";
  44317. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44318. import { Ray } from "babylonjs/Culling/ray";
  44319. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44320. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44321. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44322. /**
  44323. * Defines the WindowsMotionController object that the state of the windows motion controller
  44324. */
  44325. export class WindowsMotionController extends WebVRController {
  44326. /**
  44327. * The base url used to load the left and right controller models
  44328. */
  44329. static MODEL_BASE_URL: string;
  44330. /**
  44331. * The name of the left controller model file
  44332. */
  44333. static MODEL_LEFT_FILENAME: string;
  44334. /**
  44335. * The name of the right controller model file
  44336. */
  44337. static MODEL_RIGHT_FILENAME: string;
  44338. /**
  44339. * The controller name prefix for this controller type
  44340. */
  44341. static readonly GAMEPAD_ID_PREFIX: string;
  44342. /**
  44343. * The controller id pattern for this controller type
  44344. */
  44345. private static readonly GAMEPAD_ID_PATTERN;
  44346. private _loadedMeshInfo;
  44347. private readonly _mapping;
  44348. /**
  44349. * Fired when the trackpad on this controller is clicked
  44350. */
  44351. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  44352. /**
  44353. * Fired when the trackpad on this controller is modified
  44354. */
  44355. onTrackpadValuesChangedObservable: Observable<StickValues>;
  44356. /**
  44357. * The current x and y values of this controller's trackpad
  44358. */
  44359. trackpad: StickValues;
  44360. /**
  44361. * Creates a new WindowsMotionController from a gamepad
  44362. * @param vrGamepad the gamepad that the controller should be created from
  44363. */
  44364. constructor(vrGamepad: any);
  44365. /**
  44366. * Fired when the trigger on this controller is modified
  44367. */
  44368. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44369. /**
  44370. * Fired when the menu button on this controller is modified
  44371. */
  44372. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44373. /**
  44374. * Fired when the grip button on this controller is modified
  44375. */
  44376. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44377. /**
  44378. * Fired when the thumbstick button on this controller is modified
  44379. */
  44380. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44381. /**
  44382. * Fired when the touchpad button on this controller is modified
  44383. */
  44384. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44385. /**
  44386. * Fired when the touchpad values on this controller are modified
  44387. */
  44388. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  44389. private _updateTrackpad;
  44390. /**
  44391. * Called once per frame by the engine.
  44392. */
  44393. update(): void;
  44394. /**
  44395. * Called once for each button that changed state since the last frame
  44396. * @param buttonIdx Which button index changed
  44397. * @param state New state of the button
  44398. * @param changes Which properties on the state changed since last frame
  44399. */
  44400. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44401. /**
  44402. * Moves the buttons on the controller mesh based on their current state
  44403. * @param buttonName the name of the button to move
  44404. * @param buttonValue the value of the button which determines the buttons new position
  44405. */
  44406. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  44407. /**
  44408. * Moves the axis on the controller mesh based on its current state
  44409. * @param axis the index of the axis
  44410. * @param axisValue the value of the axis which determines the meshes new position
  44411. * @hidden
  44412. */
  44413. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  44414. /**
  44415. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44416. * @param scene scene in which to add meshes
  44417. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44418. */
  44419. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  44420. /**
  44421. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  44422. * can be transformed by button presses and axes values, based on this._mapping.
  44423. *
  44424. * @param scene scene in which the meshes exist
  44425. * @param meshes list of meshes that make up the controller model to process
  44426. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  44427. */
  44428. private processModel;
  44429. private createMeshInfo;
  44430. /**
  44431. * Gets the ray of the controller in the direction the controller is pointing
  44432. * @param length the length the resulting ray should be
  44433. * @returns a ray in the direction the controller is pointing
  44434. */
  44435. getForwardRay(length?: number): Ray;
  44436. /**
  44437. * Disposes of the controller
  44438. */
  44439. dispose(): void;
  44440. }
  44441. }
  44442. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  44443. import { Observable } from "babylonjs/Misc/observable";
  44444. import { Scene } from "babylonjs/scene";
  44445. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44446. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44447. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44448. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44449. /**
  44450. * Oculus Touch Controller
  44451. */
  44452. export class OculusTouchController extends WebVRController {
  44453. /**
  44454. * Base Url for the controller model.
  44455. */
  44456. static MODEL_BASE_URL: string;
  44457. /**
  44458. * File name for the left controller model.
  44459. */
  44460. static MODEL_LEFT_FILENAME: string;
  44461. /**
  44462. * File name for the right controller model.
  44463. */
  44464. static MODEL_RIGHT_FILENAME: string;
  44465. /**
  44466. * Base Url for the Quest controller model.
  44467. */
  44468. static QUEST_MODEL_BASE_URL: string;
  44469. /**
  44470. * @hidden
  44471. * If the controllers are running on a device that needs the updated Quest controller models
  44472. */
  44473. static _IsQuest: boolean;
  44474. /**
  44475. * Fired when the secondary trigger on this controller is modified
  44476. */
  44477. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  44478. /**
  44479. * Fired when the thumb rest on this controller is modified
  44480. */
  44481. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  44482. /**
  44483. * Creates a new OculusTouchController from a gamepad
  44484. * @param vrGamepad the gamepad that the controller should be created from
  44485. */
  44486. constructor(vrGamepad: any);
  44487. /**
  44488. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44489. * @param scene scene in which to add meshes
  44490. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44491. */
  44492. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44493. /**
  44494. * Fired when the A button on this controller is modified
  44495. */
  44496. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44497. /**
  44498. * Fired when the B button on this controller is modified
  44499. */
  44500. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44501. /**
  44502. * Fired when the X button on this controller is modified
  44503. */
  44504. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44505. /**
  44506. * Fired when the Y button on this controller is modified
  44507. */
  44508. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44509. /**
  44510. * Called once for each button that changed state since the last frame
  44511. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  44512. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  44513. * 2) secondary trigger (same)
  44514. * 3) A (right) X (left), touch, pressed = value
  44515. * 4) B / Y
  44516. * 5) thumb rest
  44517. * @param buttonIdx Which button index changed
  44518. * @param state New state of the button
  44519. * @param changes Which properties on the state changed since last frame
  44520. */
  44521. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44522. }
  44523. }
  44524. declare module "babylonjs/Gamepads/Controllers/viveController" {
  44525. import { Scene } from "babylonjs/scene";
  44526. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44527. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44528. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44529. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44530. import { Observable } from "babylonjs/Misc/observable";
  44531. /**
  44532. * Vive Controller
  44533. */
  44534. export class ViveController extends WebVRController {
  44535. /**
  44536. * Base Url for the controller model.
  44537. */
  44538. static MODEL_BASE_URL: string;
  44539. /**
  44540. * File name for the controller model.
  44541. */
  44542. static MODEL_FILENAME: string;
  44543. /**
  44544. * Creates a new ViveController from a gamepad
  44545. * @param vrGamepad the gamepad that the controller should be created from
  44546. */
  44547. constructor(vrGamepad: any);
  44548. /**
  44549. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44550. * @param scene scene in which to add meshes
  44551. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44552. */
  44553. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44554. /**
  44555. * Fired when the left button on this controller is modified
  44556. */
  44557. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44558. /**
  44559. * Fired when the right button on this controller is modified
  44560. */
  44561. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44562. /**
  44563. * Fired when the menu button on this controller is modified
  44564. */
  44565. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44566. /**
  44567. * Called once for each button that changed state since the last frame
  44568. * Vive mapping:
  44569. * 0: touchpad
  44570. * 1: trigger
  44571. * 2: left AND right buttons
  44572. * 3: menu button
  44573. * @param buttonIdx Which button index changed
  44574. * @param state New state of the button
  44575. * @param changes Which properties on the state changed since last frame
  44576. */
  44577. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44578. }
  44579. }
  44580. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  44581. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44582. /**
  44583. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  44584. */
  44585. export class WebXRControllerModelLoader {
  44586. /**
  44587. * Creates the WebXRControllerModelLoader
  44588. * @param input xr input that creates the controllers
  44589. */
  44590. constructor(input: WebXRInput);
  44591. }
  44592. }
  44593. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  44594. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44595. import { Scene } from "babylonjs/scene";
  44596. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44597. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44598. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44599. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44600. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  44601. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  44602. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44603. import { WebXRManagedOutputCanvasOptions } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44604. /**
  44605. * Options for the default xr helper
  44606. */
  44607. export class WebXRDefaultExperienceOptions {
  44608. /**
  44609. * Floor meshes that should be used for teleporting
  44610. */
  44611. floorMeshes: Array<AbstractMesh>;
  44612. /**
  44613. * Enable or disable default UI to enter XR
  44614. */
  44615. disableDefaultUI: boolean;
  44616. /**
  44617. * optional configuration for the output canvas
  44618. */
  44619. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  44620. }
  44621. /**
  44622. * Default experience which provides a similar setup to the previous webVRExperience
  44623. */
  44624. export class WebXRDefaultExperience {
  44625. /**
  44626. * Base experience
  44627. */
  44628. baseExperience: WebXRExperienceHelper;
  44629. /**
  44630. * Input experience extension
  44631. */
  44632. input: WebXRInput;
  44633. /**
  44634. * Loads the controller models
  44635. */
  44636. controllerModelLoader: WebXRControllerModelLoader;
  44637. /**
  44638. * Enables laser pointer and selection
  44639. */
  44640. pointerSelection: WebXRControllerPointerSelection;
  44641. /**
  44642. * Enables teleportation
  44643. */
  44644. teleportation: WebXRControllerTeleportation;
  44645. /**
  44646. * Enables ui for enetering/exiting xr
  44647. */
  44648. enterExitUI: WebXREnterExitUI;
  44649. /**
  44650. * Default target xr should render to
  44651. */
  44652. renderTarget: WebXRRenderTarget;
  44653. /**
  44654. * Creates the default xr experience
  44655. * @param scene scene
  44656. * @param options options for basic configuration
  44657. * @returns resulting WebXRDefaultExperience
  44658. */
  44659. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  44660. private constructor();
  44661. /**
  44662. * DIsposes of the experience helper
  44663. */
  44664. dispose(): void;
  44665. }
  44666. }
  44667. declare module "babylonjs/Cameras/XR/index" {
  44668. export * from "babylonjs/Cameras/XR/webXRCamera";
  44669. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  44670. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44671. export * from "babylonjs/Cameras/XR/webXRInput";
  44672. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44673. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44674. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44675. export * from "babylonjs/Cameras/XR/webXRController";
  44676. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44677. export * from "babylonjs/Cameras/XR/webXRTypes";
  44678. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  44679. export * from "babylonjs/Cameras/XR/webXRDefaultExperience";
  44680. }
  44681. declare module "babylonjs/Cameras/RigModes/index" {
  44682. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  44683. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  44684. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  44685. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  44686. }
  44687. declare module "babylonjs/Cameras/index" {
  44688. export * from "babylonjs/Cameras/Inputs/index";
  44689. export * from "babylonjs/Cameras/cameraInputsManager";
  44690. export * from "babylonjs/Cameras/camera";
  44691. export * from "babylonjs/Cameras/targetCamera";
  44692. export * from "babylonjs/Cameras/freeCamera";
  44693. export * from "babylonjs/Cameras/freeCameraInputsManager";
  44694. export * from "babylonjs/Cameras/touchCamera";
  44695. export * from "babylonjs/Cameras/arcRotateCamera";
  44696. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44697. export * from "babylonjs/Cameras/deviceOrientationCamera";
  44698. export * from "babylonjs/Cameras/flyCamera";
  44699. export * from "babylonjs/Cameras/flyCameraInputsManager";
  44700. export * from "babylonjs/Cameras/followCamera";
  44701. export * from "babylonjs/Cameras/followCameraInputsManager";
  44702. export * from "babylonjs/Cameras/gamepadCamera";
  44703. export * from "babylonjs/Cameras/Stereoscopic/index";
  44704. export * from "babylonjs/Cameras/universalCamera";
  44705. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  44706. export * from "babylonjs/Cameras/VR/index";
  44707. export * from "babylonjs/Cameras/XR/index";
  44708. export * from "babylonjs/Cameras/RigModes/index";
  44709. }
  44710. declare module "babylonjs/Collisions/index" {
  44711. export * from "babylonjs/Collisions/collider";
  44712. export * from "babylonjs/Collisions/collisionCoordinator";
  44713. export * from "babylonjs/Collisions/pickingInfo";
  44714. export * from "babylonjs/Collisions/intersectionInfo";
  44715. export * from "babylonjs/Collisions/meshCollisionData";
  44716. }
  44717. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  44718. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  44719. import { Vector3 } from "babylonjs/Maths/math.vector";
  44720. import { Ray } from "babylonjs/Culling/ray";
  44721. import { Plane } from "babylonjs/Maths/math.plane";
  44722. /**
  44723. * Contains an array of blocks representing the octree
  44724. */
  44725. export interface IOctreeContainer<T> {
  44726. /**
  44727. * Blocks within the octree
  44728. */
  44729. blocks: Array<OctreeBlock<T>>;
  44730. }
  44731. /**
  44732. * Class used to store a cell in an octree
  44733. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44734. */
  44735. export class OctreeBlock<T> {
  44736. /**
  44737. * Gets the content of the current block
  44738. */
  44739. entries: T[];
  44740. /**
  44741. * Gets the list of block children
  44742. */
  44743. blocks: Array<OctreeBlock<T>>;
  44744. private _depth;
  44745. private _maxDepth;
  44746. private _capacity;
  44747. private _minPoint;
  44748. private _maxPoint;
  44749. private _boundingVectors;
  44750. private _creationFunc;
  44751. /**
  44752. * Creates a new block
  44753. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  44754. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  44755. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44756. * @param depth defines the current depth of this block in the octree
  44757. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  44758. * @param creationFunc defines a callback to call when an element is added to the block
  44759. */
  44760. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  44761. /**
  44762. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44763. */
  44764. readonly capacity: number;
  44765. /**
  44766. * Gets the minimum vector (in world space) of the block's bounding box
  44767. */
  44768. readonly minPoint: Vector3;
  44769. /**
  44770. * Gets the maximum vector (in world space) of the block's bounding box
  44771. */
  44772. readonly maxPoint: Vector3;
  44773. /**
  44774. * Add a new element to this block
  44775. * @param entry defines the element to add
  44776. */
  44777. addEntry(entry: T): void;
  44778. /**
  44779. * Remove an element from this block
  44780. * @param entry defines the element to remove
  44781. */
  44782. removeEntry(entry: T): void;
  44783. /**
  44784. * Add an array of elements to this block
  44785. * @param entries defines the array of elements to add
  44786. */
  44787. addEntries(entries: T[]): void;
  44788. /**
  44789. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  44790. * @param frustumPlanes defines the frustum planes to test
  44791. * @param selection defines the array to store current content if selection is positive
  44792. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44793. */
  44794. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44795. /**
  44796. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  44797. * @param sphereCenter defines the bounding sphere center
  44798. * @param sphereRadius defines the bounding sphere radius
  44799. * @param selection defines the array to store current content if selection is positive
  44800. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44801. */
  44802. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44803. /**
  44804. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  44805. * @param ray defines the ray to test with
  44806. * @param selection defines the array to store current content if selection is positive
  44807. */
  44808. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  44809. /**
  44810. * Subdivide the content into child blocks (this block will then be empty)
  44811. */
  44812. createInnerBlocks(): void;
  44813. /**
  44814. * @hidden
  44815. */
  44816. 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;
  44817. }
  44818. }
  44819. declare module "babylonjs/Culling/Octrees/octree" {
  44820. import { SmartArray } from "babylonjs/Misc/smartArray";
  44821. import { Vector3 } from "babylonjs/Maths/math.vector";
  44822. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44823. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44824. import { Ray } from "babylonjs/Culling/ray";
  44825. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  44826. import { Plane } from "babylonjs/Maths/math.plane";
  44827. /**
  44828. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  44829. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44830. */
  44831. export class Octree<T> {
  44832. /** 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.) */
  44833. maxDepth: number;
  44834. /**
  44835. * Blocks within the octree containing objects
  44836. */
  44837. blocks: Array<OctreeBlock<T>>;
  44838. /**
  44839. * Content stored in the octree
  44840. */
  44841. dynamicContent: T[];
  44842. private _maxBlockCapacity;
  44843. private _selectionContent;
  44844. private _creationFunc;
  44845. /**
  44846. * Creates a octree
  44847. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44848. * @param creationFunc function to be used to instatiate the octree
  44849. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  44850. * @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.)
  44851. */
  44852. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  44853. /** 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.) */
  44854. maxDepth?: number);
  44855. /**
  44856. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  44857. * @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);
  44858. * @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);
  44859. * @param entries meshes to be added to the octree blocks
  44860. */
  44861. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  44862. /**
  44863. * Adds a mesh to the octree
  44864. * @param entry Mesh to add to the octree
  44865. */
  44866. addMesh(entry: T): void;
  44867. /**
  44868. * Remove an element from the octree
  44869. * @param entry defines the element to remove
  44870. */
  44871. removeMesh(entry: T): void;
  44872. /**
  44873. * Selects an array of meshes within the frustum
  44874. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  44875. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  44876. * @returns array of meshes within the frustum
  44877. */
  44878. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  44879. /**
  44880. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  44881. * @param sphereCenter defines the bounding sphere center
  44882. * @param sphereRadius defines the bounding sphere radius
  44883. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44884. * @returns an array of objects that intersect the sphere
  44885. */
  44886. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  44887. /**
  44888. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  44889. * @param ray defines the ray to test with
  44890. * @returns array of intersected objects
  44891. */
  44892. intersectsRay(ray: Ray): SmartArray<T>;
  44893. /**
  44894. * Adds a mesh into the octree block if it intersects the block
  44895. */
  44896. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  44897. /**
  44898. * Adds a submesh into the octree block if it intersects the block
  44899. */
  44900. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  44901. }
  44902. }
  44903. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  44904. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  44905. import { Scene } from "babylonjs/scene";
  44906. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44907. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44908. import { Ray } from "babylonjs/Culling/ray";
  44909. import { Octree } from "babylonjs/Culling/Octrees/octree";
  44910. import { Collider } from "babylonjs/Collisions/collider";
  44911. module "babylonjs/scene" {
  44912. interface Scene {
  44913. /**
  44914. * @hidden
  44915. * Backing Filed
  44916. */
  44917. _selectionOctree: Octree<AbstractMesh>;
  44918. /**
  44919. * Gets the octree used to boost mesh selection (picking)
  44920. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44921. */
  44922. selectionOctree: Octree<AbstractMesh>;
  44923. /**
  44924. * Creates or updates the octree used to boost selection (picking)
  44925. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44926. * @param maxCapacity defines the maximum capacity per leaf
  44927. * @param maxDepth defines the maximum depth of the octree
  44928. * @returns an octree of AbstractMesh
  44929. */
  44930. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  44931. }
  44932. }
  44933. module "babylonjs/Meshes/abstractMesh" {
  44934. interface AbstractMesh {
  44935. /**
  44936. * @hidden
  44937. * Backing Field
  44938. */
  44939. _submeshesOctree: Octree<SubMesh>;
  44940. /**
  44941. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  44942. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  44943. * @param maxCapacity defines the maximum size of each block (64 by default)
  44944. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  44945. * @returns the new octree
  44946. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  44947. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44948. */
  44949. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  44950. }
  44951. }
  44952. /**
  44953. * Defines the octree scene component responsible to manage any octrees
  44954. * in a given scene.
  44955. */
  44956. export class OctreeSceneComponent {
  44957. /**
  44958. * The component name help to identify the component in the list of scene components.
  44959. */
  44960. readonly name: string;
  44961. /**
  44962. * The scene the component belongs to.
  44963. */
  44964. scene: Scene;
  44965. /**
  44966. * Indicates if the meshes have been checked to make sure they are isEnabled()
  44967. */
  44968. readonly checksIsEnabled: boolean;
  44969. /**
  44970. * Creates a new instance of the component for the given scene
  44971. * @param scene Defines the scene to register the component in
  44972. */
  44973. constructor(scene: Scene);
  44974. /**
  44975. * Registers the component in a given scene
  44976. */
  44977. register(): void;
  44978. /**
  44979. * Return the list of active meshes
  44980. * @returns the list of active meshes
  44981. */
  44982. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44983. /**
  44984. * Return the list of active sub meshes
  44985. * @param mesh The mesh to get the candidates sub meshes from
  44986. * @returns the list of active sub meshes
  44987. */
  44988. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44989. private _tempRay;
  44990. /**
  44991. * Return the list of sub meshes intersecting with a given local ray
  44992. * @param mesh defines the mesh to find the submesh for
  44993. * @param localRay defines the ray in local space
  44994. * @returns the list of intersecting sub meshes
  44995. */
  44996. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  44997. /**
  44998. * Return the list of sub meshes colliding with a collider
  44999. * @param mesh defines the mesh to find the submesh for
  45000. * @param collider defines the collider to evaluate the collision against
  45001. * @returns the list of colliding sub meshes
  45002. */
  45003. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  45004. /**
  45005. * Rebuilds the elements related to this component in case of
  45006. * context lost for instance.
  45007. */
  45008. rebuild(): void;
  45009. /**
  45010. * Disposes the component and the associated ressources.
  45011. */
  45012. dispose(): void;
  45013. }
  45014. }
  45015. declare module "babylonjs/Culling/Octrees/index" {
  45016. export * from "babylonjs/Culling/Octrees/octree";
  45017. export * from "babylonjs/Culling/Octrees/octreeBlock";
  45018. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  45019. }
  45020. declare module "babylonjs/Culling/index" {
  45021. export * from "babylonjs/Culling/boundingBox";
  45022. export * from "babylonjs/Culling/boundingInfo";
  45023. export * from "babylonjs/Culling/boundingSphere";
  45024. export * from "babylonjs/Culling/Octrees/index";
  45025. export * from "babylonjs/Culling/ray";
  45026. }
  45027. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  45028. import { IDisposable, Scene } from "babylonjs/scene";
  45029. import { Nullable } from "babylonjs/types";
  45030. import { Observable } from "babylonjs/Misc/observable";
  45031. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45032. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  45033. import { Camera } from "babylonjs/Cameras/camera";
  45034. /**
  45035. * Renders a layer on top of an existing scene
  45036. */
  45037. export class UtilityLayerRenderer implements IDisposable {
  45038. /** the original scene that will be rendered on top of */
  45039. originalScene: Scene;
  45040. private _pointerCaptures;
  45041. private _lastPointerEvents;
  45042. private static _DefaultUtilityLayer;
  45043. private static _DefaultKeepDepthUtilityLayer;
  45044. private _sharedGizmoLight;
  45045. private _renderCamera;
  45046. /**
  45047. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  45048. * @returns the camera that is used when rendering the utility layer
  45049. */
  45050. getRenderCamera(): Nullable<Camera>;
  45051. /**
  45052. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  45053. * @param cam the camera that should be used when rendering the utility layer
  45054. */
  45055. setRenderCamera(cam: Nullable<Camera>): void;
  45056. /**
  45057. * @hidden
  45058. * Light which used by gizmos to get light shading
  45059. */
  45060. _getSharedGizmoLight(): HemisphericLight;
  45061. /**
  45062. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  45063. */
  45064. pickUtilitySceneFirst: boolean;
  45065. /**
  45066. * 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)
  45067. */
  45068. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  45069. /**
  45070. * 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)
  45071. */
  45072. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  45073. /**
  45074. * The scene that is rendered on top of the original scene
  45075. */
  45076. utilityLayerScene: Scene;
  45077. /**
  45078. * If the utility layer should automatically be rendered on top of existing scene
  45079. */
  45080. shouldRender: boolean;
  45081. /**
  45082. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  45083. */
  45084. onlyCheckPointerDownEvents: boolean;
  45085. /**
  45086. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  45087. */
  45088. processAllEvents: boolean;
  45089. /**
  45090. * Observable raised when the pointer move from the utility layer scene to the main scene
  45091. */
  45092. onPointerOutObservable: Observable<number>;
  45093. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  45094. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  45095. private _afterRenderObserver;
  45096. private _sceneDisposeObserver;
  45097. private _originalPointerObserver;
  45098. /**
  45099. * Instantiates a UtilityLayerRenderer
  45100. * @param originalScene the original scene that will be rendered on top of
  45101. * @param handleEvents boolean indicating if the utility layer should handle events
  45102. */
  45103. constructor(
  45104. /** the original scene that will be rendered on top of */
  45105. originalScene: Scene, handleEvents?: boolean);
  45106. private _notifyObservers;
  45107. /**
  45108. * Renders the utility layers scene on top of the original scene
  45109. */
  45110. render(): void;
  45111. /**
  45112. * Disposes of the renderer
  45113. */
  45114. dispose(): void;
  45115. private _updateCamera;
  45116. }
  45117. }
  45118. declare module "babylonjs/Gizmos/gizmo" {
  45119. import { Nullable } from "babylonjs/types";
  45120. import { IDisposable } from "babylonjs/scene";
  45121. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45122. import { Mesh } from "babylonjs/Meshes/mesh";
  45123. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45124. /**
  45125. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  45126. */
  45127. export class Gizmo implements IDisposable {
  45128. /** The utility layer the gizmo will be added to */
  45129. gizmoLayer: UtilityLayerRenderer;
  45130. /**
  45131. * The root mesh of the gizmo
  45132. */
  45133. _rootMesh: Mesh;
  45134. private _attachedMesh;
  45135. /**
  45136. * Ratio for the scale of the gizmo (Default: 1)
  45137. */
  45138. scaleRatio: number;
  45139. /**
  45140. * If a custom mesh has been set (Default: false)
  45141. */
  45142. protected _customMeshSet: boolean;
  45143. /**
  45144. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  45145. * * When set, interactions will be enabled
  45146. */
  45147. attachedMesh: Nullable<AbstractMesh>;
  45148. /**
  45149. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  45150. * @param mesh The mesh to replace the default mesh of the gizmo
  45151. */
  45152. setCustomMesh(mesh: Mesh): void;
  45153. /**
  45154. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  45155. */
  45156. updateGizmoRotationToMatchAttachedMesh: boolean;
  45157. /**
  45158. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  45159. */
  45160. updateGizmoPositionToMatchAttachedMesh: boolean;
  45161. /**
  45162. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  45163. */
  45164. updateScale: boolean;
  45165. protected _interactionsEnabled: boolean;
  45166. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45167. private _beforeRenderObserver;
  45168. private _tempVector;
  45169. /**
  45170. * Creates a gizmo
  45171. * @param gizmoLayer The utility layer the gizmo will be added to
  45172. */
  45173. constructor(
  45174. /** The utility layer the gizmo will be added to */
  45175. gizmoLayer?: UtilityLayerRenderer);
  45176. /**
  45177. * Updates the gizmo to match the attached mesh's position/rotation
  45178. */
  45179. protected _update(): void;
  45180. /**
  45181. * Disposes of the gizmo
  45182. */
  45183. dispose(): void;
  45184. }
  45185. }
  45186. declare module "babylonjs/Gizmos/planeDragGizmo" {
  45187. import { Observable } from "babylonjs/Misc/observable";
  45188. import { Nullable } from "babylonjs/types";
  45189. import { Vector3 } from "babylonjs/Maths/math.vector";
  45190. import { Color3 } from "babylonjs/Maths/math.color";
  45191. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45192. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45193. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45194. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45195. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45196. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  45197. import { Scene } from "babylonjs/scene";
  45198. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  45199. /**
  45200. * Single plane drag gizmo
  45201. */
  45202. export class PlaneDragGizmo extends Gizmo {
  45203. /**
  45204. * Drag behavior responsible for the gizmos dragging interactions
  45205. */
  45206. dragBehavior: PointerDragBehavior;
  45207. private _pointerObserver;
  45208. /**
  45209. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45210. */
  45211. snapDistance: number;
  45212. /**
  45213. * Event that fires each time the gizmo snaps to a new location.
  45214. * * snapDistance is the the change in distance
  45215. */
  45216. onSnapObservable: Observable<{
  45217. snapDistance: number;
  45218. }>;
  45219. private _plane;
  45220. private _coloredMaterial;
  45221. private _hoverMaterial;
  45222. private _isEnabled;
  45223. private _parent;
  45224. /** @hidden */
  45225. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  45226. /** @hidden */
  45227. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  45228. /**
  45229. * Creates a PlaneDragGizmo
  45230. * @param gizmoLayer The utility layer the gizmo will be added to
  45231. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  45232. * @param color The color of the gizmo
  45233. */
  45234. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  45235. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45236. /**
  45237. * If the gizmo is enabled
  45238. */
  45239. isEnabled: boolean;
  45240. /**
  45241. * Disposes of the gizmo
  45242. */
  45243. dispose(): void;
  45244. }
  45245. }
  45246. declare module "babylonjs/Gizmos/positionGizmo" {
  45247. import { Observable } from "babylonjs/Misc/observable";
  45248. import { Nullable } from "babylonjs/types";
  45249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45250. import { Mesh } from "babylonjs/Meshes/mesh";
  45251. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45252. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  45253. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  45254. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45255. /**
  45256. * Gizmo that enables dragging a mesh along 3 axis
  45257. */
  45258. export class PositionGizmo extends Gizmo {
  45259. /**
  45260. * Internal gizmo used for interactions on the x axis
  45261. */
  45262. xGizmo: AxisDragGizmo;
  45263. /**
  45264. * Internal gizmo used for interactions on the y axis
  45265. */
  45266. yGizmo: AxisDragGizmo;
  45267. /**
  45268. * Internal gizmo used for interactions on the z axis
  45269. */
  45270. zGizmo: AxisDragGizmo;
  45271. /**
  45272. * Internal gizmo used for interactions on the yz plane
  45273. */
  45274. xPlaneGizmo: PlaneDragGizmo;
  45275. /**
  45276. * Internal gizmo used for interactions on the xz plane
  45277. */
  45278. yPlaneGizmo: PlaneDragGizmo;
  45279. /**
  45280. * Internal gizmo used for interactions on the xy plane
  45281. */
  45282. zPlaneGizmo: PlaneDragGizmo;
  45283. /**
  45284. * private variables
  45285. */
  45286. private _meshAttached;
  45287. private _updateGizmoRotationToMatchAttachedMesh;
  45288. private _snapDistance;
  45289. private _scaleRatio;
  45290. /** Fires an event when any of it's sub gizmos are dragged */
  45291. onDragStartObservable: Observable<unknown>;
  45292. /** Fires an event when any of it's sub gizmos are released from dragging */
  45293. onDragEndObservable: Observable<unknown>;
  45294. /**
  45295. * If set to true, planar drag is enabled
  45296. */
  45297. private _planarGizmoEnabled;
  45298. attachedMesh: Nullable<AbstractMesh>;
  45299. /**
  45300. * Creates a PositionGizmo
  45301. * @param gizmoLayer The utility layer the gizmo will be added to
  45302. */
  45303. constructor(gizmoLayer?: UtilityLayerRenderer);
  45304. /**
  45305. * If the planar drag gizmo is enabled
  45306. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  45307. */
  45308. planarGizmoEnabled: boolean;
  45309. updateGizmoRotationToMatchAttachedMesh: boolean;
  45310. /**
  45311. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45312. */
  45313. snapDistance: number;
  45314. /**
  45315. * Ratio for the scale of the gizmo (Default: 1)
  45316. */
  45317. scaleRatio: number;
  45318. /**
  45319. * Disposes of the gizmo
  45320. */
  45321. dispose(): void;
  45322. /**
  45323. * CustomMeshes are not supported by this gizmo
  45324. * @param mesh The mesh to replace the default mesh of the gizmo
  45325. */
  45326. setCustomMesh(mesh: Mesh): void;
  45327. }
  45328. }
  45329. declare module "babylonjs/Gizmos/axisDragGizmo" {
  45330. import { Observable } from "babylonjs/Misc/observable";
  45331. import { Nullable } from "babylonjs/types";
  45332. import { Vector3 } from "babylonjs/Maths/math.vector";
  45333. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45334. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45335. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45336. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45337. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45338. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  45339. import { Scene } from "babylonjs/scene";
  45340. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  45341. import { Color3 } from "babylonjs/Maths/math.color";
  45342. /**
  45343. * Single axis drag gizmo
  45344. */
  45345. export class AxisDragGizmo extends Gizmo {
  45346. /**
  45347. * Drag behavior responsible for the gizmos dragging interactions
  45348. */
  45349. dragBehavior: PointerDragBehavior;
  45350. private _pointerObserver;
  45351. /**
  45352. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45353. */
  45354. snapDistance: number;
  45355. /**
  45356. * Event that fires each time the gizmo snaps to a new location.
  45357. * * snapDistance is the the change in distance
  45358. */
  45359. onSnapObservable: Observable<{
  45360. snapDistance: number;
  45361. }>;
  45362. private _isEnabled;
  45363. private _parent;
  45364. private _arrow;
  45365. private _coloredMaterial;
  45366. private _hoverMaterial;
  45367. /** @hidden */
  45368. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  45369. /** @hidden */
  45370. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  45371. /**
  45372. * Creates an AxisDragGizmo
  45373. * @param gizmoLayer The utility layer the gizmo will be added to
  45374. * @param dragAxis The axis which the gizmo will be able to drag on
  45375. * @param color The color of the gizmo
  45376. */
  45377. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  45378. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45379. /**
  45380. * If the gizmo is enabled
  45381. */
  45382. isEnabled: boolean;
  45383. /**
  45384. * Disposes of the gizmo
  45385. */
  45386. dispose(): void;
  45387. }
  45388. }
  45389. declare module "babylonjs/Debug/axesViewer" {
  45390. import { Vector3 } from "babylonjs/Maths/math.vector";
  45391. import { Nullable } from "babylonjs/types";
  45392. import { Scene } from "babylonjs/scene";
  45393. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45394. /**
  45395. * The Axes viewer will show 3 axes in a specific point in space
  45396. */
  45397. export class AxesViewer {
  45398. private _xAxis;
  45399. private _yAxis;
  45400. private _zAxis;
  45401. private _scaleLinesFactor;
  45402. private _instanced;
  45403. /**
  45404. * Gets the hosting scene
  45405. */
  45406. scene: Scene;
  45407. /**
  45408. * Gets or sets a number used to scale line length
  45409. */
  45410. scaleLines: number;
  45411. /** Gets the node hierarchy used to render x-axis */
  45412. readonly xAxis: TransformNode;
  45413. /** Gets the node hierarchy used to render y-axis */
  45414. readonly yAxis: TransformNode;
  45415. /** Gets the node hierarchy used to render z-axis */
  45416. readonly zAxis: TransformNode;
  45417. /**
  45418. * Creates a new AxesViewer
  45419. * @param scene defines the hosting scene
  45420. * @param scaleLines defines a number used to scale line length (1 by default)
  45421. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  45422. * @param xAxis defines the node hierarchy used to render the x-axis
  45423. * @param yAxis defines the node hierarchy used to render the y-axis
  45424. * @param zAxis defines the node hierarchy used to render the z-axis
  45425. */
  45426. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  45427. /**
  45428. * Force the viewer to update
  45429. * @param position defines the position of the viewer
  45430. * @param xaxis defines the x axis of the viewer
  45431. * @param yaxis defines the y axis of the viewer
  45432. * @param zaxis defines the z axis of the viewer
  45433. */
  45434. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  45435. /**
  45436. * Creates an instance of this axes viewer.
  45437. * @returns a new axes viewer with instanced meshes
  45438. */
  45439. createInstance(): AxesViewer;
  45440. /** Releases resources */
  45441. dispose(): void;
  45442. private static _SetRenderingGroupId;
  45443. }
  45444. }
  45445. declare module "babylonjs/Debug/boneAxesViewer" {
  45446. import { Nullable } from "babylonjs/types";
  45447. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  45448. import { Vector3 } from "babylonjs/Maths/math.vector";
  45449. import { Mesh } from "babylonjs/Meshes/mesh";
  45450. import { Bone } from "babylonjs/Bones/bone";
  45451. import { Scene } from "babylonjs/scene";
  45452. /**
  45453. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  45454. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  45455. */
  45456. export class BoneAxesViewer extends AxesViewer {
  45457. /**
  45458. * Gets or sets the target mesh where to display the axes viewer
  45459. */
  45460. mesh: Nullable<Mesh>;
  45461. /**
  45462. * Gets or sets the target bone where to display the axes viewer
  45463. */
  45464. bone: Nullable<Bone>;
  45465. /** Gets current position */
  45466. pos: Vector3;
  45467. /** Gets direction of X axis */
  45468. xaxis: Vector3;
  45469. /** Gets direction of Y axis */
  45470. yaxis: Vector3;
  45471. /** Gets direction of Z axis */
  45472. zaxis: Vector3;
  45473. /**
  45474. * Creates a new BoneAxesViewer
  45475. * @param scene defines the hosting scene
  45476. * @param bone defines the target bone
  45477. * @param mesh defines the target mesh
  45478. * @param scaleLines defines a scaling factor for line length (1 by default)
  45479. */
  45480. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  45481. /**
  45482. * Force the viewer to update
  45483. */
  45484. update(): void;
  45485. /** Releases resources */
  45486. dispose(): void;
  45487. }
  45488. }
  45489. declare module "babylonjs/Debug/debugLayer" {
  45490. import { Scene } from "babylonjs/scene";
  45491. /**
  45492. * Interface used to define scene explorer extensibility option
  45493. */
  45494. export interface IExplorerExtensibilityOption {
  45495. /**
  45496. * Define the option label
  45497. */
  45498. label: string;
  45499. /**
  45500. * Defines the action to execute on click
  45501. */
  45502. action: (entity: any) => void;
  45503. }
  45504. /**
  45505. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  45506. */
  45507. export interface IExplorerExtensibilityGroup {
  45508. /**
  45509. * Defines a predicate to test if a given type mut be extended
  45510. */
  45511. predicate: (entity: any) => boolean;
  45512. /**
  45513. * Gets the list of options added to a type
  45514. */
  45515. entries: IExplorerExtensibilityOption[];
  45516. }
  45517. /**
  45518. * Interface used to define the options to use to create the Inspector
  45519. */
  45520. export interface IInspectorOptions {
  45521. /**
  45522. * Display in overlay mode (default: false)
  45523. */
  45524. overlay?: boolean;
  45525. /**
  45526. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  45527. */
  45528. globalRoot?: HTMLElement;
  45529. /**
  45530. * Display the Scene explorer
  45531. */
  45532. showExplorer?: boolean;
  45533. /**
  45534. * Display the property inspector
  45535. */
  45536. showInspector?: boolean;
  45537. /**
  45538. * Display in embed mode (both panes on the right)
  45539. */
  45540. embedMode?: boolean;
  45541. /**
  45542. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  45543. */
  45544. handleResize?: boolean;
  45545. /**
  45546. * Allow the panes to popup (default: true)
  45547. */
  45548. enablePopup?: boolean;
  45549. /**
  45550. * Allow the panes to be closed by users (default: true)
  45551. */
  45552. enableClose?: boolean;
  45553. /**
  45554. * Optional list of extensibility entries
  45555. */
  45556. explorerExtensibility?: IExplorerExtensibilityGroup[];
  45557. /**
  45558. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  45559. */
  45560. inspectorURL?: string;
  45561. }
  45562. module "babylonjs/scene" {
  45563. interface Scene {
  45564. /**
  45565. * @hidden
  45566. * Backing field
  45567. */
  45568. _debugLayer: DebugLayer;
  45569. /**
  45570. * Gets the debug layer (aka Inspector) associated with the scene
  45571. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45572. */
  45573. debugLayer: DebugLayer;
  45574. }
  45575. }
  45576. /**
  45577. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45578. * what is happening in your scene
  45579. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45580. */
  45581. export class DebugLayer {
  45582. /**
  45583. * Define the url to get the inspector script from.
  45584. * By default it uses the babylonjs CDN.
  45585. * @ignoreNaming
  45586. */
  45587. static InspectorURL: string;
  45588. private _scene;
  45589. private BJSINSPECTOR;
  45590. private _onPropertyChangedObservable?;
  45591. /**
  45592. * Observable triggered when a property is changed through the inspector.
  45593. */
  45594. readonly onPropertyChangedObservable: any;
  45595. /**
  45596. * Instantiates a new debug layer.
  45597. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45598. * what is happening in your scene
  45599. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45600. * @param scene Defines the scene to inspect
  45601. */
  45602. constructor(scene: Scene);
  45603. /** Creates the inspector window. */
  45604. private _createInspector;
  45605. /**
  45606. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  45607. * @param entity defines the entity to select
  45608. * @param lineContainerTitle defines the specific block to highlight
  45609. */
  45610. select(entity: any, lineContainerTitle?: string): void;
  45611. /** Get the inspector from bundle or global */
  45612. private _getGlobalInspector;
  45613. /**
  45614. * Get if the inspector is visible or not.
  45615. * @returns true if visible otherwise, false
  45616. */
  45617. isVisible(): boolean;
  45618. /**
  45619. * Hide the inspector and close its window.
  45620. */
  45621. hide(): void;
  45622. /**
  45623. * Launch the debugLayer.
  45624. * @param config Define the configuration of the inspector
  45625. * @return a promise fulfilled when the debug layer is visible
  45626. */
  45627. show(config?: IInspectorOptions): Promise<DebugLayer>;
  45628. }
  45629. }
  45630. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  45631. import { Nullable } from "babylonjs/types";
  45632. import { Scene } from "babylonjs/scene";
  45633. import { Vector4 } from "babylonjs/Maths/math.vector";
  45634. import { Color4 } from "babylonjs/Maths/math.color";
  45635. import { Mesh } from "babylonjs/Meshes/mesh";
  45636. /**
  45637. * Class containing static functions to help procedurally build meshes
  45638. */
  45639. export class BoxBuilder {
  45640. /**
  45641. * Creates a box mesh
  45642. * * The parameter `size` sets the size (float) of each box side (default 1)
  45643. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  45644. * * 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)
  45645. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  45646. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45647. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45648. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45649. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  45650. * @param name defines the name of the mesh
  45651. * @param options defines the options used to create the mesh
  45652. * @param scene defines the hosting scene
  45653. * @returns the box mesh
  45654. */
  45655. static CreateBox(name: string, options: {
  45656. size?: number;
  45657. width?: number;
  45658. height?: number;
  45659. depth?: number;
  45660. faceUV?: Vector4[];
  45661. faceColors?: Color4[];
  45662. sideOrientation?: number;
  45663. frontUVs?: Vector4;
  45664. backUVs?: Vector4;
  45665. wrap?: boolean;
  45666. topBaseAt?: number;
  45667. bottomBaseAt?: number;
  45668. updatable?: boolean;
  45669. }, scene?: Nullable<Scene>): Mesh;
  45670. }
  45671. }
  45672. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  45673. import { Vector4 } from "babylonjs/Maths/math.vector";
  45674. import { Mesh } from "babylonjs/Meshes/mesh";
  45675. import { Scene } from "babylonjs/scene";
  45676. import { Nullable } from "babylonjs/types";
  45677. /**
  45678. * Class containing static functions to help procedurally build meshes
  45679. */
  45680. export class SphereBuilder {
  45681. /**
  45682. * Creates a sphere mesh
  45683. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  45684. * * 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`)
  45685. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  45686. * * 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
  45687. * * 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)
  45688. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45689. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45690. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45691. * @param name defines the name of the mesh
  45692. * @param options defines the options used to create the mesh
  45693. * @param scene defines the hosting scene
  45694. * @returns the sphere mesh
  45695. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  45696. */
  45697. static CreateSphere(name: string, options: {
  45698. segments?: number;
  45699. diameter?: number;
  45700. diameterX?: number;
  45701. diameterY?: number;
  45702. diameterZ?: number;
  45703. arc?: number;
  45704. slice?: number;
  45705. sideOrientation?: number;
  45706. frontUVs?: Vector4;
  45707. backUVs?: Vector4;
  45708. updatable?: boolean;
  45709. }, scene?: Nullable<Scene>): Mesh;
  45710. }
  45711. }
  45712. declare module "babylonjs/Debug/physicsViewer" {
  45713. import { Nullable } from "babylonjs/types";
  45714. import { Scene } from "babylonjs/scene";
  45715. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45716. import { Mesh } from "babylonjs/Meshes/mesh";
  45717. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  45718. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  45719. /**
  45720. * Used to show the physics impostor around the specific mesh
  45721. */
  45722. export class PhysicsViewer {
  45723. /** @hidden */
  45724. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  45725. /** @hidden */
  45726. protected _meshes: Array<Nullable<AbstractMesh>>;
  45727. /** @hidden */
  45728. protected _scene: Nullable<Scene>;
  45729. /** @hidden */
  45730. protected _numMeshes: number;
  45731. /** @hidden */
  45732. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  45733. private _renderFunction;
  45734. private _utilityLayer;
  45735. private _debugBoxMesh;
  45736. private _debugSphereMesh;
  45737. private _debugCylinderMesh;
  45738. private _debugMaterial;
  45739. private _debugMeshMeshes;
  45740. /**
  45741. * Creates a new PhysicsViewer
  45742. * @param scene defines the hosting scene
  45743. */
  45744. constructor(scene: Scene);
  45745. /** @hidden */
  45746. protected _updateDebugMeshes(): void;
  45747. /**
  45748. * Renders a specified physic impostor
  45749. * @param impostor defines the impostor to render
  45750. * @param targetMesh defines the mesh represented by the impostor
  45751. * @returns the new debug mesh used to render the impostor
  45752. */
  45753. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  45754. /**
  45755. * Hides a specified physic impostor
  45756. * @param impostor defines the impostor to hide
  45757. */
  45758. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  45759. private _getDebugMaterial;
  45760. private _getDebugBoxMesh;
  45761. private _getDebugSphereMesh;
  45762. private _getDebugCylinderMesh;
  45763. private _getDebugMeshMesh;
  45764. private _getDebugMesh;
  45765. /** Releases all resources */
  45766. dispose(): void;
  45767. }
  45768. }
  45769. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  45770. import { Vector3 } from "babylonjs/Maths/math.vector";
  45771. import { Color4 } from "babylonjs/Maths/math.color";
  45772. import { Nullable } from "babylonjs/types";
  45773. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45774. import { Scene } from "babylonjs/scene";
  45775. /**
  45776. * Class containing static functions to help procedurally build meshes
  45777. */
  45778. export class LinesBuilder {
  45779. /**
  45780. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  45781. * * 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
  45782. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  45783. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  45784. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  45785. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  45786. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  45787. * * 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
  45788. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  45789. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45790. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  45791. * @param name defines the name of the new line system
  45792. * @param options defines the options used to create the line system
  45793. * @param scene defines the hosting scene
  45794. * @returns a new line system mesh
  45795. */
  45796. static CreateLineSystem(name: string, options: {
  45797. lines: Vector3[][];
  45798. updatable?: boolean;
  45799. instance?: Nullable<LinesMesh>;
  45800. colors?: Nullable<Color4[][]>;
  45801. useVertexAlpha?: boolean;
  45802. }, scene: Nullable<Scene>): LinesMesh;
  45803. /**
  45804. * Creates a line mesh
  45805. * 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
  45806. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45807. * * The parameter `points` is an array successive Vector3
  45808. * * 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
  45809. * * The optional parameter `colors` is an array of successive Color4, one per line point
  45810. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  45811. * * When updating an instance, remember that only point positions can change, not the number of points
  45812. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45813. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  45814. * @param name defines the name of the new line system
  45815. * @param options defines the options used to create the line system
  45816. * @param scene defines the hosting scene
  45817. * @returns a new line mesh
  45818. */
  45819. static CreateLines(name: string, options: {
  45820. points: Vector3[];
  45821. updatable?: boolean;
  45822. instance?: Nullable<LinesMesh>;
  45823. colors?: Color4[];
  45824. useVertexAlpha?: boolean;
  45825. }, scene?: Nullable<Scene>): LinesMesh;
  45826. /**
  45827. * Creates a dashed line mesh
  45828. * * 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
  45829. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45830. * * The parameter `points` is an array successive Vector3
  45831. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  45832. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  45833. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  45834. * * 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
  45835. * * When updating an instance, remember that only point positions can change, not the number of points
  45836. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45837. * @param name defines the name of the mesh
  45838. * @param options defines the options used to create the mesh
  45839. * @param scene defines the hosting scene
  45840. * @returns the dashed line mesh
  45841. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  45842. */
  45843. static CreateDashedLines(name: string, options: {
  45844. points: Vector3[];
  45845. dashSize?: number;
  45846. gapSize?: number;
  45847. dashNb?: number;
  45848. updatable?: boolean;
  45849. instance?: LinesMesh;
  45850. }, scene?: Nullable<Scene>): LinesMesh;
  45851. }
  45852. }
  45853. declare module "babylonjs/Debug/rayHelper" {
  45854. import { Nullable } from "babylonjs/types";
  45855. import { Ray } from "babylonjs/Culling/ray";
  45856. import { Vector3 } from "babylonjs/Maths/math.vector";
  45857. import { Color3 } from "babylonjs/Maths/math.color";
  45858. import { Scene } from "babylonjs/scene";
  45859. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45860. import "babylonjs/Meshes/Builders/linesBuilder";
  45861. /**
  45862. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45863. * in order to better appreciate the issue one might have.
  45864. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45865. */
  45866. export class RayHelper {
  45867. /**
  45868. * Defines the ray we are currently tryin to visualize.
  45869. */
  45870. ray: Nullable<Ray>;
  45871. private _renderPoints;
  45872. private _renderLine;
  45873. private _renderFunction;
  45874. private _scene;
  45875. private _updateToMeshFunction;
  45876. private _attachedToMesh;
  45877. private _meshSpaceDirection;
  45878. private _meshSpaceOrigin;
  45879. /**
  45880. * Helper function to create a colored helper in a scene in one line.
  45881. * @param ray Defines the ray we are currently tryin to visualize
  45882. * @param scene Defines the scene the ray is used in
  45883. * @param color Defines the color we want to see the ray in
  45884. * @returns The newly created ray helper.
  45885. */
  45886. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  45887. /**
  45888. * Instantiate a new ray helper.
  45889. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45890. * in order to better appreciate the issue one might have.
  45891. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45892. * @param ray Defines the ray we are currently tryin to visualize
  45893. */
  45894. constructor(ray: Ray);
  45895. /**
  45896. * Shows the ray we are willing to debug.
  45897. * @param scene Defines the scene the ray needs to be rendered in
  45898. * @param color Defines the color the ray needs to be rendered in
  45899. */
  45900. show(scene: Scene, color?: Color3): void;
  45901. /**
  45902. * Hides the ray we are debugging.
  45903. */
  45904. hide(): void;
  45905. private _render;
  45906. /**
  45907. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  45908. * @param mesh Defines the mesh we want the helper attached to
  45909. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  45910. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  45911. * @param length Defines the length of the ray
  45912. */
  45913. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  45914. /**
  45915. * Detach the ray helper from the mesh it has previously been attached to.
  45916. */
  45917. detachFromMesh(): void;
  45918. private _updateToMesh;
  45919. /**
  45920. * Dispose the helper and release its associated resources.
  45921. */
  45922. dispose(): void;
  45923. }
  45924. }
  45925. declare module "babylonjs/Debug/skeletonViewer" {
  45926. import { Color3 } from "babylonjs/Maths/math.color";
  45927. import { Scene } from "babylonjs/scene";
  45928. import { Nullable } from "babylonjs/types";
  45929. import { Skeleton } from "babylonjs/Bones/skeleton";
  45930. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45931. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45932. /**
  45933. * Class used to render a debug view of a given skeleton
  45934. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  45935. */
  45936. export class SkeletonViewer {
  45937. /** defines the skeleton to render */
  45938. skeleton: Skeleton;
  45939. /** defines the mesh attached to the skeleton */
  45940. mesh: AbstractMesh;
  45941. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45942. autoUpdateBonesMatrices: boolean;
  45943. /** defines the rendering group id to use with the viewer */
  45944. renderingGroupId: number;
  45945. /** Gets or sets the color used to render the skeleton */
  45946. color: Color3;
  45947. private _scene;
  45948. private _debugLines;
  45949. private _debugMesh;
  45950. private _isEnabled;
  45951. private _renderFunction;
  45952. private _utilityLayer;
  45953. /**
  45954. * Returns the mesh used to render the bones
  45955. */
  45956. readonly debugMesh: Nullable<LinesMesh>;
  45957. /**
  45958. * Creates a new SkeletonViewer
  45959. * @param skeleton defines the skeleton to render
  45960. * @param mesh defines the mesh attached to the skeleton
  45961. * @param scene defines the hosting scene
  45962. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  45963. * @param renderingGroupId defines the rendering group id to use with the viewer
  45964. */
  45965. constructor(
  45966. /** defines the skeleton to render */
  45967. skeleton: Skeleton,
  45968. /** defines the mesh attached to the skeleton */
  45969. mesh: AbstractMesh, scene: Scene,
  45970. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45971. autoUpdateBonesMatrices?: boolean,
  45972. /** defines the rendering group id to use with the viewer */
  45973. renderingGroupId?: number);
  45974. /** Gets or sets a boolean indicating if the viewer is enabled */
  45975. isEnabled: boolean;
  45976. private _getBonePosition;
  45977. private _getLinesForBonesWithLength;
  45978. private _getLinesForBonesNoLength;
  45979. /** Update the viewer to sync with current skeleton state */
  45980. update(): void;
  45981. /** Release associated resources */
  45982. dispose(): void;
  45983. }
  45984. }
  45985. declare module "babylonjs/Debug/index" {
  45986. export * from "babylonjs/Debug/axesViewer";
  45987. export * from "babylonjs/Debug/boneAxesViewer";
  45988. export * from "babylonjs/Debug/debugLayer";
  45989. export * from "babylonjs/Debug/physicsViewer";
  45990. export * from "babylonjs/Debug/rayHelper";
  45991. export * from "babylonjs/Debug/skeletonViewer";
  45992. }
  45993. declare module "babylonjs/Engines/nullEngine" {
  45994. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  45995. import { Scene } from "babylonjs/scene";
  45996. import { Engine } from "babylonjs/Engines/engine";
  45997. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45998. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45999. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46000. import { Effect } from "babylonjs/Materials/effect";
  46001. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  46002. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46003. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  46004. /**
  46005. * Options to create the null engine
  46006. */
  46007. export class NullEngineOptions {
  46008. /**
  46009. * Render width (Default: 512)
  46010. */
  46011. renderWidth: number;
  46012. /**
  46013. * Render height (Default: 256)
  46014. */
  46015. renderHeight: number;
  46016. /**
  46017. * Texture size (Default: 512)
  46018. */
  46019. textureSize: number;
  46020. /**
  46021. * If delta time between frames should be constant
  46022. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  46023. */
  46024. deterministicLockstep: boolean;
  46025. /**
  46026. * Maximum about of steps between frames (Default: 4)
  46027. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  46028. */
  46029. lockstepMaxSteps: number;
  46030. }
  46031. /**
  46032. * The null engine class provides support for headless version of babylon.js.
  46033. * This can be used in server side scenario or for testing purposes
  46034. */
  46035. export class NullEngine extends Engine {
  46036. private _options;
  46037. /**
  46038. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  46039. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  46040. * @returns true if engine is in deterministic lock step mode
  46041. */
  46042. isDeterministicLockStep(): boolean;
  46043. /**
  46044. * Gets the max steps when engine is running in deterministic lock step
  46045. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  46046. * @returns the max steps
  46047. */
  46048. getLockstepMaxSteps(): number;
  46049. /**
  46050. * Gets the current hardware scaling level.
  46051. * By default the hardware scaling level is computed from the window device ratio.
  46052. * 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.
  46053. * @returns a number indicating the current hardware scaling level
  46054. */
  46055. getHardwareScalingLevel(): number;
  46056. constructor(options?: NullEngineOptions);
  46057. /**
  46058. * Creates a vertex buffer
  46059. * @param vertices the data for the vertex buffer
  46060. * @returns the new WebGL static buffer
  46061. */
  46062. createVertexBuffer(vertices: FloatArray): DataBuffer;
  46063. /**
  46064. * Creates a new index buffer
  46065. * @param indices defines the content of the index buffer
  46066. * @param updatable defines if the index buffer must be updatable
  46067. * @returns a new webGL buffer
  46068. */
  46069. createIndexBuffer(indices: IndicesArray): DataBuffer;
  46070. /**
  46071. * Clear the current render buffer or the current render target (if any is set up)
  46072. * @param color defines the color to use
  46073. * @param backBuffer defines if the back buffer must be cleared
  46074. * @param depth defines if the depth buffer must be cleared
  46075. * @param stencil defines if the stencil buffer must be cleared
  46076. */
  46077. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  46078. /**
  46079. * Gets the current render width
  46080. * @param useScreen defines if screen size must be used (or the current render target if any)
  46081. * @returns a number defining the current render width
  46082. */
  46083. getRenderWidth(useScreen?: boolean): number;
  46084. /**
  46085. * Gets the current render height
  46086. * @param useScreen defines if screen size must be used (or the current render target if any)
  46087. * @returns a number defining the current render height
  46088. */
  46089. getRenderHeight(useScreen?: boolean): number;
  46090. /**
  46091. * Set the WebGL's viewport
  46092. * @param viewport defines the viewport element to be used
  46093. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  46094. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  46095. */
  46096. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  46097. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  46098. /**
  46099. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  46100. * @param pipelineContext defines the pipeline context to use
  46101. * @param uniformsNames defines the list of uniform names
  46102. * @returns an array of webGL uniform locations
  46103. */
  46104. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  46105. /**
  46106. * Gets the lsit of active attributes for a given webGL program
  46107. * @param pipelineContext defines the pipeline context to use
  46108. * @param attributesNames defines the list of attribute names to get
  46109. * @returns an array of indices indicating the offset of each attribute
  46110. */
  46111. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  46112. /**
  46113. * Binds an effect to the webGL context
  46114. * @param effect defines the effect to bind
  46115. */
  46116. bindSamplers(effect: Effect): void;
  46117. /**
  46118. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  46119. * @param effect defines the effect to activate
  46120. */
  46121. enableEffect(effect: Effect): void;
  46122. /**
  46123. * Set various states to the webGL context
  46124. * @param culling defines backface culling state
  46125. * @param zOffset defines the value to apply to zOffset (0 by default)
  46126. * @param force defines if states must be applied even if cache is up to date
  46127. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  46128. */
  46129. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  46130. /**
  46131. * Set the value of an uniform to an array of int32
  46132. * @param uniform defines the webGL uniform location where to store the value
  46133. * @param array defines the array of int32 to store
  46134. */
  46135. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  46136. /**
  46137. * Set the value of an uniform to an array of int32 (stored as vec2)
  46138. * @param uniform defines the webGL uniform location where to store the value
  46139. * @param array defines the array of int32 to store
  46140. */
  46141. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  46142. /**
  46143. * Set the value of an uniform to an array of int32 (stored as vec3)
  46144. * @param uniform defines the webGL uniform location where to store the value
  46145. * @param array defines the array of int32 to store
  46146. */
  46147. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  46148. /**
  46149. * Set the value of an uniform to an array of int32 (stored as vec4)
  46150. * @param uniform defines the webGL uniform location where to store the value
  46151. * @param array defines the array of int32 to store
  46152. */
  46153. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  46154. /**
  46155. * Set the value of an uniform to an array of float32
  46156. * @param uniform defines the webGL uniform location where to store the value
  46157. * @param array defines the array of float32 to store
  46158. */
  46159. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  46160. /**
  46161. * Set the value of an uniform to an array of float32 (stored as vec2)
  46162. * @param uniform defines the webGL uniform location where to store the value
  46163. * @param array defines the array of float32 to store
  46164. */
  46165. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  46166. /**
  46167. * Set the value of an uniform to an array of float32 (stored as vec3)
  46168. * @param uniform defines the webGL uniform location where to store the value
  46169. * @param array defines the array of float32 to store
  46170. */
  46171. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  46172. /**
  46173. * Set the value of an uniform to an array of float32 (stored as vec4)
  46174. * @param uniform defines the webGL uniform location where to store the value
  46175. * @param array defines the array of float32 to store
  46176. */
  46177. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  46178. /**
  46179. * Set the value of an uniform to an array of number
  46180. * @param uniform defines the webGL uniform location where to store the value
  46181. * @param array defines the array of number to store
  46182. */
  46183. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  46184. /**
  46185. * Set the value of an uniform to an array of number (stored as vec2)
  46186. * @param uniform defines the webGL uniform location where to store the value
  46187. * @param array defines the array of number to store
  46188. */
  46189. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  46190. /**
  46191. * Set the value of an uniform to an array of number (stored as vec3)
  46192. * @param uniform defines the webGL uniform location where to store the value
  46193. * @param array defines the array of number to store
  46194. */
  46195. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  46196. /**
  46197. * Set the value of an uniform to an array of number (stored as vec4)
  46198. * @param uniform defines the webGL uniform location where to store the value
  46199. * @param array defines the array of number to store
  46200. */
  46201. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  46202. /**
  46203. * Set the value of an uniform to an array of float32 (stored as matrices)
  46204. * @param uniform defines the webGL uniform location where to store the value
  46205. * @param matrices defines the array of float32 to store
  46206. */
  46207. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  46208. /**
  46209. * Set the value of an uniform to a matrix (3x3)
  46210. * @param uniform defines the webGL uniform location where to store the value
  46211. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  46212. */
  46213. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46214. /**
  46215. * Set the value of an uniform to a matrix (2x2)
  46216. * @param uniform defines the webGL uniform location where to store the value
  46217. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  46218. */
  46219. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46220. /**
  46221. * Set the value of an uniform to a number (float)
  46222. * @param uniform defines the webGL uniform location where to store the value
  46223. * @param value defines the float number to store
  46224. */
  46225. setFloat(uniform: WebGLUniformLocation, value: number): void;
  46226. /**
  46227. * Set the value of an uniform to a vec2
  46228. * @param uniform defines the webGL uniform location where to store the value
  46229. * @param x defines the 1st component of the value
  46230. * @param y defines the 2nd component of the value
  46231. */
  46232. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  46233. /**
  46234. * Set the value of an uniform to a vec3
  46235. * @param uniform defines the webGL uniform location where to store the value
  46236. * @param x defines the 1st component of the value
  46237. * @param y defines the 2nd component of the value
  46238. * @param z defines the 3rd component of the value
  46239. */
  46240. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  46241. /**
  46242. * Set the value of an uniform to a boolean
  46243. * @param uniform defines the webGL uniform location where to store the value
  46244. * @param bool defines the boolean to store
  46245. */
  46246. setBool(uniform: WebGLUniformLocation, bool: number): void;
  46247. /**
  46248. * Set the value of an uniform to a vec4
  46249. * @param uniform defines the webGL uniform location where to store the value
  46250. * @param x defines the 1st component of the value
  46251. * @param y defines the 2nd component of the value
  46252. * @param z defines the 3rd component of the value
  46253. * @param w defines the 4th component of the value
  46254. */
  46255. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  46256. /**
  46257. * Sets the current alpha mode
  46258. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  46259. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  46260. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46261. */
  46262. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  46263. /**
  46264. * Bind webGl buffers directly to the webGL context
  46265. * @param vertexBuffers defines the vertex buffer to bind
  46266. * @param indexBuffer defines the index buffer to bind
  46267. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  46268. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  46269. * @param effect defines the effect associated with the vertex buffer
  46270. */
  46271. bindBuffers(vertexBuffers: {
  46272. [key: string]: VertexBuffer;
  46273. }, indexBuffer: DataBuffer, effect: Effect): void;
  46274. /**
  46275. * Force the entire cache to be cleared
  46276. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  46277. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  46278. */
  46279. wipeCaches(bruteForce?: boolean): void;
  46280. /**
  46281. * Send a draw order
  46282. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  46283. * @param indexStart defines the starting index
  46284. * @param indexCount defines the number of index to draw
  46285. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46286. */
  46287. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  46288. /**
  46289. * Draw a list of indexed primitives
  46290. * @param fillMode defines the primitive to use
  46291. * @param indexStart defines the starting index
  46292. * @param indexCount defines the number of index to draw
  46293. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46294. */
  46295. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  46296. /**
  46297. * Draw a list of unindexed primitives
  46298. * @param fillMode defines the primitive to use
  46299. * @param verticesStart defines the index of first vertex to draw
  46300. * @param verticesCount defines the count of vertices to draw
  46301. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46302. */
  46303. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  46304. /** @hidden */
  46305. _createTexture(): WebGLTexture;
  46306. /** @hidden */
  46307. _releaseTexture(texture: InternalTexture): void;
  46308. /**
  46309. * Usually called from Texture.ts.
  46310. * Passed information to create a WebGLTexture
  46311. * @param urlArg defines a value which contains one of the following:
  46312. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  46313. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  46314. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  46315. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  46316. * @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)
  46317. * @param scene needed for loading to the correct scene
  46318. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  46319. * @param onLoad optional callback to be called upon successful completion
  46320. * @param onError optional callback to be called upon failure
  46321. * @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
  46322. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  46323. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  46324. * @param forcedExtension defines the extension to use to pick the right loader
  46325. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  46326. * @returns a InternalTexture for assignment back into BABYLON.Texture
  46327. */
  46328. 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;
  46329. /**
  46330. * Creates a new render target texture
  46331. * @param size defines the size of the texture
  46332. * @param options defines the options used to create the texture
  46333. * @returns a new render target texture stored in an InternalTexture
  46334. */
  46335. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  46336. /**
  46337. * Update the sampling mode of a given texture
  46338. * @param samplingMode defines the required sampling mode
  46339. * @param texture defines the texture to update
  46340. */
  46341. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  46342. /**
  46343. * Binds the frame buffer to the specified texture.
  46344. * @param texture The texture to render to or null for the default canvas
  46345. * @param faceIndex The face of the texture to render to in case of cube texture
  46346. * @param requiredWidth The width of the target to render to
  46347. * @param requiredHeight The height of the target to render to
  46348. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  46349. * @param depthStencilTexture The depth stencil texture to use to render
  46350. * @param lodLevel defines le lod level to bind to the frame buffer
  46351. */
  46352. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  46353. /**
  46354. * Unbind the current render target texture from the webGL context
  46355. * @param texture defines the render target texture to unbind
  46356. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46357. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46358. */
  46359. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  46360. /**
  46361. * Creates a dynamic vertex buffer
  46362. * @param vertices the data for the dynamic vertex buffer
  46363. * @returns the new WebGL dynamic buffer
  46364. */
  46365. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  46366. /**
  46367. * Update the content of a dynamic texture
  46368. * @param texture defines the texture to update
  46369. * @param canvas defines the canvas containing the source
  46370. * @param invertY defines if data must be stored with Y axis inverted
  46371. * @param premulAlpha defines if alpha is stored as premultiplied
  46372. * @param format defines the format of the data
  46373. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  46374. */
  46375. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  46376. /**
  46377. * Gets a boolean indicating if all created effects are ready
  46378. * @returns true if all effects are ready
  46379. */
  46380. areAllEffectsReady(): boolean;
  46381. /**
  46382. * @hidden
  46383. * Get the current error code of the webGL context
  46384. * @returns the error code
  46385. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  46386. */
  46387. getError(): number;
  46388. /** @hidden */
  46389. _getUnpackAlignement(): number;
  46390. /** @hidden */
  46391. _unpackFlipY(value: boolean): void;
  46392. /**
  46393. * Update a dynamic index buffer
  46394. * @param indexBuffer defines the target index buffer
  46395. * @param indices defines the data to update
  46396. * @param offset defines the offset in the target index buffer where update should start
  46397. */
  46398. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  46399. /**
  46400. * Updates a dynamic vertex buffer.
  46401. * @param vertexBuffer the vertex buffer to update
  46402. * @param vertices the data used to update the vertex buffer
  46403. * @param byteOffset the byte offset of the data (optional)
  46404. * @param byteLength the byte length of the data (optional)
  46405. */
  46406. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  46407. /** @hidden */
  46408. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  46409. /** @hidden */
  46410. _bindTexture(channel: number, texture: InternalTexture): void;
  46411. protected _deleteBuffer(buffer: WebGLBuffer): void;
  46412. /**
  46413. * 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
  46414. */
  46415. releaseEffects(): void;
  46416. displayLoadingUI(): void;
  46417. hideLoadingUI(): void;
  46418. /** @hidden */
  46419. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46420. /** @hidden */
  46421. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46422. /** @hidden */
  46423. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46424. /** @hidden */
  46425. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  46426. }
  46427. }
  46428. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  46429. import { Nullable, int } from "babylonjs/types";
  46430. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  46431. /** @hidden */
  46432. export class _OcclusionDataStorage {
  46433. /** @hidden */
  46434. occlusionInternalRetryCounter: number;
  46435. /** @hidden */
  46436. isOcclusionQueryInProgress: boolean;
  46437. /** @hidden */
  46438. isOccluded: boolean;
  46439. /** @hidden */
  46440. occlusionRetryCount: number;
  46441. /** @hidden */
  46442. occlusionType: number;
  46443. /** @hidden */
  46444. occlusionQueryAlgorithmType: number;
  46445. }
  46446. module "babylonjs/Engines/engine" {
  46447. interface Engine {
  46448. /**
  46449. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  46450. * @return the new query
  46451. */
  46452. createQuery(): WebGLQuery;
  46453. /**
  46454. * Delete and release a webGL query
  46455. * @param query defines the query to delete
  46456. * @return the current engine
  46457. */
  46458. deleteQuery(query: WebGLQuery): Engine;
  46459. /**
  46460. * Check if a given query has resolved and got its value
  46461. * @param query defines the query to check
  46462. * @returns true if the query got its value
  46463. */
  46464. isQueryResultAvailable(query: WebGLQuery): boolean;
  46465. /**
  46466. * Gets the value of a given query
  46467. * @param query defines the query to check
  46468. * @returns the value of the query
  46469. */
  46470. getQueryResult(query: WebGLQuery): number;
  46471. /**
  46472. * Initiates an occlusion query
  46473. * @param algorithmType defines the algorithm to use
  46474. * @param query defines the query to use
  46475. * @returns the current engine
  46476. * @see http://doc.babylonjs.com/features/occlusionquery
  46477. */
  46478. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  46479. /**
  46480. * Ends an occlusion query
  46481. * @see http://doc.babylonjs.com/features/occlusionquery
  46482. * @param algorithmType defines the algorithm to use
  46483. * @returns the current engine
  46484. */
  46485. endOcclusionQuery(algorithmType: number): Engine;
  46486. /**
  46487. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  46488. * Please note that only one query can be issued at a time
  46489. * @returns a time token used to track the time span
  46490. */
  46491. startTimeQuery(): Nullable<_TimeToken>;
  46492. /**
  46493. * Ends a time query
  46494. * @param token defines the token used to measure the time span
  46495. * @returns the time spent (in ns)
  46496. */
  46497. endTimeQuery(token: _TimeToken): int;
  46498. /** @hidden */
  46499. _currentNonTimestampToken: Nullable<_TimeToken>;
  46500. /** @hidden */
  46501. _createTimeQuery(): WebGLQuery;
  46502. /** @hidden */
  46503. _deleteTimeQuery(query: WebGLQuery): void;
  46504. /** @hidden */
  46505. _getGlAlgorithmType(algorithmType: number): number;
  46506. /** @hidden */
  46507. _getTimeQueryResult(query: WebGLQuery): any;
  46508. /** @hidden */
  46509. _getTimeQueryAvailability(query: WebGLQuery): any;
  46510. }
  46511. }
  46512. module "babylonjs/Meshes/abstractMesh" {
  46513. interface AbstractMesh {
  46514. /**
  46515. * Backing filed
  46516. * @hidden
  46517. */
  46518. __occlusionDataStorage: _OcclusionDataStorage;
  46519. /**
  46520. * Access property
  46521. * @hidden
  46522. */
  46523. _occlusionDataStorage: _OcclusionDataStorage;
  46524. /**
  46525. * 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.
  46526. * The default value is -1 which means don't break the query and wait till the result
  46527. * @see http://doc.babylonjs.com/features/occlusionquery
  46528. */
  46529. occlusionRetryCount: number;
  46530. /**
  46531. * 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:
  46532. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  46533. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  46534. * * 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.
  46535. * @see http://doc.babylonjs.com/features/occlusionquery
  46536. */
  46537. occlusionType: number;
  46538. /**
  46539. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  46540. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  46541. * * 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.
  46542. * @see http://doc.babylonjs.com/features/occlusionquery
  46543. */
  46544. occlusionQueryAlgorithmType: number;
  46545. /**
  46546. * 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
  46547. * @see http://doc.babylonjs.com/features/occlusionquery
  46548. */
  46549. isOccluded: boolean;
  46550. /**
  46551. * Flag to check the progress status of the query
  46552. * @see http://doc.babylonjs.com/features/occlusionquery
  46553. */
  46554. isOcclusionQueryInProgress: boolean;
  46555. }
  46556. }
  46557. }
  46558. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  46559. import { Nullable } from "babylonjs/types";
  46560. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46561. /** @hidden */
  46562. export var _forceTransformFeedbackToBundle: boolean;
  46563. module "babylonjs/Engines/engine" {
  46564. interface Engine {
  46565. /**
  46566. * Creates a webGL transform feedback object
  46567. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  46568. * @returns the webGL transform feedback object
  46569. */
  46570. createTransformFeedback(): WebGLTransformFeedback;
  46571. /**
  46572. * Delete a webGL transform feedback object
  46573. * @param value defines the webGL transform feedback object to delete
  46574. */
  46575. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  46576. /**
  46577. * Bind a webGL transform feedback object to the webgl context
  46578. * @param value defines the webGL transform feedback object to bind
  46579. */
  46580. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  46581. /**
  46582. * Begins a transform feedback operation
  46583. * @param usePoints defines if points or triangles must be used
  46584. */
  46585. beginTransformFeedback(usePoints: boolean): void;
  46586. /**
  46587. * Ends a transform feedback operation
  46588. */
  46589. endTransformFeedback(): void;
  46590. /**
  46591. * Specify the varyings to use with transform feedback
  46592. * @param program defines the associated webGL program
  46593. * @param value defines the list of strings representing the varying names
  46594. */
  46595. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  46596. /**
  46597. * Bind a webGL buffer for a transform feedback operation
  46598. * @param value defines the webGL buffer to bind
  46599. */
  46600. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  46601. }
  46602. }
  46603. }
  46604. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  46605. import { Scene } from "babylonjs/scene";
  46606. import { Engine } from "babylonjs/Engines/engine";
  46607. import { Texture } from "babylonjs/Materials/Textures/texture";
  46608. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  46609. import "babylonjs/Engines/Extensions/engine.multiRender";
  46610. /**
  46611. * Creation options of the multi render target texture.
  46612. */
  46613. export interface IMultiRenderTargetOptions {
  46614. /**
  46615. * Define if the texture needs to create mip maps after render.
  46616. */
  46617. generateMipMaps?: boolean;
  46618. /**
  46619. * Define the types of all the draw buffers we want to create
  46620. */
  46621. types?: number[];
  46622. /**
  46623. * Define the sampling modes of all the draw buffers we want to create
  46624. */
  46625. samplingModes?: number[];
  46626. /**
  46627. * Define if a depth buffer is required
  46628. */
  46629. generateDepthBuffer?: boolean;
  46630. /**
  46631. * Define if a stencil buffer is required
  46632. */
  46633. generateStencilBuffer?: boolean;
  46634. /**
  46635. * Define if a depth texture is required instead of a depth buffer
  46636. */
  46637. generateDepthTexture?: boolean;
  46638. /**
  46639. * Define the number of desired draw buffers
  46640. */
  46641. textureCount?: number;
  46642. /**
  46643. * Define if aspect ratio should be adapted to the texture or stay the scene one
  46644. */
  46645. doNotChangeAspectRatio?: boolean;
  46646. /**
  46647. * Define the default type of the buffers we are creating
  46648. */
  46649. defaultType?: number;
  46650. }
  46651. /**
  46652. * A multi render target, like a render target provides the ability to render to a texture.
  46653. * Unlike the render target, it can render to several draw buffers in one draw.
  46654. * This is specially interesting in deferred rendering or for any effects requiring more than
  46655. * just one color from a single pass.
  46656. */
  46657. export class MultiRenderTarget extends RenderTargetTexture {
  46658. private _internalTextures;
  46659. private _textures;
  46660. private _multiRenderTargetOptions;
  46661. /**
  46662. * Get if draw buffers are currently supported by the used hardware and browser.
  46663. */
  46664. readonly isSupported: boolean;
  46665. /**
  46666. * Get the list of textures generated by the multi render target.
  46667. */
  46668. readonly textures: Texture[];
  46669. /**
  46670. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  46671. */
  46672. readonly depthTexture: Texture;
  46673. /**
  46674. * Set the wrapping mode on U of all the textures we are rendering to.
  46675. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46676. */
  46677. wrapU: number;
  46678. /**
  46679. * Set the wrapping mode on V of all the textures we are rendering to.
  46680. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46681. */
  46682. wrapV: number;
  46683. /**
  46684. * Instantiate a new multi render target texture.
  46685. * A multi render target, like a render target provides the ability to render to a texture.
  46686. * Unlike the render target, it can render to several draw buffers in one draw.
  46687. * This is specially interesting in deferred rendering or for any effects requiring more than
  46688. * just one color from a single pass.
  46689. * @param name Define the name of the texture
  46690. * @param size Define the size of the buffers to render to
  46691. * @param count Define the number of target we are rendering into
  46692. * @param scene Define the scene the texture belongs to
  46693. * @param options Define the options used to create the multi render target
  46694. */
  46695. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  46696. /** @hidden */
  46697. _rebuild(): void;
  46698. private _createInternalTextures;
  46699. private _createTextures;
  46700. /**
  46701. * Define the number of samples used if MSAA is enabled.
  46702. */
  46703. samples: number;
  46704. /**
  46705. * Resize all the textures in the multi render target.
  46706. * Be carrefull as it will recreate all the data in the new texture.
  46707. * @param size Define the new size
  46708. */
  46709. resize(size: any): void;
  46710. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  46711. /**
  46712. * Dispose the render targets and their associated resources
  46713. */
  46714. dispose(): void;
  46715. /**
  46716. * Release all the underlying texture used as draw buffers.
  46717. */
  46718. releaseInternalTextures(): void;
  46719. }
  46720. }
  46721. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  46722. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46723. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  46724. import { Nullable } from "babylonjs/types";
  46725. module "babylonjs/Engines/thinEngine" {
  46726. interface ThinEngine {
  46727. /**
  46728. * Unbind a list of render target textures from the webGL context
  46729. * This is used only when drawBuffer extension or webGL2 are active
  46730. * @param textures defines the render target textures to unbind
  46731. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46732. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46733. */
  46734. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  46735. /**
  46736. * Create a multi render target texture
  46737. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  46738. * @param size defines the size of the texture
  46739. * @param options defines the creation options
  46740. * @returns the cube texture as an InternalTexture
  46741. */
  46742. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  46743. /**
  46744. * Update the sample count for a given multiple render target texture
  46745. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  46746. * @param textures defines the textures to update
  46747. * @param samples defines the sample count to set
  46748. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  46749. */
  46750. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  46751. }
  46752. }
  46753. }
  46754. declare module "babylonjs/Engines/Extensions/engine.views" {
  46755. import { Camera } from "babylonjs/Cameras/camera";
  46756. import { Nullable } from "babylonjs/types";
  46757. /**
  46758. * Class used to define an additional view for the engine
  46759. * @see https://doc.babylonjs.com/how_to/multi_canvases
  46760. */
  46761. export class EngineView {
  46762. /** Defines the canvas where to render the view */
  46763. target: HTMLCanvasElement;
  46764. /** Defines an optional camera used to render the view (will use active camera else) */
  46765. camera?: Camera;
  46766. }
  46767. module "babylonjs/Engines/engine" {
  46768. interface Engine {
  46769. /**
  46770. * Gets or sets the HTML element to use for attaching events
  46771. */
  46772. inputElement: Nullable<HTMLElement>;
  46773. /**
  46774. * Gets the current engine view
  46775. * @see https://doc.babylonjs.com/how_to/multi_canvases
  46776. */
  46777. activeView: Nullable<EngineView>;
  46778. /** Gets or sets the list of views */
  46779. views: EngineView[];
  46780. /**
  46781. * Register a new child canvas
  46782. * @param canvas defines the canvas to register
  46783. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  46784. * @returns the associated view
  46785. */
  46786. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  46787. /**
  46788. * Remove a registered child canvas
  46789. * @param canvas defines the canvas to remove
  46790. * @returns the current engine
  46791. */
  46792. unRegisterView(canvas: HTMLCanvasElement): Engine;
  46793. }
  46794. }
  46795. }
  46796. declare module "babylonjs/Engines/Extensions/index" {
  46797. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  46798. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  46799. export * from "babylonjs/Engines/Extensions/engine.multiview";
  46800. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  46801. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  46802. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  46803. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  46804. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  46805. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  46806. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46807. export * from "babylonjs/Engines/Extensions/engine.webVR";
  46808. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  46809. export * from "babylonjs/Engines/Extensions/engine.views";
  46810. }
  46811. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  46812. import { Nullable } from "babylonjs/types";
  46813. /**
  46814. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  46815. */
  46816. export interface CubeMapInfo {
  46817. /**
  46818. * The pixel array for the front face.
  46819. * This is stored in format, left to right, up to down format.
  46820. */
  46821. front: Nullable<ArrayBufferView>;
  46822. /**
  46823. * The pixel array for the back face.
  46824. * This is stored in format, left to right, up to down format.
  46825. */
  46826. back: Nullable<ArrayBufferView>;
  46827. /**
  46828. * The pixel array for the left face.
  46829. * This is stored in format, left to right, up to down format.
  46830. */
  46831. left: Nullable<ArrayBufferView>;
  46832. /**
  46833. * The pixel array for the right face.
  46834. * This is stored in format, left to right, up to down format.
  46835. */
  46836. right: Nullable<ArrayBufferView>;
  46837. /**
  46838. * The pixel array for the up face.
  46839. * This is stored in format, left to right, up to down format.
  46840. */
  46841. up: Nullable<ArrayBufferView>;
  46842. /**
  46843. * The pixel array for the down face.
  46844. * This is stored in format, left to right, up to down format.
  46845. */
  46846. down: Nullable<ArrayBufferView>;
  46847. /**
  46848. * The size of the cubemap stored.
  46849. *
  46850. * Each faces will be size * size pixels.
  46851. */
  46852. size: number;
  46853. /**
  46854. * The format of the texture.
  46855. *
  46856. * RGBA, RGB.
  46857. */
  46858. format: number;
  46859. /**
  46860. * The type of the texture data.
  46861. *
  46862. * UNSIGNED_INT, FLOAT.
  46863. */
  46864. type: number;
  46865. /**
  46866. * Specifies whether the texture is in gamma space.
  46867. */
  46868. gammaSpace: boolean;
  46869. }
  46870. /**
  46871. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  46872. */
  46873. export class PanoramaToCubeMapTools {
  46874. private static FACE_FRONT;
  46875. private static FACE_BACK;
  46876. private static FACE_RIGHT;
  46877. private static FACE_LEFT;
  46878. private static FACE_DOWN;
  46879. private static FACE_UP;
  46880. /**
  46881. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  46882. *
  46883. * @param float32Array The source data.
  46884. * @param inputWidth The width of the input panorama.
  46885. * @param inputHeight The height of the input panorama.
  46886. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  46887. * @return The cubemap data
  46888. */
  46889. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  46890. private static CreateCubemapTexture;
  46891. private static CalcProjectionSpherical;
  46892. }
  46893. }
  46894. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  46895. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46896. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46897. import { Nullable } from "babylonjs/types";
  46898. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  46899. /**
  46900. * Helper class dealing with the extraction of spherical polynomial dataArray
  46901. * from a cube map.
  46902. */
  46903. export class CubeMapToSphericalPolynomialTools {
  46904. private static FileFaces;
  46905. /**
  46906. * Converts a texture to the according Spherical Polynomial data.
  46907. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46908. *
  46909. * @param texture The texture to extract the information from.
  46910. * @return The Spherical Polynomial data.
  46911. */
  46912. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  46913. /**
  46914. * Converts a cubemap to the according Spherical Polynomial data.
  46915. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46916. *
  46917. * @param cubeInfo The Cube map to extract the information from.
  46918. * @return The Spherical Polynomial data.
  46919. */
  46920. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  46921. }
  46922. }
  46923. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  46924. import { Nullable } from "babylonjs/types";
  46925. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46926. module "babylonjs/Materials/Textures/baseTexture" {
  46927. interface BaseTexture {
  46928. /**
  46929. * Get the polynomial representation of the texture data.
  46930. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  46931. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  46932. */
  46933. sphericalPolynomial: Nullable<SphericalPolynomial>;
  46934. }
  46935. }
  46936. }
  46937. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  46938. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46939. /** @hidden */
  46940. export var rgbdEncodePixelShader: {
  46941. name: string;
  46942. shader: string;
  46943. };
  46944. }
  46945. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  46946. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46947. /** @hidden */
  46948. export var rgbdDecodePixelShader: {
  46949. name: string;
  46950. shader: string;
  46951. };
  46952. }
  46953. declare module "babylonjs/Misc/environmentTextureTools" {
  46954. import { Nullable } from "babylonjs/types";
  46955. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46956. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46957. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  46958. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46959. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  46960. import "babylonjs/Shaders/rgbdEncode.fragment";
  46961. import "babylonjs/Shaders/rgbdDecode.fragment";
  46962. /**
  46963. * Raw texture data and descriptor sufficient for WebGL texture upload
  46964. */
  46965. export interface EnvironmentTextureInfo {
  46966. /**
  46967. * Version of the environment map
  46968. */
  46969. version: number;
  46970. /**
  46971. * Width of image
  46972. */
  46973. width: number;
  46974. /**
  46975. * Irradiance information stored in the file.
  46976. */
  46977. irradiance: any;
  46978. /**
  46979. * Specular information stored in the file.
  46980. */
  46981. specular: any;
  46982. }
  46983. /**
  46984. * Defines One Image in the file. It requires only the position in the file
  46985. * as well as the length.
  46986. */
  46987. interface BufferImageData {
  46988. /**
  46989. * Length of the image data.
  46990. */
  46991. length: number;
  46992. /**
  46993. * Position of the data from the null terminator delimiting the end of the JSON.
  46994. */
  46995. position: number;
  46996. }
  46997. /**
  46998. * Defines the specular data enclosed in the file.
  46999. * This corresponds to the version 1 of the data.
  47000. */
  47001. export interface EnvironmentTextureSpecularInfoV1 {
  47002. /**
  47003. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  47004. */
  47005. specularDataPosition?: number;
  47006. /**
  47007. * This contains all the images data needed to reconstruct the cubemap.
  47008. */
  47009. mipmaps: Array<BufferImageData>;
  47010. /**
  47011. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  47012. */
  47013. lodGenerationScale: number;
  47014. }
  47015. /**
  47016. * Sets of helpers addressing the serialization and deserialization of environment texture
  47017. * stored in a BabylonJS env file.
  47018. * Those files are usually stored as .env files.
  47019. */
  47020. export class EnvironmentTextureTools {
  47021. /**
  47022. * Magic number identifying the env file.
  47023. */
  47024. private static _MagicBytes;
  47025. /**
  47026. * Gets the environment info from an env file.
  47027. * @param data The array buffer containing the .env bytes.
  47028. * @returns the environment file info (the json header) if successfully parsed.
  47029. */
  47030. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  47031. /**
  47032. * Creates an environment texture from a loaded cube texture.
  47033. * @param texture defines the cube texture to convert in env file
  47034. * @return a promise containing the environment data if succesfull.
  47035. */
  47036. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  47037. /**
  47038. * Creates a JSON representation of the spherical data.
  47039. * @param texture defines the texture containing the polynomials
  47040. * @return the JSON representation of the spherical info
  47041. */
  47042. private static _CreateEnvTextureIrradiance;
  47043. /**
  47044. * Creates the ArrayBufferViews used for initializing environment texture image data.
  47045. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  47046. * @param info parameters that determine what views will be created for accessing the underlying buffer
  47047. * @return the views described by info providing access to the underlying buffer
  47048. */
  47049. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  47050. /**
  47051. * Uploads the texture info contained in the env file to the GPU.
  47052. * @param texture defines the internal texture to upload to
  47053. * @param arrayBuffer defines the buffer cotaining the data to load
  47054. * @param info defines the texture info retrieved through the GetEnvInfo method
  47055. * @returns a promise
  47056. */
  47057. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  47058. private static _OnImageReadyAsync;
  47059. /**
  47060. * Uploads the levels of image data to the GPU.
  47061. * @param texture defines the internal texture to upload to
  47062. * @param imageData defines the array buffer views of image data [mipmap][face]
  47063. * @returns a promise
  47064. */
  47065. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  47066. /**
  47067. * Uploads spherical polynomials information to the texture.
  47068. * @param texture defines the texture we are trying to upload the information to
  47069. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  47070. */
  47071. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  47072. /** @hidden */
  47073. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  47074. }
  47075. }
  47076. declare module "babylonjs/Maths/math.vertexFormat" {
  47077. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  47078. /**
  47079. * Contains position and normal vectors for a vertex
  47080. */
  47081. export class PositionNormalVertex {
  47082. /** the position of the vertex (defaut: 0,0,0) */
  47083. position: Vector3;
  47084. /** the normal of the vertex (defaut: 0,1,0) */
  47085. normal: Vector3;
  47086. /**
  47087. * Creates a PositionNormalVertex
  47088. * @param position the position of the vertex (defaut: 0,0,0)
  47089. * @param normal the normal of the vertex (defaut: 0,1,0)
  47090. */
  47091. constructor(
  47092. /** the position of the vertex (defaut: 0,0,0) */
  47093. position?: Vector3,
  47094. /** the normal of the vertex (defaut: 0,1,0) */
  47095. normal?: Vector3);
  47096. /**
  47097. * Clones the PositionNormalVertex
  47098. * @returns the cloned PositionNormalVertex
  47099. */
  47100. clone(): PositionNormalVertex;
  47101. }
  47102. /**
  47103. * Contains position, normal and uv vectors for a vertex
  47104. */
  47105. export class PositionNormalTextureVertex {
  47106. /** the position of the vertex (defaut: 0,0,0) */
  47107. position: Vector3;
  47108. /** the normal of the vertex (defaut: 0,1,0) */
  47109. normal: Vector3;
  47110. /** the uv of the vertex (default: 0,0) */
  47111. uv: Vector2;
  47112. /**
  47113. * Creates a PositionNormalTextureVertex
  47114. * @param position the position of the vertex (defaut: 0,0,0)
  47115. * @param normal the normal of the vertex (defaut: 0,1,0)
  47116. * @param uv the uv of the vertex (default: 0,0)
  47117. */
  47118. constructor(
  47119. /** the position of the vertex (defaut: 0,0,0) */
  47120. position?: Vector3,
  47121. /** the normal of the vertex (defaut: 0,1,0) */
  47122. normal?: Vector3,
  47123. /** the uv of the vertex (default: 0,0) */
  47124. uv?: Vector2);
  47125. /**
  47126. * Clones the PositionNormalTextureVertex
  47127. * @returns the cloned PositionNormalTextureVertex
  47128. */
  47129. clone(): PositionNormalTextureVertex;
  47130. }
  47131. }
  47132. declare module "babylonjs/Maths/math" {
  47133. export * from "babylonjs/Maths/math.axis";
  47134. export * from "babylonjs/Maths/math.color";
  47135. export * from "babylonjs/Maths/math.constants";
  47136. export * from "babylonjs/Maths/math.frustum";
  47137. export * from "babylonjs/Maths/math.path";
  47138. export * from "babylonjs/Maths/math.plane";
  47139. export * from "babylonjs/Maths/math.size";
  47140. export * from "babylonjs/Maths/math.vector";
  47141. export * from "babylonjs/Maths/math.vertexFormat";
  47142. export * from "babylonjs/Maths/math.viewport";
  47143. }
  47144. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  47145. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  47146. /** @hidden */
  47147. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  47148. private _genericAttributeLocation;
  47149. private _varyingLocationCount;
  47150. private _varyingLocationMap;
  47151. private _replacements;
  47152. private _textureCount;
  47153. private _uniforms;
  47154. lineProcessor(line: string): string;
  47155. attributeProcessor(attribute: string): string;
  47156. varyingProcessor(varying: string, isFragment: boolean): string;
  47157. uniformProcessor(uniform: string): string;
  47158. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  47159. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  47160. }
  47161. }
  47162. declare module "babylonjs/Engines/nativeEngine" {
  47163. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  47164. import { Engine } from "babylonjs/Engines/engine";
  47165. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  47166. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  47167. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47168. import { Effect } from "babylonjs/Materials/effect";
  47169. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  47170. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  47171. import { IColor4Like } from "babylonjs/Maths/math.like";
  47172. import { Scene } from "babylonjs/scene";
  47173. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  47174. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  47175. /**
  47176. * Container for accessors for natively-stored mesh data buffers.
  47177. */
  47178. class NativeDataBuffer extends DataBuffer {
  47179. /**
  47180. * Accessor value used to identify/retrieve a natively-stored index buffer.
  47181. */
  47182. nativeIndexBuffer?: any;
  47183. /**
  47184. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  47185. */
  47186. nativeVertexBuffer?: any;
  47187. }
  47188. /** @hidden */
  47189. class NativeTexture extends InternalTexture {
  47190. getInternalTexture(): InternalTexture;
  47191. getViewCount(): number;
  47192. }
  47193. /** @hidden */
  47194. export class NativeEngine extends Engine {
  47195. private readonly _native;
  47196. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  47197. private readonly INVALID_HANDLE;
  47198. getHardwareScalingLevel(): number;
  47199. constructor();
  47200. /**
  47201. * Can be used to override the current requestAnimationFrame requester.
  47202. * @hidden
  47203. */
  47204. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  47205. /**
  47206. * Override default engine behavior.
  47207. * @param color
  47208. * @param backBuffer
  47209. * @param depth
  47210. * @param stencil
  47211. */
  47212. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  47213. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  47214. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  47215. createVertexBuffer(data: DataArray): NativeDataBuffer;
  47216. recordVertexArrayObject(vertexBuffers: {
  47217. [key: string]: VertexBuffer;
  47218. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  47219. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  47220. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  47221. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  47222. /**
  47223. * Draw a list of indexed primitives
  47224. * @param fillMode defines the primitive to use
  47225. * @param indexStart defines the starting index
  47226. * @param indexCount defines the number of index to draw
  47227. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  47228. */
  47229. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  47230. /**
  47231. * Draw a list of unindexed primitives
  47232. * @param fillMode defines the primitive to use
  47233. * @param verticesStart defines the index of first vertex to draw
  47234. * @param verticesCount defines the count of vertices to draw
  47235. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  47236. */
  47237. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  47238. createPipelineContext(): IPipelineContext;
  47239. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  47240. /** @hidden */
  47241. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  47242. /** @hidden */
  47243. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  47244. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  47245. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  47246. protected _setProgram(program: WebGLProgram): void;
  47247. _releaseEffect(effect: Effect): void;
  47248. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  47249. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  47250. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  47251. bindSamplers(effect: Effect): void;
  47252. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  47253. getRenderWidth(useScreen?: boolean): number;
  47254. getRenderHeight(useScreen?: boolean): number;
  47255. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  47256. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  47257. /**
  47258. * Set the z offset to apply to current rendering
  47259. * @param value defines the offset to apply
  47260. */
  47261. setZOffset(value: number): void;
  47262. /**
  47263. * Gets the current value of the zOffset
  47264. * @returns the current zOffset state
  47265. */
  47266. getZOffset(): number;
  47267. /**
  47268. * Enable or disable depth buffering
  47269. * @param enable defines the state to set
  47270. */
  47271. setDepthBuffer(enable: boolean): void;
  47272. /**
  47273. * Gets a boolean indicating if depth writing is enabled
  47274. * @returns the current depth writing state
  47275. */
  47276. getDepthWrite(): boolean;
  47277. /**
  47278. * Enable or disable depth writing
  47279. * @param enable defines the state to set
  47280. */
  47281. setDepthWrite(enable: boolean): void;
  47282. /**
  47283. * Enable or disable color writing
  47284. * @param enable defines the state to set
  47285. */
  47286. setColorWrite(enable: boolean): void;
  47287. /**
  47288. * Gets a boolean indicating if color writing is enabled
  47289. * @returns the current color writing state
  47290. */
  47291. getColorWrite(): boolean;
  47292. /**
  47293. * Sets alpha constants used by some alpha blending modes
  47294. * @param r defines the red component
  47295. * @param g defines the green component
  47296. * @param b defines the blue component
  47297. * @param a defines the alpha component
  47298. */
  47299. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  47300. /**
  47301. * Sets the current alpha mode
  47302. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  47303. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  47304. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  47305. */
  47306. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  47307. /**
  47308. * Gets the current alpha mode
  47309. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  47310. * @returns the current alpha mode
  47311. */
  47312. getAlphaMode(): number;
  47313. setInt(uniform: WebGLUniformLocation, int: number): void;
  47314. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  47315. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  47316. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  47317. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  47318. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  47319. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  47320. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  47321. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  47322. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  47323. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  47324. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  47325. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  47326. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  47327. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  47328. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  47329. setFloat(uniform: WebGLUniformLocation, value: number): void;
  47330. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  47331. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  47332. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  47333. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  47334. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  47335. wipeCaches(bruteForce?: boolean): void;
  47336. _createTexture(): WebGLTexture;
  47337. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  47338. /**
  47339. * Usually called from BABYLON.Texture.ts.
  47340. * Passed information to create a WebGLTexture
  47341. * @param urlArg defines a value which contains one of the following:
  47342. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  47343. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  47344. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  47345. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  47346. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  47347. * @param scene needed for loading to the correct scene
  47348. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  47349. * @param onLoad optional callback to be called upon successful completion
  47350. * @param onError optional callback to be called upon failure
  47351. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  47352. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  47353. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  47354. * @param forcedExtension defines the extension to use to pick the right loader
  47355. * @returns a InternalTexture for assignment back into BABYLON.Texture
  47356. */
  47357. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  47358. /**
  47359. * Creates a cube texture
  47360. * @param rootUrl defines the url where the files to load is located
  47361. * @param scene defines the current scene
  47362. * @param files defines the list of files to load (1 per face)
  47363. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  47364. * @param onLoad defines an optional callback raised when the texture is loaded
  47365. * @param onError defines an optional callback raised if there is an issue to load the texture
  47366. * @param format defines the format of the data
  47367. * @param forcedExtension defines the extension to use to pick the right loader
  47368. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  47369. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  47370. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  47371. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  47372. * @returns the cube texture as an InternalTexture
  47373. */
  47374. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap?: boolean, onLoad?: Nullable<(data?: any) => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number, fallback?: Nullable<InternalTexture>): InternalTexture;
  47375. private _getSamplingFilter;
  47376. private static _GetNativeTextureFormat;
  47377. createRenderTargetTexture(size: number | {
  47378. width: number;
  47379. height: number;
  47380. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  47381. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  47382. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  47383. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  47384. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  47385. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  47386. /**
  47387. * Updates a dynamic vertex buffer.
  47388. * @param vertexBuffer the vertex buffer to update
  47389. * @param data the data used to update the vertex buffer
  47390. * @param byteOffset the byte offset of the data (optional)
  47391. * @param byteLength the byte length of the data (optional)
  47392. */
  47393. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  47394. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  47395. private _updateAnisotropicLevel;
  47396. private _getAddressMode;
  47397. /** @hidden */
  47398. _bindTexture(channel: number, texture: InternalTexture): void;
  47399. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  47400. releaseEffects(): void;
  47401. /** @hidden */
  47402. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47403. /** @hidden */
  47404. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47405. /** @hidden */
  47406. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47407. /** @hidden */
  47408. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  47409. }
  47410. }
  47411. declare module "babylonjs/Engines/index" {
  47412. export * from "babylonjs/Engines/constants";
  47413. export * from "babylonjs/Engines/engineCapabilities";
  47414. export * from "babylonjs/Engines/instancingAttributeInfo";
  47415. export * from "babylonjs/Engines/thinEngine";
  47416. export * from "babylonjs/Engines/engine";
  47417. export * from "babylonjs/Engines/engineStore";
  47418. export * from "babylonjs/Engines/nullEngine";
  47419. export * from "babylonjs/Engines/Extensions/index";
  47420. export * from "babylonjs/Engines/IPipelineContext";
  47421. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  47422. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  47423. export * from "babylonjs/Engines/nativeEngine";
  47424. }
  47425. declare module "babylonjs/Events/clipboardEvents" {
  47426. /**
  47427. * Gather the list of clipboard event types as constants.
  47428. */
  47429. export class ClipboardEventTypes {
  47430. /**
  47431. * The clipboard event is fired when a copy command is active (pressed).
  47432. */
  47433. static readonly COPY: number;
  47434. /**
  47435. * The clipboard event is fired when a cut command is active (pressed).
  47436. */
  47437. static readonly CUT: number;
  47438. /**
  47439. * The clipboard event is fired when a paste command is active (pressed).
  47440. */
  47441. static readonly PASTE: number;
  47442. }
  47443. /**
  47444. * This class is used to store clipboard related info for the onClipboardObservable event.
  47445. */
  47446. export class ClipboardInfo {
  47447. /**
  47448. * Defines the type of event (BABYLON.ClipboardEventTypes)
  47449. */
  47450. type: number;
  47451. /**
  47452. * Defines the related dom event
  47453. */
  47454. event: ClipboardEvent;
  47455. /**
  47456. *Creates an instance of ClipboardInfo.
  47457. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  47458. * @param event Defines the related dom event
  47459. */
  47460. constructor(
  47461. /**
  47462. * Defines the type of event (BABYLON.ClipboardEventTypes)
  47463. */
  47464. type: number,
  47465. /**
  47466. * Defines the related dom event
  47467. */
  47468. event: ClipboardEvent);
  47469. /**
  47470. * Get the clipboard event's type from the keycode.
  47471. * @param keyCode Defines the keyCode for the current keyboard event.
  47472. * @return {number}
  47473. */
  47474. static GetTypeFromCharacter(keyCode: number): number;
  47475. }
  47476. }
  47477. declare module "babylonjs/Events/index" {
  47478. export * from "babylonjs/Events/keyboardEvents";
  47479. export * from "babylonjs/Events/pointerEvents";
  47480. export * from "babylonjs/Events/clipboardEvents";
  47481. }
  47482. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  47483. import { Scene } from "babylonjs/scene";
  47484. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47485. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47486. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47487. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47488. /**
  47489. * Google Daydream controller
  47490. */
  47491. export class DaydreamController extends WebVRController {
  47492. /**
  47493. * Base Url for the controller model.
  47494. */
  47495. static MODEL_BASE_URL: string;
  47496. /**
  47497. * File name for the controller model.
  47498. */
  47499. static MODEL_FILENAME: string;
  47500. /**
  47501. * Gamepad Id prefix used to identify Daydream Controller.
  47502. */
  47503. static readonly GAMEPAD_ID_PREFIX: string;
  47504. /**
  47505. * Creates a new DaydreamController from a gamepad
  47506. * @param vrGamepad the gamepad that the controller should be created from
  47507. */
  47508. constructor(vrGamepad: any);
  47509. /**
  47510. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47511. * @param scene scene in which to add meshes
  47512. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47513. */
  47514. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47515. /**
  47516. * Called once for each button that changed state since the last frame
  47517. * @param buttonIdx Which button index changed
  47518. * @param state New state of the button
  47519. * @param changes Which properties on the state changed since last frame
  47520. */
  47521. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47522. }
  47523. }
  47524. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  47525. import { Scene } from "babylonjs/scene";
  47526. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47527. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47528. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47529. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47530. /**
  47531. * Gear VR Controller
  47532. */
  47533. export class GearVRController extends WebVRController {
  47534. /**
  47535. * Base Url for the controller model.
  47536. */
  47537. static MODEL_BASE_URL: string;
  47538. /**
  47539. * File name for the controller model.
  47540. */
  47541. static MODEL_FILENAME: string;
  47542. /**
  47543. * Gamepad Id prefix used to identify this controller.
  47544. */
  47545. static readonly GAMEPAD_ID_PREFIX: string;
  47546. private readonly _buttonIndexToObservableNameMap;
  47547. /**
  47548. * Creates a new GearVRController from a gamepad
  47549. * @param vrGamepad the gamepad that the controller should be created from
  47550. */
  47551. constructor(vrGamepad: any);
  47552. /**
  47553. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47554. * @param scene scene in which to add meshes
  47555. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47556. */
  47557. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47558. /**
  47559. * Called once for each button that changed state since the last frame
  47560. * @param buttonIdx Which button index changed
  47561. * @param state New state of the button
  47562. * @param changes Which properties on the state changed since last frame
  47563. */
  47564. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47565. }
  47566. }
  47567. declare module "babylonjs/Gamepads/Controllers/index" {
  47568. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  47569. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  47570. export * from "babylonjs/Gamepads/Controllers/genericController";
  47571. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  47572. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47573. export * from "babylonjs/Gamepads/Controllers/viveController";
  47574. export * from "babylonjs/Gamepads/Controllers/webVRController";
  47575. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  47576. }
  47577. declare module "babylonjs/Gamepads/index" {
  47578. export * from "babylonjs/Gamepads/Controllers/index";
  47579. export * from "babylonjs/Gamepads/gamepad";
  47580. export * from "babylonjs/Gamepads/gamepadManager";
  47581. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  47582. export * from "babylonjs/Gamepads/xboxGamepad";
  47583. export * from "babylonjs/Gamepads/dualShockGamepad";
  47584. }
  47585. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  47586. import { Scene } from "babylonjs/scene";
  47587. import { Vector4 } from "babylonjs/Maths/math.vector";
  47588. import { Color4 } from "babylonjs/Maths/math.color";
  47589. import { Mesh } from "babylonjs/Meshes/mesh";
  47590. import { Nullable } from "babylonjs/types";
  47591. /**
  47592. * Class containing static functions to help procedurally build meshes
  47593. */
  47594. export class PolyhedronBuilder {
  47595. /**
  47596. * Creates a polyhedron mesh
  47597. * * 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
  47598. * * The parameter `size` (positive float, default 1) sets the polygon size
  47599. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  47600. * * 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`
  47601. * * 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
  47602. * * 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)`)
  47603. * * 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
  47604. * * 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
  47605. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47606. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47607. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47608. * @param name defines the name of the mesh
  47609. * @param options defines the options used to create the mesh
  47610. * @param scene defines the hosting scene
  47611. * @returns the polyhedron mesh
  47612. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  47613. */
  47614. static CreatePolyhedron(name: string, options: {
  47615. type?: number;
  47616. size?: number;
  47617. sizeX?: number;
  47618. sizeY?: number;
  47619. sizeZ?: number;
  47620. custom?: any;
  47621. faceUV?: Vector4[];
  47622. faceColors?: Color4[];
  47623. flat?: boolean;
  47624. updatable?: boolean;
  47625. sideOrientation?: number;
  47626. frontUVs?: Vector4;
  47627. backUVs?: Vector4;
  47628. }, scene?: Nullable<Scene>): Mesh;
  47629. }
  47630. }
  47631. declare module "babylonjs/Gizmos/scaleGizmo" {
  47632. import { Observable } from "babylonjs/Misc/observable";
  47633. import { Nullable } from "babylonjs/types";
  47634. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47635. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47636. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  47637. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47638. /**
  47639. * Gizmo that enables scaling a mesh along 3 axis
  47640. */
  47641. export class ScaleGizmo extends Gizmo {
  47642. /**
  47643. * Internal gizmo used for interactions on the x axis
  47644. */
  47645. xGizmo: AxisScaleGizmo;
  47646. /**
  47647. * Internal gizmo used for interactions on the y axis
  47648. */
  47649. yGizmo: AxisScaleGizmo;
  47650. /**
  47651. * Internal gizmo used for interactions on the z axis
  47652. */
  47653. zGizmo: AxisScaleGizmo;
  47654. /**
  47655. * Internal gizmo used to scale all axis equally
  47656. */
  47657. uniformScaleGizmo: AxisScaleGizmo;
  47658. private _meshAttached;
  47659. private _updateGizmoRotationToMatchAttachedMesh;
  47660. private _snapDistance;
  47661. private _scaleRatio;
  47662. private _uniformScalingMesh;
  47663. private _octahedron;
  47664. private _sensitivity;
  47665. /** Fires an event when any of it's sub gizmos are dragged */
  47666. onDragStartObservable: Observable<unknown>;
  47667. /** Fires an event when any of it's sub gizmos are released from dragging */
  47668. onDragEndObservable: Observable<unknown>;
  47669. attachedMesh: Nullable<AbstractMesh>;
  47670. /**
  47671. * Creates a ScaleGizmo
  47672. * @param gizmoLayer The utility layer the gizmo will be added to
  47673. */
  47674. constructor(gizmoLayer?: UtilityLayerRenderer);
  47675. updateGizmoRotationToMatchAttachedMesh: boolean;
  47676. /**
  47677. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47678. */
  47679. snapDistance: number;
  47680. /**
  47681. * Ratio for the scale of the gizmo (Default: 1)
  47682. */
  47683. scaleRatio: number;
  47684. /**
  47685. * Sensitivity factor for dragging (Default: 1)
  47686. */
  47687. sensitivity: number;
  47688. /**
  47689. * Disposes of the gizmo
  47690. */
  47691. dispose(): void;
  47692. }
  47693. }
  47694. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  47695. import { Observable } from "babylonjs/Misc/observable";
  47696. import { Nullable } from "babylonjs/types";
  47697. import { Vector3 } from "babylonjs/Maths/math.vector";
  47698. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47699. import { Mesh } from "babylonjs/Meshes/mesh";
  47700. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47701. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47702. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47703. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47704. import { Color3 } from "babylonjs/Maths/math.color";
  47705. /**
  47706. * Single axis scale gizmo
  47707. */
  47708. export class AxisScaleGizmo extends Gizmo {
  47709. /**
  47710. * Drag behavior responsible for the gizmos dragging interactions
  47711. */
  47712. dragBehavior: PointerDragBehavior;
  47713. private _pointerObserver;
  47714. /**
  47715. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47716. */
  47717. snapDistance: number;
  47718. /**
  47719. * Event that fires each time the gizmo snaps to a new location.
  47720. * * snapDistance is the the change in distance
  47721. */
  47722. onSnapObservable: Observable<{
  47723. snapDistance: number;
  47724. }>;
  47725. /**
  47726. * If the scaling operation should be done on all axis (default: false)
  47727. */
  47728. uniformScaling: boolean;
  47729. /**
  47730. * Custom sensitivity value for the drag strength
  47731. */
  47732. sensitivity: number;
  47733. private _isEnabled;
  47734. private _parent;
  47735. private _arrow;
  47736. private _coloredMaterial;
  47737. private _hoverMaterial;
  47738. /**
  47739. * Creates an AxisScaleGizmo
  47740. * @param gizmoLayer The utility layer the gizmo will be added to
  47741. * @param dragAxis The axis which the gizmo will be able to scale on
  47742. * @param color The color of the gizmo
  47743. */
  47744. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  47745. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47746. /**
  47747. * If the gizmo is enabled
  47748. */
  47749. isEnabled: boolean;
  47750. /**
  47751. * Disposes of the gizmo
  47752. */
  47753. dispose(): void;
  47754. /**
  47755. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  47756. * @param mesh The mesh to replace the default mesh of the gizmo
  47757. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  47758. */
  47759. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  47760. }
  47761. }
  47762. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  47763. import { Observable } from "babylonjs/Misc/observable";
  47764. import { Nullable } from "babylonjs/types";
  47765. import { Vector3 } from "babylonjs/Maths/math.vector";
  47766. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47767. import { Mesh } from "babylonjs/Meshes/mesh";
  47768. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47769. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47770. import { Color3 } from "babylonjs/Maths/math.color";
  47771. import "babylonjs/Meshes/Builders/boxBuilder";
  47772. /**
  47773. * Bounding box gizmo
  47774. */
  47775. export class BoundingBoxGizmo extends Gizmo {
  47776. private _lineBoundingBox;
  47777. private _rotateSpheresParent;
  47778. private _scaleBoxesParent;
  47779. private _boundingDimensions;
  47780. private _renderObserver;
  47781. private _pointerObserver;
  47782. private _scaleDragSpeed;
  47783. private _tmpQuaternion;
  47784. private _tmpVector;
  47785. private _tmpRotationMatrix;
  47786. /**
  47787. * 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)
  47788. */
  47789. ignoreChildren: boolean;
  47790. /**
  47791. * 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)
  47792. */
  47793. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  47794. /**
  47795. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  47796. */
  47797. rotationSphereSize: number;
  47798. /**
  47799. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  47800. */
  47801. scaleBoxSize: number;
  47802. /**
  47803. * 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)
  47804. */
  47805. fixedDragMeshScreenSize: boolean;
  47806. /**
  47807. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  47808. */
  47809. fixedDragMeshScreenSizeDistanceFactor: number;
  47810. /**
  47811. * Fired when a rotation sphere or scale box is dragged
  47812. */
  47813. onDragStartObservable: Observable<{}>;
  47814. /**
  47815. * Fired when a scale box is dragged
  47816. */
  47817. onScaleBoxDragObservable: Observable<{}>;
  47818. /**
  47819. * Fired when a scale box drag is ended
  47820. */
  47821. onScaleBoxDragEndObservable: Observable<{}>;
  47822. /**
  47823. * Fired when a rotation sphere is dragged
  47824. */
  47825. onRotationSphereDragObservable: Observable<{}>;
  47826. /**
  47827. * Fired when a rotation sphere drag is ended
  47828. */
  47829. onRotationSphereDragEndObservable: Observable<{}>;
  47830. /**
  47831. * 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)
  47832. */
  47833. scalePivot: Nullable<Vector3>;
  47834. /**
  47835. * Mesh used as a pivot to rotate the attached mesh
  47836. */
  47837. private _anchorMesh;
  47838. private _existingMeshScale;
  47839. private _dragMesh;
  47840. private pointerDragBehavior;
  47841. private coloredMaterial;
  47842. private hoverColoredMaterial;
  47843. /**
  47844. * Sets the color of the bounding box gizmo
  47845. * @param color the color to set
  47846. */
  47847. setColor(color: Color3): void;
  47848. /**
  47849. * Creates an BoundingBoxGizmo
  47850. * @param gizmoLayer The utility layer the gizmo will be added to
  47851. * @param color The color of the gizmo
  47852. */
  47853. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  47854. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47855. private _selectNode;
  47856. /**
  47857. * Updates the bounding box information for the Gizmo
  47858. */
  47859. updateBoundingBox(): void;
  47860. private _updateRotationSpheres;
  47861. private _updateScaleBoxes;
  47862. /**
  47863. * Enables rotation on the specified axis and disables rotation on the others
  47864. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  47865. */
  47866. setEnabledRotationAxis(axis: string): void;
  47867. /**
  47868. * Enables/disables scaling
  47869. * @param enable if scaling should be enabled
  47870. */
  47871. setEnabledScaling(enable: boolean): void;
  47872. private _updateDummy;
  47873. /**
  47874. * Enables a pointer drag behavior on the bounding box of the gizmo
  47875. */
  47876. enableDragBehavior(): void;
  47877. /**
  47878. * Disposes of the gizmo
  47879. */
  47880. dispose(): void;
  47881. /**
  47882. * 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)
  47883. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  47884. * @returns the bounding box mesh with the passed in mesh as a child
  47885. */
  47886. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  47887. /**
  47888. * CustomMeshes are not supported by this gizmo
  47889. * @param mesh The mesh to replace the default mesh of the gizmo
  47890. */
  47891. setCustomMesh(mesh: Mesh): void;
  47892. }
  47893. }
  47894. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  47895. import { Observable } from "babylonjs/Misc/observable";
  47896. import { Nullable } from "babylonjs/types";
  47897. import { Vector3 } from "babylonjs/Maths/math.vector";
  47898. import { Color3 } from "babylonjs/Maths/math.color";
  47899. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47900. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47901. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47902. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47903. import "babylonjs/Meshes/Builders/linesBuilder";
  47904. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47905. /**
  47906. * Single plane rotation gizmo
  47907. */
  47908. export class PlaneRotationGizmo extends Gizmo {
  47909. /**
  47910. * Drag behavior responsible for the gizmos dragging interactions
  47911. */
  47912. dragBehavior: PointerDragBehavior;
  47913. private _pointerObserver;
  47914. /**
  47915. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  47916. */
  47917. snapDistance: number;
  47918. /**
  47919. * Event that fires each time the gizmo snaps to a new location.
  47920. * * snapDistance is the the change in distance
  47921. */
  47922. onSnapObservable: Observable<{
  47923. snapDistance: number;
  47924. }>;
  47925. private _isEnabled;
  47926. private _parent;
  47927. /**
  47928. * Creates a PlaneRotationGizmo
  47929. * @param gizmoLayer The utility layer the gizmo will be added to
  47930. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  47931. * @param color The color of the gizmo
  47932. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47933. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47934. */
  47935. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  47936. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47937. /**
  47938. * If the gizmo is enabled
  47939. */
  47940. isEnabled: boolean;
  47941. /**
  47942. * Disposes of the gizmo
  47943. */
  47944. dispose(): void;
  47945. }
  47946. }
  47947. declare module "babylonjs/Gizmos/rotationGizmo" {
  47948. import { Observable } from "babylonjs/Misc/observable";
  47949. import { Nullable } from "babylonjs/types";
  47950. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47951. import { Mesh } from "babylonjs/Meshes/mesh";
  47952. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47953. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  47954. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47955. /**
  47956. * Gizmo that enables rotating a mesh along 3 axis
  47957. */
  47958. export class RotationGizmo extends Gizmo {
  47959. /**
  47960. * Internal gizmo used for interactions on the x axis
  47961. */
  47962. xGizmo: PlaneRotationGizmo;
  47963. /**
  47964. * Internal gizmo used for interactions on the y axis
  47965. */
  47966. yGizmo: PlaneRotationGizmo;
  47967. /**
  47968. * Internal gizmo used for interactions on the z axis
  47969. */
  47970. zGizmo: PlaneRotationGizmo;
  47971. /** Fires an event when any of it's sub gizmos are dragged */
  47972. onDragStartObservable: Observable<unknown>;
  47973. /** Fires an event when any of it's sub gizmos are released from dragging */
  47974. onDragEndObservable: Observable<unknown>;
  47975. private _meshAttached;
  47976. attachedMesh: Nullable<AbstractMesh>;
  47977. /**
  47978. * Creates a RotationGizmo
  47979. * @param gizmoLayer The utility layer the gizmo will be added to
  47980. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47981. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47982. */
  47983. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  47984. updateGizmoRotationToMatchAttachedMesh: boolean;
  47985. /**
  47986. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47987. */
  47988. snapDistance: number;
  47989. /**
  47990. * Ratio for the scale of the gizmo (Default: 1)
  47991. */
  47992. scaleRatio: number;
  47993. /**
  47994. * Disposes of the gizmo
  47995. */
  47996. dispose(): void;
  47997. /**
  47998. * CustomMeshes are not supported by this gizmo
  47999. * @param mesh The mesh to replace the default mesh of the gizmo
  48000. */
  48001. setCustomMesh(mesh: Mesh): void;
  48002. }
  48003. }
  48004. declare module "babylonjs/Gizmos/gizmoManager" {
  48005. import { Observable } from "babylonjs/Misc/observable";
  48006. import { Nullable } from "babylonjs/types";
  48007. import { Scene, IDisposable } from "babylonjs/scene";
  48008. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48009. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  48010. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  48011. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  48012. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  48013. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  48014. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  48015. /**
  48016. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  48017. */
  48018. export class GizmoManager implements IDisposable {
  48019. private scene;
  48020. /**
  48021. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  48022. */
  48023. gizmos: {
  48024. positionGizmo: Nullable<PositionGizmo>;
  48025. rotationGizmo: Nullable<RotationGizmo>;
  48026. scaleGizmo: Nullable<ScaleGizmo>;
  48027. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  48028. };
  48029. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  48030. clearGizmoOnEmptyPointerEvent: boolean;
  48031. /** Fires an event when the manager is attached to a mesh */
  48032. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  48033. private _gizmosEnabled;
  48034. private _pointerObserver;
  48035. private _attachedMesh;
  48036. private _boundingBoxColor;
  48037. private _defaultUtilityLayer;
  48038. private _defaultKeepDepthUtilityLayer;
  48039. /**
  48040. * When bounding box gizmo is enabled, this can be used to track drag/end events
  48041. */
  48042. boundingBoxDragBehavior: SixDofDragBehavior;
  48043. /**
  48044. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  48045. */
  48046. attachableMeshes: Nullable<Array<AbstractMesh>>;
  48047. /**
  48048. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  48049. */
  48050. usePointerToAttachGizmos: boolean;
  48051. /**
  48052. * Utility layer that the bounding box gizmo belongs to
  48053. */
  48054. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  48055. /**
  48056. * Utility layer that all gizmos besides bounding box belong to
  48057. */
  48058. readonly utilityLayer: UtilityLayerRenderer;
  48059. /**
  48060. * Instatiates a gizmo manager
  48061. * @param scene the scene to overlay the gizmos on top of
  48062. */
  48063. constructor(scene: Scene);
  48064. /**
  48065. * Attaches a set of gizmos to the specified mesh
  48066. * @param mesh The mesh the gizmo's should be attached to
  48067. */
  48068. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  48069. /**
  48070. * If the position gizmo is enabled
  48071. */
  48072. positionGizmoEnabled: boolean;
  48073. /**
  48074. * If the rotation gizmo is enabled
  48075. */
  48076. rotationGizmoEnabled: boolean;
  48077. /**
  48078. * If the scale gizmo is enabled
  48079. */
  48080. scaleGizmoEnabled: boolean;
  48081. /**
  48082. * If the boundingBox gizmo is enabled
  48083. */
  48084. boundingBoxGizmoEnabled: boolean;
  48085. /**
  48086. * Disposes of the gizmo manager
  48087. */
  48088. dispose(): void;
  48089. }
  48090. }
  48091. declare module "babylonjs/Lights/directionalLight" {
  48092. import { Camera } from "babylonjs/Cameras/camera";
  48093. import { Scene } from "babylonjs/scene";
  48094. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48095. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48096. import { Light } from "babylonjs/Lights/light";
  48097. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  48098. import { Effect } from "babylonjs/Materials/effect";
  48099. /**
  48100. * A directional light is defined by a direction (what a surprise!).
  48101. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  48102. * 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.
  48103. * Documentation: https://doc.babylonjs.com/babylon101/lights
  48104. */
  48105. export class DirectionalLight extends ShadowLight {
  48106. private _shadowFrustumSize;
  48107. /**
  48108. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  48109. */
  48110. /**
  48111. * Specifies a fix frustum size for the shadow generation.
  48112. */
  48113. shadowFrustumSize: number;
  48114. private _shadowOrthoScale;
  48115. /**
  48116. * Gets the shadow projection scale against the optimal computed one.
  48117. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  48118. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  48119. */
  48120. /**
  48121. * Sets the shadow projection scale against the optimal computed one.
  48122. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  48123. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  48124. */
  48125. shadowOrthoScale: number;
  48126. /**
  48127. * Automatically compute the projection matrix to best fit (including all the casters)
  48128. * on each frame.
  48129. */
  48130. autoUpdateExtends: boolean;
  48131. private _orthoLeft;
  48132. private _orthoRight;
  48133. private _orthoTop;
  48134. private _orthoBottom;
  48135. /**
  48136. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  48137. * The directional light is emitted from everywhere in the given direction.
  48138. * It can cast shadows.
  48139. * Documentation : https://doc.babylonjs.com/babylon101/lights
  48140. * @param name The friendly name of the light
  48141. * @param direction The direction of the light
  48142. * @param scene The scene the light belongs to
  48143. */
  48144. constructor(name: string, direction: Vector3, scene: Scene);
  48145. /**
  48146. * Returns the string "DirectionalLight".
  48147. * @return The class name
  48148. */
  48149. getClassName(): string;
  48150. /**
  48151. * Returns the integer 1.
  48152. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  48153. */
  48154. getTypeID(): number;
  48155. /**
  48156. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  48157. * Returns the DirectionalLight Shadow projection matrix.
  48158. */
  48159. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48160. /**
  48161. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  48162. * Returns the DirectionalLight Shadow projection matrix.
  48163. */
  48164. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  48165. /**
  48166. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  48167. * Returns the DirectionalLight Shadow projection matrix.
  48168. */
  48169. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48170. protected _buildUniformLayout(): void;
  48171. /**
  48172. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  48173. * @param effect The effect to update
  48174. * @param lightIndex The index of the light in the effect to update
  48175. * @returns The directional light
  48176. */
  48177. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  48178. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  48179. /**
  48180. * Gets the minZ used for shadow according to both the scene and the light.
  48181. *
  48182. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  48183. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  48184. * @param activeCamera The camera we are returning the min for
  48185. * @returns the depth min z
  48186. */
  48187. getDepthMinZ(activeCamera: Camera): number;
  48188. /**
  48189. * Gets the maxZ used for shadow according to both the scene and the light.
  48190. *
  48191. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  48192. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  48193. * @param activeCamera The camera we are returning the max for
  48194. * @returns the depth max z
  48195. */
  48196. getDepthMaxZ(activeCamera: Camera): number;
  48197. /**
  48198. * Prepares the list of defines specific to the light type.
  48199. * @param defines the list of defines
  48200. * @param lightIndex defines the index of the light for the effect
  48201. */
  48202. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  48203. }
  48204. }
  48205. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  48206. import { Mesh } from "babylonjs/Meshes/mesh";
  48207. /**
  48208. * Class containing static functions to help procedurally build meshes
  48209. */
  48210. export class HemisphereBuilder {
  48211. /**
  48212. * Creates a hemisphere mesh
  48213. * @param name defines the name of the mesh
  48214. * @param options defines the options used to create the mesh
  48215. * @param scene defines the hosting scene
  48216. * @returns the hemisphere mesh
  48217. */
  48218. static CreateHemisphere(name: string, options: {
  48219. segments?: number;
  48220. diameter?: number;
  48221. sideOrientation?: number;
  48222. }, scene: any): Mesh;
  48223. }
  48224. }
  48225. declare module "babylonjs/Lights/spotLight" {
  48226. import { Nullable } from "babylonjs/types";
  48227. import { Scene } from "babylonjs/scene";
  48228. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48229. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48230. import { Effect } from "babylonjs/Materials/effect";
  48231. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48232. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  48233. /**
  48234. * A spot light is defined by a position, a direction, an angle, and an exponent.
  48235. * These values define a cone of light starting from the position, emitting toward the direction.
  48236. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  48237. * and the exponent defines the speed of the decay of the light with distance (reach).
  48238. * Documentation: https://doc.babylonjs.com/babylon101/lights
  48239. */
  48240. export class SpotLight extends ShadowLight {
  48241. private _angle;
  48242. private _innerAngle;
  48243. private _cosHalfAngle;
  48244. private _lightAngleScale;
  48245. private _lightAngleOffset;
  48246. /**
  48247. * Gets the cone angle of the spot light in Radians.
  48248. */
  48249. /**
  48250. * Sets the cone angle of the spot light in Radians.
  48251. */
  48252. angle: number;
  48253. /**
  48254. * Only used in gltf falloff mode, this defines the angle where
  48255. * the directional falloff will start before cutting at angle which could be seen
  48256. * as outer angle.
  48257. */
  48258. /**
  48259. * Only used in gltf falloff mode, this defines the angle where
  48260. * the directional falloff will start before cutting at angle which could be seen
  48261. * as outer angle.
  48262. */
  48263. innerAngle: number;
  48264. private _shadowAngleScale;
  48265. /**
  48266. * Allows scaling the angle of the light for shadow generation only.
  48267. */
  48268. /**
  48269. * Allows scaling the angle of the light for shadow generation only.
  48270. */
  48271. shadowAngleScale: number;
  48272. /**
  48273. * The light decay speed with the distance from the emission spot.
  48274. */
  48275. exponent: number;
  48276. private _projectionTextureMatrix;
  48277. /**
  48278. * Allows reading the projecton texture
  48279. */
  48280. readonly projectionTextureMatrix: Matrix;
  48281. protected _projectionTextureLightNear: number;
  48282. /**
  48283. * Gets the near clip of the Spotlight for texture projection.
  48284. */
  48285. /**
  48286. * Sets the near clip of the Spotlight for texture projection.
  48287. */
  48288. projectionTextureLightNear: number;
  48289. protected _projectionTextureLightFar: number;
  48290. /**
  48291. * Gets the far clip of the Spotlight for texture projection.
  48292. */
  48293. /**
  48294. * Sets the far clip of the Spotlight for texture projection.
  48295. */
  48296. projectionTextureLightFar: number;
  48297. protected _projectionTextureUpDirection: Vector3;
  48298. /**
  48299. * Gets the Up vector of the Spotlight for texture projection.
  48300. */
  48301. /**
  48302. * Sets the Up vector of the Spotlight for texture projection.
  48303. */
  48304. projectionTextureUpDirection: Vector3;
  48305. private _projectionTexture;
  48306. /**
  48307. * Gets the projection texture of the light.
  48308. */
  48309. /**
  48310. * Sets the projection texture of the light.
  48311. */
  48312. projectionTexture: Nullable<BaseTexture>;
  48313. private _projectionTextureViewLightDirty;
  48314. private _projectionTextureProjectionLightDirty;
  48315. private _projectionTextureDirty;
  48316. private _projectionTextureViewTargetVector;
  48317. private _projectionTextureViewLightMatrix;
  48318. private _projectionTextureProjectionLightMatrix;
  48319. private _projectionTextureScalingMatrix;
  48320. /**
  48321. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  48322. * It can cast shadows.
  48323. * Documentation : https://doc.babylonjs.com/babylon101/lights
  48324. * @param name The light friendly name
  48325. * @param position The position of the spot light in the scene
  48326. * @param direction The direction of the light in the scene
  48327. * @param angle The cone angle of the light in Radians
  48328. * @param exponent The light decay speed with the distance from the emission spot
  48329. * @param scene The scene the lights belongs to
  48330. */
  48331. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  48332. /**
  48333. * Returns the string "SpotLight".
  48334. * @returns the class name
  48335. */
  48336. getClassName(): string;
  48337. /**
  48338. * Returns the integer 2.
  48339. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  48340. */
  48341. getTypeID(): number;
  48342. /**
  48343. * Overrides the direction setter to recompute the projection texture view light Matrix.
  48344. */
  48345. protected _setDirection(value: Vector3): void;
  48346. /**
  48347. * Overrides the position setter to recompute the projection texture view light Matrix.
  48348. */
  48349. protected _setPosition(value: Vector3): void;
  48350. /**
  48351. * 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.
  48352. * Returns the SpotLight.
  48353. */
  48354. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48355. protected _computeProjectionTextureViewLightMatrix(): void;
  48356. protected _computeProjectionTextureProjectionLightMatrix(): void;
  48357. /**
  48358. * Main function for light texture projection matrix computing.
  48359. */
  48360. protected _computeProjectionTextureMatrix(): void;
  48361. protected _buildUniformLayout(): void;
  48362. private _computeAngleValues;
  48363. /**
  48364. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  48365. * @param effect The effect to update
  48366. * @param lightIndex The index of the light in the effect to update
  48367. * @returns The spot light
  48368. */
  48369. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  48370. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  48371. /**
  48372. * Disposes the light and the associated resources.
  48373. */
  48374. dispose(): void;
  48375. /**
  48376. * Prepares the list of defines specific to the light type.
  48377. * @param defines the list of defines
  48378. * @param lightIndex defines the index of the light for the effect
  48379. */
  48380. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  48381. }
  48382. }
  48383. declare module "babylonjs/Gizmos/lightGizmo" {
  48384. import { Nullable } from "babylonjs/types";
  48385. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  48386. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  48387. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  48388. import { Light } from "babylonjs/Lights/light";
  48389. /**
  48390. * Gizmo that enables viewing a light
  48391. */
  48392. export class LightGizmo extends Gizmo {
  48393. private _lightMesh;
  48394. private _material;
  48395. private _cachedPosition;
  48396. private _cachedForward;
  48397. private _attachedMeshParent;
  48398. /**
  48399. * Creates a LightGizmo
  48400. * @param gizmoLayer The utility layer the gizmo will be added to
  48401. */
  48402. constructor(gizmoLayer?: UtilityLayerRenderer);
  48403. private _light;
  48404. /**
  48405. * The light that the gizmo is attached to
  48406. */
  48407. light: Nullable<Light>;
  48408. /**
  48409. * Gets the material used to render the light gizmo
  48410. */
  48411. readonly material: StandardMaterial;
  48412. /**
  48413. * @hidden
  48414. * Updates the gizmo to match the attached mesh's position/rotation
  48415. */
  48416. protected _update(): void;
  48417. private static _Scale;
  48418. /**
  48419. * Creates the lines for a light mesh
  48420. */
  48421. private static _CreateLightLines;
  48422. /**
  48423. * Disposes of the light gizmo
  48424. */
  48425. dispose(): void;
  48426. private static _CreateHemisphericLightMesh;
  48427. private static _CreatePointLightMesh;
  48428. private static _CreateSpotLightMesh;
  48429. private static _CreateDirectionalLightMesh;
  48430. }
  48431. }
  48432. declare module "babylonjs/Gizmos/index" {
  48433. export * from "babylonjs/Gizmos/axisDragGizmo";
  48434. export * from "babylonjs/Gizmos/axisScaleGizmo";
  48435. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  48436. export * from "babylonjs/Gizmos/gizmo";
  48437. export * from "babylonjs/Gizmos/gizmoManager";
  48438. export * from "babylonjs/Gizmos/planeRotationGizmo";
  48439. export * from "babylonjs/Gizmos/positionGizmo";
  48440. export * from "babylonjs/Gizmos/rotationGizmo";
  48441. export * from "babylonjs/Gizmos/scaleGizmo";
  48442. export * from "babylonjs/Gizmos/lightGizmo";
  48443. export * from "babylonjs/Gizmos/planeDragGizmo";
  48444. }
  48445. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  48446. /** @hidden */
  48447. export var backgroundFragmentDeclaration: {
  48448. name: string;
  48449. shader: string;
  48450. };
  48451. }
  48452. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  48453. /** @hidden */
  48454. export var backgroundUboDeclaration: {
  48455. name: string;
  48456. shader: string;
  48457. };
  48458. }
  48459. declare module "babylonjs/Shaders/background.fragment" {
  48460. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  48461. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48462. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  48463. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  48464. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48465. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48466. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48467. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  48468. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  48469. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  48470. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  48471. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  48472. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  48473. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  48474. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  48475. /** @hidden */
  48476. export var backgroundPixelShader: {
  48477. name: string;
  48478. shader: string;
  48479. };
  48480. }
  48481. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  48482. /** @hidden */
  48483. export var backgroundVertexDeclaration: {
  48484. name: string;
  48485. shader: string;
  48486. };
  48487. }
  48488. declare module "babylonjs/Shaders/background.vertex" {
  48489. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  48490. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48491. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48492. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  48493. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  48494. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  48495. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  48496. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48497. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48498. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  48499. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  48500. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  48501. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  48502. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  48503. /** @hidden */
  48504. export var backgroundVertexShader: {
  48505. name: string;
  48506. shader: string;
  48507. };
  48508. }
  48509. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  48510. import { Nullable, int, float } from "babylonjs/types";
  48511. import { Scene } from "babylonjs/scene";
  48512. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48513. import { SubMesh } from "babylonjs/Meshes/subMesh";
  48514. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48515. import { Mesh } from "babylonjs/Meshes/mesh";
  48516. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48517. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  48518. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  48519. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48520. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  48521. import { Color3 } from "babylonjs/Maths/math.color";
  48522. import "babylonjs/Shaders/background.fragment";
  48523. import "babylonjs/Shaders/background.vertex";
  48524. /**
  48525. * Background material used to create an efficient environement around your scene.
  48526. */
  48527. export class BackgroundMaterial extends PushMaterial {
  48528. /**
  48529. * Standard reflectance value at parallel view angle.
  48530. */
  48531. static StandardReflectance0: number;
  48532. /**
  48533. * Standard reflectance value at grazing angle.
  48534. */
  48535. static StandardReflectance90: number;
  48536. protected _primaryColor: Color3;
  48537. /**
  48538. * Key light Color (multiply against the environement texture)
  48539. */
  48540. primaryColor: Color3;
  48541. protected __perceptualColor: Nullable<Color3>;
  48542. /**
  48543. * Experimental Internal Use Only.
  48544. *
  48545. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  48546. * This acts as a helper to set the primary color to a more "human friendly" value.
  48547. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  48548. * output color as close as possible from the chosen value.
  48549. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  48550. * part of lighting setup.)
  48551. */
  48552. _perceptualColor: Nullable<Color3>;
  48553. protected _primaryColorShadowLevel: float;
  48554. /**
  48555. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  48556. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  48557. */
  48558. primaryColorShadowLevel: float;
  48559. protected _primaryColorHighlightLevel: float;
  48560. /**
  48561. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  48562. * The primary color is used at the level chosen to define what the white area would look.
  48563. */
  48564. primaryColorHighlightLevel: float;
  48565. protected _reflectionTexture: Nullable<BaseTexture>;
  48566. /**
  48567. * Reflection Texture used in the material.
  48568. * Should be author in a specific way for the best result (refer to the documentation).
  48569. */
  48570. reflectionTexture: Nullable<BaseTexture>;
  48571. protected _reflectionBlur: float;
  48572. /**
  48573. * Reflection Texture level of blur.
  48574. *
  48575. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  48576. * texture twice.
  48577. */
  48578. reflectionBlur: float;
  48579. protected _diffuseTexture: Nullable<BaseTexture>;
  48580. /**
  48581. * Diffuse Texture used in the material.
  48582. * Should be author in a specific way for the best result (refer to the documentation).
  48583. */
  48584. diffuseTexture: Nullable<BaseTexture>;
  48585. protected _shadowLights: Nullable<IShadowLight[]>;
  48586. /**
  48587. * Specify the list of lights casting shadow on the material.
  48588. * All scene shadow lights will be included if null.
  48589. */
  48590. shadowLights: Nullable<IShadowLight[]>;
  48591. protected _shadowLevel: float;
  48592. /**
  48593. * Helps adjusting the shadow to a softer level if required.
  48594. * 0 means black shadows and 1 means no shadows.
  48595. */
  48596. shadowLevel: float;
  48597. protected _sceneCenter: Vector3;
  48598. /**
  48599. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  48600. * It is usually zero but might be interesting to modify according to your setup.
  48601. */
  48602. sceneCenter: Vector3;
  48603. protected _opacityFresnel: boolean;
  48604. /**
  48605. * This helps specifying that the material is falling off to the sky box at grazing angle.
  48606. * This helps ensuring a nice transition when the camera goes under the ground.
  48607. */
  48608. opacityFresnel: boolean;
  48609. protected _reflectionFresnel: boolean;
  48610. /**
  48611. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  48612. * This helps adding a mirror texture on the ground.
  48613. */
  48614. reflectionFresnel: boolean;
  48615. protected _reflectionFalloffDistance: number;
  48616. /**
  48617. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  48618. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  48619. */
  48620. reflectionFalloffDistance: number;
  48621. protected _reflectionAmount: number;
  48622. /**
  48623. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  48624. */
  48625. reflectionAmount: number;
  48626. protected _reflectionReflectance0: number;
  48627. /**
  48628. * This specifies the weight of the reflection at grazing angle.
  48629. */
  48630. reflectionReflectance0: number;
  48631. protected _reflectionReflectance90: number;
  48632. /**
  48633. * This specifies the weight of the reflection at a perpendicular point of view.
  48634. */
  48635. reflectionReflectance90: number;
  48636. /**
  48637. * Sets the reflection reflectance fresnel values according to the default standard
  48638. * empirically know to work well :-)
  48639. */
  48640. reflectionStandardFresnelWeight: number;
  48641. protected _useRGBColor: boolean;
  48642. /**
  48643. * Helps to directly use the maps channels instead of their level.
  48644. */
  48645. useRGBColor: boolean;
  48646. protected _enableNoise: boolean;
  48647. /**
  48648. * This helps reducing the banding effect that could occur on the background.
  48649. */
  48650. enableNoise: boolean;
  48651. /**
  48652. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48653. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  48654. * Recommended to be keep at 1.0 except for special cases.
  48655. */
  48656. fovMultiplier: number;
  48657. private _fovMultiplier;
  48658. /**
  48659. * Enable the FOV adjustment feature controlled by fovMultiplier.
  48660. */
  48661. useEquirectangularFOV: boolean;
  48662. private _maxSimultaneousLights;
  48663. /**
  48664. * Number of Simultaneous lights allowed on the material.
  48665. */
  48666. maxSimultaneousLights: int;
  48667. /**
  48668. * Default configuration related to image processing available in the Background Material.
  48669. */
  48670. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  48671. /**
  48672. * Keep track of the image processing observer to allow dispose and replace.
  48673. */
  48674. private _imageProcessingObserver;
  48675. /**
  48676. * Attaches a new image processing configuration to the PBR Material.
  48677. * @param configuration (if null the scene configuration will be use)
  48678. */
  48679. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  48680. /**
  48681. * Gets the image processing configuration used either in this material.
  48682. */
  48683. /**
  48684. * Sets the Default image processing configuration used either in the this material.
  48685. *
  48686. * If sets to null, the scene one is in use.
  48687. */
  48688. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  48689. /**
  48690. * Gets wether the color curves effect is enabled.
  48691. */
  48692. /**
  48693. * Sets wether the color curves effect is enabled.
  48694. */
  48695. cameraColorCurvesEnabled: boolean;
  48696. /**
  48697. * Gets wether the color grading effect is enabled.
  48698. */
  48699. /**
  48700. * Gets wether the color grading effect is enabled.
  48701. */
  48702. cameraColorGradingEnabled: boolean;
  48703. /**
  48704. * Gets wether tonemapping is enabled or not.
  48705. */
  48706. /**
  48707. * Sets wether tonemapping is enabled or not
  48708. */
  48709. cameraToneMappingEnabled: boolean;
  48710. /**
  48711. * The camera exposure used on this material.
  48712. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48713. * This corresponds to a photographic exposure.
  48714. */
  48715. /**
  48716. * The camera exposure used on this material.
  48717. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48718. * This corresponds to a photographic exposure.
  48719. */
  48720. cameraExposure: float;
  48721. /**
  48722. * Gets The camera contrast used on this material.
  48723. */
  48724. /**
  48725. * Sets The camera contrast used on this material.
  48726. */
  48727. cameraContrast: float;
  48728. /**
  48729. * Gets the Color Grading 2D Lookup Texture.
  48730. */
  48731. /**
  48732. * Sets the Color Grading 2D Lookup Texture.
  48733. */
  48734. cameraColorGradingTexture: Nullable<BaseTexture>;
  48735. /**
  48736. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48737. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48738. * 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;
  48739. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48740. */
  48741. /**
  48742. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48743. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48744. * 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;
  48745. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48746. */
  48747. cameraColorCurves: Nullable<ColorCurves>;
  48748. /**
  48749. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  48750. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  48751. */
  48752. switchToBGR: boolean;
  48753. private _renderTargets;
  48754. private _reflectionControls;
  48755. private _white;
  48756. private _primaryShadowColor;
  48757. private _primaryHighlightColor;
  48758. /**
  48759. * Instantiates a Background Material in the given scene
  48760. * @param name The friendly name of the material
  48761. * @param scene The scene to add the material to
  48762. */
  48763. constructor(name: string, scene: Scene);
  48764. /**
  48765. * Gets a boolean indicating that current material needs to register RTT
  48766. */
  48767. readonly hasRenderTargetTextures: boolean;
  48768. /**
  48769. * The entire material has been created in order to prevent overdraw.
  48770. * @returns false
  48771. */
  48772. needAlphaTesting(): boolean;
  48773. /**
  48774. * The entire material has been created in order to prevent overdraw.
  48775. * @returns true if blending is enable
  48776. */
  48777. needAlphaBlending(): boolean;
  48778. /**
  48779. * Checks wether the material is ready to be rendered for a given mesh.
  48780. * @param mesh The mesh to render
  48781. * @param subMesh The submesh to check against
  48782. * @param useInstances Specify wether or not the material is used with instances
  48783. * @returns true if all the dependencies are ready (Textures, Effects...)
  48784. */
  48785. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  48786. /**
  48787. * Compute the primary color according to the chosen perceptual color.
  48788. */
  48789. private _computePrimaryColorFromPerceptualColor;
  48790. /**
  48791. * Compute the highlights and shadow colors according to their chosen levels.
  48792. */
  48793. private _computePrimaryColors;
  48794. /**
  48795. * Build the uniform buffer used in the material.
  48796. */
  48797. buildUniformLayout(): void;
  48798. /**
  48799. * Unbind the material.
  48800. */
  48801. unbind(): void;
  48802. /**
  48803. * Bind only the world matrix to the material.
  48804. * @param world The world matrix to bind.
  48805. */
  48806. bindOnlyWorldMatrix(world: Matrix): void;
  48807. /**
  48808. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  48809. * @param world The world matrix to bind.
  48810. * @param subMesh The submesh to bind for.
  48811. */
  48812. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  48813. /**
  48814. * Checks to see if a texture is used in the material.
  48815. * @param texture - Base texture to use.
  48816. * @returns - Boolean specifying if a texture is used in the material.
  48817. */
  48818. hasTexture(texture: BaseTexture): boolean;
  48819. /**
  48820. * Dispose the material.
  48821. * @param forceDisposeEffect Force disposal of the associated effect.
  48822. * @param forceDisposeTextures Force disposal of the associated textures.
  48823. */
  48824. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  48825. /**
  48826. * Clones the material.
  48827. * @param name The cloned name.
  48828. * @returns The cloned material.
  48829. */
  48830. clone(name: string): BackgroundMaterial;
  48831. /**
  48832. * Serializes the current material to its JSON representation.
  48833. * @returns The JSON representation.
  48834. */
  48835. serialize(): any;
  48836. /**
  48837. * Gets the class name of the material
  48838. * @returns "BackgroundMaterial"
  48839. */
  48840. getClassName(): string;
  48841. /**
  48842. * Parse a JSON input to create back a background material.
  48843. * @param source The JSON data to parse
  48844. * @param scene The scene to create the parsed material in
  48845. * @param rootUrl The root url of the assets the material depends upon
  48846. * @returns the instantiated BackgroundMaterial.
  48847. */
  48848. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  48849. }
  48850. }
  48851. declare module "babylonjs/Helpers/environmentHelper" {
  48852. import { Observable } from "babylonjs/Misc/observable";
  48853. import { Nullable } from "babylonjs/types";
  48854. import { Scene } from "babylonjs/scene";
  48855. import { Vector3 } from "babylonjs/Maths/math.vector";
  48856. import { Color3 } from "babylonjs/Maths/math.color";
  48857. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48858. import { Mesh } from "babylonjs/Meshes/mesh";
  48859. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48860. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  48861. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48862. import "babylonjs/Meshes/Builders/planeBuilder";
  48863. import "babylonjs/Meshes/Builders/boxBuilder";
  48864. /**
  48865. * Represents the different options available during the creation of
  48866. * a Environment helper.
  48867. *
  48868. * This can control the default ground, skybox and image processing setup of your scene.
  48869. */
  48870. export interface IEnvironmentHelperOptions {
  48871. /**
  48872. * Specifies wether or not to create a ground.
  48873. * True by default.
  48874. */
  48875. createGround: boolean;
  48876. /**
  48877. * Specifies the ground size.
  48878. * 15 by default.
  48879. */
  48880. groundSize: number;
  48881. /**
  48882. * The texture used on the ground for the main color.
  48883. * Comes from the BabylonJS CDN by default.
  48884. *
  48885. * Remarks: Can be either a texture or a url.
  48886. */
  48887. groundTexture: string | BaseTexture;
  48888. /**
  48889. * The color mixed in the ground texture by default.
  48890. * BabylonJS clearColor by default.
  48891. */
  48892. groundColor: Color3;
  48893. /**
  48894. * Specifies the ground opacity.
  48895. * 1 by default.
  48896. */
  48897. groundOpacity: number;
  48898. /**
  48899. * Enables the ground to receive shadows.
  48900. * True by default.
  48901. */
  48902. enableGroundShadow: boolean;
  48903. /**
  48904. * Helps preventing the shadow to be fully black on the ground.
  48905. * 0.5 by default.
  48906. */
  48907. groundShadowLevel: number;
  48908. /**
  48909. * Creates a mirror texture attach to the ground.
  48910. * false by default.
  48911. */
  48912. enableGroundMirror: boolean;
  48913. /**
  48914. * Specifies the ground mirror size ratio.
  48915. * 0.3 by default as the default kernel is 64.
  48916. */
  48917. groundMirrorSizeRatio: number;
  48918. /**
  48919. * Specifies the ground mirror blur kernel size.
  48920. * 64 by default.
  48921. */
  48922. groundMirrorBlurKernel: number;
  48923. /**
  48924. * Specifies the ground mirror visibility amount.
  48925. * 1 by default
  48926. */
  48927. groundMirrorAmount: number;
  48928. /**
  48929. * Specifies the ground mirror reflectance weight.
  48930. * This uses the standard weight of the background material to setup the fresnel effect
  48931. * of the mirror.
  48932. * 1 by default.
  48933. */
  48934. groundMirrorFresnelWeight: number;
  48935. /**
  48936. * Specifies the ground mirror Falloff distance.
  48937. * This can helps reducing the size of the reflection.
  48938. * 0 by Default.
  48939. */
  48940. groundMirrorFallOffDistance: number;
  48941. /**
  48942. * Specifies the ground mirror texture type.
  48943. * Unsigned Int by Default.
  48944. */
  48945. groundMirrorTextureType: number;
  48946. /**
  48947. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  48948. * the shown objects.
  48949. */
  48950. groundYBias: number;
  48951. /**
  48952. * Specifies wether or not to create a skybox.
  48953. * True by default.
  48954. */
  48955. createSkybox: boolean;
  48956. /**
  48957. * Specifies the skybox size.
  48958. * 20 by default.
  48959. */
  48960. skyboxSize: number;
  48961. /**
  48962. * The texture used on the skybox for the main color.
  48963. * Comes from the BabylonJS CDN by default.
  48964. *
  48965. * Remarks: Can be either a texture or a url.
  48966. */
  48967. skyboxTexture: string | BaseTexture;
  48968. /**
  48969. * The color mixed in the skybox texture by default.
  48970. * BabylonJS clearColor by default.
  48971. */
  48972. skyboxColor: Color3;
  48973. /**
  48974. * The background rotation around the Y axis of the scene.
  48975. * This helps aligning the key lights of your scene with the background.
  48976. * 0 by default.
  48977. */
  48978. backgroundYRotation: number;
  48979. /**
  48980. * Compute automatically the size of the elements to best fit with the scene.
  48981. */
  48982. sizeAuto: boolean;
  48983. /**
  48984. * Default position of the rootMesh if autoSize is not true.
  48985. */
  48986. rootPosition: Vector3;
  48987. /**
  48988. * Sets up the image processing in the scene.
  48989. * true by default.
  48990. */
  48991. setupImageProcessing: boolean;
  48992. /**
  48993. * The texture used as your environment texture in the scene.
  48994. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  48995. *
  48996. * Remarks: Can be either a texture or a url.
  48997. */
  48998. environmentTexture: string | BaseTexture;
  48999. /**
  49000. * The value of the exposure to apply to the scene.
  49001. * 0.6 by default if setupImageProcessing is true.
  49002. */
  49003. cameraExposure: number;
  49004. /**
  49005. * The value of the contrast to apply to the scene.
  49006. * 1.6 by default if setupImageProcessing is true.
  49007. */
  49008. cameraContrast: number;
  49009. /**
  49010. * Specifies wether or not tonemapping should be enabled in the scene.
  49011. * true by default if setupImageProcessing is true.
  49012. */
  49013. toneMappingEnabled: boolean;
  49014. }
  49015. /**
  49016. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  49017. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  49018. * It also helps with the default setup of your imageProcessing configuration.
  49019. */
  49020. export class EnvironmentHelper {
  49021. /**
  49022. * Default ground texture URL.
  49023. */
  49024. private static _groundTextureCDNUrl;
  49025. /**
  49026. * Default skybox texture URL.
  49027. */
  49028. private static _skyboxTextureCDNUrl;
  49029. /**
  49030. * Default environment texture URL.
  49031. */
  49032. private static _environmentTextureCDNUrl;
  49033. /**
  49034. * Creates the default options for the helper.
  49035. */
  49036. private static _getDefaultOptions;
  49037. private _rootMesh;
  49038. /**
  49039. * Gets the root mesh created by the helper.
  49040. */
  49041. readonly rootMesh: Mesh;
  49042. private _skybox;
  49043. /**
  49044. * Gets the skybox created by the helper.
  49045. */
  49046. readonly skybox: Nullable<Mesh>;
  49047. private _skyboxTexture;
  49048. /**
  49049. * Gets the skybox texture created by the helper.
  49050. */
  49051. readonly skyboxTexture: Nullable<BaseTexture>;
  49052. private _skyboxMaterial;
  49053. /**
  49054. * Gets the skybox material created by the helper.
  49055. */
  49056. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  49057. private _ground;
  49058. /**
  49059. * Gets the ground mesh created by the helper.
  49060. */
  49061. readonly ground: Nullable<Mesh>;
  49062. private _groundTexture;
  49063. /**
  49064. * Gets the ground texture created by the helper.
  49065. */
  49066. readonly groundTexture: Nullable<BaseTexture>;
  49067. private _groundMirror;
  49068. /**
  49069. * Gets the ground mirror created by the helper.
  49070. */
  49071. readonly groundMirror: Nullable<MirrorTexture>;
  49072. /**
  49073. * Gets the ground mirror render list to helps pushing the meshes
  49074. * you wish in the ground reflection.
  49075. */
  49076. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  49077. private _groundMaterial;
  49078. /**
  49079. * Gets the ground material created by the helper.
  49080. */
  49081. readonly groundMaterial: Nullable<BackgroundMaterial>;
  49082. /**
  49083. * Stores the creation options.
  49084. */
  49085. private readonly _scene;
  49086. private _options;
  49087. /**
  49088. * This observable will be notified with any error during the creation of the environment,
  49089. * mainly texture creation errors.
  49090. */
  49091. onErrorObservable: Observable<{
  49092. message?: string;
  49093. exception?: any;
  49094. }>;
  49095. /**
  49096. * constructor
  49097. * @param options Defines the options we want to customize the helper
  49098. * @param scene The scene to add the material to
  49099. */
  49100. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  49101. /**
  49102. * Updates the background according to the new options
  49103. * @param options
  49104. */
  49105. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  49106. /**
  49107. * Sets the primary color of all the available elements.
  49108. * @param color the main color to affect to the ground and the background
  49109. */
  49110. setMainColor(color: Color3): void;
  49111. /**
  49112. * Setup the image processing according to the specified options.
  49113. */
  49114. private _setupImageProcessing;
  49115. /**
  49116. * Setup the environment texture according to the specified options.
  49117. */
  49118. private _setupEnvironmentTexture;
  49119. /**
  49120. * Setup the background according to the specified options.
  49121. */
  49122. private _setupBackground;
  49123. /**
  49124. * Get the scene sizes according to the setup.
  49125. */
  49126. private _getSceneSize;
  49127. /**
  49128. * Setup the ground according to the specified options.
  49129. */
  49130. private _setupGround;
  49131. /**
  49132. * Setup the ground material according to the specified options.
  49133. */
  49134. private _setupGroundMaterial;
  49135. /**
  49136. * Setup the ground diffuse texture according to the specified options.
  49137. */
  49138. private _setupGroundDiffuseTexture;
  49139. /**
  49140. * Setup the ground mirror texture according to the specified options.
  49141. */
  49142. private _setupGroundMirrorTexture;
  49143. /**
  49144. * Setup the ground to receive the mirror texture.
  49145. */
  49146. private _setupMirrorInGroundMaterial;
  49147. /**
  49148. * Setup the skybox according to the specified options.
  49149. */
  49150. private _setupSkybox;
  49151. /**
  49152. * Setup the skybox material according to the specified options.
  49153. */
  49154. private _setupSkyboxMaterial;
  49155. /**
  49156. * Setup the skybox reflection texture according to the specified options.
  49157. */
  49158. private _setupSkyboxReflectionTexture;
  49159. private _errorHandler;
  49160. /**
  49161. * Dispose all the elements created by the Helper.
  49162. */
  49163. dispose(): void;
  49164. }
  49165. }
  49166. declare module "babylonjs/Helpers/photoDome" {
  49167. import { Observable } from "babylonjs/Misc/observable";
  49168. import { Nullable } from "babylonjs/types";
  49169. import { Scene } from "babylonjs/scene";
  49170. import { TransformNode } from "babylonjs/Meshes/transformNode";
  49171. import { Mesh } from "babylonjs/Meshes/mesh";
  49172. import { Texture } from "babylonjs/Materials/Textures/texture";
  49173. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  49174. import "babylonjs/Meshes/Builders/sphereBuilder";
  49175. /**
  49176. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  49177. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  49178. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  49179. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  49180. */
  49181. export class PhotoDome extends TransformNode {
  49182. /**
  49183. * Define the image as a Monoscopic panoramic 360 image.
  49184. */
  49185. static readonly MODE_MONOSCOPIC: number;
  49186. /**
  49187. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  49188. */
  49189. static readonly MODE_TOPBOTTOM: number;
  49190. /**
  49191. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  49192. */
  49193. static readonly MODE_SIDEBYSIDE: number;
  49194. private _useDirectMapping;
  49195. /**
  49196. * The texture being displayed on the sphere
  49197. */
  49198. protected _photoTexture: Texture;
  49199. /**
  49200. * Gets or sets the texture being displayed on the sphere
  49201. */
  49202. photoTexture: Texture;
  49203. /**
  49204. * Observable raised when an error occured while loading the 360 image
  49205. */
  49206. onLoadErrorObservable: Observable<string>;
  49207. /**
  49208. * The skybox material
  49209. */
  49210. protected _material: BackgroundMaterial;
  49211. /**
  49212. * The surface used for the skybox
  49213. */
  49214. protected _mesh: Mesh;
  49215. /**
  49216. * Gets the mesh used for the skybox.
  49217. */
  49218. readonly mesh: Mesh;
  49219. /**
  49220. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  49221. * Also see the options.resolution property.
  49222. */
  49223. fovMultiplier: number;
  49224. private _imageMode;
  49225. /**
  49226. * Gets or set the current video mode for the video. It can be:
  49227. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  49228. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  49229. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  49230. */
  49231. imageMode: number;
  49232. /**
  49233. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  49234. * @param name Element's name, child elements will append suffixes for their own names.
  49235. * @param urlsOfPhoto defines the url of the photo to display
  49236. * @param options defines an object containing optional or exposed sub element properties
  49237. * @param onError defines a callback called when an error occured while loading the texture
  49238. */
  49239. constructor(name: string, urlOfPhoto: string, options: {
  49240. resolution?: number;
  49241. size?: number;
  49242. useDirectMapping?: boolean;
  49243. faceForward?: boolean;
  49244. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  49245. private _onBeforeCameraRenderObserver;
  49246. private _changeImageMode;
  49247. /**
  49248. * Releases resources associated with this node.
  49249. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  49250. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  49251. */
  49252. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  49253. }
  49254. }
  49255. declare module "babylonjs/Misc/rgbdTextureTools" {
  49256. import "babylonjs/Shaders/rgbdDecode.fragment";
  49257. import "babylonjs/Engines/Extensions/engine.renderTarget";
  49258. import { Texture } from "babylonjs/Materials/Textures/texture";
  49259. /**
  49260. * Class used to host RGBD texture specific utilities
  49261. */
  49262. export class RGBDTextureTools {
  49263. /**
  49264. * Expand the RGBD Texture from RGBD to Half Float if possible.
  49265. * @param texture the texture to expand.
  49266. */
  49267. static ExpandRGBDTexture(texture: Texture): void;
  49268. }
  49269. }
  49270. declare module "babylonjs/Misc/brdfTextureTools" {
  49271. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49272. import { Scene } from "babylonjs/scene";
  49273. /**
  49274. * Class used to host texture specific utilities
  49275. */
  49276. export class BRDFTextureTools {
  49277. /**
  49278. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  49279. * @param scene defines the hosting scene
  49280. * @returns the environment BRDF texture
  49281. */
  49282. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  49283. private static _environmentBRDFBase64Texture;
  49284. }
  49285. }
  49286. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  49287. import { Nullable } from "babylonjs/types";
  49288. import { Color3 } from "babylonjs/Maths/math.color";
  49289. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49290. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49291. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49292. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49293. import { Engine } from "babylonjs/Engines/engine";
  49294. import { Scene } from "babylonjs/scene";
  49295. /**
  49296. * @hidden
  49297. */
  49298. export interface IMaterialClearCoatDefines {
  49299. CLEARCOAT: boolean;
  49300. CLEARCOAT_DEFAULTIOR: boolean;
  49301. CLEARCOAT_TEXTURE: boolean;
  49302. CLEARCOAT_TEXTUREDIRECTUV: number;
  49303. CLEARCOAT_BUMP: boolean;
  49304. CLEARCOAT_BUMPDIRECTUV: number;
  49305. CLEARCOAT_TINT: boolean;
  49306. CLEARCOAT_TINT_TEXTURE: boolean;
  49307. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  49308. /** @hidden */
  49309. _areTexturesDirty: boolean;
  49310. }
  49311. /**
  49312. * Define the code related to the clear coat parameters of the pbr material.
  49313. */
  49314. export class PBRClearCoatConfiguration {
  49315. /**
  49316. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  49317. * The default fits with a polyurethane material.
  49318. */
  49319. private static readonly _DefaultIndexOfRefraction;
  49320. private _isEnabled;
  49321. /**
  49322. * Defines if the clear coat is enabled in the material.
  49323. */
  49324. isEnabled: boolean;
  49325. /**
  49326. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  49327. */
  49328. intensity: number;
  49329. /**
  49330. * Defines the clear coat layer roughness.
  49331. */
  49332. roughness: number;
  49333. private _indexOfRefraction;
  49334. /**
  49335. * Defines the index of refraction of the clear coat.
  49336. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  49337. * The default fits with a polyurethane material.
  49338. * Changing the default value is more performance intensive.
  49339. */
  49340. indexOfRefraction: number;
  49341. private _texture;
  49342. /**
  49343. * Stores the clear coat values in a texture.
  49344. */
  49345. texture: Nullable<BaseTexture>;
  49346. private _bumpTexture;
  49347. /**
  49348. * Define the clear coat specific bump texture.
  49349. */
  49350. bumpTexture: Nullable<BaseTexture>;
  49351. private _isTintEnabled;
  49352. /**
  49353. * Defines if the clear coat tint is enabled in the material.
  49354. */
  49355. isTintEnabled: boolean;
  49356. /**
  49357. * Defines the clear coat tint of the material.
  49358. * This is only use if tint is enabled
  49359. */
  49360. tintColor: Color3;
  49361. /**
  49362. * Defines the distance at which the tint color should be found in the
  49363. * clear coat media.
  49364. * This is only use if tint is enabled
  49365. */
  49366. tintColorAtDistance: number;
  49367. /**
  49368. * Defines the clear coat layer thickness.
  49369. * This is only use if tint is enabled
  49370. */
  49371. tintThickness: number;
  49372. private _tintTexture;
  49373. /**
  49374. * Stores the clear tint values in a texture.
  49375. * rgb is tint
  49376. * a is a thickness factor
  49377. */
  49378. tintTexture: Nullable<BaseTexture>;
  49379. /** @hidden */
  49380. private _internalMarkAllSubMeshesAsTexturesDirty;
  49381. /** @hidden */
  49382. _markAllSubMeshesAsTexturesDirty(): void;
  49383. /**
  49384. * Instantiate a new istance of clear coat configuration.
  49385. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49386. */
  49387. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49388. /**
  49389. * Gets wehter the submesh is ready to be used or not.
  49390. * @param defines the list of "defines" to update.
  49391. * @param scene defines the scene the material belongs to.
  49392. * @param engine defines the engine the material belongs to.
  49393. * @param disableBumpMap defines wether the material disables bump or not.
  49394. * @returns - boolean indicating that the submesh is ready or not.
  49395. */
  49396. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  49397. /**
  49398. * Checks to see if a texture is used in the material.
  49399. * @param defines the list of "defines" to update.
  49400. * @param scene defines the scene to the material belongs to.
  49401. */
  49402. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  49403. /**
  49404. * Binds the material data.
  49405. * @param uniformBuffer defines the Uniform buffer to fill in.
  49406. * @param scene defines the scene the material belongs to.
  49407. * @param engine defines the engine the material belongs to.
  49408. * @param disableBumpMap defines wether the material disables bump or not.
  49409. * @param isFrozen defines wether the material is frozen or not.
  49410. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  49411. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  49412. */
  49413. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  49414. /**
  49415. * Checks to see if a texture is used in the material.
  49416. * @param texture - Base texture to use.
  49417. * @returns - Boolean specifying if a texture is used in the material.
  49418. */
  49419. hasTexture(texture: BaseTexture): boolean;
  49420. /**
  49421. * Returns an array of the actively used textures.
  49422. * @param activeTextures Array of BaseTextures
  49423. */
  49424. getActiveTextures(activeTextures: BaseTexture[]): void;
  49425. /**
  49426. * Returns the animatable textures.
  49427. * @param animatables Array of animatable textures.
  49428. */
  49429. getAnimatables(animatables: IAnimatable[]): void;
  49430. /**
  49431. * Disposes the resources of the material.
  49432. * @param forceDisposeTextures - Forces the disposal of all textures.
  49433. */
  49434. dispose(forceDisposeTextures?: boolean): void;
  49435. /**
  49436. * Get the current class name of the texture useful for serialization or dynamic coding.
  49437. * @returns "PBRClearCoatConfiguration"
  49438. */
  49439. getClassName(): string;
  49440. /**
  49441. * Add fallbacks to the effect fallbacks list.
  49442. * @param defines defines the Base texture to use.
  49443. * @param fallbacks defines the current fallback list.
  49444. * @param currentRank defines the current fallback rank.
  49445. * @returns the new fallback rank.
  49446. */
  49447. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49448. /**
  49449. * Add the required uniforms to the current list.
  49450. * @param uniforms defines the current uniform list.
  49451. */
  49452. static AddUniforms(uniforms: string[]): void;
  49453. /**
  49454. * Add the required samplers to the current list.
  49455. * @param samplers defines the current sampler list.
  49456. */
  49457. static AddSamplers(samplers: string[]): void;
  49458. /**
  49459. * Add the required uniforms to the current buffer.
  49460. * @param uniformBuffer defines the current uniform buffer.
  49461. */
  49462. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49463. /**
  49464. * Makes a duplicate of the current configuration into another one.
  49465. * @param clearCoatConfiguration define the config where to copy the info
  49466. */
  49467. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  49468. /**
  49469. * Serializes this clear coat configuration.
  49470. * @returns - An object with the serialized config.
  49471. */
  49472. serialize(): any;
  49473. /**
  49474. * Parses a anisotropy Configuration from a serialized object.
  49475. * @param source - Serialized object.
  49476. * @param scene Defines the scene we are parsing for
  49477. * @param rootUrl Defines the rootUrl to load from
  49478. */
  49479. parse(source: any, scene: Scene, rootUrl: string): void;
  49480. }
  49481. }
  49482. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  49483. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49484. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49485. import { Vector2 } from "babylonjs/Maths/math.vector";
  49486. import { Scene } from "babylonjs/scene";
  49487. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49488. import { Nullable } from "babylonjs/types";
  49489. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49490. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49491. /**
  49492. * @hidden
  49493. */
  49494. export interface IMaterialAnisotropicDefines {
  49495. ANISOTROPIC: boolean;
  49496. ANISOTROPIC_TEXTURE: boolean;
  49497. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49498. MAINUV1: boolean;
  49499. _areTexturesDirty: boolean;
  49500. _needUVs: boolean;
  49501. }
  49502. /**
  49503. * Define the code related to the anisotropic parameters of the pbr material.
  49504. */
  49505. export class PBRAnisotropicConfiguration {
  49506. private _isEnabled;
  49507. /**
  49508. * Defines if the anisotropy is enabled in the material.
  49509. */
  49510. isEnabled: boolean;
  49511. /**
  49512. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  49513. */
  49514. intensity: number;
  49515. /**
  49516. * Defines if the effect is along the tangents, bitangents or in between.
  49517. * By default, the effect is "strectching" the highlights along the tangents.
  49518. */
  49519. direction: Vector2;
  49520. private _texture;
  49521. /**
  49522. * Stores the anisotropy values in a texture.
  49523. * rg is direction (like normal from -1 to 1)
  49524. * b is a intensity
  49525. */
  49526. texture: Nullable<BaseTexture>;
  49527. /** @hidden */
  49528. private _internalMarkAllSubMeshesAsTexturesDirty;
  49529. /** @hidden */
  49530. _markAllSubMeshesAsTexturesDirty(): void;
  49531. /**
  49532. * Instantiate a new istance of anisotropy configuration.
  49533. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49534. */
  49535. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49536. /**
  49537. * Specifies that the submesh is ready to be used.
  49538. * @param defines the list of "defines" to update.
  49539. * @param scene defines the scene the material belongs to.
  49540. * @returns - boolean indicating that the submesh is ready or not.
  49541. */
  49542. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  49543. /**
  49544. * Checks to see if a texture is used in the material.
  49545. * @param defines the list of "defines" to update.
  49546. * @param mesh the mesh we are preparing the defines for.
  49547. * @param scene defines the scene the material belongs to.
  49548. */
  49549. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  49550. /**
  49551. * Binds the material data.
  49552. * @param uniformBuffer defines the Uniform buffer to fill in.
  49553. * @param scene defines the scene the material belongs to.
  49554. * @param isFrozen defines wether the material is frozen or not.
  49555. */
  49556. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49557. /**
  49558. * Checks to see if a texture is used in the material.
  49559. * @param texture - Base texture to use.
  49560. * @returns - Boolean specifying if a texture is used in the material.
  49561. */
  49562. hasTexture(texture: BaseTexture): boolean;
  49563. /**
  49564. * Returns an array of the actively used textures.
  49565. * @param activeTextures Array of BaseTextures
  49566. */
  49567. getActiveTextures(activeTextures: BaseTexture[]): void;
  49568. /**
  49569. * Returns the animatable textures.
  49570. * @param animatables Array of animatable textures.
  49571. */
  49572. getAnimatables(animatables: IAnimatable[]): void;
  49573. /**
  49574. * Disposes the resources of the material.
  49575. * @param forceDisposeTextures - Forces the disposal of all textures.
  49576. */
  49577. dispose(forceDisposeTextures?: boolean): void;
  49578. /**
  49579. * Get the current class name of the texture useful for serialization or dynamic coding.
  49580. * @returns "PBRAnisotropicConfiguration"
  49581. */
  49582. getClassName(): string;
  49583. /**
  49584. * Add fallbacks to the effect fallbacks list.
  49585. * @param defines defines the Base texture to use.
  49586. * @param fallbacks defines the current fallback list.
  49587. * @param currentRank defines the current fallback rank.
  49588. * @returns the new fallback rank.
  49589. */
  49590. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49591. /**
  49592. * Add the required uniforms to the current list.
  49593. * @param uniforms defines the current uniform list.
  49594. */
  49595. static AddUniforms(uniforms: string[]): void;
  49596. /**
  49597. * Add the required uniforms to the current buffer.
  49598. * @param uniformBuffer defines the current uniform buffer.
  49599. */
  49600. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49601. /**
  49602. * Add the required samplers to the current list.
  49603. * @param samplers defines the current sampler list.
  49604. */
  49605. static AddSamplers(samplers: string[]): void;
  49606. /**
  49607. * Makes a duplicate of the current configuration into another one.
  49608. * @param anisotropicConfiguration define the config where to copy the info
  49609. */
  49610. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  49611. /**
  49612. * Serializes this anisotropy configuration.
  49613. * @returns - An object with the serialized config.
  49614. */
  49615. serialize(): any;
  49616. /**
  49617. * Parses a anisotropy Configuration from a serialized object.
  49618. * @param source - Serialized object.
  49619. * @param scene Defines the scene we are parsing for
  49620. * @param rootUrl Defines the rootUrl to load from
  49621. */
  49622. parse(source: any, scene: Scene, rootUrl: string): void;
  49623. }
  49624. }
  49625. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  49626. import { Scene } from "babylonjs/scene";
  49627. /**
  49628. * @hidden
  49629. */
  49630. export interface IMaterialBRDFDefines {
  49631. BRDF_V_HEIGHT_CORRELATED: boolean;
  49632. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49633. SPHERICAL_HARMONICS: boolean;
  49634. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49635. /** @hidden */
  49636. _areMiscDirty: boolean;
  49637. }
  49638. /**
  49639. * Define the code related to the BRDF parameters of the pbr material.
  49640. */
  49641. export class PBRBRDFConfiguration {
  49642. /**
  49643. * Default value used for the energy conservation.
  49644. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49645. */
  49646. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  49647. /**
  49648. * Default value used for the Smith Visibility Height Correlated mode.
  49649. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49650. */
  49651. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  49652. /**
  49653. * Default value used for the IBL diffuse part.
  49654. * This can help switching back to the polynomials mode globally which is a tiny bit
  49655. * less GPU intensive at the drawback of a lower quality.
  49656. */
  49657. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  49658. /**
  49659. * Default value used for activating energy conservation for the specular workflow.
  49660. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49661. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49662. */
  49663. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  49664. private _useEnergyConservation;
  49665. /**
  49666. * Defines if the material uses energy conservation.
  49667. */
  49668. useEnergyConservation: boolean;
  49669. private _useSmithVisibilityHeightCorrelated;
  49670. /**
  49671. * LEGACY Mode set to false
  49672. * Defines if the material uses height smith correlated visibility term.
  49673. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  49674. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  49675. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  49676. * Not relying on height correlated will also disable energy conservation.
  49677. */
  49678. useSmithVisibilityHeightCorrelated: boolean;
  49679. private _useSphericalHarmonics;
  49680. /**
  49681. * LEGACY Mode set to false
  49682. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  49683. * diffuse part of the IBL.
  49684. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  49685. * to the ground truth.
  49686. */
  49687. useSphericalHarmonics: boolean;
  49688. private _useSpecularGlossinessInputEnergyConservation;
  49689. /**
  49690. * Defines if the material uses energy conservation, when the specular workflow is active.
  49691. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49692. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49693. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  49694. */
  49695. useSpecularGlossinessInputEnergyConservation: boolean;
  49696. /** @hidden */
  49697. private _internalMarkAllSubMeshesAsMiscDirty;
  49698. /** @hidden */
  49699. _markAllSubMeshesAsMiscDirty(): void;
  49700. /**
  49701. * Instantiate a new istance of clear coat configuration.
  49702. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  49703. */
  49704. constructor(markAllSubMeshesAsMiscDirty: () => void);
  49705. /**
  49706. * Checks to see if a texture is used in the material.
  49707. * @param defines the list of "defines" to update.
  49708. */
  49709. prepareDefines(defines: IMaterialBRDFDefines): void;
  49710. /**
  49711. * Get the current class name of the texture useful for serialization or dynamic coding.
  49712. * @returns "PBRClearCoatConfiguration"
  49713. */
  49714. getClassName(): string;
  49715. /**
  49716. * Makes a duplicate of the current configuration into another one.
  49717. * @param brdfConfiguration define the config where to copy the info
  49718. */
  49719. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  49720. /**
  49721. * Serializes this BRDF configuration.
  49722. * @returns - An object with the serialized config.
  49723. */
  49724. serialize(): any;
  49725. /**
  49726. * Parses a anisotropy Configuration from a serialized object.
  49727. * @param source - Serialized object.
  49728. * @param scene Defines the scene we are parsing for
  49729. * @param rootUrl Defines the rootUrl to load from
  49730. */
  49731. parse(source: any, scene: Scene, rootUrl: string): void;
  49732. }
  49733. }
  49734. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  49735. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49736. import { Color3 } from "babylonjs/Maths/math.color";
  49737. import { Scene } from "babylonjs/scene";
  49738. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49739. import { Nullable } from "babylonjs/types";
  49740. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49741. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49742. /**
  49743. * @hidden
  49744. */
  49745. export interface IMaterialSheenDefines {
  49746. SHEEN: boolean;
  49747. SHEEN_TEXTURE: boolean;
  49748. SHEEN_TEXTUREDIRECTUV: number;
  49749. SHEEN_LINKWITHALBEDO: boolean;
  49750. /** @hidden */
  49751. _areTexturesDirty: boolean;
  49752. }
  49753. /**
  49754. * Define the code related to the Sheen parameters of the pbr material.
  49755. */
  49756. export class PBRSheenConfiguration {
  49757. private _isEnabled;
  49758. /**
  49759. * Defines if the material uses sheen.
  49760. */
  49761. isEnabled: boolean;
  49762. private _linkSheenWithAlbedo;
  49763. /**
  49764. * Defines if the sheen is linked to the sheen color.
  49765. */
  49766. linkSheenWithAlbedo: boolean;
  49767. /**
  49768. * Defines the sheen intensity.
  49769. */
  49770. intensity: number;
  49771. /**
  49772. * Defines the sheen color.
  49773. */
  49774. color: Color3;
  49775. private _texture;
  49776. /**
  49777. * Stores the sheen tint values in a texture.
  49778. * rgb is tint
  49779. * a is a intensity
  49780. */
  49781. texture: Nullable<BaseTexture>;
  49782. /** @hidden */
  49783. private _internalMarkAllSubMeshesAsTexturesDirty;
  49784. /** @hidden */
  49785. _markAllSubMeshesAsTexturesDirty(): void;
  49786. /**
  49787. * Instantiate a new istance of clear coat configuration.
  49788. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49789. */
  49790. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49791. /**
  49792. * Specifies that the submesh is ready to be used.
  49793. * @param defines the list of "defines" to update.
  49794. * @param scene defines the scene the material belongs to.
  49795. * @returns - boolean indicating that the submesh is ready or not.
  49796. */
  49797. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  49798. /**
  49799. * Checks to see if a texture is used in the material.
  49800. * @param defines the list of "defines" to update.
  49801. * @param scene defines the scene the material belongs to.
  49802. */
  49803. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  49804. /**
  49805. * Binds the material data.
  49806. * @param uniformBuffer defines the Uniform buffer to fill in.
  49807. * @param scene defines the scene the material belongs to.
  49808. * @param isFrozen defines wether the material is frozen or not.
  49809. */
  49810. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49811. /**
  49812. * Checks to see if a texture is used in the material.
  49813. * @param texture - Base texture to use.
  49814. * @returns - Boolean specifying if a texture is used in the material.
  49815. */
  49816. hasTexture(texture: BaseTexture): boolean;
  49817. /**
  49818. * Returns an array of the actively used textures.
  49819. * @param activeTextures Array of BaseTextures
  49820. */
  49821. getActiveTextures(activeTextures: BaseTexture[]): void;
  49822. /**
  49823. * Returns the animatable textures.
  49824. * @param animatables Array of animatable textures.
  49825. */
  49826. getAnimatables(animatables: IAnimatable[]): void;
  49827. /**
  49828. * Disposes the resources of the material.
  49829. * @param forceDisposeTextures - Forces the disposal of all textures.
  49830. */
  49831. dispose(forceDisposeTextures?: boolean): void;
  49832. /**
  49833. * Get the current class name of the texture useful for serialization or dynamic coding.
  49834. * @returns "PBRSheenConfiguration"
  49835. */
  49836. getClassName(): string;
  49837. /**
  49838. * Add fallbacks to the effect fallbacks list.
  49839. * @param defines defines the Base texture to use.
  49840. * @param fallbacks defines the current fallback list.
  49841. * @param currentRank defines the current fallback rank.
  49842. * @returns the new fallback rank.
  49843. */
  49844. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49845. /**
  49846. * Add the required uniforms to the current list.
  49847. * @param uniforms defines the current uniform list.
  49848. */
  49849. static AddUniforms(uniforms: string[]): void;
  49850. /**
  49851. * Add the required uniforms to the current buffer.
  49852. * @param uniformBuffer defines the current uniform buffer.
  49853. */
  49854. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49855. /**
  49856. * Add the required samplers to the current list.
  49857. * @param samplers defines the current sampler list.
  49858. */
  49859. static AddSamplers(samplers: string[]): void;
  49860. /**
  49861. * Makes a duplicate of the current configuration into another one.
  49862. * @param sheenConfiguration define the config where to copy the info
  49863. */
  49864. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  49865. /**
  49866. * Serializes this BRDF configuration.
  49867. * @returns - An object with the serialized config.
  49868. */
  49869. serialize(): any;
  49870. /**
  49871. * Parses a anisotropy Configuration from a serialized object.
  49872. * @param source - Serialized object.
  49873. * @param scene Defines the scene we are parsing for
  49874. * @param rootUrl Defines the rootUrl to load from
  49875. */
  49876. parse(source: any, scene: Scene, rootUrl: string): void;
  49877. }
  49878. }
  49879. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  49880. import { Nullable } from "babylonjs/types";
  49881. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49882. import { Color3 } from "babylonjs/Maths/math.color";
  49883. import { SmartArray } from "babylonjs/Misc/smartArray";
  49884. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49885. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  49886. import { Effect } from "babylonjs/Materials/effect";
  49887. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49888. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49889. import { Engine } from "babylonjs/Engines/engine";
  49890. import { Scene } from "babylonjs/scene";
  49891. /**
  49892. * @hidden
  49893. */
  49894. export interface IMaterialSubSurfaceDefines {
  49895. SUBSURFACE: boolean;
  49896. SS_REFRACTION: boolean;
  49897. SS_TRANSLUCENCY: boolean;
  49898. SS_SCATERRING: boolean;
  49899. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49900. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49901. SS_REFRACTIONMAP_3D: boolean;
  49902. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49903. SS_LODINREFRACTIONALPHA: boolean;
  49904. SS_GAMMAREFRACTION: boolean;
  49905. SS_RGBDREFRACTION: boolean;
  49906. SS_LINEARSPECULARREFRACTION: boolean;
  49907. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49908. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49909. /** @hidden */
  49910. _areTexturesDirty: boolean;
  49911. }
  49912. /**
  49913. * Define the code related to the sub surface parameters of the pbr material.
  49914. */
  49915. export class PBRSubSurfaceConfiguration {
  49916. private _isRefractionEnabled;
  49917. /**
  49918. * Defines if the refraction is enabled in the material.
  49919. */
  49920. isRefractionEnabled: boolean;
  49921. private _isTranslucencyEnabled;
  49922. /**
  49923. * Defines if the translucency is enabled in the material.
  49924. */
  49925. isTranslucencyEnabled: boolean;
  49926. private _isScatteringEnabled;
  49927. /**
  49928. * Defines the refraction intensity of the material.
  49929. * The refraction when enabled replaces the Diffuse part of the material.
  49930. * The intensity helps transitionning between diffuse and refraction.
  49931. */
  49932. refractionIntensity: number;
  49933. /**
  49934. * Defines the translucency intensity of the material.
  49935. * When translucency has been enabled, this defines how much of the "translucency"
  49936. * is addded to the diffuse part of the material.
  49937. */
  49938. translucencyIntensity: number;
  49939. /**
  49940. * Defines the scattering intensity of the material.
  49941. * When scattering has been enabled, this defines how much of the "scattered light"
  49942. * is addded to the diffuse part of the material.
  49943. */
  49944. scatteringIntensity: number;
  49945. private _thicknessTexture;
  49946. /**
  49947. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  49948. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  49949. * 0 would mean minimumThickness
  49950. * 1 would mean maximumThickness
  49951. * The other channels might be use as a mask to vary the different effects intensity.
  49952. */
  49953. thicknessTexture: Nullable<BaseTexture>;
  49954. private _refractionTexture;
  49955. /**
  49956. * Defines the texture to use for refraction.
  49957. */
  49958. refractionTexture: Nullable<BaseTexture>;
  49959. private _indexOfRefraction;
  49960. /**
  49961. * Defines the index of refraction used in the material.
  49962. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  49963. */
  49964. indexOfRefraction: number;
  49965. private _invertRefractionY;
  49966. /**
  49967. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49968. */
  49969. invertRefractionY: boolean;
  49970. private _linkRefractionWithTransparency;
  49971. /**
  49972. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49973. * Materials half opaque for instance using refraction could benefit from this control.
  49974. */
  49975. linkRefractionWithTransparency: boolean;
  49976. /**
  49977. * Defines the minimum thickness stored in the thickness map.
  49978. * If no thickness map is defined, this value will be used to simulate thickness.
  49979. */
  49980. minimumThickness: number;
  49981. /**
  49982. * Defines the maximum thickness stored in the thickness map.
  49983. */
  49984. maximumThickness: number;
  49985. /**
  49986. * Defines the volume tint of the material.
  49987. * This is used for both translucency and scattering.
  49988. */
  49989. tintColor: Color3;
  49990. /**
  49991. * Defines the distance at which the tint color should be found in the media.
  49992. * This is used for refraction only.
  49993. */
  49994. tintColorAtDistance: number;
  49995. /**
  49996. * Defines how far each channel transmit through the media.
  49997. * It is defined as a color to simplify it selection.
  49998. */
  49999. diffusionDistance: Color3;
  50000. private _useMaskFromThicknessTexture;
  50001. /**
  50002. * Stores the intensity of the different subsurface effects in the thickness texture.
  50003. * * the green channel is the translucency intensity.
  50004. * * the blue channel is the scattering intensity.
  50005. * * the alpha channel is the refraction intensity.
  50006. */
  50007. useMaskFromThicknessTexture: boolean;
  50008. /** @hidden */
  50009. private _internalMarkAllSubMeshesAsTexturesDirty;
  50010. /** @hidden */
  50011. _markAllSubMeshesAsTexturesDirty(): void;
  50012. /**
  50013. * Instantiate a new istance of sub surface configuration.
  50014. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  50015. */
  50016. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  50017. /**
  50018. * Gets wehter the submesh is ready to be used or not.
  50019. * @param defines the list of "defines" to update.
  50020. * @param scene defines the scene the material belongs to.
  50021. * @returns - boolean indicating that the submesh is ready or not.
  50022. */
  50023. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  50024. /**
  50025. * Checks to see if a texture is used in the material.
  50026. * @param defines the list of "defines" to update.
  50027. * @param scene defines the scene to the material belongs to.
  50028. */
  50029. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  50030. /**
  50031. * Binds the material data.
  50032. * @param uniformBuffer defines the Uniform buffer to fill in.
  50033. * @param scene defines the scene the material belongs to.
  50034. * @param engine defines the engine the material belongs to.
  50035. * @param isFrozen defines wether the material is frozen or not.
  50036. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  50037. */
  50038. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  50039. /**
  50040. * Unbinds the material from the mesh.
  50041. * @param activeEffect defines the effect that should be unbound from.
  50042. * @returns true if unbound, otherwise false
  50043. */
  50044. unbind(activeEffect: Effect): boolean;
  50045. /**
  50046. * Returns the texture used for refraction or null if none is used.
  50047. * @param scene defines the scene the material belongs to.
  50048. * @returns - Refraction texture if present. If no refraction texture and refraction
  50049. * is linked with transparency, returns environment texture. Otherwise, returns null.
  50050. */
  50051. private _getRefractionTexture;
  50052. /**
  50053. * Returns true if alpha blending should be disabled.
  50054. */
  50055. readonly disableAlphaBlending: boolean;
  50056. /**
  50057. * Fills the list of render target textures.
  50058. * @param renderTargets the list of render targets to update
  50059. */
  50060. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  50061. /**
  50062. * Checks to see if a texture is used in the material.
  50063. * @param texture - Base texture to use.
  50064. * @returns - Boolean specifying if a texture is used in the material.
  50065. */
  50066. hasTexture(texture: BaseTexture): boolean;
  50067. /**
  50068. * Gets a boolean indicating that current material needs to register RTT
  50069. * @returns true if this uses a render target otherwise false.
  50070. */
  50071. hasRenderTargetTextures(): boolean;
  50072. /**
  50073. * Returns an array of the actively used textures.
  50074. * @param activeTextures Array of BaseTextures
  50075. */
  50076. getActiveTextures(activeTextures: BaseTexture[]): void;
  50077. /**
  50078. * Returns the animatable textures.
  50079. * @param animatables Array of animatable textures.
  50080. */
  50081. getAnimatables(animatables: IAnimatable[]): void;
  50082. /**
  50083. * Disposes the resources of the material.
  50084. * @param forceDisposeTextures - Forces the disposal of all textures.
  50085. */
  50086. dispose(forceDisposeTextures?: boolean): void;
  50087. /**
  50088. * Get the current class name of the texture useful for serialization or dynamic coding.
  50089. * @returns "PBRSubSurfaceConfiguration"
  50090. */
  50091. getClassName(): string;
  50092. /**
  50093. * Add fallbacks to the effect fallbacks list.
  50094. * @param defines defines the Base texture to use.
  50095. * @param fallbacks defines the current fallback list.
  50096. * @param currentRank defines the current fallback rank.
  50097. * @returns the new fallback rank.
  50098. */
  50099. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  50100. /**
  50101. * Add the required uniforms to the current list.
  50102. * @param uniforms defines the current uniform list.
  50103. */
  50104. static AddUniforms(uniforms: string[]): void;
  50105. /**
  50106. * Add the required samplers to the current list.
  50107. * @param samplers defines the current sampler list.
  50108. */
  50109. static AddSamplers(samplers: string[]): void;
  50110. /**
  50111. * Add the required uniforms to the current buffer.
  50112. * @param uniformBuffer defines the current uniform buffer.
  50113. */
  50114. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  50115. /**
  50116. * Makes a duplicate of the current configuration into another one.
  50117. * @param configuration define the config where to copy the info
  50118. */
  50119. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  50120. /**
  50121. * Serializes this Sub Surface configuration.
  50122. * @returns - An object with the serialized config.
  50123. */
  50124. serialize(): any;
  50125. /**
  50126. * Parses a anisotropy Configuration from a serialized object.
  50127. * @param source - Serialized object.
  50128. * @param scene Defines the scene we are parsing for
  50129. * @param rootUrl Defines the rootUrl to load from
  50130. */
  50131. parse(source: any, scene: Scene, rootUrl: string): void;
  50132. }
  50133. }
  50134. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  50135. /** @hidden */
  50136. export var pbrFragmentDeclaration: {
  50137. name: string;
  50138. shader: string;
  50139. };
  50140. }
  50141. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  50142. /** @hidden */
  50143. export var pbrUboDeclaration: {
  50144. name: string;
  50145. shader: string;
  50146. };
  50147. }
  50148. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  50149. /** @hidden */
  50150. export var pbrFragmentExtraDeclaration: {
  50151. name: string;
  50152. shader: string;
  50153. };
  50154. }
  50155. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  50156. /** @hidden */
  50157. export var pbrFragmentSamplersDeclaration: {
  50158. name: string;
  50159. shader: string;
  50160. };
  50161. }
  50162. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  50163. /** @hidden */
  50164. export var pbrHelperFunctions: {
  50165. name: string;
  50166. shader: string;
  50167. };
  50168. }
  50169. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  50170. /** @hidden */
  50171. export var harmonicsFunctions: {
  50172. name: string;
  50173. shader: string;
  50174. };
  50175. }
  50176. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  50177. /** @hidden */
  50178. export var pbrDirectLightingSetupFunctions: {
  50179. name: string;
  50180. shader: string;
  50181. };
  50182. }
  50183. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  50184. /** @hidden */
  50185. export var pbrDirectLightingFalloffFunctions: {
  50186. name: string;
  50187. shader: string;
  50188. };
  50189. }
  50190. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  50191. /** @hidden */
  50192. export var pbrBRDFFunctions: {
  50193. name: string;
  50194. shader: string;
  50195. };
  50196. }
  50197. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  50198. /** @hidden */
  50199. export var pbrDirectLightingFunctions: {
  50200. name: string;
  50201. shader: string;
  50202. };
  50203. }
  50204. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  50205. /** @hidden */
  50206. export var pbrIBLFunctions: {
  50207. name: string;
  50208. shader: string;
  50209. };
  50210. }
  50211. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  50212. /** @hidden */
  50213. export var pbrDebug: {
  50214. name: string;
  50215. shader: string;
  50216. };
  50217. }
  50218. declare module "babylonjs/Shaders/pbr.fragment" {
  50219. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  50220. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  50221. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  50222. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  50223. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  50224. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  50225. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  50226. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  50227. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  50228. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  50229. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  50230. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  50231. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  50232. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  50233. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  50234. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  50235. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  50236. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  50237. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  50238. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  50239. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  50240. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  50241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  50242. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  50243. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  50244. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  50245. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  50246. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  50247. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  50248. /** @hidden */
  50249. export var pbrPixelShader: {
  50250. name: string;
  50251. shader: string;
  50252. };
  50253. }
  50254. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  50255. /** @hidden */
  50256. export var pbrVertexDeclaration: {
  50257. name: string;
  50258. shader: string;
  50259. };
  50260. }
  50261. declare module "babylonjs/Shaders/pbr.vertex" {
  50262. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  50263. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  50264. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  50265. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  50266. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  50267. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  50268. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  50269. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  50270. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  50271. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  50272. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  50273. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  50274. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  50275. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  50276. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  50277. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  50278. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  50279. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  50280. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  50281. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  50282. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  50283. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  50284. /** @hidden */
  50285. export var pbrVertexShader: {
  50286. name: string;
  50287. shader: string;
  50288. };
  50289. }
  50290. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  50291. import { Nullable } from "babylonjs/types";
  50292. import { Scene } from "babylonjs/scene";
  50293. import { Matrix } from "babylonjs/Maths/math.vector";
  50294. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50295. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50296. import { Mesh } from "babylonjs/Meshes/mesh";
  50297. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  50298. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  50299. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  50300. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  50301. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  50302. import { Color3 } from "babylonjs/Maths/math.color";
  50303. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  50304. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  50305. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  50306. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  50307. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50308. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  50309. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  50310. import "babylonjs/Shaders/pbr.fragment";
  50311. import "babylonjs/Shaders/pbr.vertex";
  50312. /**
  50313. * Manages the defines for the PBR Material.
  50314. * @hidden
  50315. */
  50316. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  50317. PBR: boolean;
  50318. MAINUV1: boolean;
  50319. MAINUV2: boolean;
  50320. UV1: boolean;
  50321. UV2: boolean;
  50322. ALBEDO: boolean;
  50323. ALBEDODIRECTUV: number;
  50324. VERTEXCOLOR: boolean;
  50325. AMBIENT: boolean;
  50326. AMBIENTDIRECTUV: number;
  50327. AMBIENTINGRAYSCALE: boolean;
  50328. OPACITY: boolean;
  50329. VERTEXALPHA: boolean;
  50330. OPACITYDIRECTUV: number;
  50331. OPACITYRGB: boolean;
  50332. ALPHATEST: boolean;
  50333. DEPTHPREPASS: boolean;
  50334. ALPHABLEND: boolean;
  50335. ALPHAFROMALBEDO: boolean;
  50336. ALPHATESTVALUE: string;
  50337. SPECULAROVERALPHA: boolean;
  50338. RADIANCEOVERALPHA: boolean;
  50339. ALPHAFRESNEL: boolean;
  50340. LINEARALPHAFRESNEL: boolean;
  50341. PREMULTIPLYALPHA: boolean;
  50342. EMISSIVE: boolean;
  50343. EMISSIVEDIRECTUV: number;
  50344. REFLECTIVITY: boolean;
  50345. REFLECTIVITYDIRECTUV: number;
  50346. SPECULARTERM: boolean;
  50347. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  50348. MICROSURFACEAUTOMATIC: boolean;
  50349. LODBASEDMICROSFURACE: boolean;
  50350. MICROSURFACEMAP: boolean;
  50351. MICROSURFACEMAPDIRECTUV: number;
  50352. METALLICWORKFLOW: boolean;
  50353. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  50354. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  50355. METALLNESSSTOREINMETALMAPBLUE: boolean;
  50356. AOSTOREINMETALMAPRED: boolean;
  50357. METALLICF0FACTORFROMMETALLICMAP: boolean;
  50358. ENVIRONMENTBRDF: boolean;
  50359. ENVIRONMENTBRDF_RGBD: boolean;
  50360. NORMAL: boolean;
  50361. TANGENT: boolean;
  50362. BUMP: boolean;
  50363. BUMPDIRECTUV: number;
  50364. OBJECTSPACE_NORMALMAP: boolean;
  50365. PARALLAX: boolean;
  50366. PARALLAXOCCLUSION: boolean;
  50367. NORMALXYSCALE: boolean;
  50368. LIGHTMAP: boolean;
  50369. LIGHTMAPDIRECTUV: number;
  50370. USELIGHTMAPASSHADOWMAP: boolean;
  50371. GAMMALIGHTMAP: boolean;
  50372. RGBDLIGHTMAP: boolean;
  50373. REFLECTION: boolean;
  50374. REFLECTIONMAP_3D: boolean;
  50375. REFLECTIONMAP_SPHERICAL: boolean;
  50376. REFLECTIONMAP_PLANAR: boolean;
  50377. REFLECTIONMAP_CUBIC: boolean;
  50378. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  50379. REFLECTIONMAP_PROJECTION: boolean;
  50380. REFLECTIONMAP_SKYBOX: boolean;
  50381. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  50382. REFLECTIONMAP_EXPLICIT: boolean;
  50383. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  50384. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  50385. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  50386. INVERTCUBICMAP: boolean;
  50387. USESPHERICALFROMREFLECTIONMAP: boolean;
  50388. USEIRRADIANCEMAP: boolean;
  50389. SPHERICAL_HARMONICS: boolean;
  50390. USESPHERICALINVERTEX: boolean;
  50391. REFLECTIONMAP_OPPOSITEZ: boolean;
  50392. LODINREFLECTIONALPHA: boolean;
  50393. GAMMAREFLECTION: boolean;
  50394. RGBDREFLECTION: boolean;
  50395. LINEARSPECULARREFLECTION: boolean;
  50396. RADIANCEOCCLUSION: boolean;
  50397. HORIZONOCCLUSION: boolean;
  50398. INSTANCES: boolean;
  50399. NUM_BONE_INFLUENCERS: number;
  50400. BonesPerMesh: number;
  50401. BONETEXTURE: boolean;
  50402. NONUNIFORMSCALING: boolean;
  50403. MORPHTARGETS: boolean;
  50404. MORPHTARGETS_NORMAL: boolean;
  50405. MORPHTARGETS_TANGENT: boolean;
  50406. MORPHTARGETS_UV: boolean;
  50407. NUM_MORPH_INFLUENCERS: number;
  50408. IMAGEPROCESSING: boolean;
  50409. VIGNETTE: boolean;
  50410. VIGNETTEBLENDMODEMULTIPLY: boolean;
  50411. VIGNETTEBLENDMODEOPAQUE: boolean;
  50412. TONEMAPPING: boolean;
  50413. TONEMAPPING_ACES: boolean;
  50414. CONTRAST: boolean;
  50415. COLORCURVES: boolean;
  50416. COLORGRADING: boolean;
  50417. COLORGRADING3D: boolean;
  50418. SAMPLER3DGREENDEPTH: boolean;
  50419. SAMPLER3DBGRMAP: boolean;
  50420. IMAGEPROCESSINGPOSTPROCESS: boolean;
  50421. EXPOSURE: boolean;
  50422. MULTIVIEW: boolean;
  50423. USEPHYSICALLIGHTFALLOFF: boolean;
  50424. USEGLTFLIGHTFALLOFF: boolean;
  50425. TWOSIDEDLIGHTING: boolean;
  50426. SHADOWFLOAT: boolean;
  50427. CLIPPLANE: boolean;
  50428. CLIPPLANE2: boolean;
  50429. CLIPPLANE3: boolean;
  50430. CLIPPLANE4: boolean;
  50431. POINTSIZE: boolean;
  50432. FOG: boolean;
  50433. LOGARITHMICDEPTH: boolean;
  50434. FORCENORMALFORWARD: boolean;
  50435. SPECULARAA: boolean;
  50436. CLEARCOAT: boolean;
  50437. CLEARCOAT_DEFAULTIOR: boolean;
  50438. CLEARCOAT_TEXTURE: boolean;
  50439. CLEARCOAT_TEXTUREDIRECTUV: number;
  50440. CLEARCOAT_BUMP: boolean;
  50441. CLEARCOAT_BUMPDIRECTUV: number;
  50442. CLEARCOAT_TINT: boolean;
  50443. CLEARCOAT_TINT_TEXTURE: boolean;
  50444. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  50445. ANISOTROPIC: boolean;
  50446. ANISOTROPIC_TEXTURE: boolean;
  50447. ANISOTROPIC_TEXTUREDIRECTUV: number;
  50448. BRDF_V_HEIGHT_CORRELATED: boolean;
  50449. MS_BRDF_ENERGY_CONSERVATION: boolean;
  50450. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  50451. SHEEN: boolean;
  50452. SHEEN_TEXTURE: boolean;
  50453. SHEEN_TEXTUREDIRECTUV: number;
  50454. SHEEN_LINKWITHALBEDO: boolean;
  50455. SUBSURFACE: boolean;
  50456. SS_REFRACTION: boolean;
  50457. SS_TRANSLUCENCY: boolean;
  50458. SS_SCATERRING: boolean;
  50459. SS_THICKNESSANDMASK_TEXTURE: boolean;
  50460. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  50461. SS_REFRACTIONMAP_3D: boolean;
  50462. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  50463. SS_LODINREFRACTIONALPHA: boolean;
  50464. SS_GAMMAREFRACTION: boolean;
  50465. SS_RGBDREFRACTION: boolean;
  50466. SS_LINEARSPECULARREFRACTION: boolean;
  50467. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  50468. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  50469. UNLIT: boolean;
  50470. DEBUGMODE: number;
  50471. /**
  50472. * Initializes the PBR Material defines.
  50473. */
  50474. constructor();
  50475. /**
  50476. * Resets the PBR Material defines.
  50477. */
  50478. reset(): void;
  50479. }
  50480. /**
  50481. * The Physically based material base class of BJS.
  50482. *
  50483. * This offers the main features of a standard PBR material.
  50484. * For more information, please refer to the documentation :
  50485. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50486. */
  50487. export abstract class PBRBaseMaterial extends PushMaterial {
  50488. /**
  50489. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50490. */
  50491. static readonly PBRMATERIAL_OPAQUE: number;
  50492. /**
  50493. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50494. */
  50495. static readonly PBRMATERIAL_ALPHATEST: number;
  50496. /**
  50497. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50498. */
  50499. static readonly PBRMATERIAL_ALPHABLEND: number;
  50500. /**
  50501. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50502. * They are also discarded below the alpha cutoff threshold to improve performances.
  50503. */
  50504. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50505. /**
  50506. * Defines the default value of how much AO map is occluding the analytical lights
  50507. * (point spot...).
  50508. */
  50509. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50510. /**
  50511. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  50512. */
  50513. static readonly LIGHTFALLOFF_PHYSICAL: number;
  50514. /**
  50515. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  50516. * to enhance interoperability with other engines.
  50517. */
  50518. static readonly LIGHTFALLOFF_GLTF: number;
  50519. /**
  50520. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  50521. * to enhance interoperability with other materials.
  50522. */
  50523. static readonly LIGHTFALLOFF_STANDARD: number;
  50524. /**
  50525. * Intensity of the direct lights e.g. the four lights available in your scene.
  50526. * This impacts both the direct diffuse and specular highlights.
  50527. */
  50528. protected _directIntensity: number;
  50529. /**
  50530. * Intensity of the emissive part of the material.
  50531. * This helps controlling the emissive effect without modifying the emissive color.
  50532. */
  50533. protected _emissiveIntensity: number;
  50534. /**
  50535. * Intensity of the environment e.g. how much the environment will light the object
  50536. * either through harmonics for rough material or through the refelction for shiny ones.
  50537. */
  50538. protected _environmentIntensity: number;
  50539. /**
  50540. * This is a special control allowing the reduction of the specular highlights coming from the
  50541. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50542. */
  50543. protected _specularIntensity: number;
  50544. /**
  50545. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  50546. */
  50547. private _lightingInfos;
  50548. /**
  50549. * Debug Control allowing disabling the bump map on this material.
  50550. */
  50551. protected _disableBumpMap: boolean;
  50552. /**
  50553. * AKA Diffuse Texture in standard nomenclature.
  50554. */
  50555. protected _albedoTexture: Nullable<BaseTexture>;
  50556. /**
  50557. * AKA Occlusion Texture in other nomenclature.
  50558. */
  50559. protected _ambientTexture: Nullable<BaseTexture>;
  50560. /**
  50561. * AKA Occlusion Texture Intensity in other nomenclature.
  50562. */
  50563. protected _ambientTextureStrength: number;
  50564. /**
  50565. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50566. * 1 means it completely occludes it
  50567. * 0 mean it has no impact
  50568. */
  50569. protected _ambientTextureImpactOnAnalyticalLights: number;
  50570. /**
  50571. * Stores the alpha values in a texture.
  50572. */
  50573. protected _opacityTexture: Nullable<BaseTexture>;
  50574. /**
  50575. * Stores the reflection values in a texture.
  50576. */
  50577. protected _reflectionTexture: Nullable<BaseTexture>;
  50578. /**
  50579. * Stores the emissive values in a texture.
  50580. */
  50581. protected _emissiveTexture: Nullable<BaseTexture>;
  50582. /**
  50583. * AKA Specular texture in other nomenclature.
  50584. */
  50585. protected _reflectivityTexture: Nullable<BaseTexture>;
  50586. /**
  50587. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50588. */
  50589. protected _metallicTexture: Nullable<BaseTexture>;
  50590. /**
  50591. * Specifies the metallic scalar of the metallic/roughness workflow.
  50592. * Can also be used to scale the metalness values of the metallic texture.
  50593. */
  50594. protected _metallic: Nullable<number>;
  50595. /**
  50596. * Specifies the roughness scalar of the metallic/roughness workflow.
  50597. * Can also be used to scale the roughness values of the metallic texture.
  50598. */
  50599. protected _roughness: Nullable<number>;
  50600. /**
  50601. * Specifies the an F0 factor to help configuring the material F0.
  50602. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  50603. * to 0.5 the previously hard coded value stays the same.
  50604. * Can also be used to scale the F0 values of the metallic texture.
  50605. */
  50606. protected _metallicF0Factor: number;
  50607. /**
  50608. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  50609. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  50610. * your expectation as it multiplies with the texture data.
  50611. */
  50612. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  50613. /**
  50614. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50615. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50616. */
  50617. protected _microSurfaceTexture: Nullable<BaseTexture>;
  50618. /**
  50619. * Stores surface normal data used to displace a mesh in a texture.
  50620. */
  50621. protected _bumpTexture: Nullable<BaseTexture>;
  50622. /**
  50623. * Stores the pre-calculated light information of a mesh in a texture.
  50624. */
  50625. protected _lightmapTexture: Nullable<BaseTexture>;
  50626. /**
  50627. * The color of a material in ambient lighting.
  50628. */
  50629. protected _ambientColor: Color3;
  50630. /**
  50631. * AKA Diffuse Color in other nomenclature.
  50632. */
  50633. protected _albedoColor: Color3;
  50634. /**
  50635. * AKA Specular Color in other nomenclature.
  50636. */
  50637. protected _reflectivityColor: Color3;
  50638. /**
  50639. * The color applied when light is reflected from a material.
  50640. */
  50641. protected _reflectionColor: Color3;
  50642. /**
  50643. * The color applied when light is emitted from a material.
  50644. */
  50645. protected _emissiveColor: Color3;
  50646. /**
  50647. * AKA Glossiness in other nomenclature.
  50648. */
  50649. protected _microSurface: number;
  50650. /**
  50651. * Specifies that the material will use the light map as a show map.
  50652. */
  50653. protected _useLightmapAsShadowmap: boolean;
  50654. /**
  50655. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50656. * makes the reflect vector face the model (under horizon).
  50657. */
  50658. protected _useHorizonOcclusion: boolean;
  50659. /**
  50660. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50661. * too much the area relying on ambient texture to define their ambient occlusion.
  50662. */
  50663. protected _useRadianceOcclusion: boolean;
  50664. /**
  50665. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50666. */
  50667. protected _useAlphaFromAlbedoTexture: boolean;
  50668. /**
  50669. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  50670. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50671. */
  50672. protected _useSpecularOverAlpha: boolean;
  50673. /**
  50674. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50675. */
  50676. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50677. /**
  50678. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50679. */
  50680. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  50681. /**
  50682. * Specifies if the metallic texture contains the roughness information in its green channel.
  50683. */
  50684. protected _useRoughnessFromMetallicTextureGreen: boolean;
  50685. /**
  50686. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50687. */
  50688. protected _useMetallnessFromMetallicTextureBlue: boolean;
  50689. /**
  50690. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50691. */
  50692. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  50693. /**
  50694. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50695. */
  50696. protected _useAmbientInGrayScale: boolean;
  50697. /**
  50698. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50699. * The material will try to infer what glossiness each pixel should be.
  50700. */
  50701. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  50702. /**
  50703. * Defines the falloff type used in this material.
  50704. * It by default is Physical.
  50705. */
  50706. protected _lightFalloff: number;
  50707. /**
  50708. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50709. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50710. */
  50711. protected _useRadianceOverAlpha: boolean;
  50712. /**
  50713. * Allows using an object space normal map (instead of tangent space).
  50714. */
  50715. protected _useObjectSpaceNormalMap: boolean;
  50716. /**
  50717. * Allows using the bump map in parallax mode.
  50718. */
  50719. protected _useParallax: boolean;
  50720. /**
  50721. * Allows using the bump map in parallax occlusion mode.
  50722. */
  50723. protected _useParallaxOcclusion: boolean;
  50724. /**
  50725. * Controls the scale bias of the parallax mode.
  50726. */
  50727. protected _parallaxScaleBias: number;
  50728. /**
  50729. * If sets to true, disables all the lights affecting the material.
  50730. */
  50731. protected _disableLighting: boolean;
  50732. /**
  50733. * Number of Simultaneous lights allowed on the material.
  50734. */
  50735. protected _maxSimultaneousLights: number;
  50736. /**
  50737. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  50738. */
  50739. protected _invertNormalMapX: boolean;
  50740. /**
  50741. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  50742. */
  50743. protected _invertNormalMapY: boolean;
  50744. /**
  50745. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50746. */
  50747. protected _twoSidedLighting: boolean;
  50748. /**
  50749. * Defines the alpha limits in alpha test mode.
  50750. */
  50751. protected _alphaCutOff: number;
  50752. /**
  50753. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50754. */
  50755. protected _forceAlphaTest: boolean;
  50756. /**
  50757. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50758. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50759. */
  50760. protected _useAlphaFresnel: boolean;
  50761. /**
  50762. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50763. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50764. */
  50765. protected _useLinearAlphaFresnel: boolean;
  50766. /**
  50767. * The transparency mode of the material.
  50768. */
  50769. protected _transparencyMode: Nullable<number>;
  50770. /**
  50771. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  50772. * from cos thetav and roughness:
  50773. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  50774. */
  50775. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  50776. /**
  50777. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50778. */
  50779. protected _forceIrradianceInFragment: boolean;
  50780. /**
  50781. * Force normal to face away from face.
  50782. */
  50783. protected _forceNormalForward: boolean;
  50784. /**
  50785. * Enables specular anti aliasing in the PBR shader.
  50786. * It will both interacts on the Geometry for analytical and IBL lighting.
  50787. * It also prefilter the roughness map based on the bump values.
  50788. */
  50789. protected _enableSpecularAntiAliasing: boolean;
  50790. /**
  50791. * Default configuration related to image processing available in the PBR Material.
  50792. */
  50793. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  50794. /**
  50795. * Keep track of the image processing observer to allow dispose and replace.
  50796. */
  50797. private _imageProcessingObserver;
  50798. /**
  50799. * Attaches a new image processing configuration to the PBR Material.
  50800. * @param configuration
  50801. */
  50802. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  50803. /**
  50804. * Stores the available render targets.
  50805. */
  50806. private _renderTargets;
  50807. /**
  50808. * Sets the global ambient color for the material used in lighting calculations.
  50809. */
  50810. private _globalAmbientColor;
  50811. /**
  50812. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  50813. */
  50814. private _useLogarithmicDepth;
  50815. /**
  50816. * If set to true, no lighting calculations will be applied.
  50817. */
  50818. private _unlit;
  50819. private _debugMode;
  50820. /**
  50821. * @hidden
  50822. * This is reserved for the inspector.
  50823. * Defines the material debug mode.
  50824. * It helps seeing only some components of the material while troubleshooting.
  50825. */
  50826. debugMode: number;
  50827. /**
  50828. * @hidden
  50829. * This is reserved for the inspector.
  50830. * Specify from where on screen the debug mode should start.
  50831. * The value goes from -1 (full screen) to 1 (not visible)
  50832. * It helps with side by side comparison against the final render
  50833. * This defaults to -1
  50834. */
  50835. private debugLimit;
  50836. /**
  50837. * @hidden
  50838. * This is reserved for the inspector.
  50839. * As the default viewing range might not be enough (if the ambient is really small for instance)
  50840. * You can use the factor to better multiply the final value.
  50841. */
  50842. private debugFactor;
  50843. /**
  50844. * Defines the clear coat layer parameters for the material.
  50845. */
  50846. readonly clearCoat: PBRClearCoatConfiguration;
  50847. /**
  50848. * Defines the anisotropic parameters for the material.
  50849. */
  50850. readonly anisotropy: PBRAnisotropicConfiguration;
  50851. /**
  50852. * Defines the BRDF parameters for the material.
  50853. */
  50854. readonly brdf: PBRBRDFConfiguration;
  50855. /**
  50856. * Defines the Sheen parameters for the material.
  50857. */
  50858. readonly sheen: PBRSheenConfiguration;
  50859. /**
  50860. * Defines the SubSurface parameters for the material.
  50861. */
  50862. readonly subSurface: PBRSubSurfaceConfiguration;
  50863. /**
  50864. * Custom callback helping to override the default shader used in the material.
  50865. */
  50866. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  50867. protected _rebuildInParallel: boolean;
  50868. /**
  50869. * Instantiates a new PBRMaterial instance.
  50870. *
  50871. * @param name The material name
  50872. * @param scene The scene the material will be use in.
  50873. */
  50874. constructor(name: string, scene: Scene);
  50875. /**
  50876. * Gets a boolean indicating that current material needs to register RTT
  50877. */
  50878. readonly hasRenderTargetTextures: boolean;
  50879. /**
  50880. * Gets the name of the material class.
  50881. */
  50882. getClassName(): string;
  50883. /**
  50884. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50885. */
  50886. /**
  50887. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50888. */
  50889. useLogarithmicDepth: boolean;
  50890. /**
  50891. * Gets the current transparency mode.
  50892. */
  50893. /**
  50894. * Sets the transparency mode of the material.
  50895. *
  50896. * | Value | Type | Description |
  50897. * | ----- | ----------------------------------- | ----------- |
  50898. * | 0 | OPAQUE | |
  50899. * | 1 | ALPHATEST | |
  50900. * | 2 | ALPHABLEND | |
  50901. * | 3 | ALPHATESTANDBLEND | |
  50902. *
  50903. */
  50904. transparencyMode: Nullable<number>;
  50905. /**
  50906. * Returns true if alpha blending should be disabled.
  50907. */
  50908. private readonly _disableAlphaBlending;
  50909. /**
  50910. * Specifies whether or not this material should be rendered in alpha blend mode.
  50911. */
  50912. needAlphaBlending(): boolean;
  50913. /**
  50914. * Specifies if the mesh will require alpha blending.
  50915. * @param mesh - BJS mesh.
  50916. */
  50917. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  50918. /**
  50919. * Specifies whether or not this material should be rendered in alpha test mode.
  50920. */
  50921. needAlphaTesting(): boolean;
  50922. /**
  50923. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  50924. */
  50925. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  50926. /**
  50927. * Gets the texture used for the alpha test.
  50928. */
  50929. getAlphaTestTexture(): Nullable<BaseTexture>;
  50930. /**
  50931. * Specifies that the submesh is ready to be used.
  50932. * @param mesh - BJS mesh.
  50933. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  50934. * @param useInstances - Specifies that instances should be used.
  50935. * @returns - boolean indicating that the submesh is ready or not.
  50936. */
  50937. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  50938. /**
  50939. * Specifies if the material uses metallic roughness workflow.
  50940. * @returns boolean specifiying if the material uses metallic roughness workflow.
  50941. */
  50942. isMetallicWorkflow(): boolean;
  50943. private _prepareEffect;
  50944. private _prepareDefines;
  50945. /**
  50946. * Force shader compilation
  50947. */
  50948. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  50949. /**
  50950. * Initializes the uniform buffer layout for the shader.
  50951. */
  50952. buildUniformLayout(): void;
  50953. /**
  50954. * Unbinds the material from the mesh
  50955. */
  50956. unbind(): void;
  50957. /**
  50958. * Binds the submesh data.
  50959. * @param world - The world matrix.
  50960. * @param mesh - The BJS mesh.
  50961. * @param subMesh - A submesh of the BJS mesh.
  50962. */
  50963. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  50964. /**
  50965. * Returns the animatable textures.
  50966. * @returns - Array of animatable textures.
  50967. */
  50968. getAnimatables(): IAnimatable[];
  50969. /**
  50970. * Returns the texture used for reflections.
  50971. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  50972. */
  50973. private _getReflectionTexture;
  50974. /**
  50975. * Returns an array of the actively used textures.
  50976. * @returns - Array of BaseTextures
  50977. */
  50978. getActiveTextures(): BaseTexture[];
  50979. /**
  50980. * Checks to see if a texture is used in the material.
  50981. * @param texture - Base texture to use.
  50982. * @returns - Boolean specifying if a texture is used in the material.
  50983. */
  50984. hasTexture(texture: BaseTexture): boolean;
  50985. /**
  50986. * Disposes the resources of the material.
  50987. * @param forceDisposeEffect - Forces the disposal of effects.
  50988. * @param forceDisposeTextures - Forces the disposal of all textures.
  50989. */
  50990. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  50991. }
  50992. }
  50993. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  50994. import { Nullable } from "babylonjs/types";
  50995. import { Scene } from "babylonjs/scene";
  50996. import { Color3 } from "babylonjs/Maths/math.color";
  50997. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  50998. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  50999. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51000. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  51001. /**
  51002. * The Physically based material of BJS.
  51003. *
  51004. * This offers the main features of a standard PBR material.
  51005. * For more information, please refer to the documentation :
  51006. * https://doc.babylonjs.com/how_to/physically_based_rendering
  51007. */
  51008. export class PBRMaterial extends PBRBaseMaterial {
  51009. /**
  51010. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  51011. */
  51012. static readonly PBRMATERIAL_OPAQUE: number;
  51013. /**
  51014. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  51015. */
  51016. static readonly PBRMATERIAL_ALPHATEST: number;
  51017. /**
  51018. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  51019. */
  51020. static readonly PBRMATERIAL_ALPHABLEND: number;
  51021. /**
  51022. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  51023. * They are also discarded below the alpha cutoff threshold to improve performances.
  51024. */
  51025. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  51026. /**
  51027. * Defines the default value of how much AO map is occluding the analytical lights
  51028. * (point spot...).
  51029. */
  51030. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  51031. /**
  51032. * Intensity of the direct lights e.g. the four lights available in your scene.
  51033. * This impacts both the direct diffuse and specular highlights.
  51034. */
  51035. directIntensity: number;
  51036. /**
  51037. * Intensity of the emissive part of the material.
  51038. * This helps controlling the emissive effect without modifying the emissive color.
  51039. */
  51040. emissiveIntensity: number;
  51041. /**
  51042. * Intensity of the environment e.g. how much the environment will light the object
  51043. * either through harmonics for rough material or through the refelction for shiny ones.
  51044. */
  51045. environmentIntensity: number;
  51046. /**
  51047. * This is a special control allowing the reduction of the specular highlights coming from the
  51048. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  51049. */
  51050. specularIntensity: number;
  51051. /**
  51052. * Debug Control allowing disabling the bump map on this material.
  51053. */
  51054. disableBumpMap: boolean;
  51055. /**
  51056. * AKA Diffuse Texture in standard nomenclature.
  51057. */
  51058. albedoTexture: BaseTexture;
  51059. /**
  51060. * AKA Occlusion Texture in other nomenclature.
  51061. */
  51062. ambientTexture: BaseTexture;
  51063. /**
  51064. * AKA Occlusion Texture Intensity in other nomenclature.
  51065. */
  51066. ambientTextureStrength: number;
  51067. /**
  51068. * Defines how much the AO map is occluding the analytical lights (point spot...).
  51069. * 1 means it completely occludes it
  51070. * 0 mean it has no impact
  51071. */
  51072. ambientTextureImpactOnAnalyticalLights: number;
  51073. /**
  51074. * Stores the alpha values in a texture.
  51075. */
  51076. opacityTexture: BaseTexture;
  51077. /**
  51078. * Stores the reflection values in a texture.
  51079. */
  51080. reflectionTexture: Nullable<BaseTexture>;
  51081. /**
  51082. * Stores the emissive values in a texture.
  51083. */
  51084. emissiveTexture: BaseTexture;
  51085. /**
  51086. * AKA Specular texture in other nomenclature.
  51087. */
  51088. reflectivityTexture: BaseTexture;
  51089. /**
  51090. * Used to switch from specular/glossiness to metallic/roughness workflow.
  51091. */
  51092. metallicTexture: BaseTexture;
  51093. /**
  51094. * Specifies the metallic scalar of the metallic/roughness workflow.
  51095. * Can also be used to scale the metalness values of the metallic texture.
  51096. */
  51097. metallic: Nullable<number>;
  51098. /**
  51099. * Specifies the roughness scalar of the metallic/roughness workflow.
  51100. * Can also be used to scale the roughness values of the metallic texture.
  51101. */
  51102. roughness: Nullable<number>;
  51103. /**
  51104. * Specifies the an F0 factor to help configuring the material F0.
  51105. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  51106. * to 0.5 the previously hard coded value stays the same.
  51107. * Can also be used to scale the F0 values of the metallic texture.
  51108. */
  51109. metallicF0Factor: number;
  51110. /**
  51111. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  51112. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  51113. * your expectation as it multiplies with the texture data.
  51114. */
  51115. useMetallicF0FactorFromMetallicTexture: boolean;
  51116. /**
  51117. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  51118. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  51119. */
  51120. microSurfaceTexture: BaseTexture;
  51121. /**
  51122. * Stores surface normal data used to displace a mesh in a texture.
  51123. */
  51124. bumpTexture: BaseTexture;
  51125. /**
  51126. * Stores the pre-calculated light information of a mesh in a texture.
  51127. */
  51128. lightmapTexture: BaseTexture;
  51129. /**
  51130. * Stores the refracted light information in a texture.
  51131. */
  51132. refractionTexture: Nullable<BaseTexture>;
  51133. /**
  51134. * The color of a material in ambient lighting.
  51135. */
  51136. ambientColor: Color3;
  51137. /**
  51138. * AKA Diffuse Color in other nomenclature.
  51139. */
  51140. albedoColor: Color3;
  51141. /**
  51142. * AKA Specular Color in other nomenclature.
  51143. */
  51144. reflectivityColor: Color3;
  51145. /**
  51146. * The color reflected from the material.
  51147. */
  51148. reflectionColor: Color3;
  51149. /**
  51150. * The color emitted from the material.
  51151. */
  51152. emissiveColor: Color3;
  51153. /**
  51154. * AKA Glossiness in other nomenclature.
  51155. */
  51156. microSurface: number;
  51157. /**
  51158. * source material index of refraction (IOR)' / 'destination material IOR.
  51159. */
  51160. indexOfRefraction: number;
  51161. /**
  51162. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  51163. */
  51164. invertRefractionY: boolean;
  51165. /**
  51166. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  51167. * Materials half opaque for instance using refraction could benefit from this control.
  51168. */
  51169. linkRefractionWithTransparency: boolean;
  51170. /**
  51171. * If true, the light map contains occlusion information instead of lighting info.
  51172. */
  51173. useLightmapAsShadowmap: boolean;
  51174. /**
  51175. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  51176. */
  51177. useAlphaFromAlbedoTexture: boolean;
  51178. /**
  51179. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  51180. */
  51181. forceAlphaTest: boolean;
  51182. /**
  51183. * Defines the alpha limits in alpha test mode.
  51184. */
  51185. alphaCutOff: number;
  51186. /**
  51187. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  51188. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  51189. */
  51190. useSpecularOverAlpha: boolean;
  51191. /**
  51192. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  51193. */
  51194. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  51195. /**
  51196. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  51197. */
  51198. useRoughnessFromMetallicTextureAlpha: boolean;
  51199. /**
  51200. * Specifies if the metallic texture contains the roughness information in its green channel.
  51201. */
  51202. useRoughnessFromMetallicTextureGreen: boolean;
  51203. /**
  51204. * Specifies if the metallic texture contains the metallness information in its blue channel.
  51205. */
  51206. useMetallnessFromMetallicTextureBlue: boolean;
  51207. /**
  51208. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  51209. */
  51210. useAmbientOcclusionFromMetallicTextureRed: boolean;
  51211. /**
  51212. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  51213. */
  51214. useAmbientInGrayScale: boolean;
  51215. /**
  51216. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  51217. * The material will try to infer what glossiness each pixel should be.
  51218. */
  51219. useAutoMicroSurfaceFromReflectivityMap: boolean;
  51220. /**
  51221. * BJS is using an harcoded light falloff based on a manually sets up range.
  51222. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  51223. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  51224. */
  51225. /**
  51226. * BJS is using an harcoded light falloff based on a manually sets up range.
  51227. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  51228. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  51229. */
  51230. usePhysicalLightFalloff: boolean;
  51231. /**
  51232. * In order to support the falloff compatibility with gltf, a special mode has been added
  51233. * to reproduce the gltf light falloff.
  51234. */
  51235. /**
  51236. * In order to support the falloff compatibility with gltf, a special mode has been added
  51237. * to reproduce the gltf light falloff.
  51238. */
  51239. useGLTFLightFalloff: boolean;
  51240. /**
  51241. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  51242. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  51243. */
  51244. useRadianceOverAlpha: boolean;
  51245. /**
  51246. * Allows using an object space normal map (instead of tangent space).
  51247. */
  51248. useObjectSpaceNormalMap: boolean;
  51249. /**
  51250. * Allows using the bump map in parallax mode.
  51251. */
  51252. useParallax: boolean;
  51253. /**
  51254. * Allows using the bump map in parallax occlusion mode.
  51255. */
  51256. useParallaxOcclusion: boolean;
  51257. /**
  51258. * Controls the scale bias of the parallax mode.
  51259. */
  51260. parallaxScaleBias: number;
  51261. /**
  51262. * If sets to true, disables all the lights affecting the material.
  51263. */
  51264. disableLighting: boolean;
  51265. /**
  51266. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  51267. */
  51268. forceIrradianceInFragment: boolean;
  51269. /**
  51270. * Number of Simultaneous lights allowed on the material.
  51271. */
  51272. maxSimultaneousLights: number;
  51273. /**
  51274. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  51275. */
  51276. invertNormalMapX: boolean;
  51277. /**
  51278. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  51279. */
  51280. invertNormalMapY: boolean;
  51281. /**
  51282. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  51283. */
  51284. twoSidedLighting: boolean;
  51285. /**
  51286. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  51287. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  51288. */
  51289. useAlphaFresnel: boolean;
  51290. /**
  51291. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  51292. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  51293. */
  51294. useLinearAlphaFresnel: boolean;
  51295. /**
  51296. * Let user defines the brdf lookup texture used for IBL.
  51297. * A default 8bit version is embedded but you could point at :
  51298. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  51299. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  51300. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  51301. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  51302. */
  51303. environmentBRDFTexture: Nullable<BaseTexture>;
  51304. /**
  51305. * Force normal to face away from face.
  51306. */
  51307. forceNormalForward: boolean;
  51308. /**
  51309. * Enables specular anti aliasing in the PBR shader.
  51310. * It will both interacts on the Geometry for analytical and IBL lighting.
  51311. * It also prefilter the roughness map based on the bump values.
  51312. */
  51313. enableSpecularAntiAliasing: boolean;
  51314. /**
  51315. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  51316. * makes the reflect vector face the model (under horizon).
  51317. */
  51318. useHorizonOcclusion: boolean;
  51319. /**
  51320. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  51321. * too much the area relying on ambient texture to define their ambient occlusion.
  51322. */
  51323. useRadianceOcclusion: boolean;
  51324. /**
  51325. * If set to true, no lighting calculations will be applied.
  51326. */
  51327. unlit: boolean;
  51328. /**
  51329. * Gets the image processing configuration used either in this material.
  51330. */
  51331. /**
  51332. * Sets the Default image processing configuration used either in the this material.
  51333. *
  51334. * If sets to null, the scene one is in use.
  51335. */
  51336. imageProcessingConfiguration: ImageProcessingConfiguration;
  51337. /**
  51338. * Gets wether the color curves effect is enabled.
  51339. */
  51340. /**
  51341. * Sets wether the color curves effect is enabled.
  51342. */
  51343. cameraColorCurvesEnabled: boolean;
  51344. /**
  51345. * Gets wether the color grading effect is enabled.
  51346. */
  51347. /**
  51348. * Gets wether the color grading effect is enabled.
  51349. */
  51350. cameraColorGradingEnabled: boolean;
  51351. /**
  51352. * Gets wether tonemapping is enabled or not.
  51353. */
  51354. /**
  51355. * Sets wether tonemapping is enabled or not
  51356. */
  51357. cameraToneMappingEnabled: boolean;
  51358. /**
  51359. * The camera exposure used on this material.
  51360. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  51361. * This corresponds to a photographic exposure.
  51362. */
  51363. /**
  51364. * The camera exposure used on this material.
  51365. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  51366. * This corresponds to a photographic exposure.
  51367. */
  51368. cameraExposure: number;
  51369. /**
  51370. * Gets The camera contrast used on this material.
  51371. */
  51372. /**
  51373. * Sets The camera contrast used on this material.
  51374. */
  51375. cameraContrast: number;
  51376. /**
  51377. * Gets the Color Grading 2D Lookup Texture.
  51378. */
  51379. /**
  51380. * Sets the Color Grading 2D Lookup Texture.
  51381. */
  51382. cameraColorGradingTexture: Nullable<BaseTexture>;
  51383. /**
  51384. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  51385. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  51386. * 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;
  51387. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  51388. */
  51389. /**
  51390. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  51391. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  51392. * 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;
  51393. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  51394. */
  51395. cameraColorCurves: Nullable<ColorCurves>;
  51396. /**
  51397. * Instantiates a new PBRMaterial instance.
  51398. *
  51399. * @param name The material name
  51400. * @param scene The scene the material will be use in.
  51401. */
  51402. constructor(name: string, scene: Scene);
  51403. /**
  51404. * Returns the name of this material class.
  51405. */
  51406. getClassName(): string;
  51407. /**
  51408. * Makes a duplicate of the current material.
  51409. * @param name - name to use for the new material.
  51410. */
  51411. clone(name: string): PBRMaterial;
  51412. /**
  51413. * Serializes this PBR Material.
  51414. * @returns - An object with the serialized material.
  51415. */
  51416. serialize(): any;
  51417. /**
  51418. * Parses a PBR Material from a serialized object.
  51419. * @param source - Serialized object.
  51420. * @param scene - BJS scene instance.
  51421. * @param rootUrl - url for the scene object
  51422. * @returns - PBRMaterial
  51423. */
  51424. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  51425. }
  51426. }
  51427. declare module "babylonjs/Misc/dds" {
  51428. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  51429. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51430. import { Nullable } from "babylonjs/types";
  51431. import { Scene } from "babylonjs/scene";
  51432. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  51433. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  51434. /**
  51435. * Direct draw surface info
  51436. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  51437. */
  51438. export interface DDSInfo {
  51439. /**
  51440. * Width of the texture
  51441. */
  51442. width: number;
  51443. /**
  51444. * Width of the texture
  51445. */
  51446. height: number;
  51447. /**
  51448. * Number of Mipmaps for the texture
  51449. * @see https://en.wikipedia.org/wiki/Mipmap
  51450. */
  51451. mipmapCount: number;
  51452. /**
  51453. * If the textures format is a known fourCC format
  51454. * @see https://www.fourcc.org/
  51455. */
  51456. isFourCC: boolean;
  51457. /**
  51458. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  51459. */
  51460. isRGB: boolean;
  51461. /**
  51462. * If the texture is a lumincance format
  51463. */
  51464. isLuminance: boolean;
  51465. /**
  51466. * If this is a cube texture
  51467. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  51468. */
  51469. isCube: boolean;
  51470. /**
  51471. * If the texture is a compressed format eg. FOURCC_DXT1
  51472. */
  51473. isCompressed: boolean;
  51474. /**
  51475. * The dxgiFormat of the texture
  51476. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  51477. */
  51478. dxgiFormat: number;
  51479. /**
  51480. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  51481. */
  51482. textureType: number;
  51483. /**
  51484. * Sphericle polynomial created for the dds texture
  51485. */
  51486. sphericalPolynomial?: SphericalPolynomial;
  51487. }
  51488. /**
  51489. * Class used to provide DDS decompression tools
  51490. */
  51491. export class DDSTools {
  51492. /**
  51493. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  51494. */
  51495. static StoreLODInAlphaChannel: boolean;
  51496. /**
  51497. * Gets DDS information from an array buffer
  51498. * @param arrayBuffer defines the array buffer to read data from
  51499. * @returns the DDS information
  51500. */
  51501. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  51502. private static _FloatView;
  51503. private static _Int32View;
  51504. private static _ToHalfFloat;
  51505. private static _FromHalfFloat;
  51506. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  51507. private static _GetHalfFloatRGBAArrayBuffer;
  51508. private static _GetFloatRGBAArrayBuffer;
  51509. private static _GetFloatAsUIntRGBAArrayBuffer;
  51510. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  51511. private static _GetRGBAArrayBuffer;
  51512. private static _ExtractLongWordOrder;
  51513. private static _GetRGBArrayBuffer;
  51514. private static _GetLuminanceArrayBuffer;
  51515. /**
  51516. * Uploads DDS Levels to a Babylon Texture
  51517. * @hidden
  51518. */
  51519. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  51520. }
  51521. module "babylonjs/Engines/thinEngine" {
  51522. interface ThinEngine {
  51523. /**
  51524. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  51525. * @param rootUrl defines the url where the file to load is located
  51526. * @param scene defines the current scene
  51527. * @param lodScale defines scale to apply to the mip map selection
  51528. * @param lodOffset defines offset to apply to the mip map selection
  51529. * @param onLoad defines an optional callback raised when the texture is loaded
  51530. * @param onError defines an optional callback raised if there is an issue to load the texture
  51531. * @param format defines the format of the data
  51532. * @param forcedExtension defines the extension to use to pick the right loader
  51533. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  51534. * @returns the cube texture as an InternalTexture
  51535. */
  51536. 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;
  51537. }
  51538. }
  51539. }
  51540. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  51541. import { Nullable } from "babylonjs/types";
  51542. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51543. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51544. /**
  51545. * Implementation of the DDS Texture Loader.
  51546. * @hidden
  51547. */
  51548. export class _DDSTextureLoader implements IInternalTextureLoader {
  51549. /**
  51550. * Defines wether the loader supports cascade loading the different faces.
  51551. */
  51552. readonly supportCascades: boolean;
  51553. /**
  51554. * This returns if the loader support the current file information.
  51555. * @param extension defines the file extension of the file being loaded
  51556. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51557. * @param fallback defines the fallback internal texture if any
  51558. * @param isBase64 defines whether the texture is encoded as a base64
  51559. * @param isBuffer defines whether the texture data are stored as a buffer
  51560. * @returns true if the loader can load the specified file
  51561. */
  51562. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51563. /**
  51564. * Transform the url before loading if required.
  51565. * @param rootUrl the url of the texture
  51566. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51567. * @returns the transformed texture
  51568. */
  51569. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51570. /**
  51571. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51572. * @param rootUrl the url of the texture
  51573. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51574. * @returns the fallback texture
  51575. */
  51576. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51577. /**
  51578. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51579. * @param data contains the texture data
  51580. * @param texture defines the BabylonJS internal texture
  51581. * @param createPolynomials will be true if polynomials have been requested
  51582. * @param onLoad defines the callback to trigger once the texture is ready
  51583. * @param onError defines the callback to trigger in case of error
  51584. */
  51585. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51586. /**
  51587. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51588. * @param data contains the texture data
  51589. * @param texture defines the BabylonJS internal texture
  51590. * @param callback defines the method to call once ready to upload
  51591. */
  51592. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51593. }
  51594. }
  51595. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  51596. import { Nullable } from "babylonjs/types";
  51597. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51598. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51599. /**
  51600. * Implementation of the ENV Texture Loader.
  51601. * @hidden
  51602. */
  51603. export class _ENVTextureLoader implements IInternalTextureLoader {
  51604. /**
  51605. * Defines wether the loader supports cascade loading the different faces.
  51606. */
  51607. readonly supportCascades: boolean;
  51608. /**
  51609. * This returns if the loader support the current file information.
  51610. * @param extension defines the file extension of the file being loaded
  51611. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51612. * @param fallback defines the fallback internal texture if any
  51613. * @param isBase64 defines whether the texture is encoded as a base64
  51614. * @param isBuffer defines whether the texture data are stored as a buffer
  51615. * @returns true if the loader can load the specified file
  51616. */
  51617. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51618. /**
  51619. * Transform the url before loading if required.
  51620. * @param rootUrl the url of the texture
  51621. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51622. * @returns the transformed texture
  51623. */
  51624. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51625. /**
  51626. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51627. * @param rootUrl the url of the texture
  51628. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51629. * @returns the fallback texture
  51630. */
  51631. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51632. /**
  51633. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51634. * @param data contains the texture data
  51635. * @param texture defines the BabylonJS internal texture
  51636. * @param createPolynomials will be true if polynomials have been requested
  51637. * @param onLoad defines the callback to trigger once the texture is ready
  51638. * @param onError defines the callback to trigger in case of error
  51639. */
  51640. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51641. /**
  51642. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51643. * @param data contains the texture data
  51644. * @param texture defines the BabylonJS internal texture
  51645. * @param callback defines the method to call once ready to upload
  51646. */
  51647. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51648. }
  51649. }
  51650. declare module "babylonjs/Misc/khronosTextureContainer" {
  51651. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51652. /**
  51653. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  51654. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  51655. */
  51656. export class KhronosTextureContainer {
  51657. /** contents of the KTX container file */
  51658. arrayBuffer: any;
  51659. private static HEADER_LEN;
  51660. private static COMPRESSED_2D;
  51661. private static COMPRESSED_3D;
  51662. private static TEX_2D;
  51663. private static TEX_3D;
  51664. /**
  51665. * Gets the openGL type
  51666. */
  51667. glType: number;
  51668. /**
  51669. * Gets the openGL type size
  51670. */
  51671. glTypeSize: number;
  51672. /**
  51673. * Gets the openGL format
  51674. */
  51675. glFormat: number;
  51676. /**
  51677. * Gets the openGL internal format
  51678. */
  51679. glInternalFormat: number;
  51680. /**
  51681. * Gets the base internal format
  51682. */
  51683. glBaseInternalFormat: number;
  51684. /**
  51685. * Gets image width in pixel
  51686. */
  51687. pixelWidth: number;
  51688. /**
  51689. * Gets image height in pixel
  51690. */
  51691. pixelHeight: number;
  51692. /**
  51693. * Gets image depth in pixels
  51694. */
  51695. pixelDepth: number;
  51696. /**
  51697. * Gets the number of array elements
  51698. */
  51699. numberOfArrayElements: number;
  51700. /**
  51701. * Gets the number of faces
  51702. */
  51703. numberOfFaces: number;
  51704. /**
  51705. * Gets the number of mipmap levels
  51706. */
  51707. numberOfMipmapLevels: number;
  51708. /**
  51709. * Gets the bytes of key value data
  51710. */
  51711. bytesOfKeyValueData: number;
  51712. /**
  51713. * Gets the load type
  51714. */
  51715. loadType: number;
  51716. /**
  51717. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  51718. */
  51719. isInvalid: boolean;
  51720. /**
  51721. * Creates a new KhronosTextureContainer
  51722. * @param arrayBuffer contents of the KTX container file
  51723. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  51724. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  51725. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  51726. */
  51727. constructor(
  51728. /** contents of the KTX container file */
  51729. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  51730. /**
  51731. * Uploads KTX content to a Babylon Texture.
  51732. * It is assumed that the texture has already been created & is currently bound
  51733. * @hidden
  51734. */
  51735. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  51736. private _upload2DCompressedLevels;
  51737. }
  51738. }
  51739. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  51740. import { Nullable } from "babylonjs/types";
  51741. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51742. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51743. /**
  51744. * Implementation of the KTX Texture Loader.
  51745. * @hidden
  51746. */
  51747. export class _KTXTextureLoader implements IInternalTextureLoader {
  51748. /**
  51749. * Defines wether the loader supports cascade loading the different faces.
  51750. */
  51751. readonly supportCascades: boolean;
  51752. /**
  51753. * This returns if the loader support the current file information.
  51754. * @param extension defines the file extension of the file being loaded
  51755. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51756. * @param fallback defines the fallback internal texture if any
  51757. * @param isBase64 defines whether the texture is encoded as a base64
  51758. * @param isBuffer defines whether the texture data are stored as a buffer
  51759. * @returns true if the loader can load the specified file
  51760. */
  51761. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51762. /**
  51763. * Transform the url before loading if required.
  51764. * @param rootUrl the url of the texture
  51765. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51766. * @returns the transformed texture
  51767. */
  51768. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51769. /**
  51770. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51771. * @param rootUrl the url of the texture
  51772. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51773. * @returns the fallback texture
  51774. */
  51775. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51776. /**
  51777. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51778. * @param data contains the texture data
  51779. * @param texture defines the BabylonJS internal texture
  51780. * @param createPolynomials will be true if polynomials have been requested
  51781. * @param onLoad defines the callback to trigger once the texture is ready
  51782. * @param onError defines the callback to trigger in case of error
  51783. */
  51784. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51785. /**
  51786. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51787. * @param data contains the texture data
  51788. * @param texture defines the BabylonJS internal texture
  51789. * @param callback defines the method to call once ready to upload
  51790. */
  51791. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  51792. }
  51793. }
  51794. declare module "babylonjs/Helpers/sceneHelpers" {
  51795. import { Nullable } from "babylonjs/types";
  51796. import { Mesh } from "babylonjs/Meshes/mesh";
  51797. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51798. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  51799. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  51800. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  51801. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  51802. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  51803. import "babylonjs/Meshes/Builders/boxBuilder";
  51804. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  51805. /** @hidden */
  51806. export var _forceSceneHelpersToBundle: boolean;
  51807. module "babylonjs/scene" {
  51808. interface Scene {
  51809. /**
  51810. * Creates a default light for the scene.
  51811. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  51812. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  51813. */
  51814. createDefaultLight(replace?: boolean): void;
  51815. /**
  51816. * Creates a default camera for the scene.
  51817. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  51818. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51819. * @param replace has default false, when true replaces the active camera in the scene
  51820. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  51821. */
  51822. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51823. /**
  51824. * Creates a default camera and a default light.
  51825. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  51826. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51827. * @param replace has the default false, when true replaces the active camera/light in the scene
  51828. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  51829. */
  51830. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51831. /**
  51832. * Creates a new sky box
  51833. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  51834. * @param environmentTexture defines the texture to use as environment texture
  51835. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  51836. * @param scale defines the overall scale of the skybox
  51837. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  51838. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  51839. * @returns a new mesh holding the sky box
  51840. */
  51841. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  51842. /**
  51843. * Creates a new environment
  51844. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  51845. * @param options defines the options you can use to configure the environment
  51846. * @returns the new EnvironmentHelper
  51847. */
  51848. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  51849. /**
  51850. * Creates a new VREXperienceHelper
  51851. * @see http://doc.babylonjs.com/how_to/webvr_helper
  51852. * @param webVROptions defines the options used to create the new VREXperienceHelper
  51853. * @returns a new VREXperienceHelper
  51854. */
  51855. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  51856. /**
  51857. * Creates a new WebXRDefaultExperience
  51858. * @see http://doc.babylonjs.com/how_to/webxr
  51859. * @param options experience options
  51860. * @returns a promise for a new WebXRDefaultExperience
  51861. */
  51862. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51863. }
  51864. }
  51865. }
  51866. declare module "babylonjs/Helpers/videoDome" {
  51867. import { Scene } from "babylonjs/scene";
  51868. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51869. import { Mesh } from "babylonjs/Meshes/mesh";
  51870. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  51871. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  51872. import "babylonjs/Meshes/Builders/sphereBuilder";
  51873. /**
  51874. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  51875. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  51876. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  51877. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  51878. */
  51879. export class VideoDome extends TransformNode {
  51880. /**
  51881. * Define the video source as a Monoscopic panoramic 360 video.
  51882. */
  51883. static readonly MODE_MONOSCOPIC: number;
  51884. /**
  51885. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51886. */
  51887. static readonly MODE_TOPBOTTOM: number;
  51888. /**
  51889. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51890. */
  51891. static readonly MODE_SIDEBYSIDE: number;
  51892. private _halfDome;
  51893. private _useDirectMapping;
  51894. /**
  51895. * The video texture being displayed on the sphere
  51896. */
  51897. protected _videoTexture: VideoTexture;
  51898. /**
  51899. * Gets the video texture being displayed on the sphere
  51900. */
  51901. readonly videoTexture: VideoTexture;
  51902. /**
  51903. * The skybox material
  51904. */
  51905. protected _material: BackgroundMaterial;
  51906. /**
  51907. * The surface used for the skybox
  51908. */
  51909. protected _mesh: Mesh;
  51910. /**
  51911. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  51912. */
  51913. private _halfDomeMask;
  51914. /**
  51915. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  51916. * Also see the options.resolution property.
  51917. */
  51918. fovMultiplier: number;
  51919. private _videoMode;
  51920. /**
  51921. * Gets or set the current video mode for the video. It can be:
  51922. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  51923. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51924. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51925. */
  51926. videoMode: number;
  51927. /**
  51928. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  51929. *
  51930. */
  51931. /**
  51932. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  51933. */
  51934. halfDome: boolean;
  51935. /**
  51936. * Oberserver used in Stereoscopic VR Mode.
  51937. */
  51938. private _onBeforeCameraRenderObserver;
  51939. /**
  51940. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  51941. * @param name Element's name, child elements will append suffixes for their own names.
  51942. * @param urlsOrVideo defines the url(s) or the video element to use
  51943. * @param options An object containing optional or exposed sub element properties
  51944. */
  51945. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  51946. resolution?: number;
  51947. clickToPlay?: boolean;
  51948. autoPlay?: boolean;
  51949. loop?: boolean;
  51950. size?: number;
  51951. poster?: string;
  51952. faceForward?: boolean;
  51953. useDirectMapping?: boolean;
  51954. halfDomeMode?: boolean;
  51955. }, scene: Scene);
  51956. private _changeVideoMode;
  51957. /**
  51958. * Releases resources associated with this node.
  51959. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  51960. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  51961. */
  51962. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  51963. }
  51964. }
  51965. declare module "babylonjs/Helpers/index" {
  51966. export * from "babylonjs/Helpers/environmentHelper";
  51967. export * from "babylonjs/Helpers/photoDome";
  51968. export * from "babylonjs/Helpers/sceneHelpers";
  51969. export * from "babylonjs/Helpers/videoDome";
  51970. }
  51971. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  51972. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51973. import { IDisposable } from "babylonjs/scene";
  51974. import { Engine } from "babylonjs/Engines/engine";
  51975. /**
  51976. * This class can be used to get instrumentation data from a Babylon engine
  51977. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51978. */
  51979. export class EngineInstrumentation implements IDisposable {
  51980. /**
  51981. * Define the instrumented engine.
  51982. */
  51983. engine: Engine;
  51984. private _captureGPUFrameTime;
  51985. private _gpuFrameTimeToken;
  51986. private _gpuFrameTime;
  51987. private _captureShaderCompilationTime;
  51988. private _shaderCompilationTime;
  51989. private _onBeginFrameObserver;
  51990. private _onEndFrameObserver;
  51991. private _onBeforeShaderCompilationObserver;
  51992. private _onAfterShaderCompilationObserver;
  51993. /**
  51994. * Gets the perf counter used for GPU frame time
  51995. */
  51996. readonly gpuFrameTimeCounter: PerfCounter;
  51997. /**
  51998. * Gets the GPU frame time capture status
  51999. */
  52000. /**
  52001. * Enable or disable the GPU frame time capture
  52002. */
  52003. captureGPUFrameTime: boolean;
  52004. /**
  52005. * Gets the perf counter used for shader compilation time
  52006. */
  52007. readonly shaderCompilationTimeCounter: PerfCounter;
  52008. /**
  52009. * Gets the shader compilation time capture status
  52010. */
  52011. /**
  52012. * Enable or disable the shader compilation time capture
  52013. */
  52014. captureShaderCompilationTime: boolean;
  52015. /**
  52016. * Instantiates a new engine instrumentation.
  52017. * This class can be used to get instrumentation data from a Babylon engine
  52018. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  52019. * @param engine Defines the engine to instrument
  52020. */
  52021. constructor(
  52022. /**
  52023. * Define the instrumented engine.
  52024. */
  52025. engine: Engine);
  52026. /**
  52027. * Dispose and release associated resources.
  52028. */
  52029. dispose(): void;
  52030. }
  52031. }
  52032. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  52033. import { Scene, IDisposable } from "babylonjs/scene";
  52034. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  52035. /**
  52036. * This class can be used to get instrumentation data from a Babylon engine
  52037. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  52038. */
  52039. export class SceneInstrumentation implements IDisposable {
  52040. /**
  52041. * Defines the scene to instrument
  52042. */
  52043. scene: Scene;
  52044. private _captureActiveMeshesEvaluationTime;
  52045. private _activeMeshesEvaluationTime;
  52046. private _captureRenderTargetsRenderTime;
  52047. private _renderTargetsRenderTime;
  52048. private _captureFrameTime;
  52049. private _frameTime;
  52050. private _captureRenderTime;
  52051. private _renderTime;
  52052. private _captureInterFrameTime;
  52053. private _interFrameTime;
  52054. private _captureParticlesRenderTime;
  52055. private _particlesRenderTime;
  52056. private _captureSpritesRenderTime;
  52057. private _spritesRenderTime;
  52058. private _capturePhysicsTime;
  52059. private _physicsTime;
  52060. private _captureAnimationsTime;
  52061. private _animationsTime;
  52062. private _captureCameraRenderTime;
  52063. private _cameraRenderTime;
  52064. private _onBeforeActiveMeshesEvaluationObserver;
  52065. private _onAfterActiveMeshesEvaluationObserver;
  52066. private _onBeforeRenderTargetsRenderObserver;
  52067. private _onAfterRenderTargetsRenderObserver;
  52068. private _onAfterRenderObserver;
  52069. private _onBeforeDrawPhaseObserver;
  52070. private _onAfterDrawPhaseObserver;
  52071. private _onBeforeAnimationsObserver;
  52072. private _onBeforeParticlesRenderingObserver;
  52073. private _onAfterParticlesRenderingObserver;
  52074. private _onBeforeSpritesRenderingObserver;
  52075. private _onAfterSpritesRenderingObserver;
  52076. private _onBeforePhysicsObserver;
  52077. private _onAfterPhysicsObserver;
  52078. private _onAfterAnimationsObserver;
  52079. private _onBeforeCameraRenderObserver;
  52080. private _onAfterCameraRenderObserver;
  52081. /**
  52082. * Gets the perf counter used for active meshes evaluation time
  52083. */
  52084. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  52085. /**
  52086. * Gets the active meshes evaluation time capture status
  52087. */
  52088. /**
  52089. * Enable or disable the active meshes evaluation time capture
  52090. */
  52091. captureActiveMeshesEvaluationTime: boolean;
  52092. /**
  52093. * Gets the perf counter used for render targets render time
  52094. */
  52095. readonly renderTargetsRenderTimeCounter: PerfCounter;
  52096. /**
  52097. * Gets the render targets render time capture status
  52098. */
  52099. /**
  52100. * Enable or disable the render targets render time capture
  52101. */
  52102. captureRenderTargetsRenderTime: boolean;
  52103. /**
  52104. * Gets the perf counter used for particles render time
  52105. */
  52106. readonly particlesRenderTimeCounter: PerfCounter;
  52107. /**
  52108. * Gets the particles render time capture status
  52109. */
  52110. /**
  52111. * Enable or disable the particles render time capture
  52112. */
  52113. captureParticlesRenderTime: boolean;
  52114. /**
  52115. * Gets the perf counter used for sprites render time
  52116. */
  52117. readonly spritesRenderTimeCounter: PerfCounter;
  52118. /**
  52119. * Gets the sprites render time capture status
  52120. */
  52121. /**
  52122. * Enable or disable the sprites render time capture
  52123. */
  52124. captureSpritesRenderTime: boolean;
  52125. /**
  52126. * Gets the perf counter used for physics time
  52127. */
  52128. readonly physicsTimeCounter: PerfCounter;
  52129. /**
  52130. * Gets the physics time capture status
  52131. */
  52132. /**
  52133. * Enable or disable the physics time capture
  52134. */
  52135. capturePhysicsTime: boolean;
  52136. /**
  52137. * Gets the perf counter used for animations time
  52138. */
  52139. readonly animationsTimeCounter: PerfCounter;
  52140. /**
  52141. * Gets the animations time capture status
  52142. */
  52143. /**
  52144. * Enable or disable the animations time capture
  52145. */
  52146. captureAnimationsTime: boolean;
  52147. /**
  52148. * Gets the perf counter used for frame time capture
  52149. */
  52150. readonly frameTimeCounter: PerfCounter;
  52151. /**
  52152. * Gets the frame time capture status
  52153. */
  52154. /**
  52155. * Enable or disable the frame time capture
  52156. */
  52157. captureFrameTime: boolean;
  52158. /**
  52159. * Gets the perf counter used for inter-frames time capture
  52160. */
  52161. readonly interFrameTimeCounter: PerfCounter;
  52162. /**
  52163. * Gets the inter-frames time capture status
  52164. */
  52165. /**
  52166. * Enable or disable the inter-frames time capture
  52167. */
  52168. captureInterFrameTime: boolean;
  52169. /**
  52170. * Gets the perf counter used for render time capture
  52171. */
  52172. readonly renderTimeCounter: PerfCounter;
  52173. /**
  52174. * Gets the render time capture status
  52175. */
  52176. /**
  52177. * Enable or disable the render time capture
  52178. */
  52179. captureRenderTime: boolean;
  52180. /**
  52181. * Gets the perf counter used for camera render time capture
  52182. */
  52183. readonly cameraRenderTimeCounter: PerfCounter;
  52184. /**
  52185. * Gets the camera render time capture status
  52186. */
  52187. /**
  52188. * Enable or disable the camera render time capture
  52189. */
  52190. captureCameraRenderTime: boolean;
  52191. /**
  52192. * Gets the perf counter used for draw calls
  52193. */
  52194. readonly drawCallsCounter: PerfCounter;
  52195. /**
  52196. * Instantiates a new scene instrumentation.
  52197. * This class can be used to get instrumentation data from a Babylon engine
  52198. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  52199. * @param scene Defines the scene to instrument
  52200. */
  52201. constructor(
  52202. /**
  52203. * Defines the scene to instrument
  52204. */
  52205. scene: Scene);
  52206. /**
  52207. * Dispose and release associated resources.
  52208. */
  52209. dispose(): void;
  52210. }
  52211. }
  52212. declare module "babylonjs/Instrumentation/index" {
  52213. export * from "babylonjs/Instrumentation/engineInstrumentation";
  52214. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  52215. export * from "babylonjs/Instrumentation/timeToken";
  52216. }
  52217. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  52218. /** @hidden */
  52219. export var glowMapGenerationPixelShader: {
  52220. name: string;
  52221. shader: string;
  52222. };
  52223. }
  52224. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  52225. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  52226. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  52227. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  52228. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  52229. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  52230. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  52231. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  52232. /** @hidden */
  52233. export var glowMapGenerationVertexShader: {
  52234. name: string;
  52235. shader: string;
  52236. };
  52237. }
  52238. declare module "babylonjs/Layers/effectLayer" {
  52239. import { Observable } from "babylonjs/Misc/observable";
  52240. import { Nullable } from "babylonjs/types";
  52241. import { Camera } from "babylonjs/Cameras/camera";
  52242. import { Scene } from "babylonjs/scene";
  52243. import { ISize } from "babylonjs/Maths/math.size";
  52244. import { Color4 } from "babylonjs/Maths/math.color";
  52245. import { Engine } from "babylonjs/Engines/engine";
  52246. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52247. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52248. import { Mesh } from "babylonjs/Meshes/mesh";
  52249. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  52250. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  52251. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  52252. import { Effect } from "babylonjs/Materials/effect";
  52253. import { Material } from "babylonjs/Materials/material";
  52254. import "babylonjs/Shaders/glowMapGeneration.fragment";
  52255. import "babylonjs/Shaders/glowMapGeneration.vertex";
  52256. /**
  52257. * Effect layer options. This helps customizing the behaviour
  52258. * of the effect layer.
  52259. */
  52260. export interface IEffectLayerOptions {
  52261. /**
  52262. * Multiplication factor apply to the canvas size to compute the render target size
  52263. * used to generated the objects (the smaller the faster).
  52264. */
  52265. mainTextureRatio: number;
  52266. /**
  52267. * Enforces a fixed size texture to ensure effect stability across devices.
  52268. */
  52269. mainTextureFixedSize?: number;
  52270. /**
  52271. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  52272. */
  52273. alphaBlendingMode: number;
  52274. /**
  52275. * The camera attached to the layer.
  52276. */
  52277. camera: Nullable<Camera>;
  52278. /**
  52279. * The rendering group to draw the layer in.
  52280. */
  52281. renderingGroupId: number;
  52282. }
  52283. /**
  52284. * The effect layer Helps adding post process effect blended with the main pass.
  52285. *
  52286. * This can be for instance use to generate glow or higlight effects on the scene.
  52287. *
  52288. * The effect layer class can not be used directly and is intented to inherited from to be
  52289. * customized per effects.
  52290. */
  52291. export abstract class EffectLayer {
  52292. private _vertexBuffers;
  52293. private _indexBuffer;
  52294. private _cachedDefines;
  52295. private _effectLayerMapGenerationEffect;
  52296. private _effectLayerOptions;
  52297. private _mergeEffect;
  52298. protected _scene: Scene;
  52299. protected _engine: Engine;
  52300. protected _maxSize: number;
  52301. protected _mainTextureDesiredSize: ISize;
  52302. protected _mainTexture: RenderTargetTexture;
  52303. protected _shouldRender: boolean;
  52304. protected _postProcesses: PostProcess[];
  52305. protected _textures: BaseTexture[];
  52306. protected _emissiveTextureAndColor: {
  52307. texture: Nullable<BaseTexture>;
  52308. color: Color4;
  52309. };
  52310. /**
  52311. * The name of the layer
  52312. */
  52313. name: string;
  52314. /**
  52315. * The clear color of the texture used to generate the glow map.
  52316. */
  52317. neutralColor: Color4;
  52318. /**
  52319. * Specifies wether the highlight layer is enabled or not.
  52320. */
  52321. isEnabled: boolean;
  52322. /**
  52323. * Gets the camera attached to the layer.
  52324. */
  52325. readonly camera: Nullable<Camera>;
  52326. /**
  52327. * Gets the rendering group id the layer should render in.
  52328. */
  52329. renderingGroupId: number;
  52330. /**
  52331. * An event triggered when the effect layer has been disposed.
  52332. */
  52333. onDisposeObservable: Observable<EffectLayer>;
  52334. /**
  52335. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  52336. */
  52337. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  52338. /**
  52339. * An event triggered when the generated texture is being merged in the scene.
  52340. */
  52341. onBeforeComposeObservable: Observable<EffectLayer>;
  52342. /**
  52343. * An event triggered when the mesh is rendered into the effect render target.
  52344. */
  52345. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  52346. /**
  52347. * An event triggered after the mesh has been rendered into the effect render target.
  52348. */
  52349. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  52350. /**
  52351. * An event triggered when the generated texture has been merged in the scene.
  52352. */
  52353. onAfterComposeObservable: Observable<EffectLayer>;
  52354. /**
  52355. * An event triggered when the efffect layer changes its size.
  52356. */
  52357. onSizeChangedObservable: Observable<EffectLayer>;
  52358. /** @hidden */
  52359. static _SceneComponentInitialization: (scene: Scene) => void;
  52360. /**
  52361. * Instantiates a new effect Layer and references it in the scene.
  52362. * @param name The name of the layer
  52363. * @param scene The scene to use the layer in
  52364. */
  52365. constructor(
  52366. /** The Friendly of the effect in the scene */
  52367. name: string, scene: Scene);
  52368. /**
  52369. * Get the effect name of the layer.
  52370. * @return The effect name
  52371. */
  52372. abstract getEffectName(): string;
  52373. /**
  52374. * Checks for the readiness of the element composing the layer.
  52375. * @param subMesh the mesh to check for
  52376. * @param useInstances specify wether or not to use instances to render the mesh
  52377. * @return true if ready otherwise, false
  52378. */
  52379. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52380. /**
  52381. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52382. * @returns true if the effect requires stencil during the main canvas render pass.
  52383. */
  52384. abstract needStencil(): boolean;
  52385. /**
  52386. * Create the merge effect. This is the shader use to blit the information back
  52387. * to the main canvas at the end of the scene rendering.
  52388. * @returns The effect containing the shader used to merge the effect on the main canvas
  52389. */
  52390. protected abstract _createMergeEffect(): Effect;
  52391. /**
  52392. * Creates the render target textures and post processes used in the effect layer.
  52393. */
  52394. protected abstract _createTextureAndPostProcesses(): void;
  52395. /**
  52396. * Implementation specific of rendering the generating effect on the main canvas.
  52397. * @param effect The effect used to render through
  52398. */
  52399. protected abstract _internalRender(effect: Effect): void;
  52400. /**
  52401. * Sets the required values for both the emissive texture and and the main color.
  52402. */
  52403. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52404. /**
  52405. * Free any resources and references associated to a mesh.
  52406. * Internal use
  52407. * @param mesh The mesh to free.
  52408. */
  52409. abstract _disposeMesh(mesh: Mesh): void;
  52410. /**
  52411. * Serializes this layer (Glow or Highlight for example)
  52412. * @returns a serialized layer object
  52413. */
  52414. abstract serialize?(): any;
  52415. /**
  52416. * Initializes the effect layer with the required options.
  52417. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  52418. */
  52419. protected _init(options: Partial<IEffectLayerOptions>): void;
  52420. /**
  52421. * Generates the index buffer of the full screen quad blending to the main canvas.
  52422. */
  52423. private _generateIndexBuffer;
  52424. /**
  52425. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  52426. */
  52427. private _generateVertexBuffer;
  52428. /**
  52429. * Sets the main texture desired size which is the closest power of two
  52430. * of the engine canvas size.
  52431. */
  52432. private _setMainTextureSize;
  52433. /**
  52434. * Creates the main texture for the effect layer.
  52435. */
  52436. protected _createMainTexture(): void;
  52437. /**
  52438. * Adds specific effects defines.
  52439. * @param defines The defines to add specifics to.
  52440. */
  52441. protected _addCustomEffectDefines(defines: string[]): void;
  52442. /**
  52443. * Checks for the readiness of the element composing the layer.
  52444. * @param subMesh the mesh to check for
  52445. * @param useInstances specify wether or not to use instances to render the mesh
  52446. * @param emissiveTexture the associated emissive texture used to generate the glow
  52447. * @return true if ready otherwise, false
  52448. */
  52449. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  52450. /**
  52451. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  52452. */
  52453. render(): void;
  52454. /**
  52455. * Determine if a given mesh will be used in the current effect.
  52456. * @param mesh mesh to test
  52457. * @returns true if the mesh will be used
  52458. */
  52459. hasMesh(mesh: AbstractMesh): boolean;
  52460. /**
  52461. * Returns true if the layer contains information to display, otherwise false.
  52462. * @returns true if the glow layer should be rendered
  52463. */
  52464. shouldRender(): boolean;
  52465. /**
  52466. * Returns true if the mesh should render, otherwise false.
  52467. * @param mesh The mesh to render
  52468. * @returns true if it should render otherwise false
  52469. */
  52470. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  52471. /**
  52472. * Returns true if the mesh can be rendered, otherwise false.
  52473. * @param mesh The mesh to render
  52474. * @param material The material used on the mesh
  52475. * @returns true if it can be rendered otherwise false
  52476. */
  52477. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52478. /**
  52479. * Returns true if the mesh should render, otherwise false.
  52480. * @param mesh The mesh to render
  52481. * @returns true if it should render otherwise false
  52482. */
  52483. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  52484. /**
  52485. * Renders the submesh passed in parameter to the generation map.
  52486. */
  52487. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  52488. /**
  52489. * Defines wether the current material of the mesh should be use to render the effect.
  52490. * @param mesh defines the current mesh to render
  52491. */
  52492. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52493. /**
  52494. * Rebuild the required buffers.
  52495. * @hidden Internal use only.
  52496. */
  52497. _rebuild(): void;
  52498. /**
  52499. * Dispose only the render target textures and post process.
  52500. */
  52501. private _disposeTextureAndPostProcesses;
  52502. /**
  52503. * Dispose the highlight layer and free resources.
  52504. */
  52505. dispose(): void;
  52506. /**
  52507. * Gets the class name of the effect layer
  52508. * @returns the string with the class name of the effect layer
  52509. */
  52510. getClassName(): string;
  52511. /**
  52512. * Creates an effect layer from parsed effect layer data
  52513. * @param parsedEffectLayer defines effect layer data
  52514. * @param scene defines the current scene
  52515. * @param rootUrl defines the root URL containing the effect layer information
  52516. * @returns a parsed effect Layer
  52517. */
  52518. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  52519. }
  52520. }
  52521. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  52522. import { Scene } from "babylonjs/scene";
  52523. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52524. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52525. import { AbstractScene } from "babylonjs/abstractScene";
  52526. module "babylonjs/abstractScene" {
  52527. interface AbstractScene {
  52528. /**
  52529. * The list of effect layers (highlights/glow) added to the scene
  52530. * @see http://doc.babylonjs.com/how_to/highlight_layer
  52531. * @see http://doc.babylonjs.com/how_to/glow_layer
  52532. */
  52533. effectLayers: Array<EffectLayer>;
  52534. /**
  52535. * Removes the given effect layer from this scene.
  52536. * @param toRemove defines the effect layer to remove
  52537. * @returns the index of the removed effect layer
  52538. */
  52539. removeEffectLayer(toRemove: EffectLayer): number;
  52540. /**
  52541. * Adds the given effect layer to this scene
  52542. * @param newEffectLayer defines the effect layer to add
  52543. */
  52544. addEffectLayer(newEffectLayer: EffectLayer): void;
  52545. }
  52546. }
  52547. /**
  52548. * Defines the layer scene component responsible to manage any effect layers
  52549. * in a given scene.
  52550. */
  52551. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  52552. /**
  52553. * The component name helpfull to identify the component in the list of scene components.
  52554. */
  52555. readonly name: string;
  52556. /**
  52557. * The scene the component belongs to.
  52558. */
  52559. scene: Scene;
  52560. private _engine;
  52561. private _renderEffects;
  52562. private _needStencil;
  52563. private _previousStencilState;
  52564. /**
  52565. * Creates a new instance of the component for the given scene
  52566. * @param scene Defines the scene to register the component in
  52567. */
  52568. constructor(scene: Scene);
  52569. /**
  52570. * Registers the component in a given scene
  52571. */
  52572. register(): void;
  52573. /**
  52574. * Rebuilds the elements related to this component in case of
  52575. * context lost for instance.
  52576. */
  52577. rebuild(): void;
  52578. /**
  52579. * Serializes the component data to the specified json object
  52580. * @param serializationObject The object to serialize to
  52581. */
  52582. serialize(serializationObject: any): void;
  52583. /**
  52584. * Adds all the elements from the container to the scene
  52585. * @param container the container holding the elements
  52586. */
  52587. addFromContainer(container: AbstractScene): void;
  52588. /**
  52589. * Removes all the elements in the container from the scene
  52590. * @param container contains the elements to remove
  52591. * @param dispose if the removed element should be disposed (default: false)
  52592. */
  52593. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52594. /**
  52595. * Disposes the component and the associated ressources.
  52596. */
  52597. dispose(): void;
  52598. private _isReadyForMesh;
  52599. private _renderMainTexture;
  52600. private _setStencil;
  52601. private _setStencilBack;
  52602. private _draw;
  52603. private _drawCamera;
  52604. private _drawRenderingGroup;
  52605. }
  52606. }
  52607. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  52608. /** @hidden */
  52609. export var glowMapMergePixelShader: {
  52610. name: string;
  52611. shader: string;
  52612. };
  52613. }
  52614. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  52615. /** @hidden */
  52616. export var glowMapMergeVertexShader: {
  52617. name: string;
  52618. shader: string;
  52619. };
  52620. }
  52621. declare module "babylonjs/Layers/glowLayer" {
  52622. import { Nullable } from "babylonjs/types";
  52623. import { Camera } from "babylonjs/Cameras/camera";
  52624. import { Scene } from "babylonjs/scene";
  52625. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52626. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52627. import { Mesh } from "babylonjs/Meshes/mesh";
  52628. import { Texture } from "babylonjs/Materials/Textures/texture";
  52629. import { Effect } from "babylonjs/Materials/effect";
  52630. import { Material } from "babylonjs/Materials/material";
  52631. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52632. import { Color4 } from "babylonjs/Maths/math.color";
  52633. import "babylonjs/Shaders/glowMapMerge.fragment";
  52634. import "babylonjs/Shaders/glowMapMerge.vertex";
  52635. import "babylonjs/Layers/effectLayerSceneComponent";
  52636. module "babylonjs/abstractScene" {
  52637. interface AbstractScene {
  52638. /**
  52639. * Return a the first highlight layer of the scene with a given name.
  52640. * @param name The name of the highlight layer to look for.
  52641. * @return The highlight layer if found otherwise null.
  52642. */
  52643. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  52644. }
  52645. }
  52646. /**
  52647. * Glow layer options. This helps customizing the behaviour
  52648. * of the glow layer.
  52649. */
  52650. export interface IGlowLayerOptions {
  52651. /**
  52652. * Multiplication factor apply to the canvas size to compute the render target size
  52653. * used to generated the glowing objects (the smaller the faster).
  52654. */
  52655. mainTextureRatio: number;
  52656. /**
  52657. * Enforces a fixed size texture to ensure resize independant blur.
  52658. */
  52659. mainTextureFixedSize?: number;
  52660. /**
  52661. * How big is the kernel of the blur texture.
  52662. */
  52663. blurKernelSize: number;
  52664. /**
  52665. * The camera attached to the layer.
  52666. */
  52667. camera: Nullable<Camera>;
  52668. /**
  52669. * Enable MSAA by chosing the number of samples.
  52670. */
  52671. mainTextureSamples?: number;
  52672. /**
  52673. * The rendering group to draw the layer in.
  52674. */
  52675. renderingGroupId: number;
  52676. }
  52677. /**
  52678. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  52679. *
  52680. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  52681. *
  52682. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  52683. */
  52684. export class GlowLayer extends EffectLayer {
  52685. /**
  52686. * Effect Name of the layer.
  52687. */
  52688. static readonly EffectName: string;
  52689. /**
  52690. * The default blur kernel size used for the glow.
  52691. */
  52692. static DefaultBlurKernelSize: number;
  52693. /**
  52694. * The default texture size ratio used for the glow.
  52695. */
  52696. static DefaultTextureRatio: number;
  52697. /**
  52698. * Sets the kernel size of the blur.
  52699. */
  52700. /**
  52701. * Gets the kernel size of the blur.
  52702. */
  52703. blurKernelSize: number;
  52704. /**
  52705. * Sets the glow intensity.
  52706. */
  52707. /**
  52708. * Gets the glow intensity.
  52709. */
  52710. intensity: number;
  52711. private _options;
  52712. private _intensity;
  52713. private _horizontalBlurPostprocess1;
  52714. private _verticalBlurPostprocess1;
  52715. private _horizontalBlurPostprocess2;
  52716. private _verticalBlurPostprocess2;
  52717. private _blurTexture1;
  52718. private _blurTexture2;
  52719. private _postProcesses1;
  52720. private _postProcesses2;
  52721. private _includedOnlyMeshes;
  52722. private _excludedMeshes;
  52723. private _meshesUsingTheirOwnMaterials;
  52724. /**
  52725. * Callback used to let the user override the color selection on a per mesh basis
  52726. */
  52727. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  52728. /**
  52729. * Callback used to let the user override the texture selection on a per mesh basis
  52730. */
  52731. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  52732. /**
  52733. * Instantiates a new glow Layer and references it to the scene.
  52734. * @param name The name of the layer
  52735. * @param scene The scene to use the layer in
  52736. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  52737. */
  52738. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  52739. /**
  52740. * Get the effect name of the layer.
  52741. * @return The effect name
  52742. */
  52743. getEffectName(): string;
  52744. /**
  52745. * Create the merge effect. This is the shader use to blit the information back
  52746. * to the main canvas at the end of the scene rendering.
  52747. */
  52748. protected _createMergeEffect(): Effect;
  52749. /**
  52750. * Creates the render target textures and post processes used in the glow layer.
  52751. */
  52752. protected _createTextureAndPostProcesses(): void;
  52753. /**
  52754. * Checks for the readiness of the element composing the layer.
  52755. * @param subMesh the mesh to check for
  52756. * @param useInstances specify wether or not to use instances to render the mesh
  52757. * @param emissiveTexture the associated emissive texture used to generate the glow
  52758. * @return true if ready otherwise, false
  52759. */
  52760. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52761. /**
  52762. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52763. */
  52764. needStencil(): boolean;
  52765. /**
  52766. * Returns true if the mesh can be rendered, otherwise false.
  52767. * @param mesh The mesh to render
  52768. * @param material The material used on the mesh
  52769. * @returns true if it can be rendered otherwise false
  52770. */
  52771. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52772. /**
  52773. * Implementation specific of rendering the generating effect on the main canvas.
  52774. * @param effect The effect used to render through
  52775. */
  52776. protected _internalRender(effect: Effect): void;
  52777. /**
  52778. * Sets the required values for both the emissive texture and and the main color.
  52779. */
  52780. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52781. /**
  52782. * Returns true if the mesh should render, otherwise false.
  52783. * @param mesh The mesh to render
  52784. * @returns true if it should render otherwise false
  52785. */
  52786. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52787. /**
  52788. * Adds specific effects defines.
  52789. * @param defines The defines to add specifics to.
  52790. */
  52791. protected _addCustomEffectDefines(defines: string[]): void;
  52792. /**
  52793. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  52794. * @param mesh The mesh to exclude from the glow layer
  52795. */
  52796. addExcludedMesh(mesh: Mesh): void;
  52797. /**
  52798. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  52799. * @param mesh The mesh to remove
  52800. */
  52801. removeExcludedMesh(mesh: Mesh): void;
  52802. /**
  52803. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  52804. * @param mesh The mesh to include in the glow layer
  52805. */
  52806. addIncludedOnlyMesh(mesh: Mesh): void;
  52807. /**
  52808. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  52809. * @param mesh The mesh to remove
  52810. */
  52811. removeIncludedOnlyMesh(mesh: Mesh): void;
  52812. /**
  52813. * Determine if a given mesh will be used in the glow layer
  52814. * @param mesh The mesh to test
  52815. * @returns true if the mesh will be highlighted by the current glow layer
  52816. */
  52817. hasMesh(mesh: AbstractMesh): boolean;
  52818. /**
  52819. * Defines wether the current material of the mesh should be use to render the effect.
  52820. * @param mesh defines the current mesh to render
  52821. */
  52822. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52823. /**
  52824. * Add a mesh to be rendered through its own material and not with emissive only.
  52825. * @param mesh The mesh for which we need to use its material
  52826. */
  52827. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  52828. /**
  52829. * Remove a mesh from being rendered through its own material and not with emissive only.
  52830. * @param mesh The mesh for which we need to not use its material
  52831. */
  52832. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  52833. /**
  52834. * Free any resources and references associated to a mesh.
  52835. * Internal use
  52836. * @param mesh The mesh to free.
  52837. * @hidden
  52838. */
  52839. _disposeMesh(mesh: Mesh): void;
  52840. /**
  52841. * Gets the class name of the effect layer
  52842. * @returns the string with the class name of the effect layer
  52843. */
  52844. getClassName(): string;
  52845. /**
  52846. * Serializes this glow layer
  52847. * @returns a serialized glow layer object
  52848. */
  52849. serialize(): any;
  52850. /**
  52851. * Creates a Glow Layer from parsed glow layer data
  52852. * @param parsedGlowLayer defines glow layer data
  52853. * @param scene defines the current scene
  52854. * @param rootUrl defines the root URL containing the glow layer information
  52855. * @returns a parsed Glow Layer
  52856. */
  52857. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  52858. }
  52859. }
  52860. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  52861. /** @hidden */
  52862. export var glowBlurPostProcessPixelShader: {
  52863. name: string;
  52864. shader: string;
  52865. };
  52866. }
  52867. declare module "babylonjs/Layers/highlightLayer" {
  52868. import { Observable } from "babylonjs/Misc/observable";
  52869. import { Nullable } from "babylonjs/types";
  52870. import { Camera } from "babylonjs/Cameras/camera";
  52871. import { Scene } from "babylonjs/scene";
  52872. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52873. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52874. import { Mesh } from "babylonjs/Meshes/mesh";
  52875. import { Effect } from "babylonjs/Materials/effect";
  52876. import { Material } from "babylonjs/Materials/material";
  52877. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52878. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  52879. import "babylonjs/Shaders/glowMapMerge.fragment";
  52880. import "babylonjs/Shaders/glowMapMerge.vertex";
  52881. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  52882. module "babylonjs/abstractScene" {
  52883. interface AbstractScene {
  52884. /**
  52885. * Return a the first highlight layer of the scene with a given name.
  52886. * @param name The name of the highlight layer to look for.
  52887. * @return The highlight layer if found otherwise null.
  52888. */
  52889. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  52890. }
  52891. }
  52892. /**
  52893. * Highlight layer options. This helps customizing the behaviour
  52894. * of the highlight layer.
  52895. */
  52896. export interface IHighlightLayerOptions {
  52897. /**
  52898. * Multiplication factor apply to the canvas size to compute the render target size
  52899. * used to generated the glowing objects (the smaller the faster).
  52900. */
  52901. mainTextureRatio: number;
  52902. /**
  52903. * Enforces a fixed size texture to ensure resize independant blur.
  52904. */
  52905. mainTextureFixedSize?: number;
  52906. /**
  52907. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  52908. * of the picture to blur (the smaller the faster).
  52909. */
  52910. blurTextureSizeRatio: number;
  52911. /**
  52912. * How big in texel of the blur texture is the vertical blur.
  52913. */
  52914. blurVerticalSize: number;
  52915. /**
  52916. * How big in texel of the blur texture is the horizontal blur.
  52917. */
  52918. blurHorizontalSize: number;
  52919. /**
  52920. * Alpha blending mode used to apply the blur. Default is combine.
  52921. */
  52922. alphaBlendingMode: number;
  52923. /**
  52924. * The camera attached to the layer.
  52925. */
  52926. camera: Nullable<Camera>;
  52927. /**
  52928. * Should we display highlight as a solid stroke?
  52929. */
  52930. isStroke?: boolean;
  52931. /**
  52932. * The rendering group to draw the layer in.
  52933. */
  52934. renderingGroupId: number;
  52935. }
  52936. /**
  52937. * The highlight layer Helps adding a glow effect around a mesh.
  52938. *
  52939. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  52940. * glowy meshes to your scene.
  52941. *
  52942. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  52943. */
  52944. export class HighlightLayer extends EffectLayer {
  52945. name: string;
  52946. /**
  52947. * Effect Name of the highlight layer.
  52948. */
  52949. static readonly EffectName: string;
  52950. /**
  52951. * The neutral color used during the preparation of the glow effect.
  52952. * This is black by default as the blend operation is a blend operation.
  52953. */
  52954. static NeutralColor: Color4;
  52955. /**
  52956. * Stencil value used for glowing meshes.
  52957. */
  52958. static GlowingMeshStencilReference: number;
  52959. /**
  52960. * Stencil value used for the other meshes in the scene.
  52961. */
  52962. static NormalMeshStencilReference: number;
  52963. /**
  52964. * Specifies whether or not the inner glow is ACTIVE in the layer.
  52965. */
  52966. innerGlow: boolean;
  52967. /**
  52968. * Specifies whether or not the outer glow is ACTIVE in the layer.
  52969. */
  52970. outerGlow: boolean;
  52971. /**
  52972. * Specifies the horizontal size of the blur.
  52973. */
  52974. /**
  52975. * Gets the horizontal size of the blur.
  52976. */
  52977. blurHorizontalSize: number;
  52978. /**
  52979. * Specifies the vertical size of the blur.
  52980. */
  52981. /**
  52982. * Gets the vertical size of the blur.
  52983. */
  52984. blurVerticalSize: number;
  52985. /**
  52986. * An event triggered when the highlight layer is being blurred.
  52987. */
  52988. onBeforeBlurObservable: Observable<HighlightLayer>;
  52989. /**
  52990. * An event triggered when the highlight layer has been blurred.
  52991. */
  52992. onAfterBlurObservable: Observable<HighlightLayer>;
  52993. private _instanceGlowingMeshStencilReference;
  52994. private _options;
  52995. private _downSamplePostprocess;
  52996. private _horizontalBlurPostprocess;
  52997. private _verticalBlurPostprocess;
  52998. private _blurTexture;
  52999. private _meshes;
  53000. private _excludedMeshes;
  53001. /**
  53002. * Instantiates a new highlight Layer and references it to the scene..
  53003. * @param name The name of the layer
  53004. * @param scene The scene to use the layer in
  53005. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  53006. */
  53007. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  53008. /**
  53009. * Get the effect name of the layer.
  53010. * @return The effect name
  53011. */
  53012. getEffectName(): string;
  53013. /**
  53014. * Create the merge effect. This is the shader use to blit the information back
  53015. * to the main canvas at the end of the scene rendering.
  53016. */
  53017. protected _createMergeEffect(): Effect;
  53018. /**
  53019. * Creates the render target textures and post processes used in the highlight layer.
  53020. */
  53021. protected _createTextureAndPostProcesses(): void;
  53022. /**
  53023. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  53024. */
  53025. needStencil(): boolean;
  53026. /**
  53027. * Checks for the readiness of the element composing the layer.
  53028. * @param subMesh the mesh to check for
  53029. * @param useInstances specify wether or not to use instances to render the mesh
  53030. * @param emissiveTexture the associated emissive texture used to generate the glow
  53031. * @return true if ready otherwise, false
  53032. */
  53033. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  53034. /**
  53035. * Implementation specific of rendering the generating effect on the main canvas.
  53036. * @param effect The effect used to render through
  53037. */
  53038. protected _internalRender(effect: Effect): void;
  53039. /**
  53040. * Returns true if the layer contains information to display, otherwise false.
  53041. */
  53042. shouldRender(): boolean;
  53043. /**
  53044. * Returns true if the mesh should render, otherwise false.
  53045. * @param mesh The mesh to render
  53046. * @returns true if it should render otherwise false
  53047. */
  53048. protected _shouldRenderMesh(mesh: Mesh): boolean;
  53049. /**
  53050. * Sets the required values for both the emissive texture and and the main color.
  53051. */
  53052. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  53053. /**
  53054. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  53055. * @param mesh The mesh to exclude from the highlight layer
  53056. */
  53057. addExcludedMesh(mesh: Mesh): void;
  53058. /**
  53059. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  53060. * @param mesh The mesh to highlight
  53061. */
  53062. removeExcludedMesh(mesh: Mesh): void;
  53063. /**
  53064. * Determine if a given mesh will be highlighted by the current HighlightLayer
  53065. * @param mesh mesh to test
  53066. * @returns true if the mesh will be highlighted by the current HighlightLayer
  53067. */
  53068. hasMesh(mesh: AbstractMesh): boolean;
  53069. /**
  53070. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  53071. * @param mesh The mesh to highlight
  53072. * @param color The color of the highlight
  53073. * @param glowEmissiveOnly Extract the glow from the emissive texture
  53074. */
  53075. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  53076. /**
  53077. * Remove a mesh from the highlight layer in order to make it stop glowing.
  53078. * @param mesh The mesh to highlight
  53079. */
  53080. removeMesh(mesh: Mesh): void;
  53081. /**
  53082. * Force the stencil to the normal expected value for none glowing parts
  53083. */
  53084. private _defaultStencilReference;
  53085. /**
  53086. * Free any resources and references associated to a mesh.
  53087. * Internal use
  53088. * @param mesh The mesh to free.
  53089. * @hidden
  53090. */
  53091. _disposeMesh(mesh: Mesh): void;
  53092. /**
  53093. * Dispose the highlight layer and free resources.
  53094. */
  53095. dispose(): void;
  53096. /**
  53097. * Gets the class name of the effect layer
  53098. * @returns the string with the class name of the effect layer
  53099. */
  53100. getClassName(): string;
  53101. /**
  53102. * Serializes this Highlight layer
  53103. * @returns a serialized Highlight layer object
  53104. */
  53105. serialize(): any;
  53106. /**
  53107. * Creates a Highlight layer from parsed Highlight layer data
  53108. * @param parsedHightlightLayer defines the Highlight layer data
  53109. * @param scene defines the current scene
  53110. * @param rootUrl defines the root URL containing the Highlight layer information
  53111. * @returns a parsed Highlight layer
  53112. */
  53113. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  53114. }
  53115. }
  53116. declare module "babylonjs/Layers/layerSceneComponent" {
  53117. import { Scene } from "babylonjs/scene";
  53118. import { ISceneComponent } from "babylonjs/sceneComponent";
  53119. import { Layer } from "babylonjs/Layers/layer";
  53120. import { AbstractScene } from "babylonjs/abstractScene";
  53121. module "babylonjs/abstractScene" {
  53122. interface AbstractScene {
  53123. /**
  53124. * The list of layers (background and foreground) of the scene
  53125. */
  53126. layers: Array<Layer>;
  53127. }
  53128. }
  53129. /**
  53130. * Defines the layer scene component responsible to manage any layers
  53131. * in a given scene.
  53132. */
  53133. export class LayerSceneComponent implements ISceneComponent {
  53134. /**
  53135. * The component name helpfull to identify the component in the list of scene components.
  53136. */
  53137. readonly name: string;
  53138. /**
  53139. * The scene the component belongs to.
  53140. */
  53141. scene: Scene;
  53142. private _engine;
  53143. /**
  53144. * Creates a new instance of the component for the given scene
  53145. * @param scene Defines the scene to register the component in
  53146. */
  53147. constructor(scene: Scene);
  53148. /**
  53149. * Registers the component in a given scene
  53150. */
  53151. register(): void;
  53152. /**
  53153. * Rebuilds the elements related to this component in case of
  53154. * context lost for instance.
  53155. */
  53156. rebuild(): void;
  53157. /**
  53158. * Disposes the component and the associated ressources.
  53159. */
  53160. dispose(): void;
  53161. private _draw;
  53162. private _drawCameraPredicate;
  53163. private _drawCameraBackground;
  53164. private _drawCameraForeground;
  53165. private _drawRenderTargetPredicate;
  53166. private _drawRenderTargetBackground;
  53167. private _drawRenderTargetForeground;
  53168. /**
  53169. * Adds all the elements from the container to the scene
  53170. * @param container the container holding the elements
  53171. */
  53172. addFromContainer(container: AbstractScene): void;
  53173. /**
  53174. * Removes all the elements in the container from the scene
  53175. * @param container contains the elements to remove
  53176. * @param dispose if the removed element should be disposed (default: false)
  53177. */
  53178. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53179. }
  53180. }
  53181. declare module "babylonjs/Shaders/layer.fragment" {
  53182. /** @hidden */
  53183. export var layerPixelShader: {
  53184. name: string;
  53185. shader: string;
  53186. };
  53187. }
  53188. declare module "babylonjs/Shaders/layer.vertex" {
  53189. /** @hidden */
  53190. export var layerVertexShader: {
  53191. name: string;
  53192. shader: string;
  53193. };
  53194. }
  53195. declare module "babylonjs/Layers/layer" {
  53196. import { Observable } from "babylonjs/Misc/observable";
  53197. import { Nullable } from "babylonjs/types";
  53198. import { Scene } from "babylonjs/scene";
  53199. import { Vector2 } from "babylonjs/Maths/math.vector";
  53200. import { Color4 } from "babylonjs/Maths/math.color";
  53201. import { Texture } from "babylonjs/Materials/Textures/texture";
  53202. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  53203. import "babylonjs/Shaders/layer.fragment";
  53204. import "babylonjs/Shaders/layer.vertex";
  53205. /**
  53206. * This represents a full screen 2d layer.
  53207. * This can be useful to display a picture in the background of your scene for instance.
  53208. * @see https://www.babylonjs-playground.com/#08A2BS#1
  53209. */
  53210. export class Layer {
  53211. /**
  53212. * Define the name of the layer.
  53213. */
  53214. name: string;
  53215. /**
  53216. * Define the texture the layer should display.
  53217. */
  53218. texture: Nullable<Texture>;
  53219. /**
  53220. * Is the layer in background or foreground.
  53221. */
  53222. isBackground: boolean;
  53223. /**
  53224. * Define the color of the layer (instead of texture).
  53225. */
  53226. color: Color4;
  53227. /**
  53228. * Define the scale of the layer in order to zoom in out of the texture.
  53229. */
  53230. scale: Vector2;
  53231. /**
  53232. * Define an offset for the layer in order to shift the texture.
  53233. */
  53234. offset: Vector2;
  53235. /**
  53236. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  53237. */
  53238. alphaBlendingMode: number;
  53239. /**
  53240. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  53241. * Alpha test will not mix with the background color in case of transparency.
  53242. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  53243. */
  53244. alphaTest: boolean;
  53245. /**
  53246. * Define a mask to restrict the layer to only some of the scene cameras.
  53247. */
  53248. layerMask: number;
  53249. /**
  53250. * Define the list of render target the layer is visible into.
  53251. */
  53252. renderTargetTextures: RenderTargetTexture[];
  53253. /**
  53254. * Define if the layer is only used in renderTarget or if it also
  53255. * renders in the main frame buffer of the canvas.
  53256. */
  53257. renderOnlyInRenderTargetTextures: boolean;
  53258. private _scene;
  53259. private _vertexBuffers;
  53260. private _indexBuffer;
  53261. private _effect;
  53262. private _alphaTestEffect;
  53263. /**
  53264. * An event triggered when the layer is disposed.
  53265. */
  53266. onDisposeObservable: Observable<Layer>;
  53267. private _onDisposeObserver;
  53268. /**
  53269. * Back compatibility with callback before the onDisposeObservable existed.
  53270. * The set callback will be triggered when the layer has been disposed.
  53271. */
  53272. onDispose: () => void;
  53273. /**
  53274. * An event triggered before rendering the scene
  53275. */
  53276. onBeforeRenderObservable: Observable<Layer>;
  53277. private _onBeforeRenderObserver;
  53278. /**
  53279. * Back compatibility with callback before the onBeforeRenderObservable existed.
  53280. * The set callback will be triggered just before rendering the layer.
  53281. */
  53282. onBeforeRender: () => void;
  53283. /**
  53284. * An event triggered after rendering the scene
  53285. */
  53286. onAfterRenderObservable: Observable<Layer>;
  53287. private _onAfterRenderObserver;
  53288. /**
  53289. * Back compatibility with callback before the onAfterRenderObservable existed.
  53290. * The set callback will be triggered just after rendering the layer.
  53291. */
  53292. onAfterRender: () => void;
  53293. /**
  53294. * Instantiates a new layer.
  53295. * This represents a full screen 2d layer.
  53296. * This can be useful to display a picture in the background of your scene for instance.
  53297. * @see https://www.babylonjs-playground.com/#08A2BS#1
  53298. * @param name Define the name of the layer in the scene
  53299. * @param imgUrl Define the url of the texture to display in the layer
  53300. * @param scene Define the scene the layer belongs to
  53301. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  53302. * @param color Defines a color for the layer
  53303. */
  53304. constructor(
  53305. /**
  53306. * Define the name of the layer.
  53307. */
  53308. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  53309. private _createIndexBuffer;
  53310. /** @hidden */
  53311. _rebuild(): void;
  53312. /**
  53313. * Renders the layer in the scene.
  53314. */
  53315. render(): void;
  53316. /**
  53317. * Disposes and releases the associated ressources.
  53318. */
  53319. dispose(): void;
  53320. }
  53321. }
  53322. declare module "babylonjs/Layers/index" {
  53323. export * from "babylonjs/Layers/effectLayer";
  53324. export * from "babylonjs/Layers/effectLayerSceneComponent";
  53325. export * from "babylonjs/Layers/glowLayer";
  53326. export * from "babylonjs/Layers/highlightLayer";
  53327. export * from "babylonjs/Layers/layer";
  53328. export * from "babylonjs/Layers/layerSceneComponent";
  53329. }
  53330. declare module "babylonjs/Shaders/lensFlare.fragment" {
  53331. /** @hidden */
  53332. export var lensFlarePixelShader: {
  53333. name: string;
  53334. shader: string;
  53335. };
  53336. }
  53337. declare module "babylonjs/Shaders/lensFlare.vertex" {
  53338. /** @hidden */
  53339. export var lensFlareVertexShader: {
  53340. name: string;
  53341. shader: string;
  53342. };
  53343. }
  53344. declare module "babylonjs/LensFlares/lensFlareSystem" {
  53345. import { Scene } from "babylonjs/scene";
  53346. import { Vector3 } from "babylonjs/Maths/math.vector";
  53347. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53348. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  53349. import "babylonjs/Shaders/lensFlare.fragment";
  53350. import "babylonjs/Shaders/lensFlare.vertex";
  53351. import { Viewport } from "babylonjs/Maths/math.viewport";
  53352. /**
  53353. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  53354. * It is usually composed of several `lensFlare`.
  53355. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53356. */
  53357. export class LensFlareSystem {
  53358. /**
  53359. * Define the name of the lens flare system
  53360. */
  53361. name: string;
  53362. /**
  53363. * List of lens flares used in this system.
  53364. */
  53365. lensFlares: LensFlare[];
  53366. /**
  53367. * Define a limit from the border the lens flare can be visible.
  53368. */
  53369. borderLimit: number;
  53370. /**
  53371. * Define a viewport border we do not want to see the lens flare in.
  53372. */
  53373. viewportBorder: number;
  53374. /**
  53375. * Define a predicate which could limit the list of meshes able to occlude the effect.
  53376. */
  53377. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  53378. /**
  53379. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  53380. */
  53381. layerMask: number;
  53382. /**
  53383. * Define the id of the lens flare system in the scene.
  53384. * (equal to name by default)
  53385. */
  53386. id: string;
  53387. private _scene;
  53388. private _emitter;
  53389. private _vertexBuffers;
  53390. private _indexBuffer;
  53391. private _effect;
  53392. private _positionX;
  53393. private _positionY;
  53394. private _isEnabled;
  53395. /** @hidden */
  53396. static _SceneComponentInitialization: (scene: Scene) => void;
  53397. /**
  53398. * Instantiates a lens flare system.
  53399. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  53400. * It is usually composed of several `lensFlare`.
  53401. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53402. * @param name Define the name of the lens flare system in the scene
  53403. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  53404. * @param scene Define the scene the lens flare system belongs to
  53405. */
  53406. constructor(
  53407. /**
  53408. * Define the name of the lens flare system
  53409. */
  53410. name: string, emitter: any, scene: Scene);
  53411. /**
  53412. * Define if the lens flare system is enabled.
  53413. */
  53414. isEnabled: boolean;
  53415. /**
  53416. * Get the scene the effects belongs to.
  53417. * @returns the scene holding the lens flare system
  53418. */
  53419. getScene(): Scene;
  53420. /**
  53421. * Get the emitter of the lens flare system.
  53422. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53423. * @returns the emitter of the lens flare system
  53424. */
  53425. getEmitter(): any;
  53426. /**
  53427. * Set the emitter of the lens flare system.
  53428. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53429. * @param newEmitter Define the new emitter of the system
  53430. */
  53431. setEmitter(newEmitter: any): void;
  53432. /**
  53433. * Get the lens flare system emitter position.
  53434. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  53435. * @returns the position
  53436. */
  53437. getEmitterPosition(): Vector3;
  53438. /**
  53439. * @hidden
  53440. */
  53441. computeEffectivePosition(globalViewport: Viewport): boolean;
  53442. /** @hidden */
  53443. _isVisible(): boolean;
  53444. /**
  53445. * @hidden
  53446. */
  53447. render(): boolean;
  53448. /**
  53449. * Dispose and release the lens flare with its associated resources.
  53450. */
  53451. dispose(): void;
  53452. /**
  53453. * Parse a lens flare system from a JSON repressentation
  53454. * @param parsedLensFlareSystem Define the JSON to parse
  53455. * @param scene Define the scene the parsed system should be instantiated in
  53456. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  53457. * @returns the parsed system
  53458. */
  53459. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  53460. /**
  53461. * Serialize the current Lens Flare System into a JSON representation.
  53462. * @returns the serialized JSON
  53463. */
  53464. serialize(): any;
  53465. }
  53466. }
  53467. declare module "babylonjs/LensFlares/lensFlare" {
  53468. import { Nullable } from "babylonjs/types";
  53469. import { Color3 } from "babylonjs/Maths/math.color";
  53470. import { Texture } from "babylonjs/Materials/Textures/texture";
  53471. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53472. /**
  53473. * This represents one of the lens effect in a `lensFlareSystem`.
  53474. * It controls one of the indiviual texture used in the effect.
  53475. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53476. */
  53477. export class LensFlare {
  53478. /**
  53479. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53480. */
  53481. size: number;
  53482. /**
  53483. * 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.
  53484. */
  53485. position: number;
  53486. /**
  53487. * Define the lens color.
  53488. */
  53489. color: Color3;
  53490. /**
  53491. * Define the lens texture.
  53492. */
  53493. texture: Nullable<Texture>;
  53494. /**
  53495. * Define the alpha mode to render this particular lens.
  53496. */
  53497. alphaMode: number;
  53498. private _system;
  53499. /**
  53500. * Creates a new Lens Flare.
  53501. * This represents one of the lens effect in a `lensFlareSystem`.
  53502. * It controls one of the indiviual texture used in the effect.
  53503. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53504. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  53505. * @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.
  53506. * @param color Define the lens color
  53507. * @param imgUrl Define the lens texture url
  53508. * @param system Define the `lensFlareSystem` this flare is part of
  53509. * @returns The newly created Lens Flare
  53510. */
  53511. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  53512. /**
  53513. * Instantiates a new Lens Flare.
  53514. * This represents one of the lens effect in a `lensFlareSystem`.
  53515. * It controls one of the indiviual texture used in the effect.
  53516. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53517. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  53518. * @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.
  53519. * @param color Define the lens color
  53520. * @param imgUrl Define the lens texture url
  53521. * @param system Define the `lensFlareSystem` this flare is part of
  53522. */
  53523. constructor(
  53524. /**
  53525. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53526. */
  53527. size: number,
  53528. /**
  53529. * 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.
  53530. */
  53531. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  53532. /**
  53533. * Dispose and release the lens flare with its associated resources.
  53534. */
  53535. dispose(): void;
  53536. }
  53537. }
  53538. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  53539. import { Nullable } from "babylonjs/types";
  53540. import { Scene } from "babylonjs/scene";
  53541. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53542. import { AbstractScene } from "babylonjs/abstractScene";
  53543. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53544. module "babylonjs/abstractScene" {
  53545. interface AbstractScene {
  53546. /**
  53547. * The list of lens flare system added to the scene
  53548. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53549. */
  53550. lensFlareSystems: Array<LensFlareSystem>;
  53551. /**
  53552. * Removes the given lens flare system from this scene.
  53553. * @param toRemove The lens flare system to remove
  53554. * @returns The index of the removed lens flare system
  53555. */
  53556. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  53557. /**
  53558. * Adds the given lens flare system to this scene
  53559. * @param newLensFlareSystem The lens flare system to add
  53560. */
  53561. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  53562. /**
  53563. * Gets a lens flare system using its name
  53564. * @param name defines the name to look for
  53565. * @returns the lens flare system or null if not found
  53566. */
  53567. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  53568. /**
  53569. * Gets a lens flare system using its id
  53570. * @param id defines the id to look for
  53571. * @returns the lens flare system or null if not found
  53572. */
  53573. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  53574. }
  53575. }
  53576. /**
  53577. * Defines the lens flare scene component responsible to manage any lens flares
  53578. * in a given scene.
  53579. */
  53580. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  53581. /**
  53582. * The component name helpfull to identify the component in the list of scene components.
  53583. */
  53584. readonly name: string;
  53585. /**
  53586. * The scene the component belongs to.
  53587. */
  53588. scene: Scene;
  53589. /**
  53590. * Creates a new instance of the component for the given scene
  53591. * @param scene Defines the scene to register the component in
  53592. */
  53593. constructor(scene: Scene);
  53594. /**
  53595. * Registers the component in a given scene
  53596. */
  53597. register(): void;
  53598. /**
  53599. * Rebuilds the elements related to this component in case of
  53600. * context lost for instance.
  53601. */
  53602. rebuild(): void;
  53603. /**
  53604. * Adds all the elements from the container to the scene
  53605. * @param container the container holding the elements
  53606. */
  53607. addFromContainer(container: AbstractScene): void;
  53608. /**
  53609. * Removes all the elements in the container from the scene
  53610. * @param container contains the elements to remove
  53611. * @param dispose if the removed element should be disposed (default: false)
  53612. */
  53613. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53614. /**
  53615. * Serializes the component data to the specified json object
  53616. * @param serializationObject The object to serialize to
  53617. */
  53618. serialize(serializationObject: any): void;
  53619. /**
  53620. * Disposes the component and the associated ressources.
  53621. */
  53622. dispose(): void;
  53623. private _draw;
  53624. }
  53625. }
  53626. declare module "babylonjs/LensFlares/index" {
  53627. export * from "babylonjs/LensFlares/lensFlare";
  53628. export * from "babylonjs/LensFlares/lensFlareSystem";
  53629. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  53630. }
  53631. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  53632. import { Scene } from "babylonjs/scene";
  53633. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53634. import { AbstractScene } from "babylonjs/abstractScene";
  53635. /**
  53636. * Defines the shadow generator component responsible to manage any shadow generators
  53637. * in a given scene.
  53638. */
  53639. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  53640. /**
  53641. * The component name helpfull to identify the component in the list of scene components.
  53642. */
  53643. readonly name: string;
  53644. /**
  53645. * The scene the component belongs to.
  53646. */
  53647. scene: Scene;
  53648. /**
  53649. * Creates a new instance of the component for the given scene
  53650. * @param scene Defines the scene to register the component in
  53651. */
  53652. constructor(scene: Scene);
  53653. /**
  53654. * Registers the component in a given scene
  53655. */
  53656. register(): void;
  53657. /**
  53658. * Rebuilds the elements related to this component in case of
  53659. * context lost for instance.
  53660. */
  53661. rebuild(): void;
  53662. /**
  53663. * Serializes the component data to the specified json object
  53664. * @param serializationObject The object to serialize to
  53665. */
  53666. serialize(serializationObject: any): void;
  53667. /**
  53668. * Adds all the elements from the container to the scene
  53669. * @param container the container holding the elements
  53670. */
  53671. addFromContainer(container: AbstractScene): void;
  53672. /**
  53673. * Removes all the elements in the container from the scene
  53674. * @param container contains the elements to remove
  53675. * @param dispose if the removed element should be disposed (default: false)
  53676. */
  53677. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53678. /**
  53679. * Rebuilds the elements related to this component in case of
  53680. * context lost for instance.
  53681. */
  53682. dispose(): void;
  53683. private _gatherRenderTargets;
  53684. }
  53685. }
  53686. declare module "babylonjs/Lights/Shadows/index" {
  53687. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  53688. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  53689. }
  53690. declare module "babylonjs/Lights/pointLight" {
  53691. import { Scene } from "babylonjs/scene";
  53692. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53693. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53694. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  53695. import { Effect } from "babylonjs/Materials/effect";
  53696. /**
  53697. * A point light is a light defined by an unique point in world space.
  53698. * The light is emitted in every direction from this point.
  53699. * A good example of a point light is a standard light bulb.
  53700. * Documentation: https://doc.babylonjs.com/babylon101/lights
  53701. */
  53702. export class PointLight extends ShadowLight {
  53703. private _shadowAngle;
  53704. /**
  53705. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53706. * This specifies what angle the shadow will use to be created.
  53707. *
  53708. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53709. */
  53710. /**
  53711. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53712. * This specifies what angle the shadow will use to be created.
  53713. *
  53714. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53715. */
  53716. shadowAngle: number;
  53717. /**
  53718. * Gets the direction if it has been set.
  53719. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53720. */
  53721. /**
  53722. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53723. */
  53724. direction: Vector3;
  53725. /**
  53726. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  53727. * A PointLight emits the light in every direction.
  53728. * It can cast shadows.
  53729. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  53730. * ```javascript
  53731. * var pointLight = new PointLight("pl", camera.position, scene);
  53732. * ```
  53733. * Documentation : https://doc.babylonjs.com/babylon101/lights
  53734. * @param name The light friendly name
  53735. * @param position The position of the point light in the scene
  53736. * @param scene The scene the lights belongs to
  53737. */
  53738. constructor(name: string, position: Vector3, scene: Scene);
  53739. /**
  53740. * Returns the string "PointLight"
  53741. * @returns the class name
  53742. */
  53743. getClassName(): string;
  53744. /**
  53745. * Returns the integer 0.
  53746. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  53747. */
  53748. getTypeID(): number;
  53749. /**
  53750. * Specifies wether or not the shadowmap should be a cube texture.
  53751. * @returns true if the shadowmap needs to be a cube texture.
  53752. */
  53753. needCube(): boolean;
  53754. /**
  53755. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  53756. * @param faceIndex The index of the face we are computed the direction to generate shadow
  53757. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  53758. */
  53759. getShadowDirection(faceIndex?: number): Vector3;
  53760. /**
  53761. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  53762. * - fov = PI / 2
  53763. * - aspect ratio : 1.0
  53764. * - z-near and far equal to the active camera minZ and maxZ.
  53765. * Returns the PointLight.
  53766. */
  53767. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  53768. protected _buildUniformLayout(): void;
  53769. /**
  53770. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  53771. * @param effect The effect to update
  53772. * @param lightIndex The index of the light in the effect to update
  53773. * @returns The point light
  53774. */
  53775. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  53776. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  53777. /**
  53778. * Prepares the list of defines specific to the light type.
  53779. * @param defines the list of defines
  53780. * @param lightIndex defines the index of the light for the effect
  53781. */
  53782. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  53783. }
  53784. }
  53785. declare module "babylonjs/Lights/index" {
  53786. export * from "babylonjs/Lights/light";
  53787. export * from "babylonjs/Lights/shadowLight";
  53788. export * from "babylonjs/Lights/Shadows/index";
  53789. export * from "babylonjs/Lights/directionalLight";
  53790. export * from "babylonjs/Lights/hemisphericLight";
  53791. export * from "babylonjs/Lights/pointLight";
  53792. export * from "babylonjs/Lights/spotLight";
  53793. }
  53794. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  53795. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53796. /**
  53797. * Header information of HDR texture files.
  53798. */
  53799. export interface HDRInfo {
  53800. /**
  53801. * The height of the texture in pixels.
  53802. */
  53803. height: number;
  53804. /**
  53805. * The width of the texture in pixels.
  53806. */
  53807. width: number;
  53808. /**
  53809. * The index of the beginning of the data in the binary file.
  53810. */
  53811. dataPosition: number;
  53812. }
  53813. /**
  53814. * This groups tools to convert HDR texture to native colors array.
  53815. */
  53816. export class HDRTools {
  53817. private static Ldexp;
  53818. private static Rgbe2float;
  53819. private static readStringLine;
  53820. /**
  53821. * Reads header information from an RGBE texture stored in a native array.
  53822. * More information on this format are available here:
  53823. * https://en.wikipedia.org/wiki/RGBE_image_format
  53824. *
  53825. * @param uint8array The binary file stored in native array.
  53826. * @return The header information.
  53827. */
  53828. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  53829. /**
  53830. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  53831. * This RGBE texture needs to store the information as a panorama.
  53832. *
  53833. * More information on this format are available here:
  53834. * https://en.wikipedia.org/wiki/RGBE_image_format
  53835. *
  53836. * @param buffer The binary file stored in an array buffer.
  53837. * @param size The expected size of the extracted cubemap.
  53838. * @return The Cube Map information.
  53839. */
  53840. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  53841. /**
  53842. * Returns the pixels data extracted from an RGBE texture.
  53843. * This pixels will be stored left to right up to down in the R G B order in one array.
  53844. *
  53845. * More information on this format are available here:
  53846. * https://en.wikipedia.org/wiki/RGBE_image_format
  53847. *
  53848. * @param uint8array The binary file stored in an array buffer.
  53849. * @param hdrInfo The header information of the file.
  53850. * @return The pixels data in RGB right to left up to down order.
  53851. */
  53852. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  53853. private static RGBE_ReadPixels_RLE;
  53854. }
  53855. }
  53856. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  53857. import { Nullable } from "babylonjs/types";
  53858. import { Scene } from "babylonjs/scene";
  53859. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53860. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53861. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53862. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  53863. /**
  53864. * This represents a texture coming from an HDR input.
  53865. *
  53866. * The only supported format is currently panorama picture stored in RGBE format.
  53867. * Example of such files can be found on HDRLib: http://hdrlib.com/
  53868. */
  53869. export class HDRCubeTexture extends BaseTexture {
  53870. private static _facesMapping;
  53871. private _generateHarmonics;
  53872. private _noMipmap;
  53873. private _textureMatrix;
  53874. private _size;
  53875. private _onLoad;
  53876. private _onError;
  53877. /**
  53878. * The texture URL.
  53879. */
  53880. url: string;
  53881. /**
  53882. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  53883. */
  53884. coordinatesMode: number;
  53885. protected _isBlocking: boolean;
  53886. /**
  53887. * Sets wether or not the texture is blocking during loading.
  53888. */
  53889. /**
  53890. * Gets wether or not the texture is blocking during loading.
  53891. */
  53892. isBlocking: boolean;
  53893. protected _rotationY: number;
  53894. /**
  53895. * Sets texture matrix rotation angle around Y axis in radians.
  53896. */
  53897. /**
  53898. * Gets texture matrix rotation angle around Y axis radians.
  53899. */
  53900. rotationY: number;
  53901. /**
  53902. * Gets or sets the center of the bounding box associated with the cube texture
  53903. * It must define where the camera used to render the texture was set
  53904. */
  53905. boundingBoxPosition: Vector3;
  53906. private _boundingBoxSize;
  53907. /**
  53908. * Gets or sets the size of the bounding box associated with the cube texture
  53909. * When defined, the cubemap will switch to local mode
  53910. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  53911. * @example https://www.babylonjs-playground.com/#RNASML
  53912. */
  53913. boundingBoxSize: Vector3;
  53914. /**
  53915. * Instantiates an HDRTexture from the following parameters.
  53916. *
  53917. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  53918. * @param scene The scene the texture will be used in
  53919. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53920. * @param noMipmap Forces to not generate the mipmap if true
  53921. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  53922. * @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)
  53923. * @param reserved Reserved flag for internal use.
  53924. */
  53925. 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>);
  53926. /**
  53927. * Get the current class name of the texture useful for serialization or dynamic coding.
  53928. * @returns "HDRCubeTexture"
  53929. */
  53930. getClassName(): string;
  53931. /**
  53932. * Occurs when the file is raw .hdr file.
  53933. */
  53934. private loadTexture;
  53935. clone(): HDRCubeTexture;
  53936. delayLoad(): void;
  53937. /**
  53938. * Get the texture reflection matrix used to rotate/transform the reflection.
  53939. * @returns the reflection matrix
  53940. */
  53941. getReflectionTextureMatrix(): Matrix;
  53942. /**
  53943. * Set the texture reflection matrix used to rotate/transform the reflection.
  53944. * @param value Define the reflection matrix to set
  53945. */
  53946. setReflectionTextureMatrix(value: Matrix): void;
  53947. /**
  53948. * Parses a JSON representation of an HDR Texture in order to create the texture
  53949. * @param parsedTexture Define the JSON representation
  53950. * @param scene Define the scene the texture should be created in
  53951. * @param rootUrl Define the root url in case we need to load relative dependencies
  53952. * @returns the newly created texture after parsing
  53953. */
  53954. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  53955. serialize(): any;
  53956. }
  53957. }
  53958. declare module "babylonjs/Physics/physicsEngine" {
  53959. import { Nullable } from "babylonjs/types";
  53960. import { Vector3 } from "babylonjs/Maths/math.vector";
  53961. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53962. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  53963. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  53964. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53965. /**
  53966. * Class used to control physics engine
  53967. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  53968. */
  53969. export class PhysicsEngine implements IPhysicsEngine {
  53970. private _physicsPlugin;
  53971. /**
  53972. * Global value used to control the smallest number supported by the simulation
  53973. */
  53974. static Epsilon: number;
  53975. private _impostors;
  53976. private _joints;
  53977. /**
  53978. * Gets the gravity vector used by the simulation
  53979. */
  53980. gravity: Vector3;
  53981. /**
  53982. * Factory used to create the default physics plugin.
  53983. * @returns The default physics plugin
  53984. */
  53985. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  53986. /**
  53987. * Creates a new Physics Engine
  53988. * @param gravity defines the gravity vector used by the simulation
  53989. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  53990. */
  53991. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  53992. /**
  53993. * Sets the gravity vector used by the simulation
  53994. * @param gravity defines the gravity vector to use
  53995. */
  53996. setGravity(gravity: Vector3): void;
  53997. /**
  53998. * Set the time step of the physics engine.
  53999. * Default is 1/60.
  54000. * To slow it down, enter 1/600 for example.
  54001. * To speed it up, 1/30
  54002. * @param newTimeStep defines the new timestep to apply to this world.
  54003. */
  54004. setTimeStep(newTimeStep?: number): void;
  54005. /**
  54006. * Get the time step of the physics engine.
  54007. * @returns the current time step
  54008. */
  54009. getTimeStep(): number;
  54010. /**
  54011. * Release all resources
  54012. */
  54013. dispose(): void;
  54014. /**
  54015. * Gets the name of the current physics plugin
  54016. * @returns the name of the plugin
  54017. */
  54018. getPhysicsPluginName(): string;
  54019. /**
  54020. * Adding a new impostor for the impostor tracking.
  54021. * This will be done by the impostor itself.
  54022. * @param impostor the impostor to add
  54023. */
  54024. addImpostor(impostor: PhysicsImpostor): void;
  54025. /**
  54026. * Remove an impostor from the engine.
  54027. * This impostor and its mesh will not longer be updated by the physics engine.
  54028. * @param impostor the impostor to remove
  54029. */
  54030. removeImpostor(impostor: PhysicsImpostor): void;
  54031. /**
  54032. * Add a joint to the physics engine
  54033. * @param mainImpostor defines the main impostor to which the joint is added.
  54034. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  54035. * @param joint defines the joint that will connect both impostors.
  54036. */
  54037. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  54038. /**
  54039. * Removes a joint from the simulation
  54040. * @param mainImpostor defines the impostor used with the joint
  54041. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  54042. * @param joint defines the joint to remove
  54043. */
  54044. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  54045. /**
  54046. * Called by the scene. No need to call it.
  54047. * @param delta defines the timespam between frames
  54048. */
  54049. _step(delta: number): void;
  54050. /**
  54051. * Gets the current plugin used to run the simulation
  54052. * @returns current plugin
  54053. */
  54054. getPhysicsPlugin(): IPhysicsEnginePlugin;
  54055. /**
  54056. * Gets the list of physic impostors
  54057. * @returns an array of PhysicsImpostor
  54058. */
  54059. getImpostors(): Array<PhysicsImpostor>;
  54060. /**
  54061. * Gets the impostor for a physics enabled object
  54062. * @param object defines the object impersonated by the impostor
  54063. * @returns the PhysicsImpostor or null if not found
  54064. */
  54065. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  54066. /**
  54067. * Gets the impostor for a physics body object
  54068. * @param body defines physics body used by the impostor
  54069. * @returns the PhysicsImpostor or null if not found
  54070. */
  54071. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  54072. /**
  54073. * Does a raycast in the physics world
  54074. * @param from when should the ray start?
  54075. * @param to when should the ray end?
  54076. * @returns PhysicsRaycastResult
  54077. */
  54078. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54079. }
  54080. }
  54081. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  54082. import { Nullable } from "babylonjs/types";
  54083. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  54084. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54085. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54086. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54087. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54088. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54089. /** @hidden */
  54090. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  54091. private _useDeltaForWorldStep;
  54092. world: any;
  54093. name: string;
  54094. private _physicsMaterials;
  54095. private _fixedTimeStep;
  54096. private _cannonRaycastResult;
  54097. private _raycastResult;
  54098. private _physicsBodysToRemoveAfterStep;
  54099. BJSCANNON: any;
  54100. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  54101. setGravity(gravity: Vector3): void;
  54102. setTimeStep(timeStep: number): void;
  54103. getTimeStep(): number;
  54104. executeStep(delta: number): void;
  54105. private _removeMarkedPhysicsBodiesFromWorld;
  54106. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54107. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54108. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54109. private _processChildMeshes;
  54110. removePhysicsBody(impostor: PhysicsImpostor): void;
  54111. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54112. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54113. private _addMaterial;
  54114. private _checkWithEpsilon;
  54115. private _createShape;
  54116. private _createHeightmap;
  54117. private _minus90X;
  54118. private _plus90X;
  54119. private _tmpPosition;
  54120. private _tmpDeltaPosition;
  54121. private _tmpUnityRotation;
  54122. private _updatePhysicsBodyTransformation;
  54123. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54124. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54125. isSupported(): boolean;
  54126. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54127. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54128. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54129. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54130. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54131. getBodyMass(impostor: PhysicsImpostor): number;
  54132. getBodyFriction(impostor: PhysicsImpostor): number;
  54133. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54134. getBodyRestitution(impostor: PhysicsImpostor): number;
  54135. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54136. sleepBody(impostor: PhysicsImpostor): void;
  54137. wakeUpBody(impostor: PhysicsImpostor): void;
  54138. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  54139. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54140. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54141. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54142. getRadius(impostor: PhysicsImpostor): number;
  54143. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54144. dispose(): void;
  54145. private _extendNamespace;
  54146. /**
  54147. * Does a raycast in the physics world
  54148. * @param from when should the ray start?
  54149. * @param to when should the ray end?
  54150. * @returns PhysicsRaycastResult
  54151. */
  54152. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54153. }
  54154. }
  54155. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  54156. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54157. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54158. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54159. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54160. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  54161. import { Nullable } from "babylonjs/types";
  54162. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54163. /** @hidden */
  54164. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  54165. world: any;
  54166. name: string;
  54167. BJSOIMO: any;
  54168. private _raycastResult;
  54169. constructor(iterations?: number, oimoInjection?: any);
  54170. setGravity(gravity: Vector3): void;
  54171. setTimeStep(timeStep: number): void;
  54172. getTimeStep(): number;
  54173. private _tmpImpostorsArray;
  54174. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  54175. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54176. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54177. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54178. private _tmpPositionVector;
  54179. removePhysicsBody(impostor: PhysicsImpostor): void;
  54180. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54181. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54182. isSupported(): boolean;
  54183. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54184. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54185. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54186. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54187. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54188. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54189. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54190. getBodyMass(impostor: PhysicsImpostor): number;
  54191. getBodyFriction(impostor: PhysicsImpostor): number;
  54192. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54193. getBodyRestitution(impostor: PhysicsImpostor): number;
  54194. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54195. sleepBody(impostor: PhysicsImpostor): void;
  54196. wakeUpBody(impostor: PhysicsImpostor): void;
  54197. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54198. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  54199. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  54200. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54201. getRadius(impostor: PhysicsImpostor): number;
  54202. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54203. dispose(): void;
  54204. /**
  54205. * Does a raycast in the physics world
  54206. * @param from when should the ray start?
  54207. * @param to when should the ray end?
  54208. * @returns PhysicsRaycastResult
  54209. */
  54210. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54211. }
  54212. }
  54213. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  54214. import { Nullable } from "babylonjs/types";
  54215. import { Scene } from "babylonjs/scene";
  54216. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  54217. import { Color4 } from "babylonjs/Maths/math.color";
  54218. import { Mesh } from "babylonjs/Meshes/mesh";
  54219. /**
  54220. * Class containing static functions to help procedurally build meshes
  54221. */
  54222. export class RibbonBuilder {
  54223. /**
  54224. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  54225. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  54226. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  54227. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  54228. * * 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
  54229. * * 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
  54230. * * 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
  54231. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54232. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54233. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  54234. * * 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
  54235. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  54236. * * 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
  54237. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  54238. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54239. * @param name defines the name of the mesh
  54240. * @param options defines the options used to create the mesh
  54241. * @param scene defines the hosting scene
  54242. * @returns the ribbon mesh
  54243. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  54244. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54245. */
  54246. static CreateRibbon(name: string, options: {
  54247. pathArray: Vector3[][];
  54248. closeArray?: boolean;
  54249. closePath?: boolean;
  54250. offset?: number;
  54251. updatable?: boolean;
  54252. sideOrientation?: number;
  54253. frontUVs?: Vector4;
  54254. backUVs?: Vector4;
  54255. instance?: Mesh;
  54256. invertUV?: boolean;
  54257. uvs?: Vector2[];
  54258. colors?: Color4[];
  54259. }, scene?: Nullable<Scene>): Mesh;
  54260. }
  54261. }
  54262. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  54263. import { Nullable } from "babylonjs/types";
  54264. import { Scene } from "babylonjs/scene";
  54265. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  54266. import { Mesh } from "babylonjs/Meshes/mesh";
  54267. /**
  54268. * Class containing static functions to help procedurally build meshes
  54269. */
  54270. export class ShapeBuilder {
  54271. /**
  54272. * 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.
  54273. * * 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.
  54274. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  54275. * * 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.
  54276. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  54277. * * 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
  54278. * * 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
  54279. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  54280. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54281. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54282. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  54283. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  54284. * @param name defines the name of the mesh
  54285. * @param options defines the options used to create the mesh
  54286. * @param scene defines the hosting scene
  54287. * @returns the extruded shape mesh
  54288. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54289. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  54290. */
  54291. static ExtrudeShape(name: string, options: {
  54292. shape: Vector3[];
  54293. path: Vector3[];
  54294. scale?: number;
  54295. rotation?: number;
  54296. cap?: number;
  54297. updatable?: boolean;
  54298. sideOrientation?: number;
  54299. frontUVs?: Vector4;
  54300. backUVs?: Vector4;
  54301. instance?: Mesh;
  54302. invertUV?: boolean;
  54303. }, scene?: Nullable<Scene>): Mesh;
  54304. /**
  54305. * Creates an custom extruded shape mesh.
  54306. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  54307. * * 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.
  54308. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  54309. * * 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
  54310. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  54311. * * 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
  54312. * * It must returns a float value that will be the scale value applied to the shape on each path point
  54313. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  54314. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  54315. * * 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
  54316. * * 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
  54317. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  54318. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54319. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54320. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  54321. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54322. * @param name defines the name of the mesh
  54323. * @param options defines the options used to create the mesh
  54324. * @param scene defines the hosting scene
  54325. * @returns the custom extruded shape mesh
  54326. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  54327. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54328. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  54329. */
  54330. static ExtrudeShapeCustom(name: string, options: {
  54331. shape: Vector3[];
  54332. path: Vector3[];
  54333. scaleFunction?: any;
  54334. rotationFunction?: any;
  54335. ribbonCloseArray?: boolean;
  54336. ribbonClosePath?: boolean;
  54337. cap?: number;
  54338. updatable?: boolean;
  54339. sideOrientation?: number;
  54340. frontUVs?: Vector4;
  54341. backUVs?: Vector4;
  54342. instance?: Mesh;
  54343. invertUV?: boolean;
  54344. }, scene?: Nullable<Scene>): Mesh;
  54345. private static _ExtrudeShapeGeneric;
  54346. }
  54347. }
  54348. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  54349. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  54350. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54351. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54352. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54353. import { Nullable } from "babylonjs/types";
  54354. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54355. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54356. /**
  54357. * AmmoJS Physics plugin
  54358. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  54359. * @see https://github.com/kripken/ammo.js/
  54360. */
  54361. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  54362. private _useDeltaForWorldStep;
  54363. /**
  54364. * Reference to the Ammo library
  54365. */
  54366. bjsAMMO: any;
  54367. /**
  54368. * Created ammoJS world which physics bodies are added to
  54369. */
  54370. world: any;
  54371. /**
  54372. * Name of the plugin
  54373. */
  54374. name: string;
  54375. private _timeStep;
  54376. private _fixedTimeStep;
  54377. private _maxSteps;
  54378. private _tmpQuaternion;
  54379. private _tmpAmmoTransform;
  54380. private _tmpAmmoQuaternion;
  54381. private _tmpAmmoConcreteContactResultCallback;
  54382. private _collisionConfiguration;
  54383. private _dispatcher;
  54384. private _overlappingPairCache;
  54385. private _solver;
  54386. private _softBodySolver;
  54387. private _tmpAmmoVectorA;
  54388. private _tmpAmmoVectorB;
  54389. private _tmpAmmoVectorC;
  54390. private _tmpAmmoVectorD;
  54391. private _tmpContactCallbackResult;
  54392. private _tmpAmmoVectorRCA;
  54393. private _tmpAmmoVectorRCB;
  54394. private _raycastResult;
  54395. private static readonly DISABLE_COLLISION_FLAG;
  54396. private static readonly KINEMATIC_FLAG;
  54397. private static readonly DISABLE_DEACTIVATION_FLAG;
  54398. /**
  54399. * Initializes the ammoJS plugin
  54400. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  54401. * @param ammoInjection can be used to inject your own ammo reference
  54402. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  54403. */
  54404. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  54405. /**
  54406. * Sets the gravity of the physics world (m/(s^2))
  54407. * @param gravity Gravity to set
  54408. */
  54409. setGravity(gravity: Vector3): void;
  54410. /**
  54411. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  54412. * @param timeStep timestep to use in seconds
  54413. */
  54414. setTimeStep(timeStep: number): void;
  54415. /**
  54416. * 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)
  54417. * @param fixedTimeStep fixedTimeStep to use in seconds
  54418. */
  54419. setFixedTimeStep(fixedTimeStep: number): void;
  54420. /**
  54421. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  54422. * @param maxSteps the maximum number of steps by the physics engine per frame
  54423. */
  54424. setMaxSteps(maxSteps: number): void;
  54425. /**
  54426. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  54427. * @returns the current timestep in seconds
  54428. */
  54429. getTimeStep(): number;
  54430. private _isImpostorInContact;
  54431. private _isImpostorPairInContact;
  54432. private _stepSimulation;
  54433. /**
  54434. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  54435. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  54436. * After the step the babylon meshes are set to the position of the physics imposters
  54437. * @param delta amount of time to step forward
  54438. * @param impostors array of imposters to update before/after the step
  54439. */
  54440. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  54441. /**
  54442. * Update babylon mesh to match physics world object
  54443. * @param impostor imposter to match
  54444. */
  54445. private _afterSoftStep;
  54446. /**
  54447. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54448. * @param impostor imposter to match
  54449. */
  54450. private _ropeStep;
  54451. /**
  54452. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54453. * @param impostor imposter to match
  54454. */
  54455. private _softbodyOrClothStep;
  54456. private _tmpVector;
  54457. private _tmpMatrix;
  54458. /**
  54459. * Applies an impulse on the imposter
  54460. * @param impostor imposter to apply impulse to
  54461. * @param force amount of force to be applied to the imposter
  54462. * @param contactPoint the location to apply the impulse on the imposter
  54463. */
  54464. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54465. /**
  54466. * Applies a force on the imposter
  54467. * @param impostor imposter to apply force
  54468. * @param force amount of force to be applied to the imposter
  54469. * @param contactPoint the location to apply the force on the imposter
  54470. */
  54471. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54472. /**
  54473. * Creates a physics body using the plugin
  54474. * @param impostor the imposter to create the physics body on
  54475. */
  54476. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54477. /**
  54478. * Removes the physics body from the imposter and disposes of the body's memory
  54479. * @param impostor imposter to remove the physics body from
  54480. */
  54481. removePhysicsBody(impostor: PhysicsImpostor): void;
  54482. /**
  54483. * Generates a joint
  54484. * @param impostorJoint the imposter joint to create the joint with
  54485. */
  54486. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54487. /**
  54488. * Removes a joint
  54489. * @param impostorJoint the imposter joint to remove the joint from
  54490. */
  54491. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54492. private _addMeshVerts;
  54493. /**
  54494. * Initialise the soft body vertices to match its object's (mesh) vertices
  54495. * Softbody vertices (nodes) are in world space and to match this
  54496. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  54497. * @param impostor to create the softbody for
  54498. */
  54499. private _softVertexData;
  54500. /**
  54501. * Create an impostor's soft body
  54502. * @param impostor to create the softbody for
  54503. */
  54504. private _createSoftbody;
  54505. /**
  54506. * Create cloth for an impostor
  54507. * @param impostor to create the softbody for
  54508. */
  54509. private _createCloth;
  54510. /**
  54511. * Create rope for an impostor
  54512. * @param impostor to create the softbody for
  54513. */
  54514. private _createRope;
  54515. private _addHullVerts;
  54516. private _createShape;
  54517. /**
  54518. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  54519. * @param impostor imposter containing the physics body and babylon object
  54520. */
  54521. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54522. /**
  54523. * Sets the babylon object's position/rotation from the physics body's position/rotation
  54524. * @param impostor imposter containing the physics body and babylon object
  54525. * @param newPosition new position
  54526. * @param newRotation new rotation
  54527. */
  54528. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54529. /**
  54530. * If this plugin is supported
  54531. * @returns true if its supported
  54532. */
  54533. isSupported(): boolean;
  54534. /**
  54535. * Sets the linear velocity of the physics body
  54536. * @param impostor imposter to set the velocity on
  54537. * @param velocity velocity to set
  54538. */
  54539. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54540. /**
  54541. * Sets the angular velocity of the physics body
  54542. * @param impostor imposter to set the velocity on
  54543. * @param velocity velocity to set
  54544. */
  54545. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54546. /**
  54547. * gets the linear velocity
  54548. * @param impostor imposter to get linear velocity from
  54549. * @returns linear velocity
  54550. */
  54551. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54552. /**
  54553. * gets the angular velocity
  54554. * @param impostor imposter to get angular velocity from
  54555. * @returns angular velocity
  54556. */
  54557. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54558. /**
  54559. * Sets the mass of physics body
  54560. * @param impostor imposter to set the mass on
  54561. * @param mass mass to set
  54562. */
  54563. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54564. /**
  54565. * Gets the mass of the physics body
  54566. * @param impostor imposter to get the mass from
  54567. * @returns mass
  54568. */
  54569. getBodyMass(impostor: PhysicsImpostor): number;
  54570. /**
  54571. * Gets friction of the impostor
  54572. * @param impostor impostor to get friction from
  54573. * @returns friction value
  54574. */
  54575. getBodyFriction(impostor: PhysicsImpostor): number;
  54576. /**
  54577. * Sets friction of the impostor
  54578. * @param impostor impostor to set friction on
  54579. * @param friction friction value
  54580. */
  54581. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54582. /**
  54583. * Gets restitution of the impostor
  54584. * @param impostor impostor to get restitution from
  54585. * @returns restitution value
  54586. */
  54587. getBodyRestitution(impostor: PhysicsImpostor): number;
  54588. /**
  54589. * Sets resitution of the impostor
  54590. * @param impostor impostor to set resitution on
  54591. * @param restitution resitution value
  54592. */
  54593. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54594. /**
  54595. * Gets pressure inside the impostor
  54596. * @param impostor impostor to get pressure from
  54597. * @returns pressure value
  54598. */
  54599. getBodyPressure(impostor: PhysicsImpostor): number;
  54600. /**
  54601. * Sets pressure inside a soft body impostor
  54602. * Cloth and rope must remain 0 pressure
  54603. * @param impostor impostor to set pressure on
  54604. * @param pressure pressure value
  54605. */
  54606. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  54607. /**
  54608. * Gets stiffness of the impostor
  54609. * @param impostor impostor to get stiffness from
  54610. * @returns pressure value
  54611. */
  54612. getBodyStiffness(impostor: PhysicsImpostor): number;
  54613. /**
  54614. * Sets stiffness of the impostor
  54615. * @param impostor impostor to set stiffness on
  54616. * @param stiffness stiffness value from 0 to 1
  54617. */
  54618. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  54619. /**
  54620. * Gets velocityIterations of the impostor
  54621. * @param impostor impostor to get velocity iterations from
  54622. * @returns velocityIterations value
  54623. */
  54624. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  54625. /**
  54626. * Sets velocityIterations of the impostor
  54627. * @param impostor impostor to set velocity iterations on
  54628. * @param velocityIterations velocityIterations value
  54629. */
  54630. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  54631. /**
  54632. * Gets positionIterations of the impostor
  54633. * @param impostor impostor to get position iterations from
  54634. * @returns positionIterations value
  54635. */
  54636. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  54637. /**
  54638. * Sets positionIterations of the impostor
  54639. * @param impostor impostor to set position on
  54640. * @param positionIterations positionIterations value
  54641. */
  54642. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  54643. /**
  54644. * Append an anchor to a cloth object
  54645. * @param impostor is the cloth impostor to add anchor to
  54646. * @param otherImpostor is the rigid impostor to anchor to
  54647. * @param width ratio across width from 0 to 1
  54648. * @param height ratio up height from 0 to 1
  54649. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  54650. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54651. */
  54652. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54653. /**
  54654. * Append an hook to a rope object
  54655. * @param impostor is the rope impostor to add hook to
  54656. * @param otherImpostor is the rigid impostor to hook to
  54657. * @param length ratio along the rope from 0 to 1
  54658. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  54659. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54660. */
  54661. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54662. /**
  54663. * Sleeps the physics body and stops it from being active
  54664. * @param impostor impostor to sleep
  54665. */
  54666. sleepBody(impostor: PhysicsImpostor): void;
  54667. /**
  54668. * Activates the physics body
  54669. * @param impostor impostor to activate
  54670. */
  54671. wakeUpBody(impostor: PhysicsImpostor): void;
  54672. /**
  54673. * Updates the distance parameters of the joint
  54674. * @param joint joint to update
  54675. * @param maxDistance maximum distance of the joint
  54676. * @param minDistance minimum distance of the joint
  54677. */
  54678. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54679. /**
  54680. * Sets a motor on the joint
  54681. * @param joint joint to set motor on
  54682. * @param speed speed of the motor
  54683. * @param maxForce maximum force of the motor
  54684. * @param motorIndex index of the motor
  54685. */
  54686. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54687. /**
  54688. * Sets the motors limit
  54689. * @param joint joint to set limit on
  54690. * @param upperLimit upper limit
  54691. * @param lowerLimit lower limit
  54692. */
  54693. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54694. /**
  54695. * Syncs the position and rotation of a mesh with the impostor
  54696. * @param mesh mesh to sync
  54697. * @param impostor impostor to update the mesh with
  54698. */
  54699. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54700. /**
  54701. * Gets the radius of the impostor
  54702. * @param impostor impostor to get radius from
  54703. * @returns the radius
  54704. */
  54705. getRadius(impostor: PhysicsImpostor): number;
  54706. /**
  54707. * Gets the box size of the impostor
  54708. * @param impostor impostor to get box size from
  54709. * @param result the resulting box size
  54710. */
  54711. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54712. /**
  54713. * Disposes of the impostor
  54714. */
  54715. dispose(): void;
  54716. /**
  54717. * Does a raycast in the physics world
  54718. * @param from when should the ray start?
  54719. * @param to when should the ray end?
  54720. * @returns PhysicsRaycastResult
  54721. */
  54722. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54723. }
  54724. }
  54725. declare module "babylonjs/Probes/reflectionProbe" {
  54726. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  54727. import { Vector3 } from "babylonjs/Maths/math.vector";
  54728. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54729. import { Nullable } from "babylonjs/types";
  54730. import { Scene } from "babylonjs/scene";
  54731. module "babylonjs/abstractScene" {
  54732. interface AbstractScene {
  54733. /**
  54734. * The list of reflection probes added to the scene
  54735. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54736. */
  54737. reflectionProbes: Array<ReflectionProbe>;
  54738. /**
  54739. * Removes the given reflection probe from this scene.
  54740. * @param toRemove The reflection probe to remove
  54741. * @returns The index of the removed reflection probe
  54742. */
  54743. removeReflectionProbe(toRemove: ReflectionProbe): number;
  54744. /**
  54745. * Adds the given reflection probe to this scene.
  54746. * @param newReflectionProbe The reflection probe to add
  54747. */
  54748. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  54749. }
  54750. }
  54751. /**
  54752. * Class used to generate realtime reflection / refraction cube textures
  54753. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54754. */
  54755. export class ReflectionProbe {
  54756. /** defines the name of the probe */
  54757. name: string;
  54758. private _scene;
  54759. private _renderTargetTexture;
  54760. private _projectionMatrix;
  54761. private _viewMatrix;
  54762. private _target;
  54763. private _add;
  54764. private _attachedMesh;
  54765. private _invertYAxis;
  54766. /** Gets or sets probe position (center of the cube map) */
  54767. position: Vector3;
  54768. /**
  54769. * Creates a new reflection probe
  54770. * @param name defines the name of the probe
  54771. * @param size defines the texture resolution (for each face)
  54772. * @param scene defines the hosting scene
  54773. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  54774. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  54775. */
  54776. constructor(
  54777. /** defines the name of the probe */
  54778. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  54779. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  54780. samples: number;
  54781. /** Gets or sets the refresh rate to use (on every frame by default) */
  54782. refreshRate: number;
  54783. /**
  54784. * Gets the hosting scene
  54785. * @returns a Scene
  54786. */
  54787. getScene(): Scene;
  54788. /** Gets the internal CubeTexture used to render to */
  54789. readonly cubeTexture: RenderTargetTexture;
  54790. /** Gets the list of meshes to render */
  54791. readonly renderList: Nullable<AbstractMesh[]>;
  54792. /**
  54793. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  54794. * @param mesh defines the mesh to attach to
  54795. */
  54796. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  54797. /**
  54798. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  54799. * @param renderingGroupId The rendering group id corresponding to its index
  54800. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  54801. */
  54802. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  54803. /**
  54804. * Clean all associated resources
  54805. */
  54806. dispose(): void;
  54807. /**
  54808. * Converts the reflection probe information to a readable string for debug purpose.
  54809. * @param fullDetails Supports for multiple levels of logging within scene loading
  54810. * @returns the human readable reflection probe info
  54811. */
  54812. toString(fullDetails?: boolean): string;
  54813. /**
  54814. * Get the class name of the relfection probe.
  54815. * @returns "ReflectionProbe"
  54816. */
  54817. getClassName(): string;
  54818. /**
  54819. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  54820. * @returns The JSON representation of the texture
  54821. */
  54822. serialize(): any;
  54823. /**
  54824. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  54825. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  54826. * @param scene Define the scene the parsed reflection probe should be instantiated in
  54827. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  54828. * @returns The parsed reflection probe if successful
  54829. */
  54830. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  54831. }
  54832. }
  54833. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  54834. /** @hidden */
  54835. export var _BabylonLoaderRegistered: boolean;
  54836. /**
  54837. * Helps setting up some configuration for the babylon file loader.
  54838. */
  54839. export class BabylonFileLoaderConfiguration {
  54840. /**
  54841. * The loader does not allow injecting custom physix engine into the plugins.
  54842. * Unfortunately in ES6, we need to manually inject them into the plugin.
  54843. * So you could set this variable to your engine import to make it work.
  54844. */
  54845. static LoaderInjectedPhysicsEngine: any;
  54846. }
  54847. }
  54848. declare module "babylonjs/Loading/Plugins/index" {
  54849. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  54850. }
  54851. declare module "babylonjs/Loading/index" {
  54852. export * from "babylonjs/Loading/loadingScreen";
  54853. export * from "babylonjs/Loading/Plugins/index";
  54854. export * from "babylonjs/Loading/sceneLoader";
  54855. export * from "babylonjs/Loading/sceneLoaderFlags";
  54856. }
  54857. declare module "babylonjs/Materials/Background/index" {
  54858. export * from "babylonjs/Materials/Background/backgroundMaterial";
  54859. }
  54860. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  54861. import { Scene } from "babylonjs/scene";
  54862. import { Color3 } from "babylonjs/Maths/math.color";
  54863. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54864. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54865. /**
  54866. * The Physically based simple base material of BJS.
  54867. *
  54868. * This enables better naming and convention enforcements on top of the pbrMaterial.
  54869. * It is used as the base class for both the specGloss and metalRough conventions.
  54870. */
  54871. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  54872. /**
  54873. * Number of Simultaneous lights allowed on the material.
  54874. */
  54875. maxSimultaneousLights: number;
  54876. /**
  54877. * If sets to true, disables all the lights affecting the material.
  54878. */
  54879. disableLighting: boolean;
  54880. /**
  54881. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  54882. */
  54883. environmentTexture: BaseTexture;
  54884. /**
  54885. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  54886. */
  54887. invertNormalMapX: boolean;
  54888. /**
  54889. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  54890. */
  54891. invertNormalMapY: boolean;
  54892. /**
  54893. * Normal map used in the model.
  54894. */
  54895. normalTexture: BaseTexture;
  54896. /**
  54897. * Emissivie color used to self-illuminate the model.
  54898. */
  54899. emissiveColor: Color3;
  54900. /**
  54901. * Emissivie texture used to self-illuminate the model.
  54902. */
  54903. emissiveTexture: BaseTexture;
  54904. /**
  54905. * Occlusion Channel Strenght.
  54906. */
  54907. occlusionStrength: number;
  54908. /**
  54909. * Occlusion Texture of the material (adding extra occlusion effects).
  54910. */
  54911. occlusionTexture: BaseTexture;
  54912. /**
  54913. * Defines the alpha limits in alpha test mode.
  54914. */
  54915. alphaCutOff: number;
  54916. /**
  54917. * Gets the current double sided mode.
  54918. */
  54919. /**
  54920. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  54921. */
  54922. doubleSided: boolean;
  54923. /**
  54924. * Stores the pre-calculated light information of a mesh in a texture.
  54925. */
  54926. lightmapTexture: BaseTexture;
  54927. /**
  54928. * If true, the light map contains occlusion information instead of lighting info.
  54929. */
  54930. useLightmapAsShadowmap: boolean;
  54931. /**
  54932. * Instantiates a new PBRMaterial instance.
  54933. *
  54934. * @param name The material name
  54935. * @param scene The scene the material will be use in.
  54936. */
  54937. constructor(name: string, scene: Scene);
  54938. getClassName(): string;
  54939. }
  54940. }
  54941. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  54942. import { Scene } from "babylonjs/scene";
  54943. import { Color3 } from "babylonjs/Maths/math.color";
  54944. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54945. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54946. /**
  54947. * The PBR material of BJS following the metal roughness convention.
  54948. *
  54949. * This fits to the PBR convention in the GLTF definition:
  54950. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  54951. */
  54952. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  54953. /**
  54954. * The base color has two different interpretations depending on the value of metalness.
  54955. * When the material is a metal, the base color is the specific measured reflectance value
  54956. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  54957. * of the material.
  54958. */
  54959. baseColor: Color3;
  54960. /**
  54961. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  54962. * well as opacity information in the alpha channel.
  54963. */
  54964. baseTexture: BaseTexture;
  54965. /**
  54966. * Specifies the metallic scalar value of the material.
  54967. * Can also be used to scale the metalness values of the metallic texture.
  54968. */
  54969. metallic: number;
  54970. /**
  54971. * Specifies the roughness scalar value of the material.
  54972. * Can also be used to scale the roughness values of the metallic texture.
  54973. */
  54974. roughness: number;
  54975. /**
  54976. * Texture containing both the metallic value in the B channel and the
  54977. * roughness value in the G channel to keep better precision.
  54978. */
  54979. metallicRoughnessTexture: BaseTexture;
  54980. /**
  54981. * Instantiates a new PBRMetalRoughnessMaterial instance.
  54982. *
  54983. * @param name The material name
  54984. * @param scene The scene the material will be use in.
  54985. */
  54986. constructor(name: string, scene: Scene);
  54987. /**
  54988. * Return the currrent class name of the material.
  54989. */
  54990. getClassName(): string;
  54991. /**
  54992. * Makes a duplicate of the current material.
  54993. * @param name - name to use for the new material.
  54994. */
  54995. clone(name: string): PBRMetallicRoughnessMaterial;
  54996. /**
  54997. * Serialize the material to a parsable JSON object.
  54998. */
  54999. serialize(): any;
  55000. /**
  55001. * Parses a JSON object correponding to the serialize function.
  55002. */
  55003. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  55004. }
  55005. }
  55006. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  55007. import { Scene } from "babylonjs/scene";
  55008. import { Color3 } from "babylonjs/Maths/math.color";
  55009. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55010. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  55011. /**
  55012. * The PBR material of BJS following the specular glossiness convention.
  55013. *
  55014. * This fits to the PBR convention in the GLTF definition:
  55015. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  55016. */
  55017. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  55018. /**
  55019. * Specifies the diffuse color of the material.
  55020. */
  55021. diffuseColor: Color3;
  55022. /**
  55023. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  55024. * channel.
  55025. */
  55026. diffuseTexture: BaseTexture;
  55027. /**
  55028. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  55029. */
  55030. specularColor: Color3;
  55031. /**
  55032. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  55033. */
  55034. glossiness: number;
  55035. /**
  55036. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  55037. */
  55038. specularGlossinessTexture: BaseTexture;
  55039. /**
  55040. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  55041. *
  55042. * @param name The material name
  55043. * @param scene The scene the material will be use in.
  55044. */
  55045. constructor(name: string, scene: Scene);
  55046. /**
  55047. * Return the currrent class name of the material.
  55048. */
  55049. getClassName(): string;
  55050. /**
  55051. * Makes a duplicate of the current material.
  55052. * @param name - name to use for the new material.
  55053. */
  55054. clone(name: string): PBRSpecularGlossinessMaterial;
  55055. /**
  55056. * Serialize the material to a parsable JSON object.
  55057. */
  55058. serialize(): any;
  55059. /**
  55060. * Parses a JSON object correponding to the serialize function.
  55061. */
  55062. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  55063. }
  55064. }
  55065. declare module "babylonjs/Materials/PBR/index" {
  55066. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  55067. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  55068. export * from "babylonjs/Materials/PBR/pbrMaterial";
  55069. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  55070. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  55071. }
  55072. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  55073. import { Nullable } from "babylonjs/types";
  55074. import { Scene } from "babylonjs/scene";
  55075. import { Matrix } from "babylonjs/Maths/math.vector";
  55076. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55077. /**
  55078. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  55079. * It can help converting any input color in a desired output one. This can then be used to create effects
  55080. * from sepia, black and white to sixties or futuristic rendering...
  55081. *
  55082. * The only supported format is currently 3dl.
  55083. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  55084. */
  55085. export class ColorGradingTexture extends BaseTexture {
  55086. /**
  55087. * The current texture matrix. (will always be identity in color grading texture)
  55088. */
  55089. private _textureMatrix;
  55090. /**
  55091. * The texture URL.
  55092. */
  55093. url: string;
  55094. /**
  55095. * Empty line regex stored for GC.
  55096. */
  55097. private static _noneEmptyLineRegex;
  55098. private _engine;
  55099. /**
  55100. * Instantiates a ColorGradingTexture from the following parameters.
  55101. *
  55102. * @param url The location of the color gradind data (currently only supporting 3dl)
  55103. * @param scene The scene the texture will be used in
  55104. */
  55105. constructor(url: string, scene: Scene);
  55106. /**
  55107. * Returns the texture matrix used in most of the material.
  55108. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  55109. */
  55110. getTextureMatrix(): Matrix;
  55111. /**
  55112. * Occurs when the file being loaded is a .3dl LUT file.
  55113. */
  55114. private load3dlTexture;
  55115. /**
  55116. * Starts the loading process of the texture.
  55117. */
  55118. private loadTexture;
  55119. /**
  55120. * Clones the color gradind texture.
  55121. */
  55122. clone(): ColorGradingTexture;
  55123. /**
  55124. * Called during delayed load for textures.
  55125. */
  55126. delayLoad(): void;
  55127. /**
  55128. * Parses a color grading texture serialized by Babylon.
  55129. * @param parsedTexture The texture information being parsedTexture
  55130. * @param scene The scene to load the texture in
  55131. * @param rootUrl The root url of the data assets to load
  55132. * @return A color gradind texture
  55133. */
  55134. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  55135. /**
  55136. * Serializes the LUT texture to json format.
  55137. */
  55138. serialize(): any;
  55139. }
  55140. }
  55141. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  55142. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55143. import { Scene } from "babylonjs/scene";
  55144. import { Nullable } from "babylonjs/types";
  55145. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55146. /**
  55147. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  55148. */
  55149. export class EquiRectangularCubeTexture extends BaseTexture {
  55150. /** The six faces of the cube. */
  55151. private static _FacesMapping;
  55152. private _noMipmap;
  55153. private _onLoad;
  55154. private _onError;
  55155. /** The size of the cubemap. */
  55156. private _size;
  55157. /** The buffer of the image. */
  55158. private _buffer;
  55159. /** The width of the input image. */
  55160. private _width;
  55161. /** The height of the input image. */
  55162. private _height;
  55163. /** The URL to the image. */
  55164. url: string;
  55165. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  55166. coordinatesMode: number;
  55167. /**
  55168. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  55169. * @param url The location of the image
  55170. * @param scene The scene the texture will be used in
  55171. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  55172. * @param noMipmap Forces to not generate the mipmap if true
  55173. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  55174. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  55175. * @param onLoad — defines a callback called when texture is loaded
  55176. * @param onError — defines a callback called if there is an error
  55177. */
  55178. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  55179. /**
  55180. * Load the image data, by putting the image on a canvas and extracting its buffer.
  55181. */
  55182. private loadImage;
  55183. /**
  55184. * Convert the image buffer into a cubemap and create a CubeTexture.
  55185. */
  55186. private loadTexture;
  55187. /**
  55188. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  55189. * @param buffer The ArrayBuffer that should be converted.
  55190. * @returns The buffer as Float32Array.
  55191. */
  55192. private getFloat32ArrayFromArrayBuffer;
  55193. /**
  55194. * Get the current class name of the texture useful for serialization or dynamic coding.
  55195. * @returns "EquiRectangularCubeTexture"
  55196. */
  55197. getClassName(): string;
  55198. /**
  55199. * Create a clone of the current EquiRectangularCubeTexture and return it.
  55200. * @returns A clone of the current EquiRectangularCubeTexture.
  55201. */
  55202. clone(): EquiRectangularCubeTexture;
  55203. }
  55204. }
  55205. declare module "babylonjs/Misc/tga" {
  55206. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55207. /**
  55208. * Based on jsTGALoader - Javascript loader for TGA file
  55209. * By Vincent Thibault
  55210. * @see http://blog.robrowser.com/javascript-tga-loader.html
  55211. */
  55212. export class TGATools {
  55213. private static _TYPE_INDEXED;
  55214. private static _TYPE_RGB;
  55215. private static _TYPE_GREY;
  55216. private static _TYPE_RLE_INDEXED;
  55217. private static _TYPE_RLE_RGB;
  55218. private static _TYPE_RLE_GREY;
  55219. private static _ORIGIN_MASK;
  55220. private static _ORIGIN_SHIFT;
  55221. private static _ORIGIN_BL;
  55222. private static _ORIGIN_BR;
  55223. private static _ORIGIN_UL;
  55224. private static _ORIGIN_UR;
  55225. /**
  55226. * Gets the header of a TGA file
  55227. * @param data defines the TGA data
  55228. * @returns the header
  55229. */
  55230. static GetTGAHeader(data: Uint8Array): any;
  55231. /**
  55232. * Uploads TGA content to a Babylon Texture
  55233. * @hidden
  55234. */
  55235. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  55236. /** @hidden */
  55237. 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;
  55238. /** @hidden */
  55239. 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;
  55240. /** @hidden */
  55241. 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;
  55242. /** @hidden */
  55243. 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;
  55244. /** @hidden */
  55245. 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;
  55246. /** @hidden */
  55247. 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;
  55248. }
  55249. }
  55250. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  55251. import { Nullable } from "babylonjs/types";
  55252. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55253. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55254. /**
  55255. * Implementation of the TGA Texture Loader.
  55256. * @hidden
  55257. */
  55258. export class _TGATextureLoader implements IInternalTextureLoader {
  55259. /**
  55260. * Defines wether the loader supports cascade loading the different faces.
  55261. */
  55262. readonly supportCascades: boolean;
  55263. /**
  55264. * This returns if the loader support the current file information.
  55265. * @param extension defines the file extension of the file being loaded
  55266. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55267. * @param fallback defines the fallback internal texture if any
  55268. * @param isBase64 defines whether the texture is encoded as a base64
  55269. * @param isBuffer defines whether the texture data are stored as a buffer
  55270. * @returns true if the loader can load the specified file
  55271. */
  55272. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55273. /**
  55274. * Transform the url before loading if required.
  55275. * @param rootUrl the url of the texture
  55276. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55277. * @returns the transformed texture
  55278. */
  55279. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55280. /**
  55281. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55282. * @param rootUrl the url of the texture
  55283. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55284. * @returns the fallback texture
  55285. */
  55286. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55287. /**
  55288. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  55289. * @param data contains the texture data
  55290. * @param texture defines the BabylonJS internal texture
  55291. * @param createPolynomials will be true if polynomials have been requested
  55292. * @param onLoad defines the callback to trigger once the texture is ready
  55293. * @param onError defines the callback to trigger in case of error
  55294. */
  55295. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55296. /**
  55297. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55298. * @param data contains the texture data
  55299. * @param texture defines the BabylonJS internal texture
  55300. * @param callback defines the method to call once ready to upload
  55301. */
  55302. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55303. }
  55304. }
  55305. declare module "babylonjs/Misc/basis" {
  55306. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55307. /**
  55308. * Info about the .basis files
  55309. */
  55310. class BasisFileInfo {
  55311. /**
  55312. * If the file has alpha
  55313. */
  55314. hasAlpha: boolean;
  55315. /**
  55316. * Info about each image of the basis file
  55317. */
  55318. images: Array<{
  55319. levels: Array<{
  55320. width: number;
  55321. height: number;
  55322. transcodedPixels: ArrayBufferView;
  55323. }>;
  55324. }>;
  55325. }
  55326. /**
  55327. * Result of transcoding a basis file
  55328. */
  55329. class TranscodeResult {
  55330. /**
  55331. * Info about the .basis file
  55332. */
  55333. fileInfo: BasisFileInfo;
  55334. /**
  55335. * Format to use when loading the file
  55336. */
  55337. format: number;
  55338. }
  55339. /**
  55340. * Configuration options for the Basis transcoder
  55341. */
  55342. export class BasisTranscodeConfiguration {
  55343. /**
  55344. * Supported compression formats used to determine the supported output format of the transcoder
  55345. */
  55346. supportedCompressionFormats?: {
  55347. /**
  55348. * etc1 compression format
  55349. */
  55350. etc1?: boolean;
  55351. /**
  55352. * s3tc compression format
  55353. */
  55354. s3tc?: boolean;
  55355. /**
  55356. * pvrtc compression format
  55357. */
  55358. pvrtc?: boolean;
  55359. /**
  55360. * etc2 compression format
  55361. */
  55362. etc2?: boolean;
  55363. };
  55364. /**
  55365. * If mipmap levels should be loaded for transcoded images (Default: true)
  55366. */
  55367. loadMipmapLevels?: boolean;
  55368. /**
  55369. * Index of a single image to load (Default: all images)
  55370. */
  55371. loadSingleImage?: number;
  55372. }
  55373. /**
  55374. * Used to load .Basis files
  55375. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  55376. */
  55377. export class BasisTools {
  55378. private static _IgnoreSupportedFormats;
  55379. /**
  55380. * URL to use when loading the basis transcoder
  55381. */
  55382. static JSModuleURL: string;
  55383. /**
  55384. * URL to use when loading the wasm module for the transcoder
  55385. */
  55386. static WasmModuleURL: string;
  55387. /**
  55388. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  55389. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  55390. * @returns internal format corresponding to the Basis format
  55391. */
  55392. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  55393. private static _WorkerPromise;
  55394. private static _Worker;
  55395. private static _actionId;
  55396. private static _CreateWorkerAsync;
  55397. /**
  55398. * Transcodes a loaded image file to compressed pixel data
  55399. * @param imageData image data to transcode
  55400. * @param config configuration options for the transcoding
  55401. * @returns a promise resulting in the transcoded image
  55402. */
  55403. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  55404. /**
  55405. * Loads a texture from the transcode result
  55406. * @param texture texture load to
  55407. * @param transcodeResult the result of transcoding the basis file to load from
  55408. */
  55409. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  55410. }
  55411. }
  55412. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  55413. import { Nullable } from "babylonjs/types";
  55414. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55415. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55416. /**
  55417. * Loader for .basis file format
  55418. */
  55419. export class _BasisTextureLoader implements IInternalTextureLoader {
  55420. /**
  55421. * Defines whether the loader supports cascade loading the different faces.
  55422. */
  55423. readonly supportCascades: boolean;
  55424. /**
  55425. * This returns if the loader support the current file information.
  55426. * @param extension defines the file extension of the file being loaded
  55427. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55428. * @param fallback defines the fallback internal texture if any
  55429. * @param isBase64 defines whether the texture is encoded as a base64
  55430. * @param isBuffer defines whether the texture data are stored as a buffer
  55431. * @returns true if the loader can load the specified file
  55432. */
  55433. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55434. /**
  55435. * Transform the url before loading if required.
  55436. * @param rootUrl the url of the texture
  55437. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55438. * @returns the transformed texture
  55439. */
  55440. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55441. /**
  55442. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55443. * @param rootUrl the url of the texture
  55444. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55445. * @returns the fallback texture
  55446. */
  55447. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55448. /**
  55449. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  55450. * @param data contains the texture data
  55451. * @param texture defines the BabylonJS internal texture
  55452. * @param createPolynomials will be true if polynomials have been requested
  55453. * @param onLoad defines the callback to trigger once the texture is ready
  55454. * @param onError defines the callback to trigger in case of error
  55455. */
  55456. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55457. /**
  55458. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55459. * @param data contains the texture data
  55460. * @param texture defines the BabylonJS internal texture
  55461. * @param callback defines the method to call once ready to upload
  55462. */
  55463. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55464. }
  55465. }
  55466. declare module "babylonjs/Materials/Textures/Loaders/index" {
  55467. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  55468. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  55469. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  55470. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  55471. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  55472. }
  55473. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  55474. import { Scene } from "babylonjs/scene";
  55475. import { Texture } from "babylonjs/Materials/Textures/texture";
  55476. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55477. /**
  55478. * 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.
  55479. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55480. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55481. */
  55482. export class CustomProceduralTexture extends ProceduralTexture {
  55483. private _animate;
  55484. private _time;
  55485. private _config;
  55486. private _texturePath;
  55487. /**
  55488. * Instantiates a new Custom Procedural Texture.
  55489. * 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.
  55490. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55491. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55492. * @param name Define the name of the texture
  55493. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  55494. * @param size Define the size of the texture to create
  55495. * @param scene Define the scene the texture belongs to
  55496. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  55497. * @param generateMipMaps Define if the texture should creates mip maps or not
  55498. */
  55499. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55500. private _loadJson;
  55501. /**
  55502. * Is the texture ready to be used ? (rendered at least once)
  55503. * @returns true if ready, otherwise, false.
  55504. */
  55505. isReady(): boolean;
  55506. /**
  55507. * Render the texture to its associated render target.
  55508. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  55509. */
  55510. render(useCameraPostProcess?: boolean): void;
  55511. /**
  55512. * Update the list of dependant textures samplers in the shader.
  55513. */
  55514. updateTextures(): void;
  55515. /**
  55516. * Update the uniform values of the procedural texture in the shader.
  55517. */
  55518. updateShaderUniforms(): void;
  55519. /**
  55520. * Define if the texture animates or not.
  55521. */
  55522. animate: boolean;
  55523. }
  55524. }
  55525. declare module "babylonjs/Shaders/noise.fragment" {
  55526. /** @hidden */
  55527. export var noisePixelShader: {
  55528. name: string;
  55529. shader: string;
  55530. };
  55531. }
  55532. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  55533. import { Nullable } from "babylonjs/types";
  55534. import { Scene } from "babylonjs/scene";
  55535. import { Texture } from "babylonjs/Materials/Textures/texture";
  55536. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55537. import "babylonjs/Shaders/noise.fragment";
  55538. /**
  55539. * Class used to generate noise procedural textures
  55540. */
  55541. export class NoiseProceduralTexture extends ProceduralTexture {
  55542. private _time;
  55543. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  55544. brightness: number;
  55545. /** Defines the number of octaves to process */
  55546. octaves: number;
  55547. /** Defines the level of persistence (0.8 by default) */
  55548. persistence: number;
  55549. /** Gets or sets animation speed factor (default is 1) */
  55550. animationSpeedFactor: number;
  55551. /**
  55552. * Creates a new NoiseProceduralTexture
  55553. * @param name defines the name fo the texture
  55554. * @param size defines the size of the texture (default is 256)
  55555. * @param scene defines the hosting scene
  55556. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  55557. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  55558. */
  55559. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55560. private _updateShaderUniforms;
  55561. protected _getDefines(): string;
  55562. /** Generate the current state of the procedural texture */
  55563. render(useCameraPostProcess?: boolean): void;
  55564. /**
  55565. * Serializes this noise procedural texture
  55566. * @returns a serialized noise procedural texture object
  55567. */
  55568. serialize(): any;
  55569. /**
  55570. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  55571. * @param parsedTexture defines parsed texture data
  55572. * @param scene defines the current scene
  55573. * @param rootUrl defines the root URL containing noise procedural texture information
  55574. * @returns a parsed NoiseProceduralTexture
  55575. */
  55576. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  55577. }
  55578. }
  55579. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  55580. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  55581. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  55582. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55583. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  55584. }
  55585. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  55586. import { Nullable } from "babylonjs/types";
  55587. import { Scene } from "babylonjs/scene";
  55588. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  55589. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55590. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  55591. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55592. /**
  55593. * Raw cube texture where the raw buffers are passed in
  55594. */
  55595. export class RawCubeTexture extends CubeTexture {
  55596. /**
  55597. * Creates a cube texture where the raw buffers are passed in.
  55598. * @param scene defines the scene the texture is attached to
  55599. * @param data defines the array of data to use to create each face
  55600. * @param size defines the size of the textures
  55601. * @param format defines the format of the data
  55602. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  55603. * @param generateMipMaps defines if the engine should generate the mip levels
  55604. * @param invertY defines if data must be stored with Y axis inverted
  55605. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  55606. * @param compression defines the compression used (null by default)
  55607. */
  55608. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  55609. /**
  55610. * Updates the raw cube texture.
  55611. * @param data defines the data to store
  55612. * @param format defines the data format
  55613. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  55614. * @param invertY defines if data must be stored with Y axis inverted
  55615. * @param compression defines the compression used (null by default)
  55616. * @param level defines which level of the texture to update
  55617. */
  55618. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  55619. /**
  55620. * Updates a raw cube texture with RGBD encoded data.
  55621. * @param data defines the array of data [mipmap][face] to use to create each face
  55622. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  55623. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55624. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55625. * @returns a promsie that resolves when the operation is complete
  55626. */
  55627. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  55628. /**
  55629. * Clones the raw cube texture.
  55630. * @return a new cube texture
  55631. */
  55632. clone(): CubeTexture;
  55633. /** @hidden */
  55634. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  55635. }
  55636. }
  55637. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  55638. import { Scene } from "babylonjs/scene";
  55639. import { Texture } from "babylonjs/Materials/Textures/texture";
  55640. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55641. /**
  55642. * Class used to store 3D textures containing user data
  55643. */
  55644. export class RawTexture3D extends Texture {
  55645. /** Gets or sets the texture format to use */
  55646. format: number;
  55647. private _engine;
  55648. /**
  55649. * Create a new RawTexture3D
  55650. * @param data defines the data of the texture
  55651. * @param width defines the width of the texture
  55652. * @param height defines the height of the texture
  55653. * @param depth defines the depth of the texture
  55654. * @param format defines the texture format to use
  55655. * @param scene defines the hosting scene
  55656. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55657. * @param invertY defines if texture must be stored with Y axis inverted
  55658. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55659. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55660. */
  55661. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55662. /** Gets or sets the texture format to use */
  55663. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55664. /**
  55665. * Update the texture with new data
  55666. * @param data defines the data to store in the texture
  55667. */
  55668. update(data: ArrayBufferView): void;
  55669. }
  55670. }
  55671. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  55672. import { Scene } from "babylonjs/scene";
  55673. import { Texture } from "babylonjs/Materials/Textures/texture";
  55674. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55675. /**
  55676. * Class used to store 2D array textures containing user data
  55677. */
  55678. export class RawTexture2DArray extends Texture {
  55679. /** Gets or sets the texture format to use */
  55680. format: number;
  55681. private _engine;
  55682. /**
  55683. * Create a new RawTexture2DArray
  55684. * @param data defines the data of the texture
  55685. * @param width defines the width of the texture
  55686. * @param height defines the height of the texture
  55687. * @param depth defines the number of layers of the texture
  55688. * @param format defines the texture format to use
  55689. * @param scene defines the hosting scene
  55690. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55691. * @param invertY defines if texture must be stored with Y axis inverted
  55692. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55693. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55694. */
  55695. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55696. /** Gets or sets the texture format to use */
  55697. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55698. /**
  55699. * Update the texture with new data
  55700. * @param data defines the data to store in the texture
  55701. */
  55702. update(data: ArrayBufferView): void;
  55703. }
  55704. }
  55705. declare module "babylonjs/Materials/Textures/refractionTexture" {
  55706. import { Scene } from "babylonjs/scene";
  55707. import { Plane } from "babylonjs/Maths/math.plane";
  55708. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  55709. /**
  55710. * Creates a refraction texture used by refraction channel of the standard material.
  55711. * It is like a mirror but to see through a material.
  55712. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55713. */
  55714. export class RefractionTexture extends RenderTargetTexture {
  55715. /**
  55716. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  55717. * 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.
  55718. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55719. */
  55720. refractionPlane: Plane;
  55721. /**
  55722. * Define how deep under the surface we should see.
  55723. */
  55724. depth: number;
  55725. /**
  55726. * Creates a refraction texture used by refraction channel of the standard material.
  55727. * It is like a mirror but to see through a material.
  55728. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55729. * @param name Define the texture name
  55730. * @param size Define the size of the underlying texture
  55731. * @param scene Define the scene the refraction belongs to
  55732. * @param generateMipMaps Define if we need to generate mips level for the refraction
  55733. */
  55734. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  55735. /**
  55736. * Clone the refraction texture.
  55737. * @returns the cloned texture
  55738. */
  55739. clone(): RefractionTexture;
  55740. /**
  55741. * Serialize the texture to a JSON representation you could use in Parse later on
  55742. * @returns the serialized JSON representation
  55743. */
  55744. serialize(): any;
  55745. }
  55746. }
  55747. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  55748. import { Nullable } from "babylonjs/types";
  55749. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55750. import { Matrix } from "babylonjs/Maths/math.vector";
  55751. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  55752. import "babylonjs/Engines/Extensions/engine.videoTexture";
  55753. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  55754. import { Scene } from "babylonjs/scene";
  55755. /**
  55756. * Defines the options related to the creation of an HtmlElementTexture
  55757. */
  55758. export interface IHtmlElementTextureOptions {
  55759. /**
  55760. * Defines wether mip maps should be created or not.
  55761. */
  55762. generateMipMaps?: boolean;
  55763. /**
  55764. * Defines the sampling mode of the texture.
  55765. */
  55766. samplingMode?: number;
  55767. /**
  55768. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  55769. */
  55770. engine: Nullable<ThinEngine>;
  55771. /**
  55772. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  55773. */
  55774. scene: Nullable<Scene>;
  55775. }
  55776. /**
  55777. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  55778. * To be as efficient as possible depending on your constraints nothing aside the first upload
  55779. * is automatically managed.
  55780. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  55781. * in your application.
  55782. *
  55783. * As the update is not automatic, you need to call them manually.
  55784. */
  55785. export class HtmlElementTexture extends BaseTexture {
  55786. /**
  55787. * The texture URL.
  55788. */
  55789. element: HTMLVideoElement | HTMLCanvasElement;
  55790. private static readonly DefaultOptions;
  55791. private _textureMatrix;
  55792. private _engine;
  55793. private _isVideo;
  55794. private _generateMipMaps;
  55795. private _samplingMode;
  55796. /**
  55797. * Instantiates a HtmlElementTexture from the following parameters.
  55798. *
  55799. * @param name Defines the name of the texture
  55800. * @param element Defines the video or canvas the texture is filled with
  55801. * @param options Defines the other none mandatory texture creation options
  55802. */
  55803. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  55804. private _createInternalTexture;
  55805. /**
  55806. * Returns the texture matrix used in most of the material.
  55807. */
  55808. getTextureMatrix(): Matrix;
  55809. /**
  55810. * Updates the content of the texture.
  55811. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  55812. */
  55813. update(invertY?: Nullable<boolean>): void;
  55814. }
  55815. }
  55816. declare module "babylonjs/Materials/Textures/index" {
  55817. export * from "babylonjs/Materials/Textures/baseTexture";
  55818. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  55819. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  55820. export * from "babylonjs/Materials/Textures/cubeTexture";
  55821. export * from "babylonjs/Materials/Textures/dynamicTexture";
  55822. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  55823. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  55824. export * from "babylonjs/Materials/Textures/internalTexture";
  55825. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  55826. export * from "babylonjs/Materials/Textures/Loaders/index";
  55827. export * from "babylonjs/Materials/Textures/mirrorTexture";
  55828. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  55829. export * from "babylonjs/Materials/Textures/Procedurals/index";
  55830. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  55831. export * from "babylonjs/Materials/Textures/rawTexture";
  55832. export * from "babylonjs/Materials/Textures/rawTexture3D";
  55833. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  55834. export * from "babylonjs/Materials/Textures/refractionTexture";
  55835. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  55836. export * from "babylonjs/Materials/Textures/texture";
  55837. export * from "babylonjs/Materials/Textures/videoTexture";
  55838. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  55839. }
  55840. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  55841. /**
  55842. * Enum used to define the target of a block
  55843. */
  55844. export enum NodeMaterialBlockTargets {
  55845. /** Vertex shader */
  55846. Vertex = 1,
  55847. /** Fragment shader */
  55848. Fragment = 2,
  55849. /** Neutral */
  55850. Neutral = 4,
  55851. /** Vertex and Fragment */
  55852. VertexAndFragment = 3
  55853. }
  55854. }
  55855. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  55856. /**
  55857. * Defines the kind of connection point for node based material
  55858. */
  55859. export enum NodeMaterialBlockConnectionPointTypes {
  55860. /** Float */
  55861. Float = 1,
  55862. /** Int */
  55863. Int = 2,
  55864. /** Vector2 */
  55865. Vector2 = 4,
  55866. /** Vector3 */
  55867. Vector3 = 8,
  55868. /** Vector4 */
  55869. Vector4 = 16,
  55870. /** Color3 */
  55871. Color3 = 32,
  55872. /** Color4 */
  55873. Color4 = 64,
  55874. /** Matrix */
  55875. Matrix = 128,
  55876. /** Detect type based on connection */
  55877. AutoDetect = 1024,
  55878. /** Output type that will be defined by input type */
  55879. BasedOnInput = 2048
  55880. }
  55881. }
  55882. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  55883. /**
  55884. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  55885. */
  55886. export enum NodeMaterialBlockConnectionPointMode {
  55887. /** Value is an uniform */
  55888. Uniform = 0,
  55889. /** Value is a mesh attribute */
  55890. Attribute = 1,
  55891. /** Value is a varying between vertex and fragment shaders */
  55892. Varying = 2,
  55893. /** Mode is undefined */
  55894. Undefined = 3
  55895. }
  55896. }
  55897. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  55898. /**
  55899. * Enum used to define system values e.g. values automatically provided by the system
  55900. */
  55901. export enum NodeMaterialSystemValues {
  55902. /** World */
  55903. World = 1,
  55904. /** View */
  55905. View = 2,
  55906. /** Projection */
  55907. Projection = 3,
  55908. /** ViewProjection */
  55909. ViewProjection = 4,
  55910. /** WorldView */
  55911. WorldView = 5,
  55912. /** WorldViewProjection */
  55913. WorldViewProjection = 6,
  55914. /** CameraPosition */
  55915. CameraPosition = 7,
  55916. /** Fog Color */
  55917. FogColor = 8,
  55918. /** Delta time */
  55919. DeltaTime = 9
  55920. }
  55921. }
  55922. declare module "babylonjs/Materials/Node/Enums/index" {
  55923. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  55924. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  55925. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  55926. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  55927. }
  55928. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  55929. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55930. /**
  55931. * Root class for all node material optimizers
  55932. */
  55933. export class NodeMaterialOptimizer {
  55934. /**
  55935. * Function used to optimize a NodeMaterial graph
  55936. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  55937. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  55938. */
  55939. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  55940. }
  55941. }
  55942. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  55943. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55944. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55945. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55946. import { Scene } from "babylonjs/scene";
  55947. /**
  55948. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  55949. */
  55950. export class TransformBlock extends NodeMaterialBlock {
  55951. /**
  55952. * Defines the value to use to complement W value to transform it to a Vector4
  55953. */
  55954. complementW: number;
  55955. /**
  55956. * Defines the value to use to complement z value to transform it to a Vector4
  55957. */
  55958. complementZ: number;
  55959. /**
  55960. * Creates a new TransformBlock
  55961. * @param name defines the block name
  55962. */
  55963. constructor(name: string);
  55964. /**
  55965. * Gets the current class name
  55966. * @returns the class name
  55967. */
  55968. getClassName(): string;
  55969. /**
  55970. * Gets the vector input
  55971. */
  55972. readonly vector: NodeMaterialConnectionPoint;
  55973. /**
  55974. * Gets the output component
  55975. */
  55976. readonly output: NodeMaterialConnectionPoint;
  55977. /**
  55978. * Gets the matrix transform input
  55979. */
  55980. readonly transform: NodeMaterialConnectionPoint;
  55981. protected _buildBlock(state: NodeMaterialBuildState): this;
  55982. serialize(): any;
  55983. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55984. protected _dumpPropertiesCode(): string;
  55985. }
  55986. }
  55987. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  55988. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55989. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55990. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55991. /**
  55992. * Block used to output the vertex position
  55993. */
  55994. export class VertexOutputBlock extends NodeMaterialBlock {
  55995. /**
  55996. * Creates a new VertexOutputBlock
  55997. * @param name defines the block name
  55998. */
  55999. constructor(name: string);
  56000. /**
  56001. * Gets the current class name
  56002. * @returns the class name
  56003. */
  56004. getClassName(): string;
  56005. /**
  56006. * Gets the vector input component
  56007. */
  56008. readonly vector: NodeMaterialConnectionPoint;
  56009. protected _buildBlock(state: NodeMaterialBuildState): this;
  56010. }
  56011. }
  56012. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  56013. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56014. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56015. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56016. /**
  56017. * Block used to output the final color
  56018. */
  56019. export class FragmentOutputBlock extends NodeMaterialBlock {
  56020. /**
  56021. * Create a new FragmentOutputBlock
  56022. * @param name defines the block name
  56023. */
  56024. constructor(name: string);
  56025. /**
  56026. * Gets the current class name
  56027. * @returns the class name
  56028. */
  56029. getClassName(): string;
  56030. /**
  56031. * Gets the rgba input component
  56032. */
  56033. readonly rgba: NodeMaterialConnectionPoint;
  56034. /**
  56035. * Gets the rgb input component
  56036. */
  56037. readonly rgb: NodeMaterialConnectionPoint;
  56038. /**
  56039. * Gets the a input component
  56040. */
  56041. readonly a: NodeMaterialConnectionPoint;
  56042. protected _buildBlock(state: NodeMaterialBuildState): this;
  56043. }
  56044. }
  56045. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  56046. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56047. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56048. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56049. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56050. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56051. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56052. import { Effect } from "babylonjs/Materials/effect";
  56053. import { Mesh } from "babylonjs/Meshes/mesh";
  56054. import { Nullable } from "babylonjs/types";
  56055. import { Scene } from "babylonjs/scene";
  56056. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56057. /**
  56058. * Block used to read a reflection texture from a sampler
  56059. */
  56060. export class ReflectionTextureBlock extends NodeMaterialBlock {
  56061. private _define3DName;
  56062. private _defineCubicName;
  56063. private _defineExplicitName;
  56064. private _defineProjectionName;
  56065. private _defineLocalCubicName;
  56066. private _defineSphericalName;
  56067. private _definePlanarName;
  56068. private _defineEquirectangularName;
  56069. private _defineMirroredEquirectangularFixedName;
  56070. private _defineEquirectangularFixedName;
  56071. private _defineSkyboxName;
  56072. private _cubeSamplerName;
  56073. private _2DSamplerName;
  56074. private _positionUVWName;
  56075. private _directionWName;
  56076. private _reflectionCoordsName;
  56077. private _reflection2DCoordsName;
  56078. private _reflectionColorName;
  56079. private _reflectionMatrixName;
  56080. /**
  56081. * Gets or sets the texture associated with the node
  56082. */
  56083. texture: Nullable<BaseTexture>;
  56084. /**
  56085. * Create a new TextureBlock
  56086. * @param name defines the block name
  56087. */
  56088. constructor(name: string);
  56089. /**
  56090. * Gets the current class name
  56091. * @returns the class name
  56092. */
  56093. getClassName(): string;
  56094. /**
  56095. * Gets the world position input component
  56096. */
  56097. readonly position: NodeMaterialConnectionPoint;
  56098. /**
  56099. * Gets the world position input component
  56100. */
  56101. readonly worldPosition: NodeMaterialConnectionPoint;
  56102. /**
  56103. * Gets the world normal input component
  56104. */
  56105. readonly worldNormal: NodeMaterialConnectionPoint;
  56106. /**
  56107. * Gets the world input component
  56108. */
  56109. readonly world: NodeMaterialConnectionPoint;
  56110. /**
  56111. * Gets the camera (or eye) position component
  56112. */
  56113. readonly cameraPosition: NodeMaterialConnectionPoint;
  56114. /**
  56115. * Gets the view input component
  56116. */
  56117. readonly view: NodeMaterialConnectionPoint;
  56118. /**
  56119. * Gets the rgb output component
  56120. */
  56121. readonly rgb: NodeMaterialConnectionPoint;
  56122. /**
  56123. * Gets the r output component
  56124. */
  56125. readonly r: NodeMaterialConnectionPoint;
  56126. /**
  56127. * Gets the g output component
  56128. */
  56129. readonly g: NodeMaterialConnectionPoint;
  56130. /**
  56131. * Gets the b output component
  56132. */
  56133. readonly b: NodeMaterialConnectionPoint;
  56134. autoConfigure(material: NodeMaterial): void;
  56135. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56136. isReady(): boolean;
  56137. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56138. private _injectVertexCode;
  56139. private _writeOutput;
  56140. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56141. protected _dumpPropertiesCode(): string;
  56142. serialize(): any;
  56143. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56144. }
  56145. }
  56146. declare module "babylonjs/Materials/Node/nodeMaterial" {
  56147. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56148. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56149. import { Scene } from "babylonjs/scene";
  56150. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56151. import { Matrix } from "babylonjs/Maths/math.vector";
  56152. import { Mesh } from "babylonjs/Meshes/mesh";
  56153. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56154. import { Observable } from "babylonjs/Misc/observable";
  56155. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56156. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  56157. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  56158. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  56159. import { Nullable } from "babylonjs/types";
  56160. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56161. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56162. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56163. /**
  56164. * Interface used to configure the node material editor
  56165. */
  56166. export interface INodeMaterialEditorOptions {
  56167. /** Define the URl to load node editor script */
  56168. editorURL?: string;
  56169. }
  56170. /** @hidden */
  56171. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  56172. /** BONES */
  56173. NUM_BONE_INFLUENCERS: number;
  56174. BonesPerMesh: number;
  56175. BONETEXTURE: boolean;
  56176. /** MORPH TARGETS */
  56177. MORPHTARGETS: boolean;
  56178. MORPHTARGETS_NORMAL: boolean;
  56179. MORPHTARGETS_TANGENT: boolean;
  56180. MORPHTARGETS_UV: boolean;
  56181. NUM_MORPH_INFLUENCERS: number;
  56182. /** IMAGE PROCESSING */
  56183. IMAGEPROCESSING: boolean;
  56184. VIGNETTE: boolean;
  56185. VIGNETTEBLENDMODEMULTIPLY: boolean;
  56186. VIGNETTEBLENDMODEOPAQUE: boolean;
  56187. TONEMAPPING: boolean;
  56188. TONEMAPPING_ACES: boolean;
  56189. CONTRAST: boolean;
  56190. EXPOSURE: boolean;
  56191. COLORCURVES: boolean;
  56192. COLORGRADING: boolean;
  56193. COLORGRADING3D: boolean;
  56194. SAMPLER3DGREENDEPTH: boolean;
  56195. SAMPLER3DBGRMAP: boolean;
  56196. IMAGEPROCESSINGPOSTPROCESS: boolean;
  56197. /** MISC. */
  56198. BUMPDIRECTUV: number;
  56199. constructor();
  56200. setValue(name: string, value: boolean): void;
  56201. }
  56202. /**
  56203. * Class used to configure NodeMaterial
  56204. */
  56205. export interface INodeMaterialOptions {
  56206. /**
  56207. * Defines if blocks should emit comments
  56208. */
  56209. emitComments: boolean;
  56210. }
  56211. /**
  56212. * Class used to create a node based material built by assembling shader blocks
  56213. */
  56214. export class NodeMaterial extends PushMaterial {
  56215. private static _BuildIdGenerator;
  56216. private _options;
  56217. private _vertexCompilationState;
  56218. private _fragmentCompilationState;
  56219. private _sharedData;
  56220. private _buildId;
  56221. private _buildWasSuccessful;
  56222. private _cachedWorldViewMatrix;
  56223. private _cachedWorldViewProjectionMatrix;
  56224. private _optimizers;
  56225. private _animationFrame;
  56226. /** Define the URl to load node editor script */
  56227. static EditorURL: string;
  56228. private BJSNODEMATERIALEDITOR;
  56229. /** Get the inspector from bundle or global */
  56230. private _getGlobalNodeMaterialEditor;
  56231. /**
  56232. * Gets or sets data used by visual editor
  56233. * @see https://nme.babylonjs.com
  56234. */
  56235. editorData: any;
  56236. /**
  56237. * 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)
  56238. */
  56239. ignoreAlpha: boolean;
  56240. /**
  56241. * Defines the maximum number of lights that can be used in the material
  56242. */
  56243. maxSimultaneousLights: number;
  56244. /**
  56245. * Observable raised when the material is built
  56246. */
  56247. onBuildObservable: Observable<NodeMaterial>;
  56248. /**
  56249. * Gets or sets the root nodes of the material vertex shader
  56250. */
  56251. _vertexOutputNodes: NodeMaterialBlock[];
  56252. /**
  56253. * Gets or sets the root nodes of the material fragment (pixel) shader
  56254. */
  56255. _fragmentOutputNodes: NodeMaterialBlock[];
  56256. /** Gets or sets options to control the node material overall behavior */
  56257. options: INodeMaterialOptions;
  56258. /**
  56259. * Default configuration related to image processing available in the standard Material.
  56260. */
  56261. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56262. /**
  56263. * Gets the image processing configuration used either in this material.
  56264. */
  56265. /**
  56266. * Sets the Default image processing configuration used either in the this material.
  56267. *
  56268. * If sets to null, the scene one is in use.
  56269. */
  56270. imageProcessingConfiguration: ImageProcessingConfiguration;
  56271. /**
  56272. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  56273. */
  56274. attachedBlocks: NodeMaterialBlock[];
  56275. /**
  56276. * Create a new node based material
  56277. * @param name defines the material name
  56278. * @param scene defines the hosting scene
  56279. * @param options defines creation option
  56280. */
  56281. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  56282. /**
  56283. * Gets the current class name of the material e.g. "NodeMaterial"
  56284. * @returns the class name
  56285. */
  56286. getClassName(): string;
  56287. /**
  56288. * Keep track of the image processing observer to allow dispose and replace.
  56289. */
  56290. private _imageProcessingObserver;
  56291. /**
  56292. * Attaches a new image processing configuration to the Standard Material.
  56293. * @param configuration
  56294. */
  56295. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56296. /**
  56297. * Get a block by its name
  56298. * @param name defines the name of the block to retrieve
  56299. * @returns the required block or null if not found
  56300. */
  56301. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  56302. /**
  56303. * Get a block by its name
  56304. * @param predicate defines the predicate used to find the good candidate
  56305. * @returns the required block or null if not found
  56306. */
  56307. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  56308. /**
  56309. * Get an input block by its name
  56310. * @param predicate defines the predicate used to find the good candidate
  56311. * @returns the required input block or null if not found
  56312. */
  56313. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  56314. /**
  56315. * Gets the list of input blocks attached to this material
  56316. * @returns an array of InputBlocks
  56317. */
  56318. getInputBlocks(): InputBlock[];
  56319. /**
  56320. * Adds a new optimizer to the list of optimizers
  56321. * @param optimizer defines the optimizers to add
  56322. * @returns the current material
  56323. */
  56324. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  56325. /**
  56326. * Remove an optimizer from the list of optimizers
  56327. * @param optimizer defines the optimizers to remove
  56328. * @returns the current material
  56329. */
  56330. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  56331. /**
  56332. * Add a new block to the list of output nodes
  56333. * @param node defines the node to add
  56334. * @returns the current material
  56335. */
  56336. addOutputNode(node: NodeMaterialBlock): this;
  56337. /**
  56338. * Remove a block from the list of root nodes
  56339. * @param node defines the node to remove
  56340. * @returns the current material
  56341. */
  56342. removeOutputNode(node: NodeMaterialBlock): this;
  56343. private _addVertexOutputNode;
  56344. private _removeVertexOutputNode;
  56345. private _addFragmentOutputNode;
  56346. private _removeFragmentOutputNode;
  56347. /**
  56348. * Specifies if the material will require alpha blending
  56349. * @returns a boolean specifying if alpha blending is needed
  56350. */
  56351. needAlphaBlending(): boolean;
  56352. /**
  56353. * Specifies if this material should be rendered in alpha test mode
  56354. * @returns a boolean specifying if an alpha test is needed.
  56355. */
  56356. needAlphaTesting(): boolean;
  56357. private _initializeBlock;
  56358. private _resetDualBlocks;
  56359. /**
  56360. * Build the material and generates the inner effect
  56361. * @param verbose defines if the build should log activity
  56362. */
  56363. build(verbose?: boolean): void;
  56364. /**
  56365. * Runs an otpimization phase to try to improve the shader code
  56366. */
  56367. optimize(): void;
  56368. private _prepareDefinesForAttributes;
  56369. /**
  56370. * Get if the submesh is ready to be used and all its information available.
  56371. * Child classes can use it to update shaders
  56372. * @param mesh defines the mesh to check
  56373. * @param subMesh defines which submesh to check
  56374. * @param useInstances specifies that instances should be used
  56375. * @returns a boolean indicating that the submesh is ready or not
  56376. */
  56377. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56378. /**
  56379. * Get a string representing the shaders built by the current node graph
  56380. */
  56381. readonly compiledShaders: string;
  56382. /**
  56383. * Binds the world matrix to the material
  56384. * @param world defines the world transformation matrix
  56385. */
  56386. bindOnlyWorldMatrix(world: Matrix): void;
  56387. /**
  56388. * Binds the submesh to this material by preparing the effect and shader to draw
  56389. * @param world defines the world transformation matrix
  56390. * @param mesh defines the mesh containing the submesh
  56391. * @param subMesh defines the submesh to bind the material to
  56392. */
  56393. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56394. /**
  56395. * Gets the active textures from the material
  56396. * @returns an array of textures
  56397. */
  56398. getActiveTextures(): BaseTexture[];
  56399. /**
  56400. * Gets the list of texture blocks
  56401. * @returns an array of texture blocks
  56402. */
  56403. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  56404. /**
  56405. * Specifies if the material uses a texture
  56406. * @param texture defines the texture to check against the material
  56407. * @returns a boolean specifying if the material uses the texture
  56408. */
  56409. hasTexture(texture: BaseTexture): boolean;
  56410. /**
  56411. * Disposes the material
  56412. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  56413. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  56414. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  56415. */
  56416. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  56417. /** Creates the node editor window. */
  56418. private _createNodeEditor;
  56419. /**
  56420. * Launch the node material editor
  56421. * @param config Define the configuration of the editor
  56422. * @return a promise fulfilled when the node editor is visible
  56423. */
  56424. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  56425. /**
  56426. * Clear the current material
  56427. */
  56428. clear(): void;
  56429. /**
  56430. * Clear the current material and set it to a default state
  56431. */
  56432. setToDefault(): void;
  56433. /**
  56434. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  56435. * @param url defines the url to load from
  56436. * @returns a promise that will fullfil when the material is fully loaded
  56437. */
  56438. loadAsync(url: string): Promise<void>;
  56439. private _gatherBlocks;
  56440. /**
  56441. * Generate a string containing the code declaration required to create an equivalent of this material
  56442. * @returns a string
  56443. */
  56444. generateCode(): string;
  56445. /**
  56446. * Serializes this material in a JSON representation
  56447. * @returns the serialized material object
  56448. */
  56449. serialize(): any;
  56450. private _restoreConnections;
  56451. /**
  56452. * Clear the current graph and load a new one from a serialization object
  56453. * @param source defines the JSON representation of the material
  56454. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56455. */
  56456. loadFromSerialization(source: any, rootUrl?: string): void;
  56457. /**
  56458. * Creates a node material from parsed material data
  56459. * @param source defines the JSON representation of the material
  56460. * @param scene defines the hosting scene
  56461. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56462. * @returns a new node material
  56463. */
  56464. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  56465. /**
  56466. * Creates a new node material set to default basic configuration
  56467. * @param name defines the name of the material
  56468. * @param scene defines the hosting scene
  56469. * @returns a new NodeMaterial
  56470. */
  56471. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  56472. }
  56473. }
  56474. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  56475. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56476. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56477. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56478. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56479. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56480. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56481. import { Effect } from "babylonjs/Materials/effect";
  56482. import { Mesh } from "babylonjs/Meshes/mesh";
  56483. import { Nullable } from "babylonjs/types";
  56484. import { Texture } from "babylonjs/Materials/Textures/texture";
  56485. import { Scene } from "babylonjs/scene";
  56486. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56487. /**
  56488. * Block used to read a texture from a sampler
  56489. */
  56490. export class TextureBlock extends NodeMaterialBlock {
  56491. private _defineName;
  56492. private _linearDefineName;
  56493. private _tempTextureRead;
  56494. private _samplerName;
  56495. private _transformedUVName;
  56496. private _textureTransformName;
  56497. private _textureInfoName;
  56498. private _mainUVName;
  56499. private _mainUVDefineName;
  56500. /**
  56501. * Gets or sets the texture associated with the node
  56502. */
  56503. texture: Nullable<Texture>;
  56504. /**
  56505. * Create a new TextureBlock
  56506. * @param name defines the block name
  56507. */
  56508. constructor(name: string);
  56509. /**
  56510. * Gets the current class name
  56511. * @returns the class name
  56512. */
  56513. getClassName(): string;
  56514. /**
  56515. * Gets the uv input component
  56516. */
  56517. readonly uv: NodeMaterialConnectionPoint;
  56518. /**
  56519. * Gets the rgba output component
  56520. */
  56521. readonly rgba: NodeMaterialConnectionPoint;
  56522. /**
  56523. * Gets the rgb output component
  56524. */
  56525. readonly rgb: NodeMaterialConnectionPoint;
  56526. /**
  56527. * Gets the r output component
  56528. */
  56529. readonly r: NodeMaterialConnectionPoint;
  56530. /**
  56531. * Gets the g output component
  56532. */
  56533. readonly g: NodeMaterialConnectionPoint;
  56534. /**
  56535. * Gets the b output component
  56536. */
  56537. readonly b: NodeMaterialConnectionPoint;
  56538. /**
  56539. * Gets the a output component
  56540. */
  56541. readonly a: NodeMaterialConnectionPoint;
  56542. readonly target: NodeMaterialBlockTargets;
  56543. autoConfigure(material: NodeMaterial): void;
  56544. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56545. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56546. isReady(): boolean;
  56547. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56548. private readonly _isMixed;
  56549. private _injectVertexCode;
  56550. private _writeTextureRead;
  56551. private _writeOutput;
  56552. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56553. protected _dumpPropertiesCode(): string;
  56554. serialize(): any;
  56555. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56556. }
  56557. }
  56558. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  56559. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56561. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56562. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56563. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56564. import { Scene } from "babylonjs/scene";
  56565. /**
  56566. * Class used to store shared data between 2 NodeMaterialBuildState
  56567. */
  56568. export class NodeMaterialBuildStateSharedData {
  56569. /**
  56570. * Gets the list of emitted varyings
  56571. */
  56572. temps: string[];
  56573. /**
  56574. * Gets the list of emitted varyings
  56575. */
  56576. varyings: string[];
  56577. /**
  56578. * Gets the varying declaration string
  56579. */
  56580. varyingDeclaration: string;
  56581. /**
  56582. * Input blocks
  56583. */
  56584. inputBlocks: InputBlock[];
  56585. /**
  56586. * Input blocks
  56587. */
  56588. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  56589. /**
  56590. * Bindable blocks (Blocks that need to set data to the effect)
  56591. */
  56592. bindableBlocks: NodeMaterialBlock[];
  56593. /**
  56594. * List of blocks that can provide a compilation fallback
  56595. */
  56596. blocksWithFallbacks: NodeMaterialBlock[];
  56597. /**
  56598. * List of blocks that can provide a define update
  56599. */
  56600. blocksWithDefines: NodeMaterialBlock[];
  56601. /**
  56602. * List of blocks that can provide a repeatable content
  56603. */
  56604. repeatableContentBlocks: NodeMaterialBlock[];
  56605. /**
  56606. * List of blocks that can provide a dynamic list of uniforms
  56607. */
  56608. dynamicUniformBlocks: NodeMaterialBlock[];
  56609. /**
  56610. * List of blocks that can block the isReady function for the material
  56611. */
  56612. blockingBlocks: NodeMaterialBlock[];
  56613. /**
  56614. * Gets the list of animated inputs
  56615. */
  56616. animatedInputs: InputBlock[];
  56617. /**
  56618. * Build Id used to avoid multiple recompilations
  56619. */
  56620. buildId: number;
  56621. /** List of emitted variables */
  56622. variableNames: {
  56623. [key: string]: number;
  56624. };
  56625. /** List of emitted defines */
  56626. defineNames: {
  56627. [key: string]: number;
  56628. };
  56629. /** Should emit comments? */
  56630. emitComments: boolean;
  56631. /** Emit build activity */
  56632. verbose: boolean;
  56633. /** Gets or sets the hosting scene */
  56634. scene: Scene;
  56635. /**
  56636. * Gets the compilation hints emitted at compilation time
  56637. */
  56638. hints: {
  56639. needWorldViewMatrix: boolean;
  56640. needWorldViewProjectionMatrix: boolean;
  56641. needAlphaBlending: boolean;
  56642. needAlphaTesting: boolean;
  56643. };
  56644. /**
  56645. * List of compilation checks
  56646. */
  56647. checks: {
  56648. emitVertex: boolean;
  56649. emitFragment: boolean;
  56650. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  56651. };
  56652. /** Creates a new shared data */
  56653. constructor();
  56654. /**
  56655. * Emits console errors and exceptions if there is a failing check
  56656. */
  56657. emitErrors(): void;
  56658. }
  56659. }
  56660. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  56661. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56662. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56663. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  56664. /**
  56665. * Class used to store node based material build state
  56666. */
  56667. export class NodeMaterialBuildState {
  56668. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  56669. supportUniformBuffers: boolean;
  56670. /**
  56671. * Gets the list of emitted attributes
  56672. */
  56673. attributes: string[];
  56674. /**
  56675. * Gets the list of emitted uniforms
  56676. */
  56677. uniforms: string[];
  56678. /**
  56679. * Gets the list of emitted constants
  56680. */
  56681. constants: string[];
  56682. /**
  56683. * Gets the list of emitted samplers
  56684. */
  56685. samplers: string[];
  56686. /**
  56687. * Gets the list of emitted functions
  56688. */
  56689. functions: {
  56690. [key: string]: string;
  56691. };
  56692. /**
  56693. * Gets the list of emitted extensions
  56694. */
  56695. extensions: {
  56696. [key: string]: string;
  56697. };
  56698. /**
  56699. * Gets the target of the compilation state
  56700. */
  56701. target: NodeMaterialBlockTargets;
  56702. /**
  56703. * Gets the list of emitted counters
  56704. */
  56705. counters: {
  56706. [key: string]: number;
  56707. };
  56708. /**
  56709. * Shared data between multiple NodeMaterialBuildState instances
  56710. */
  56711. sharedData: NodeMaterialBuildStateSharedData;
  56712. /** @hidden */
  56713. _vertexState: NodeMaterialBuildState;
  56714. /** @hidden */
  56715. _attributeDeclaration: string;
  56716. /** @hidden */
  56717. _uniformDeclaration: string;
  56718. /** @hidden */
  56719. _constantDeclaration: string;
  56720. /** @hidden */
  56721. _samplerDeclaration: string;
  56722. /** @hidden */
  56723. _varyingTransfer: string;
  56724. private _repeatableContentAnchorIndex;
  56725. /** @hidden */
  56726. _builtCompilationString: string;
  56727. /**
  56728. * Gets the emitted compilation strings
  56729. */
  56730. compilationString: string;
  56731. /**
  56732. * Finalize the compilation strings
  56733. * @param state defines the current compilation state
  56734. */
  56735. finalize(state: NodeMaterialBuildState): void;
  56736. /** @hidden */
  56737. readonly _repeatableContentAnchor: string;
  56738. /** @hidden */
  56739. _getFreeVariableName(prefix: string): string;
  56740. /** @hidden */
  56741. _getFreeDefineName(prefix: string): string;
  56742. /** @hidden */
  56743. _excludeVariableName(name: string): void;
  56744. /** @hidden */
  56745. _emit2DSampler(name: string): void;
  56746. /** @hidden */
  56747. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  56748. /** @hidden */
  56749. _emitExtension(name: string, extension: string): void;
  56750. /** @hidden */
  56751. _emitFunction(name: string, code: string, comments: string): void;
  56752. /** @hidden */
  56753. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  56754. replaceStrings?: {
  56755. search: RegExp;
  56756. replace: string;
  56757. }[];
  56758. repeatKey?: string;
  56759. }): string;
  56760. /** @hidden */
  56761. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  56762. repeatKey?: string;
  56763. removeAttributes?: boolean;
  56764. removeUniforms?: boolean;
  56765. removeVaryings?: boolean;
  56766. removeIfDef?: boolean;
  56767. replaceStrings?: {
  56768. search: RegExp;
  56769. replace: string;
  56770. }[];
  56771. }, storeKey?: string): void;
  56772. /** @hidden */
  56773. _registerTempVariable(name: string): boolean;
  56774. /** @hidden */
  56775. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  56776. /** @hidden */
  56777. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  56778. /** @hidden */
  56779. _emitFloat(value: number): string;
  56780. }
  56781. }
  56782. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  56783. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56784. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56785. import { Nullable } from "babylonjs/types";
  56786. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56787. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56788. import { Effect } from "babylonjs/Materials/effect";
  56789. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56790. import { Mesh } from "babylonjs/Meshes/mesh";
  56791. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56792. import { Scene } from "babylonjs/scene";
  56793. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56794. /**
  56795. * Defines a block that can be used inside a node based material
  56796. */
  56797. export class NodeMaterialBlock {
  56798. private _buildId;
  56799. private _buildTarget;
  56800. private _target;
  56801. private _isFinalMerger;
  56802. private _isInput;
  56803. protected _isUnique: boolean;
  56804. /** @hidden */
  56805. _codeVariableName: string;
  56806. /** @hidden */
  56807. _inputs: NodeMaterialConnectionPoint[];
  56808. /** @hidden */
  56809. _outputs: NodeMaterialConnectionPoint[];
  56810. /** @hidden */
  56811. _preparationId: number;
  56812. /**
  56813. * Gets or sets the name of the block
  56814. */
  56815. name: string;
  56816. /**
  56817. * Gets or sets the unique id of the node
  56818. */
  56819. uniqueId: number;
  56820. /**
  56821. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  56822. */
  56823. readonly isUnique: boolean;
  56824. /**
  56825. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  56826. */
  56827. readonly isFinalMerger: boolean;
  56828. /**
  56829. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  56830. */
  56831. readonly isInput: boolean;
  56832. /**
  56833. * Gets or sets the build Id
  56834. */
  56835. buildId: number;
  56836. /**
  56837. * Gets or sets the target of the block
  56838. */
  56839. target: NodeMaterialBlockTargets;
  56840. /**
  56841. * Gets the list of input points
  56842. */
  56843. readonly inputs: NodeMaterialConnectionPoint[];
  56844. /** Gets the list of output points */
  56845. readonly outputs: NodeMaterialConnectionPoint[];
  56846. /**
  56847. * Find an input by its name
  56848. * @param name defines the name of the input to look for
  56849. * @returns the input or null if not found
  56850. */
  56851. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56852. /**
  56853. * Find an output by its name
  56854. * @param name defines the name of the outputto look for
  56855. * @returns the output or null if not found
  56856. */
  56857. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56858. /**
  56859. * Creates a new NodeMaterialBlock
  56860. * @param name defines the block name
  56861. * @param target defines the target of that block (Vertex by default)
  56862. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  56863. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  56864. */
  56865. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  56866. /**
  56867. * Initialize the block and prepare the context for build
  56868. * @param state defines the state that will be used for the build
  56869. */
  56870. initialize(state: NodeMaterialBuildState): void;
  56871. /**
  56872. * Bind data to effect. Will only be called for blocks with isBindable === true
  56873. * @param effect defines the effect to bind data to
  56874. * @param nodeMaterial defines the hosting NodeMaterial
  56875. * @param mesh defines the mesh that will be rendered
  56876. */
  56877. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56878. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  56879. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  56880. protected _writeFloat(value: number): string;
  56881. /**
  56882. * Gets the current class name e.g. "NodeMaterialBlock"
  56883. * @returns the class name
  56884. */
  56885. getClassName(): string;
  56886. /**
  56887. * Register a new input. Must be called inside a block constructor
  56888. * @param name defines the connection point name
  56889. * @param type defines the connection point type
  56890. * @param isOptional defines a boolean indicating that this input can be omitted
  56891. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56892. * @returns the current block
  56893. */
  56894. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  56895. /**
  56896. * Register a new output. Must be called inside a block constructor
  56897. * @param name defines the connection point name
  56898. * @param type defines the connection point type
  56899. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56900. * @returns the current block
  56901. */
  56902. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  56903. /**
  56904. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  56905. * @param forOutput defines an optional connection point to check compatibility with
  56906. * @returns the first available input or null
  56907. */
  56908. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  56909. /**
  56910. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  56911. * @param forBlock defines an optional block to check compatibility with
  56912. * @returns the first available input or null
  56913. */
  56914. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  56915. /**
  56916. * Gets the sibling of the given output
  56917. * @param current defines the current output
  56918. * @returns the next output in the list or null
  56919. */
  56920. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  56921. /**
  56922. * Connect current block with another block
  56923. * @param other defines the block to connect with
  56924. * @param options define the various options to help pick the right connections
  56925. * @returns the current block
  56926. */
  56927. connectTo(other: NodeMaterialBlock, options?: {
  56928. input?: string;
  56929. output?: string;
  56930. outputSwizzle?: string;
  56931. }): this | undefined;
  56932. protected _buildBlock(state: NodeMaterialBuildState): void;
  56933. /**
  56934. * Add uniforms, samplers and uniform buffers at compilation time
  56935. * @param state defines the state to update
  56936. * @param nodeMaterial defines the node material requesting the update
  56937. * @param defines defines the material defines to update
  56938. * @param uniformBuffers defines the list of uniform buffer names
  56939. */
  56940. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  56941. /**
  56942. * Add potential fallbacks if shader compilation fails
  56943. * @param mesh defines the mesh to be rendered
  56944. * @param fallbacks defines the current prioritized list of fallbacks
  56945. */
  56946. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56947. /**
  56948. * Initialize defines for shader compilation
  56949. * @param mesh defines the mesh to be rendered
  56950. * @param nodeMaterial defines the node material requesting the update
  56951. * @param defines defines the material defines to update
  56952. * @param useInstances specifies that instances should be used
  56953. */
  56954. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56955. /**
  56956. * Update defines for shader compilation
  56957. * @param mesh defines the mesh to be rendered
  56958. * @param nodeMaterial defines the node material requesting the update
  56959. * @param defines defines the material defines to update
  56960. * @param useInstances specifies that instances should be used
  56961. */
  56962. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56963. /**
  56964. * Lets the block try to connect some inputs automatically
  56965. * @param material defines the hosting NodeMaterial
  56966. */
  56967. autoConfigure(material: NodeMaterial): void;
  56968. /**
  56969. * Function called when a block is declared as repeatable content generator
  56970. * @param vertexShaderState defines the current compilation state for the vertex shader
  56971. * @param fragmentShaderState defines the current compilation state for the fragment shader
  56972. * @param mesh defines the mesh to be rendered
  56973. * @param defines defines the material defines to update
  56974. */
  56975. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  56976. /**
  56977. * Checks if the block is ready
  56978. * @param mesh defines the mesh to be rendered
  56979. * @param nodeMaterial defines the node material requesting the update
  56980. * @param defines defines the material defines to update
  56981. * @param useInstances specifies that instances should be used
  56982. * @returns true if the block is ready
  56983. */
  56984. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  56985. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  56986. private _processBuild;
  56987. /**
  56988. * Compile the current node and generate the shader code
  56989. * @param state defines the current compilation state (uniforms, samplers, current string)
  56990. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  56991. * @returns true if already built
  56992. */
  56993. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  56994. protected _inputRename(name: string): string;
  56995. protected _outputRename(name: string): string;
  56996. protected _dumpPropertiesCode(): string;
  56997. /** @hidden */
  56998. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  56999. /** @hidden */
  57000. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  57001. /**
  57002. * Clone the current block to a new identical block
  57003. * @param scene defines the hosting scene
  57004. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  57005. * @returns a copy of the current block
  57006. */
  57007. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  57008. /**
  57009. * Serializes this block in a JSON representation
  57010. * @returns the serialized block object
  57011. */
  57012. serialize(): any;
  57013. /** @hidden */
  57014. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57015. /**
  57016. * Release resources
  57017. */
  57018. dispose(): void;
  57019. }
  57020. }
  57021. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  57022. /**
  57023. * Enum defining the type of animations supported by InputBlock
  57024. */
  57025. export enum AnimatedInputBlockTypes {
  57026. /** No animation */
  57027. None = 0,
  57028. /** Time based animation. Will only work for floats */
  57029. Time = 1
  57030. }
  57031. }
  57032. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  57033. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57034. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  57035. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  57036. import { Nullable } from "babylonjs/types";
  57037. import { Effect } from "babylonjs/Materials/effect";
  57038. import { Matrix } from "babylonjs/Maths/math.vector";
  57039. import { Scene } from "babylonjs/scene";
  57040. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57041. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57042. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  57043. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57044. /**
  57045. * Block used to expose an input value
  57046. */
  57047. export class InputBlock extends NodeMaterialBlock {
  57048. private _mode;
  57049. private _associatedVariableName;
  57050. private _storedValue;
  57051. private _valueCallback;
  57052. private _type;
  57053. private _animationType;
  57054. /** Gets or set a value used to limit the range of float values */
  57055. min: number;
  57056. /** Gets or set a value used to limit the range of float values */
  57057. max: number;
  57058. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  57059. matrixMode: number;
  57060. /** @hidden */
  57061. _systemValue: Nullable<NodeMaterialSystemValues>;
  57062. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  57063. visibleInInspector: boolean;
  57064. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  57065. isConstant: boolean;
  57066. /**
  57067. * Gets or sets the connection point type (default is float)
  57068. */
  57069. readonly type: NodeMaterialBlockConnectionPointTypes;
  57070. /**
  57071. * Creates a new InputBlock
  57072. * @param name defines the block name
  57073. * @param target defines the target of that block (Vertex by default)
  57074. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  57075. */
  57076. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  57077. /**
  57078. * Gets the output component
  57079. */
  57080. readonly output: NodeMaterialConnectionPoint;
  57081. /**
  57082. * Set the source of this connection point to a vertex attribute
  57083. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  57084. * @returns the current connection point
  57085. */
  57086. setAsAttribute(attributeName?: string): InputBlock;
  57087. /**
  57088. * Set the source of this connection point to a system value
  57089. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  57090. * @returns the current connection point
  57091. */
  57092. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  57093. /**
  57094. * Gets or sets the value of that point.
  57095. * Please note that this value will be ignored if valueCallback is defined
  57096. */
  57097. value: any;
  57098. /**
  57099. * Gets or sets a callback used to get the value of that point.
  57100. * Please note that setting this value will force the connection point to ignore the value property
  57101. */
  57102. valueCallback: () => any;
  57103. /**
  57104. * Gets or sets the associated variable name in the shader
  57105. */
  57106. associatedVariableName: string;
  57107. /** Gets or sets the type of animation applied to the input */
  57108. animationType: AnimatedInputBlockTypes;
  57109. /**
  57110. * Gets a boolean indicating that this connection point not defined yet
  57111. */
  57112. readonly isUndefined: boolean;
  57113. /**
  57114. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  57115. * In this case the connection point name must be the name of the uniform to use.
  57116. * Can only be set on inputs
  57117. */
  57118. isUniform: boolean;
  57119. /**
  57120. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  57121. * In this case the connection point name must be the name of the attribute to use
  57122. * Can only be set on inputs
  57123. */
  57124. isAttribute: boolean;
  57125. /**
  57126. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  57127. * Can only be set on exit points
  57128. */
  57129. isVarying: boolean;
  57130. /**
  57131. * Gets a boolean indicating that the current connection point is a system value
  57132. */
  57133. readonly isSystemValue: boolean;
  57134. /**
  57135. * Gets or sets the current well known value or null if not defined as a system value
  57136. */
  57137. systemValue: Nullable<NodeMaterialSystemValues>;
  57138. /**
  57139. * Gets the current class name
  57140. * @returns the class name
  57141. */
  57142. getClassName(): string;
  57143. /**
  57144. * Animate the input if animationType !== None
  57145. * @param scene defines the rendering scene
  57146. */
  57147. animate(scene: Scene): void;
  57148. private _emitDefine;
  57149. initialize(state: NodeMaterialBuildState): void;
  57150. /**
  57151. * Set the input block to its default value (based on its type)
  57152. */
  57153. setDefaultValue(): void;
  57154. private _emitConstant;
  57155. private _emit;
  57156. /** @hidden */
  57157. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  57158. /** @hidden */
  57159. _transmit(effect: Effect, scene: Scene): void;
  57160. protected _buildBlock(state: NodeMaterialBuildState): void;
  57161. protected _dumpPropertiesCode(): string;
  57162. serialize(): any;
  57163. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57164. }
  57165. }
  57166. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  57167. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  57168. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  57169. import { Nullable } from "babylonjs/types";
  57170. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57171. import { Observable } from "babylonjs/Misc/observable";
  57172. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57173. /**
  57174. * Enum used to define the compatibility state between two connection points
  57175. */
  57176. export enum NodeMaterialConnectionPointCompatibilityStates {
  57177. /** Points are compatibles */
  57178. Compatible = 0,
  57179. /** Points are incompatible because of their types */
  57180. TypeIncompatible = 1,
  57181. /** Points are incompatible because of their targets (vertex vs fragment) */
  57182. TargetIncompatible = 2
  57183. }
  57184. /**
  57185. * Defines a connection point for a block
  57186. */
  57187. export class NodeMaterialConnectionPoint {
  57188. /** @hidden */
  57189. _ownerBlock: NodeMaterialBlock;
  57190. /** @hidden */
  57191. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  57192. private _endpoints;
  57193. private _associatedVariableName;
  57194. /** @hidden */
  57195. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  57196. /** @hidden */
  57197. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  57198. private _type;
  57199. /** @hidden */
  57200. _enforceAssociatedVariableName: boolean;
  57201. /**
  57202. * Gets or sets the additional types supported by this connection point
  57203. */
  57204. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  57205. /**
  57206. * Gets or sets the additional types excluded by this connection point
  57207. */
  57208. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  57209. /**
  57210. * Observable triggered when this point is connected
  57211. */
  57212. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  57213. /**
  57214. * Gets or sets the associated variable name in the shader
  57215. */
  57216. associatedVariableName: string;
  57217. /**
  57218. * Gets or sets the connection point type (default is float)
  57219. */
  57220. type: NodeMaterialBlockConnectionPointTypes;
  57221. /**
  57222. * Gets or sets the connection point name
  57223. */
  57224. name: string;
  57225. /**
  57226. * Gets or sets a boolean indicating that this connection point can be omitted
  57227. */
  57228. isOptional: boolean;
  57229. /**
  57230. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  57231. */
  57232. define: string;
  57233. /** @hidden */
  57234. _prioritizeVertex: boolean;
  57235. private _target;
  57236. /** Gets or sets the target of that connection point */
  57237. target: NodeMaterialBlockTargets;
  57238. /**
  57239. * Gets a boolean indicating that the current point is connected
  57240. */
  57241. readonly isConnected: boolean;
  57242. /**
  57243. * Gets a boolean indicating that the current point is connected to an input block
  57244. */
  57245. readonly isConnectedToInputBlock: boolean;
  57246. /**
  57247. * Gets a the connected input block (if any)
  57248. */
  57249. readonly connectInputBlock: Nullable<InputBlock>;
  57250. /** Get the other side of the connection (if any) */
  57251. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  57252. /** Get the block that owns this connection point */
  57253. readonly ownerBlock: NodeMaterialBlock;
  57254. /** Get the block connected on the other side of this connection (if any) */
  57255. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  57256. /** Get the block connected on the endpoints of this connection (if any) */
  57257. readonly connectedBlocks: Array<NodeMaterialBlock>;
  57258. /** Gets the list of connected endpoints */
  57259. readonly endpoints: NodeMaterialConnectionPoint[];
  57260. /** Gets a boolean indicating if that output point is connected to at least one input */
  57261. readonly hasEndpoints: boolean;
  57262. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  57263. readonly isConnectedInVertexShader: boolean;
  57264. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  57265. readonly isConnectedInFragmentShader: boolean;
  57266. /**
  57267. * Creates a new connection point
  57268. * @param name defines the connection point name
  57269. * @param ownerBlock defines the block hosting this connection point
  57270. */
  57271. constructor(name: string, ownerBlock: NodeMaterialBlock);
  57272. /**
  57273. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  57274. * @returns the class name
  57275. */
  57276. getClassName(): string;
  57277. /**
  57278. * Gets a boolean indicating if the current point can be connected to another point
  57279. * @param connectionPoint defines the other connection point
  57280. * @returns a boolean
  57281. */
  57282. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  57283. /**
  57284. * Gets a number indicating if the current point can be connected to another point
  57285. * @param connectionPoint defines the other connection point
  57286. * @returns a number defining the compatibility state
  57287. */
  57288. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  57289. /**
  57290. * Connect this point to another connection point
  57291. * @param connectionPoint defines the other connection point
  57292. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  57293. * @returns the current connection point
  57294. */
  57295. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  57296. /**
  57297. * Disconnect this point from one of his endpoint
  57298. * @param endpoint defines the other connection point
  57299. * @returns the current connection point
  57300. */
  57301. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  57302. /**
  57303. * Serializes this point in a JSON representation
  57304. * @returns the serialized point object
  57305. */
  57306. serialize(): any;
  57307. /**
  57308. * Release resources
  57309. */
  57310. dispose(): void;
  57311. }
  57312. }
  57313. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  57314. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57315. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57316. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57317. import { Mesh } from "babylonjs/Meshes/mesh";
  57318. import { Effect } from "babylonjs/Materials/effect";
  57319. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57320. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57321. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  57322. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  57323. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57324. /**
  57325. * Block used to add support for vertex skinning (bones)
  57326. */
  57327. export class BonesBlock extends NodeMaterialBlock {
  57328. /**
  57329. * Creates a new BonesBlock
  57330. * @param name defines the block name
  57331. */
  57332. constructor(name: string);
  57333. /**
  57334. * Initialize the block and prepare the context for build
  57335. * @param state defines the state that will be used for the build
  57336. */
  57337. initialize(state: NodeMaterialBuildState): void;
  57338. /**
  57339. * Gets the current class name
  57340. * @returns the class name
  57341. */
  57342. getClassName(): string;
  57343. /**
  57344. * Gets the matrix indices input component
  57345. */
  57346. readonly matricesIndices: NodeMaterialConnectionPoint;
  57347. /**
  57348. * Gets the matrix weights input component
  57349. */
  57350. readonly matricesWeights: NodeMaterialConnectionPoint;
  57351. /**
  57352. * Gets the extra matrix indices input component
  57353. */
  57354. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  57355. /**
  57356. * Gets the extra matrix weights input component
  57357. */
  57358. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  57359. /**
  57360. * Gets the world input component
  57361. */
  57362. readonly world: NodeMaterialConnectionPoint;
  57363. /**
  57364. * Gets the output component
  57365. */
  57366. readonly output: NodeMaterialConnectionPoint;
  57367. autoConfigure(material: NodeMaterial): void;
  57368. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  57369. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57370. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57371. protected _buildBlock(state: NodeMaterialBuildState): this;
  57372. }
  57373. }
  57374. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  57375. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57376. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57377. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57378. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57379. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57380. /**
  57381. * Block used to add support for instances
  57382. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  57383. */
  57384. export class InstancesBlock extends NodeMaterialBlock {
  57385. /**
  57386. * Creates a new InstancesBlock
  57387. * @param name defines the block name
  57388. */
  57389. constructor(name: string);
  57390. /**
  57391. * Gets the current class name
  57392. * @returns the class name
  57393. */
  57394. getClassName(): string;
  57395. /**
  57396. * Gets the first world row input component
  57397. */
  57398. readonly world0: NodeMaterialConnectionPoint;
  57399. /**
  57400. * Gets the second world row input component
  57401. */
  57402. readonly world1: NodeMaterialConnectionPoint;
  57403. /**
  57404. * Gets the third world row input component
  57405. */
  57406. readonly world2: NodeMaterialConnectionPoint;
  57407. /**
  57408. * Gets the forth world row input component
  57409. */
  57410. readonly world3: NodeMaterialConnectionPoint;
  57411. /**
  57412. * Gets the world input component
  57413. */
  57414. readonly world: NodeMaterialConnectionPoint;
  57415. /**
  57416. * Gets the output component
  57417. */
  57418. readonly output: NodeMaterialConnectionPoint;
  57419. autoConfigure(material: NodeMaterial): void;
  57420. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  57421. protected _buildBlock(state: NodeMaterialBuildState): this;
  57422. }
  57423. }
  57424. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  57425. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57426. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57427. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57428. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57429. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57430. import { Effect } from "babylonjs/Materials/effect";
  57431. import { Mesh } from "babylonjs/Meshes/mesh";
  57432. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  57433. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  57434. /**
  57435. * Block used to add morph targets support to vertex shader
  57436. */
  57437. export class MorphTargetsBlock extends NodeMaterialBlock {
  57438. private _repeatableContentAnchor;
  57439. private _repeatebleContentGenerated;
  57440. /**
  57441. * Create a new MorphTargetsBlock
  57442. * @param name defines the block name
  57443. */
  57444. constructor(name: string);
  57445. /**
  57446. * Gets the current class name
  57447. * @returns the class name
  57448. */
  57449. getClassName(): string;
  57450. /**
  57451. * Gets the position input component
  57452. */
  57453. readonly position: NodeMaterialConnectionPoint;
  57454. /**
  57455. * Gets the normal input component
  57456. */
  57457. readonly normal: NodeMaterialConnectionPoint;
  57458. /**
  57459. * Gets the tangent input component
  57460. */
  57461. readonly tangent: NodeMaterialConnectionPoint;
  57462. /**
  57463. * Gets the tangent input component
  57464. */
  57465. readonly uv: NodeMaterialConnectionPoint;
  57466. /**
  57467. * Gets the position output component
  57468. */
  57469. readonly positionOutput: NodeMaterialConnectionPoint;
  57470. /**
  57471. * Gets the normal output component
  57472. */
  57473. readonly normalOutput: NodeMaterialConnectionPoint;
  57474. /**
  57475. * Gets the tangent output component
  57476. */
  57477. readonly tangentOutput: NodeMaterialConnectionPoint;
  57478. /**
  57479. * Gets the tangent output component
  57480. */
  57481. readonly uvOutput: NodeMaterialConnectionPoint;
  57482. initialize(state: NodeMaterialBuildState): void;
  57483. autoConfigure(material: NodeMaterial): void;
  57484. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57485. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57486. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  57487. protected _buildBlock(state: NodeMaterialBuildState): this;
  57488. }
  57489. }
  57490. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  57491. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57492. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57493. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57494. import { Nullable } from "babylonjs/types";
  57495. import { Scene } from "babylonjs/scene";
  57496. import { Effect } from "babylonjs/Materials/effect";
  57497. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57498. import { Mesh } from "babylonjs/Meshes/mesh";
  57499. import { Light } from "babylonjs/Lights/light";
  57500. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57501. /**
  57502. * Block used to get data information from a light
  57503. */
  57504. export class LightInformationBlock extends NodeMaterialBlock {
  57505. private _lightDataUniformName;
  57506. private _lightColorUniformName;
  57507. private _lightTypeDefineName;
  57508. /**
  57509. * Gets or sets the light associated with this block
  57510. */
  57511. light: Nullable<Light>;
  57512. /**
  57513. * Creates a new LightInformationBlock
  57514. * @param name defines the block name
  57515. */
  57516. constructor(name: string);
  57517. /**
  57518. * Gets the current class name
  57519. * @returns the class name
  57520. */
  57521. getClassName(): string;
  57522. /**
  57523. * Gets the world position input component
  57524. */
  57525. readonly worldPosition: NodeMaterialConnectionPoint;
  57526. /**
  57527. * Gets the direction output component
  57528. */
  57529. readonly direction: NodeMaterialConnectionPoint;
  57530. /**
  57531. * Gets the direction output component
  57532. */
  57533. readonly color: NodeMaterialConnectionPoint;
  57534. /**
  57535. * Gets the direction output component
  57536. */
  57537. readonly intensity: NodeMaterialConnectionPoint;
  57538. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57539. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57540. protected _buildBlock(state: NodeMaterialBuildState): this;
  57541. serialize(): any;
  57542. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57543. }
  57544. }
  57545. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  57546. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  57547. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  57548. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  57549. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  57550. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  57551. }
  57552. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  57553. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57554. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57555. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57556. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57557. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57558. import { Effect } from "babylonjs/Materials/effect";
  57559. import { Mesh } from "babylonjs/Meshes/mesh";
  57560. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57561. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57562. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57563. /**
  57564. * Block used to add image processing support to fragment shader
  57565. */
  57566. export class ImageProcessingBlock extends NodeMaterialBlock {
  57567. /**
  57568. * Create a new ImageProcessingBlock
  57569. * @param name defines the block name
  57570. */
  57571. constructor(name: string);
  57572. /**
  57573. * Gets the current class name
  57574. * @returns the class name
  57575. */
  57576. getClassName(): string;
  57577. /**
  57578. * Gets the color input component
  57579. */
  57580. readonly color: NodeMaterialConnectionPoint;
  57581. /**
  57582. * Gets the output component
  57583. */
  57584. readonly output: NodeMaterialConnectionPoint;
  57585. /**
  57586. * Initialize the block and prepare the context for build
  57587. * @param state defines the state that will be used for the build
  57588. */
  57589. initialize(state: NodeMaterialBuildState): void;
  57590. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  57591. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57592. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57593. protected _buildBlock(state: NodeMaterialBuildState): this;
  57594. }
  57595. }
  57596. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  57597. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57598. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57599. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57600. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57601. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57602. import { Effect } from "babylonjs/Materials/effect";
  57603. import { Mesh } from "babylonjs/Meshes/mesh";
  57604. import { Scene } from "babylonjs/scene";
  57605. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57606. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57607. /**
  57608. * Block used to pertub normals based on a normal map
  57609. */
  57610. export class PerturbNormalBlock extends NodeMaterialBlock {
  57611. private _tangentSpaceParameterName;
  57612. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  57613. invertX: boolean;
  57614. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  57615. invertY: boolean;
  57616. /**
  57617. * Create a new PerturbNormalBlock
  57618. * @param name defines the block name
  57619. */
  57620. constructor(name: string);
  57621. /**
  57622. * Gets the current class name
  57623. * @returns the class name
  57624. */
  57625. getClassName(): string;
  57626. /**
  57627. * Gets the world position input component
  57628. */
  57629. readonly worldPosition: NodeMaterialConnectionPoint;
  57630. /**
  57631. * Gets the world normal input component
  57632. */
  57633. readonly worldNormal: NodeMaterialConnectionPoint;
  57634. /**
  57635. * Gets the uv input component
  57636. */
  57637. readonly uv: NodeMaterialConnectionPoint;
  57638. /**
  57639. * Gets the normal map color input component
  57640. */
  57641. readonly normalMapColor: NodeMaterialConnectionPoint;
  57642. /**
  57643. * Gets the strength input component
  57644. */
  57645. readonly strength: NodeMaterialConnectionPoint;
  57646. /**
  57647. * Gets the output component
  57648. */
  57649. readonly output: NodeMaterialConnectionPoint;
  57650. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57651. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57652. autoConfigure(material: NodeMaterial): void;
  57653. protected _buildBlock(state: NodeMaterialBuildState): this;
  57654. protected _dumpPropertiesCode(): string;
  57655. serialize(): any;
  57656. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57657. }
  57658. }
  57659. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  57660. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57661. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57662. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57663. /**
  57664. * Block used to discard a pixel if a value is smaller than a cutoff
  57665. */
  57666. export class DiscardBlock extends NodeMaterialBlock {
  57667. /**
  57668. * Create a new DiscardBlock
  57669. * @param name defines the block name
  57670. */
  57671. constructor(name: string);
  57672. /**
  57673. * Gets the current class name
  57674. * @returns the class name
  57675. */
  57676. getClassName(): string;
  57677. /**
  57678. * Gets the color input component
  57679. */
  57680. readonly value: NodeMaterialConnectionPoint;
  57681. /**
  57682. * Gets the cutoff input component
  57683. */
  57684. readonly cutoff: NodeMaterialConnectionPoint;
  57685. protected _buildBlock(state: NodeMaterialBuildState): this;
  57686. }
  57687. }
  57688. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  57689. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57690. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57691. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57692. /**
  57693. * Block used to test if the fragment shader is front facing
  57694. */
  57695. export class FrontFacingBlock extends NodeMaterialBlock {
  57696. /**
  57697. * Creates a new FrontFacingBlock
  57698. * @param name defines the block name
  57699. */
  57700. constructor(name: string);
  57701. /**
  57702. * Gets the current class name
  57703. * @returns the class name
  57704. */
  57705. getClassName(): string;
  57706. /**
  57707. * Gets the output component
  57708. */
  57709. readonly output: NodeMaterialConnectionPoint;
  57710. protected _buildBlock(state: NodeMaterialBuildState): this;
  57711. }
  57712. }
  57713. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  57714. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  57715. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  57716. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  57717. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  57718. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  57719. }
  57720. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  57721. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57722. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57723. import { Mesh } from "babylonjs/Meshes/mesh";
  57724. import { Effect } from "babylonjs/Materials/effect";
  57725. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57726. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57727. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57728. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57729. /**
  57730. * Block used to add support for scene fog
  57731. */
  57732. export class FogBlock extends NodeMaterialBlock {
  57733. private _fogDistanceName;
  57734. private _fogParameters;
  57735. /**
  57736. * Create a new FogBlock
  57737. * @param name defines the block name
  57738. */
  57739. constructor(name: string);
  57740. /**
  57741. * Gets the current class name
  57742. * @returns the class name
  57743. */
  57744. getClassName(): string;
  57745. /**
  57746. * Gets the world position input component
  57747. */
  57748. readonly worldPosition: NodeMaterialConnectionPoint;
  57749. /**
  57750. * Gets the view input component
  57751. */
  57752. readonly view: NodeMaterialConnectionPoint;
  57753. /**
  57754. * Gets the color input component
  57755. */
  57756. readonly input: NodeMaterialConnectionPoint;
  57757. /**
  57758. * Gets the fog color input component
  57759. */
  57760. readonly fogColor: NodeMaterialConnectionPoint;
  57761. /**
  57762. * Gets the output component
  57763. */
  57764. readonly output: NodeMaterialConnectionPoint;
  57765. autoConfigure(material: NodeMaterial): void;
  57766. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57767. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57768. protected _buildBlock(state: NodeMaterialBuildState): this;
  57769. }
  57770. }
  57771. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  57772. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57773. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57774. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57775. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57776. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57777. import { Effect } from "babylonjs/Materials/effect";
  57778. import { Mesh } from "babylonjs/Meshes/mesh";
  57779. import { Light } from "babylonjs/Lights/light";
  57780. import { Nullable } from "babylonjs/types";
  57781. import { Scene } from "babylonjs/scene";
  57782. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57783. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57784. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57785. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57786. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  57787. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57788. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57789. /**
  57790. * Block used to add light in the fragment shader
  57791. */
  57792. export class LightBlock extends NodeMaterialBlock {
  57793. private _lightId;
  57794. /**
  57795. * Gets or sets the light associated with this block
  57796. */
  57797. light: Nullable<Light>;
  57798. /**
  57799. * Create a new LightBlock
  57800. * @param name defines the block name
  57801. */
  57802. constructor(name: string);
  57803. /**
  57804. * Gets the current class name
  57805. * @returns the class name
  57806. */
  57807. getClassName(): string;
  57808. /**
  57809. * Gets the world position input component
  57810. */
  57811. readonly worldPosition: NodeMaterialConnectionPoint;
  57812. /**
  57813. * Gets the world normal input component
  57814. */
  57815. readonly worldNormal: NodeMaterialConnectionPoint;
  57816. /**
  57817. * Gets the camera (or eye) position component
  57818. */
  57819. readonly cameraPosition: NodeMaterialConnectionPoint;
  57820. /**
  57821. * Gets the glossiness component
  57822. */
  57823. readonly glossiness: NodeMaterialConnectionPoint;
  57824. /**
  57825. * Gets the glossinness power component
  57826. */
  57827. readonly glossPower: NodeMaterialConnectionPoint;
  57828. /**
  57829. * Gets the diffuse color component
  57830. */
  57831. readonly diffuseColor: NodeMaterialConnectionPoint;
  57832. /**
  57833. * Gets the specular color component
  57834. */
  57835. readonly specularColor: NodeMaterialConnectionPoint;
  57836. /**
  57837. * Gets the diffuse output component
  57838. */
  57839. readonly diffuseOutput: NodeMaterialConnectionPoint;
  57840. /**
  57841. * Gets the specular output component
  57842. */
  57843. readonly specularOutput: NodeMaterialConnectionPoint;
  57844. autoConfigure(material: NodeMaterial): void;
  57845. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57846. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  57847. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57848. private _injectVertexCode;
  57849. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57850. serialize(): any;
  57851. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57852. }
  57853. }
  57854. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  57855. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  57856. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  57857. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  57858. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  57859. }
  57860. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  57861. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57862. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57863. }
  57864. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  57865. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57866. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57867. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57868. /**
  57869. * Block used to multiply 2 values
  57870. */
  57871. export class MultiplyBlock extends NodeMaterialBlock {
  57872. /**
  57873. * Creates a new MultiplyBlock
  57874. * @param name defines the block name
  57875. */
  57876. constructor(name: string);
  57877. /**
  57878. * Gets the current class name
  57879. * @returns the class name
  57880. */
  57881. getClassName(): string;
  57882. /**
  57883. * Gets the left operand input component
  57884. */
  57885. readonly left: NodeMaterialConnectionPoint;
  57886. /**
  57887. * Gets the right operand input component
  57888. */
  57889. readonly right: NodeMaterialConnectionPoint;
  57890. /**
  57891. * Gets the output component
  57892. */
  57893. readonly output: NodeMaterialConnectionPoint;
  57894. protected _buildBlock(state: NodeMaterialBuildState): this;
  57895. }
  57896. }
  57897. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  57898. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57899. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57900. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57901. /**
  57902. * Block used to add 2 vectors
  57903. */
  57904. export class AddBlock extends NodeMaterialBlock {
  57905. /**
  57906. * Creates a new AddBlock
  57907. * @param name defines the block name
  57908. */
  57909. constructor(name: string);
  57910. /**
  57911. * Gets the current class name
  57912. * @returns the class name
  57913. */
  57914. getClassName(): string;
  57915. /**
  57916. * Gets the left operand input component
  57917. */
  57918. readonly left: NodeMaterialConnectionPoint;
  57919. /**
  57920. * Gets the right operand input component
  57921. */
  57922. readonly right: NodeMaterialConnectionPoint;
  57923. /**
  57924. * Gets the output component
  57925. */
  57926. readonly output: NodeMaterialConnectionPoint;
  57927. protected _buildBlock(state: NodeMaterialBuildState): this;
  57928. }
  57929. }
  57930. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  57931. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57932. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57933. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57934. /**
  57935. * Block used to scale a vector by a float
  57936. */
  57937. export class ScaleBlock extends NodeMaterialBlock {
  57938. /**
  57939. * Creates a new ScaleBlock
  57940. * @param name defines the block name
  57941. */
  57942. constructor(name: string);
  57943. /**
  57944. * Gets the current class name
  57945. * @returns the class name
  57946. */
  57947. getClassName(): string;
  57948. /**
  57949. * Gets the input component
  57950. */
  57951. readonly input: NodeMaterialConnectionPoint;
  57952. /**
  57953. * Gets the factor input component
  57954. */
  57955. readonly factor: NodeMaterialConnectionPoint;
  57956. /**
  57957. * Gets the output component
  57958. */
  57959. readonly output: NodeMaterialConnectionPoint;
  57960. protected _buildBlock(state: NodeMaterialBuildState): this;
  57961. }
  57962. }
  57963. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  57964. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57965. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57966. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57967. import { Scene } from "babylonjs/scene";
  57968. /**
  57969. * Block used to clamp a float
  57970. */
  57971. export class ClampBlock extends NodeMaterialBlock {
  57972. /** Gets or sets the minimum range */
  57973. minimum: number;
  57974. /** Gets or sets the maximum range */
  57975. maximum: number;
  57976. /**
  57977. * Creates a new ClampBlock
  57978. * @param name defines the block name
  57979. */
  57980. constructor(name: string);
  57981. /**
  57982. * Gets the current class name
  57983. * @returns the class name
  57984. */
  57985. getClassName(): string;
  57986. /**
  57987. * Gets the value input component
  57988. */
  57989. readonly value: NodeMaterialConnectionPoint;
  57990. /**
  57991. * Gets the output component
  57992. */
  57993. readonly output: NodeMaterialConnectionPoint;
  57994. protected _buildBlock(state: NodeMaterialBuildState): this;
  57995. protected _dumpPropertiesCode(): string;
  57996. serialize(): any;
  57997. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57998. }
  57999. }
  58000. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  58001. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58002. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58003. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58004. /**
  58005. * Block used to apply a cross product between 2 vectors
  58006. */
  58007. export class CrossBlock extends NodeMaterialBlock {
  58008. /**
  58009. * Creates a new CrossBlock
  58010. * @param name defines the block name
  58011. */
  58012. constructor(name: string);
  58013. /**
  58014. * Gets the current class name
  58015. * @returns the class name
  58016. */
  58017. getClassName(): string;
  58018. /**
  58019. * Gets the left operand input component
  58020. */
  58021. readonly left: NodeMaterialConnectionPoint;
  58022. /**
  58023. * Gets the right operand input component
  58024. */
  58025. readonly right: NodeMaterialConnectionPoint;
  58026. /**
  58027. * Gets the output component
  58028. */
  58029. readonly output: NodeMaterialConnectionPoint;
  58030. protected _buildBlock(state: NodeMaterialBuildState): this;
  58031. }
  58032. }
  58033. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  58034. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58035. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58036. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58037. /**
  58038. * Block used to apply a dot product between 2 vectors
  58039. */
  58040. export class DotBlock extends NodeMaterialBlock {
  58041. /**
  58042. * Creates a new DotBlock
  58043. * @param name defines the block name
  58044. */
  58045. constructor(name: string);
  58046. /**
  58047. * Gets the current class name
  58048. * @returns the class name
  58049. */
  58050. getClassName(): string;
  58051. /**
  58052. * Gets the left operand input component
  58053. */
  58054. readonly left: NodeMaterialConnectionPoint;
  58055. /**
  58056. * Gets the right operand input component
  58057. */
  58058. readonly right: NodeMaterialConnectionPoint;
  58059. /**
  58060. * Gets the output component
  58061. */
  58062. readonly output: NodeMaterialConnectionPoint;
  58063. protected _buildBlock(state: NodeMaterialBuildState): this;
  58064. }
  58065. }
  58066. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  58067. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58068. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58069. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58070. import { Vector2 } from "babylonjs/Maths/math.vector";
  58071. import { Scene } from "babylonjs/scene";
  58072. /**
  58073. * Block used to remap a float from a range to a new one
  58074. */
  58075. export class RemapBlock extends NodeMaterialBlock {
  58076. /**
  58077. * Gets or sets the source range
  58078. */
  58079. sourceRange: Vector2;
  58080. /**
  58081. * Gets or sets the target range
  58082. */
  58083. targetRange: Vector2;
  58084. /**
  58085. * Creates a new RemapBlock
  58086. * @param name defines the block name
  58087. */
  58088. constructor(name: string);
  58089. /**
  58090. * Gets the current class name
  58091. * @returns the class name
  58092. */
  58093. getClassName(): string;
  58094. /**
  58095. * Gets the input component
  58096. */
  58097. readonly input: NodeMaterialConnectionPoint;
  58098. /**
  58099. * Gets the source min input component
  58100. */
  58101. readonly sourceMin: NodeMaterialConnectionPoint;
  58102. /**
  58103. * Gets the source max input component
  58104. */
  58105. readonly sourceMax: NodeMaterialConnectionPoint;
  58106. /**
  58107. * Gets the target min input component
  58108. */
  58109. readonly targetMin: NodeMaterialConnectionPoint;
  58110. /**
  58111. * Gets the target max input component
  58112. */
  58113. readonly targetMax: NodeMaterialConnectionPoint;
  58114. /**
  58115. * Gets the output component
  58116. */
  58117. readonly output: NodeMaterialConnectionPoint;
  58118. protected _buildBlock(state: NodeMaterialBuildState): this;
  58119. protected _dumpPropertiesCode(): string;
  58120. serialize(): any;
  58121. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58122. }
  58123. }
  58124. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  58125. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58126. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58127. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58128. /**
  58129. * Block used to normalize a vector
  58130. */
  58131. export class NormalizeBlock extends NodeMaterialBlock {
  58132. /**
  58133. * Creates a new NormalizeBlock
  58134. * @param name defines the block name
  58135. */
  58136. constructor(name: string);
  58137. /**
  58138. * Gets the current class name
  58139. * @returns the class name
  58140. */
  58141. getClassName(): string;
  58142. /**
  58143. * Gets the input component
  58144. */
  58145. readonly input: NodeMaterialConnectionPoint;
  58146. /**
  58147. * Gets the output component
  58148. */
  58149. readonly output: NodeMaterialConnectionPoint;
  58150. protected _buildBlock(state: NodeMaterialBuildState): this;
  58151. }
  58152. }
  58153. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  58154. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58155. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58156. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58157. import { Scene } from "babylonjs/scene";
  58158. /**
  58159. * Operations supported by the Trigonometry block
  58160. */
  58161. export enum TrigonometryBlockOperations {
  58162. /** Cos */
  58163. Cos = 0,
  58164. /** Sin */
  58165. Sin = 1,
  58166. /** Abs */
  58167. Abs = 2,
  58168. /** Exp */
  58169. Exp = 3,
  58170. /** Exp2 */
  58171. Exp2 = 4,
  58172. /** Round */
  58173. Round = 5,
  58174. /** Floor */
  58175. Floor = 6,
  58176. /** Ceiling */
  58177. Ceiling = 7,
  58178. /** Square root */
  58179. Sqrt = 8,
  58180. /** Log */
  58181. Log = 9,
  58182. /** Tangent */
  58183. Tan = 10,
  58184. /** Arc tangent */
  58185. ArcTan = 11,
  58186. /** Arc cosinus */
  58187. ArcCos = 12,
  58188. /** Arc sinus */
  58189. ArcSin = 13,
  58190. /** Fraction */
  58191. Fract = 14,
  58192. /** Sign */
  58193. Sign = 15,
  58194. /** To radians (from degrees) */
  58195. Radians = 16,
  58196. /** To degrees (from radians) */
  58197. Degrees = 17
  58198. }
  58199. /**
  58200. * Block used to apply trigonometry operation to floats
  58201. */
  58202. export class TrigonometryBlock extends NodeMaterialBlock {
  58203. /**
  58204. * Gets or sets the operation applied by the block
  58205. */
  58206. operation: TrigonometryBlockOperations;
  58207. /**
  58208. * Creates a new TrigonometryBlock
  58209. * @param name defines the block name
  58210. */
  58211. constructor(name: string);
  58212. /**
  58213. * Gets the current class name
  58214. * @returns the class name
  58215. */
  58216. getClassName(): string;
  58217. /**
  58218. * Gets the input component
  58219. */
  58220. readonly input: NodeMaterialConnectionPoint;
  58221. /**
  58222. * Gets the output component
  58223. */
  58224. readonly output: NodeMaterialConnectionPoint;
  58225. protected _buildBlock(state: NodeMaterialBuildState): this;
  58226. serialize(): any;
  58227. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58228. protected _dumpPropertiesCode(): string;
  58229. }
  58230. }
  58231. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  58232. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58233. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58234. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58235. /**
  58236. * Block used to create a Color3/4 out of individual inputs (one for each component)
  58237. */
  58238. export class ColorMergerBlock extends NodeMaterialBlock {
  58239. /**
  58240. * Create a new ColorMergerBlock
  58241. * @param name defines the block name
  58242. */
  58243. constructor(name: string);
  58244. /**
  58245. * Gets the current class name
  58246. * @returns the class name
  58247. */
  58248. getClassName(): string;
  58249. /**
  58250. * Gets the r component (input)
  58251. */
  58252. readonly r: NodeMaterialConnectionPoint;
  58253. /**
  58254. * Gets the g component (input)
  58255. */
  58256. readonly g: NodeMaterialConnectionPoint;
  58257. /**
  58258. * Gets the b component (input)
  58259. */
  58260. readonly b: NodeMaterialConnectionPoint;
  58261. /**
  58262. * Gets the a component (input)
  58263. */
  58264. readonly a: NodeMaterialConnectionPoint;
  58265. /**
  58266. * Gets the rgba component (output)
  58267. */
  58268. readonly rgba: NodeMaterialConnectionPoint;
  58269. /**
  58270. * Gets the rgb component (output)
  58271. */
  58272. readonly rgb: NodeMaterialConnectionPoint;
  58273. protected _buildBlock(state: NodeMaterialBuildState): this;
  58274. }
  58275. }
  58276. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  58277. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58278. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58279. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58280. /**
  58281. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  58282. */
  58283. export class VectorMergerBlock extends NodeMaterialBlock {
  58284. /**
  58285. * Create a new VectorMergerBlock
  58286. * @param name defines the block name
  58287. */
  58288. constructor(name: string);
  58289. /**
  58290. * Gets the current class name
  58291. * @returns the class name
  58292. */
  58293. getClassName(): string;
  58294. /**
  58295. * Gets the x component (input)
  58296. */
  58297. readonly x: NodeMaterialConnectionPoint;
  58298. /**
  58299. * Gets the y component (input)
  58300. */
  58301. readonly y: NodeMaterialConnectionPoint;
  58302. /**
  58303. * Gets the z component (input)
  58304. */
  58305. readonly z: NodeMaterialConnectionPoint;
  58306. /**
  58307. * Gets the w component (input)
  58308. */
  58309. readonly w: NodeMaterialConnectionPoint;
  58310. /**
  58311. * Gets the xyzw component (output)
  58312. */
  58313. readonly xyzw: NodeMaterialConnectionPoint;
  58314. /**
  58315. * Gets the xyz component (output)
  58316. */
  58317. readonly xyz: NodeMaterialConnectionPoint;
  58318. /**
  58319. * Gets the xy component (output)
  58320. */
  58321. readonly xy: NodeMaterialConnectionPoint;
  58322. protected _buildBlock(state: NodeMaterialBuildState): this;
  58323. }
  58324. }
  58325. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  58326. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58327. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58328. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58329. /**
  58330. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  58331. */
  58332. export class ColorSplitterBlock extends NodeMaterialBlock {
  58333. /**
  58334. * Create a new ColorSplitterBlock
  58335. * @param name defines the block name
  58336. */
  58337. constructor(name: string);
  58338. /**
  58339. * Gets the current class name
  58340. * @returns the class name
  58341. */
  58342. getClassName(): string;
  58343. /**
  58344. * Gets the rgba component (input)
  58345. */
  58346. readonly rgba: NodeMaterialConnectionPoint;
  58347. /**
  58348. * Gets the rgb component (input)
  58349. */
  58350. readonly rgbIn: NodeMaterialConnectionPoint;
  58351. /**
  58352. * Gets the rgb component (output)
  58353. */
  58354. readonly rgbOut: NodeMaterialConnectionPoint;
  58355. /**
  58356. * Gets the r component (output)
  58357. */
  58358. readonly r: NodeMaterialConnectionPoint;
  58359. /**
  58360. * Gets the g component (output)
  58361. */
  58362. readonly g: NodeMaterialConnectionPoint;
  58363. /**
  58364. * Gets the b component (output)
  58365. */
  58366. readonly b: NodeMaterialConnectionPoint;
  58367. /**
  58368. * Gets the a component (output)
  58369. */
  58370. readonly a: NodeMaterialConnectionPoint;
  58371. protected _inputRename(name: string): string;
  58372. protected _outputRename(name: string): string;
  58373. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  58374. }
  58375. }
  58376. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  58377. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58378. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58379. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58380. /**
  58381. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  58382. */
  58383. export class VectorSplitterBlock extends NodeMaterialBlock {
  58384. /**
  58385. * Create a new VectorSplitterBlock
  58386. * @param name defines the block name
  58387. */
  58388. constructor(name: string);
  58389. /**
  58390. * Gets the current class name
  58391. * @returns the class name
  58392. */
  58393. getClassName(): string;
  58394. /**
  58395. * Gets the xyzw component (input)
  58396. */
  58397. readonly xyzw: NodeMaterialConnectionPoint;
  58398. /**
  58399. * Gets the xyz component (input)
  58400. */
  58401. readonly xyzIn: NodeMaterialConnectionPoint;
  58402. /**
  58403. * Gets the xy component (input)
  58404. */
  58405. readonly xyIn: NodeMaterialConnectionPoint;
  58406. /**
  58407. * Gets the xyz component (output)
  58408. */
  58409. readonly xyzOut: NodeMaterialConnectionPoint;
  58410. /**
  58411. * Gets the xy component (output)
  58412. */
  58413. readonly xyOut: NodeMaterialConnectionPoint;
  58414. /**
  58415. * Gets the x component (output)
  58416. */
  58417. readonly x: NodeMaterialConnectionPoint;
  58418. /**
  58419. * Gets the y component (output)
  58420. */
  58421. readonly y: NodeMaterialConnectionPoint;
  58422. /**
  58423. * Gets the z component (output)
  58424. */
  58425. readonly z: NodeMaterialConnectionPoint;
  58426. /**
  58427. * Gets the w component (output)
  58428. */
  58429. readonly w: NodeMaterialConnectionPoint;
  58430. protected _inputRename(name: string): string;
  58431. protected _outputRename(name: string): string;
  58432. protected _buildBlock(state: NodeMaterialBuildState): this;
  58433. }
  58434. }
  58435. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  58436. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58437. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58438. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58439. /**
  58440. * Block used to lerp between 2 values
  58441. */
  58442. export class LerpBlock extends NodeMaterialBlock {
  58443. /**
  58444. * Creates a new LerpBlock
  58445. * @param name defines the block name
  58446. */
  58447. constructor(name: string);
  58448. /**
  58449. * Gets the current class name
  58450. * @returns the class name
  58451. */
  58452. getClassName(): string;
  58453. /**
  58454. * Gets the left operand input component
  58455. */
  58456. readonly left: NodeMaterialConnectionPoint;
  58457. /**
  58458. * Gets the right operand input component
  58459. */
  58460. readonly right: NodeMaterialConnectionPoint;
  58461. /**
  58462. * Gets the gradient operand input component
  58463. */
  58464. readonly gradient: NodeMaterialConnectionPoint;
  58465. /**
  58466. * Gets the output component
  58467. */
  58468. readonly output: NodeMaterialConnectionPoint;
  58469. protected _buildBlock(state: NodeMaterialBuildState): this;
  58470. }
  58471. }
  58472. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  58473. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58474. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58475. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58476. /**
  58477. * Block used to divide 2 vectors
  58478. */
  58479. export class DivideBlock extends NodeMaterialBlock {
  58480. /**
  58481. * Creates a new DivideBlock
  58482. * @param name defines the block name
  58483. */
  58484. constructor(name: string);
  58485. /**
  58486. * Gets the current class name
  58487. * @returns the class name
  58488. */
  58489. getClassName(): string;
  58490. /**
  58491. * Gets the left operand input component
  58492. */
  58493. readonly left: NodeMaterialConnectionPoint;
  58494. /**
  58495. * Gets the right operand input component
  58496. */
  58497. readonly right: NodeMaterialConnectionPoint;
  58498. /**
  58499. * Gets the output component
  58500. */
  58501. readonly output: NodeMaterialConnectionPoint;
  58502. protected _buildBlock(state: NodeMaterialBuildState): this;
  58503. }
  58504. }
  58505. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  58506. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58507. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58508. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58509. /**
  58510. * Block used to subtract 2 vectors
  58511. */
  58512. export class SubtractBlock extends NodeMaterialBlock {
  58513. /**
  58514. * Creates a new SubtractBlock
  58515. * @param name defines the block name
  58516. */
  58517. constructor(name: string);
  58518. /**
  58519. * Gets the current class name
  58520. * @returns the class name
  58521. */
  58522. getClassName(): string;
  58523. /**
  58524. * Gets the left operand input component
  58525. */
  58526. readonly left: NodeMaterialConnectionPoint;
  58527. /**
  58528. * Gets the right operand input component
  58529. */
  58530. readonly right: NodeMaterialConnectionPoint;
  58531. /**
  58532. * Gets the output component
  58533. */
  58534. readonly output: NodeMaterialConnectionPoint;
  58535. protected _buildBlock(state: NodeMaterialBuildState): this;
  58536. }
  58537. }
  58538. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  58539. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58540. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58541. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58542. /**
  58543. * Block used to step a value
  58544. */
  58545. export class StepBlock extends NodeMaterialBlock {
  58546. /**
  58547. * Creates a new StepBlock
  58548. * @param name defines the block name
  58549. */
  58550. constructor(name: string);
  58551. /**
  58552. * Gets the current class name
  58553. * @returns the class name
  58554. */
  58555. getClassName(): string;
  58556. /**
  58557. * Gets the value operand input component
  58558. */
  58559. readonly value: NodeMaterialConnectionPoint;
  58560. /**
  58561. * Gets the edge operand input component
  58562. */
  58563. readonly edge: NodeMaterialConnectionPoint;
  58564. /**
  58565. * Gets the output component
  58566. */
  58567. readonly output: NodeMaterialConnectionPoint;
  58568. protected _buildBlock(state: NodeMaterialBuildState): this;
  58569. }
  58570. }
  58571. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  58572. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58573. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58574. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58575. /**
  58576. * Block used to get the opposite (1 - x) of a value
  58577. */
  58578. export class OneMinusBlock extends NodeMaterialBlock {
  58579. /**
  58580. * Creates a new OneMinusBlock
  58581. * @param name defines the block name
  58582. */
  58583. constructor(name: string);
  58584. /**
  58585. * Gets the current class name
  58586. * @returns the class name
  58587. */
  58588. getClassName(): string;
  58589. /**
  58590. * Gets the input component
  58591. */
  58592. readonly input: NodeMaterialConnectionPoint;
  58593. /**
  58594. * Gets the output component
  58595. */
  58596. readonly output: NodeMaterialConnectionPoint;
  58597. protected _buildBlock(state: NodeMaterialBuildState): this;
  58598. }
  58599. }
  58600. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  58601. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58602. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58603. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58604. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58605. /**
  58606. * Block used to get the view direction
  58607. */
  58608. export class ViewDirectionBlock extends NodeMaterialBlock {
  58609. /**
  58610. * Creates a new ViewDirectionBlock
  58611. * @param name defines the block name
  58612. */
  58613. constructor(name: string);
  58614. /**
  58615. * Gets the current class name
  58616. * @returns the class name
  58617. */
  58618. getClassName(): string;
  58619. /**
  58620. * Gets the world position component
  58621. */
  58622. readonly worldPosition: NodeMaterialConnectionPoint;
  58623. /**
  58624. * Gets the camera position component
  58625. */
  58626. readonly cameraPosition: NodeMaterialConnectionPoint;
  58627. /**
  58628. * Gets the output component
  58629. */
  58630. readonly output: NodeMaterialConnectionPoint;
  58631. autoConfigure(material: NodeMaterial): void;
  58632. protected _buildBlock(state: NodeMaterialBuildState): this;
  58633. }
  58634. }
  58635. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  58636. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58637. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58638. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58639. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58640. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  58641. /**
  58642. * Block used to compute fresnel value
  58643. */
  58644. export class FresnelBlock extends NodeMaterialBlock {
  58645. /**
  58646. * Create a new FresnelBlock
  58647. * @param name defines the block name
  58648. */
  58649. constructor(name: string);
  58650. /**
  58651. * Gets the current class name
  58652. * @returns the class name
  58653. */
  58654. getClassName(): string;
  58655. /**
  58656. * Gets the world normal input component
  58657. */
  58658. readonly worldNormal: NodeMaterialConnectionPoint;
  58659. /**
  58660. * Gets the view direction input component
  58661. */
  58662. readonly viewDirection: NodeMaterialConnectionPoint;
  58663. /**
  58664. * Gets the bias input component
  58665. */
  58666. readonly bias: NodeMaterialConnectionPoint;
  58667. /**
  58668. * Gets the camera (or eye) position component
  58669. */
  58670. readonly power: NodeMaterialConnectionPoint;
  58671. /**
  58672. * Gets the fresnel output component
  58673. */
  58674. readonly fresnel: NodeMaterialConnectionPoint;
  58675. autoConfigure(material: NodeMaterial): void;
  58676. protected _buildBlock(state: NodeMaterialBuildState): this;
  58677. }
  58678. }
  58679. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  58680. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58681. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58682. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58683. /**
  58684. * Block used to get the max of 2 values
  58685. */
  58686. export class MaxBlock extends NodeMaterialBlock {
  58687. /**
  58688. * Creates a new MaxBlock
  58689. * @param name defines the block name
  58690. */
  58691. constructor(name: string);
  58692. /**
  58693. * Gets the current class name
  58694. * @returns the class name
  58695. */
  58696. getClassName(): string;
  58697. /**
  58698. * Gets the left operand input component
  58699. */
  58700. readonly left: NodeMaterialConnectionPoint;
  58701. /**
  58702. * Gets the right operand input component
  58703. */
  58704. readonly right: NodeMaterialConnectionPoint;
  58705. /**
  58706. * Gets the output component
  58707. */
  58708. readonly output: NodeMaterialConnectionPoint;
  58709. protected _buildBlock(state: NodeMaterialBuildState): this;
  58710. }
  58711. }
  58712. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  58713. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58714. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58715. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58716. /**
  58717. * Block used to get the min of 2 values
  58718. */
  58719. export class MinBlock extends NodeMaterialBlock {
  58720. /**
  58721. * Creates a new MinBlock
  58722. * @param name defines the block name
  58723. */
  58724. constructor(name: string);
  58725. /**
  58726. * Gets the current class name
  58727. * @returns the class name
  58728. */
  58729. getClassName(): string;
  58730. /**
  58731. * Gets the left operand input component
  58732. */
  58733. readonly left: NodeMaterialConnectionPoint;
  58734. /**
  58735. * Gets the right operand input component
  58736. */
  58737. readonly right: NodeMaterialConnectionPoint;
  58738. /**
  58739. * Gets the output component
  58740. */
  58741. readonly output: NodeMaterialConnectionPoint;
  58742. protected _buildBlock(state: NodeMaterialBuildState): this;
  58743. }
  58744. }
  58745. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  58746. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58747. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58748. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58749. /**
  58750. * Block used to get the distance between 2 values
  58751. */
  58752. export class DistanceBlock extends NodeMaterialBlock {
  58753. /**
  58754. * Creates a new DistanceBlock
  58755. * @param name defines the block name
  58756. */
  58757. constructor(name: string);
  58758. /**
  58759. * Gets the current class name
  58760. * @returns the class name
  58761. */
  58762. getClassName(): string;
  58763. /**
  58764. * Gets the left operand input component
  58765. */
  58766. readonly left: NodeMaterialConnectionPoint;
  58767. /**
  58768. * Gets the right operand input component
  58769. */
  58770. readonly right: NodeMaterialConnectionPoint;
  58771. /**
  58772. * Gets the output component
  58773. */
  58774. readonly output: NodeMaterialConnectionPoint;
  58775. protected _buildBlock(state: NodeMaterialBuildState): this;
  58776. }
  58777. }
  58778. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  58779. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58780. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58781. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58782. /**
  58783. * Block used to get the length of a vector
  58784. */
  58785. export class LengthBlock extends NodeMaterialBlock {
  58786. /**
  58787. * Creates a new LengthBlock
  58788. * @param name defines the block name
  58789. */
  58790. constructor(name: string);
  58791. /**
  58792. * Gets the current class name
  58793. * @returns the class name
  58794. */
  58795. getClassName(): string;
  58796. /**
  58797. * Gets the value input component
  58798. */
  58799. readonly value: NodeMaterialConnectionPoint;
  58800. /**
  58801. * Gets the output component
  58802. */
  58803. readonly output: NodeMaterialConnectionPoint;
  58804. protected _buildBlock(state: NodeMaterialBuildState): this;
  58805. }
  58806. }
  58807. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  58808. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58809. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58810. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58811. /**
  58812. * Block used to get negative version of a value (i.e. x * -1)
  58813. */
  58814. export class NegateBlock extends NodeMaterialBlock {
  58815. /**
  58816. * Creates a new NegateBlock
  58817. * @param name defines the block name
  58818. */
  58819. constructor(name: string);
  58820. /**
  58821. * Gets the current class name
  58822. * @returns the class name
  58823. */
  58824. getClassName(): string;
  58825. /**
  58826. * Gets the value input component
  58827. */
  58828. readonly value: NodeMaterialConnectionPoint;
  58829. /**
  58830. * Gets the output component
  58831. */
  58832. readonly output: NodeMaterialConnectionPoint;
  58833. protected _buildBlock(state: NodeMaterialBuildState): this;
  58834. }
  58835. }
  58836. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  58837. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58838. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58839. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58840. /**
  58841. * Block used to get the value of the first parameter raised to the power of the second
  58842. */
  58843. export class PowBlock extends NodeMaterialBlock {
  58844. /**
  58845. * Creates a new PowBlock
  58846. * @param name defines the block name
  58847. */
  58848. constructor(name: string);
  58849. /**
  58850. * Gets the current class name
  58851. * @returns the class name
  58852. */
  58853. getClassName(): string;
  58854. /**
  58855. * Gets the value operand input component
  58856. */
  58857. readonly value: NodeMaterialConnectionPoint;
  58858. /**
  58859. * Gets the power operand input component
  58860. */
  58861. readonly power: NodeMaterialConnectionPoint;
  58862. /**
  58863. * Gets the output component
  58864. */
  58865. readonly output: NodeMaterialConnectionPoint;
  58866. protected _buildBlock(state: NodeMaterialBuildState): this;
  58867. }
  58868. }
  58869. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  58870. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58871. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58872. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58873. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58874. /**
  58875. * Block used to get a random number
  58876. */
  58877. export class RandomNumberBlock extends NodeMaterialBlock {
  58878. /**
  58879. * Creates a new RandomNumberBlock
  58880. * @param name defines the block name
  58881. */
  58882. constructor(name: string);
  58883. /**
  58884. * Gets the current class name
  58885. * @returns the class name
  58886. */
  58887. getClassName(): string;
  58888. /**
  58889. * Gets the seed input component
  58890. */
  58891. readonly seed: NodeMaterialConnectionPoint;
  58892. /**
  58893. * Gets the output component
  58894. */
  58895. readonly output: NodeMaterialConnectionPoint;
  58896. protected _buildBlock(state: NodeMaterialBuildState): this;
  58897. }
  58898. }
  58899. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  58900. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58901. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58902. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58903. /**
  58904. * Block used to compute arc tangent of 2 values
  58905. */
  58906. export class ArcTan2Block extends NodeMaterialBlock {
  58907. /**
  58908. * Creates a new ArcTan2Block
  58909. * @param name defines the block name
  58910. */
  58911. constructor(name: string);
  58912. /**
  58913. * Gets the current class name
  58914. * @returns the class name
  58915. */
  58916. getClassName(): string;
  58917. /**
  58918. * Gets the x operand input component
  58919. */
  58920. readonly x: NodeMaterialConnectionPoint;
  58921. /**
  58922. * Gets the y operand input component
  58923. */
  58924. readonly y: NodeMaterialConnectionPoint;
  58925. /**
  58926. * Gets the output component
  58927. */
  58928. readonly output: NodeMaterialConnectionPoint;
  58929. protected _buildBlock(state: NodeMaterialBuildState): this;
  58930. }
  58931. }
  58932. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  58933. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58934. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58935. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58936. /**
  58937. * Block used to smooth step a value
  58938. */
  58939. export class SmoothStepBlock extends NodeMaterialBlock {
  58940. /**
  58941. * Creates a new SmoothStepBlock
  58942. * @param name defines the block name
  58943. */
  58944. constructor(name: string);
  58945. /**
  58946. * Gets the current class name
  58947. * @returns the class name
  58948. */
  58949. getClassName(): string;
  58950. /**
  58951. * Gets the value operand input component
  58952. */
  58953. readonly value: NodeMaterialConnectionPoint;
  58954. /**
  58955. * Gets the first edge operand input component
  58956. */
  58957. readonly edge0: NodeMaterialConnectionPoint;
  58958. /**
  58959. * Gets the second edge operand input component
  58960. */
  58961. readonly edge1: NodeMaterialConnectionPoint;
  58962. /**
  58963. * Gets the output component
  58964. */
  58965. readonly output: NodeMaterialConnectionPoint;
  58966. protected _buildBlock(state: NodeMaterialBuildState): this;
  58967. }
  58968. }
  58969. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  58970. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58971. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58972. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58973. /**
  58974. * Block used to get the reciprocal (1 / x) of a value
  58975. */
  58976. export class ReciprocalBlock extends NodeMaterialBlock {
  58977. /**
  58978. * Creates a new ReciprocalBlock
  58979. * @param name defines the block name
  58980. */
  58981. constructor(name: string);
  58982. /**
  58983. * Gets the current class name
  58984. * @returns the class name
  58985. */
  58986. getClassName(): string;
  58987. /**
  58988. * Gets the input component
  58989. */
  58990. readonly input: NodeMaterialConnectionPoint;
  58991. /**
  58992. * Gets the output component
  58993. */
  58994. readonly output: NodeMaterialConnectionPoint;
  58995. protected _buildBlock(state: NodeMaterialBuildState): this;
  58996. }
  58997. }
  58998. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  58999. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59000. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59001. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59002. /**
  59003. * Block used to replace a color by another one
  59004. */
  59005. export class ReplaceColorBlock extends NodeMaterialBlock {
  59006. /**
  59007. * Creates a new ReplaceColorBlock
  59008. * @param name defines the block name
  59009. */
  59010. constructor(name: string);
  59011. /**
  59012. * Gets the current class name
  59013. * @returns the class name
  59014. */
  59015. getClassName(): string;
  59016. /**
  59017. * Gets the value input component
  59018. */
  59019. readonly value: NodeMaterialConnectionPoint;
  59020. /**
  59021. * Gets the reference input component
  59022. */
  59023. readonly reference: NodeMaterialConnectionPoint;
  59024. /**
  59025. * Gets the distance input component
  59026. */
  59027. readonly distance: NodeMaterialConnectionPoint;
  59028. /**
  59029. * Gets the replacement input component
  59030. */
  59031. readonly replacement: NodeMaterialConnectionPoint;
  59032. /**
  59033. * Gets the output component
  59034. */
  59035. readonly output: NodeMaterialConnectionPoint;
  59036. protected _buildBlock(state: NodeMaterialBuildState): this;
  59037. }
  59038. }
  59039. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  59040. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59041. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59042. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59043. /**
  59044. * Block used to posterize a value
  59045. * @see https://en.wikipedia.org/wiki/Posterization
  59046. */
  59047. export class PosterizeBlock extends NodeMaterialBlock {
  59048. /**
  59049. * Creates a new PosterizeBlock
  59050. * @param name defines the block name
  59051. */
  59052. constructor(name: string);
  59053. /**
  59054. * Gets the current class name
  59055. * @returns the class name
  59056. */
  59057. getClassName(): string;
  59058. /**
  59059. * Gets the value input component
  59060. */
  59061. readonly value: NodeMaterialConnectionPoint;
  59062. /**
  59063. * Gets the steps input component
  59064. */
  59065. readonly steps: NodeMaterialConnectionPoint;
  59066. /**
  59067. * Gets the output component
  59068. */
  59069. readonly output: NodeMaterialConnectionPoint;
  59070. protected _buildBlock(state: NodeMaterialBuildState): this;
  59071. }
  59072. }
  59073. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  59074. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59075. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59076. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59077. import { Scene } from "babylonjs/scene";
  59078. /**
  59079. * Operations supported by the Wave block
  59080. */
  59081. export enum WaveBlockKind {
  59082. /** SawTooth */
  59083. SawTooth = 0,
  59084. /** Square */
  59085. Square = 1,
  59086. /** Triangle */
  59087. Triangle = 2
  59088. }
  59089. /**
  59090. * Block used to apply wave operation to floats
  59091. */
  59092. export class WaveBlock extends NodeMaterialBlock {
  59093. /**
  59094. * Gets or sets the kibnd of wave to be applied by the block
  59095. */
  59096. kind: WaveBlockKind;
  59097. /**
  59098. * Creates a new WaveBlock
  59099. * @param name defines the block name
  59100. */
  59101. constructor(name: string);
  59102. /**
  59103. * Gets the current class name
  59104. * @returns the class name
  59105. */
  59106. getClassName(): string;
  59107. /**
  59108. * Gets the input component
  59109. */
  59110. readonly input: NodeMaterialConnectionPoint;
  59111. /**
  59112. * Gets the output component
  59113. */
  59114. readonly output: NodeMaterialConnectionPoint;
  59115. protected _buildBlock(state: NodeMaterialBuildState): this;
  59116. serialize(): any;
  59117. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  59118. }
  59119. }
  59120. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  59121. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59122. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59123. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59124. import { Color3 } from "babylonjs/Maths/math.color";
  59125. import { Scene } from "babylonjs/scene";
  59126. /**
  59127. * Class used to store a color step for the GradientBlock
  59128. */
  59129. export class GradientBlockColorStep {
  59130. /**
  59131. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  59132. */
  59133. step: number;
  59134. /**
  59135. * Gets or sets the color associated with this step
  59136. */
  59137. color: Color3;
  59138. /**
  59139. * Creates a new GradientBlockColorStep
  59140. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  59141. * @param color defines the color associated with this step
  59142. */
  59143. constructor(
  59144. /**
  59145. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  59146. */
  59147. step: number,
  59148. /**
  59149. * Gets or sets the color associated with this step
  59150. */
  59151. color: Color3);
  59152. }
  59153. /**
  59154. * Block used to return a color from a gradient based on an input value between 0 and 1
  59155. */
  59156. export class GradientBlock extends NodeMaterialBlock {
  59157. /**
  59158. * Gets or sets the list of color steps
  59159. */
  59160. colorSteps: GradientBlockColorStep[];
  59161. /**
  59162. * Creates a new GradientBlock
  59163. * @param name defines the block name
  59164. */
  59165. constructor(name: string);
  59166. /**
  59167. * Gets the current class name
  59168. * @returns the class name
  59169. */
  59170. getClassName(): string;
  59171. /**
  59172. * Gets the gradient input component
  59173. */
  59174. readonly gradient: NodeMaterialConnectionPoint;
  59175. /**
  59176. * Gets the output component
  59177. */
  59178. readonly output: NodeMaterialConnectionPoint;
  59179. private _writeColorConstant;
  59180. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  59181. serialize(): any;
  59182. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  59183. protected _dumpPropertiesCode(): string;
  59184. }
  59185. }
  59186. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  59187. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59188. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59189. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59190. /**
  59191. * Block used to normalize lerp between 2 values
  59192. */
  59193. export class NLerpBlock extends NodeMaterialBlock {
  59194. /**
  59195. * Creates a new NLerpBlock
  59196. * @param name defines the block name
  59197. */
  59198. constructor(name: string);
  59199. /**
  59200. * Gets the current class name
  59201. * @returns the class name
  59202. */
  59203. getClassName(): string;
  59204. /**
  59205. * Gets the left operand input component
  59206. */
  59207. readonly left: NodeMaterialConnectionPoint;
  59208. /**
  59209. * Gets the right operand input component
  59210. */
  59211. readonly right: NodeMaterialConnectionPoint;
  59212. /**
  59213. * Gets the gradient operand input component
  59214. */
  59215. readonly gradient: NodeMaterialConnectionPoint;
  59216. /**
  59217. * Gets the output component
  59218. */
  59219. readonly output: NodeMaterialConnectionPoint;
  59220. protected _buildBlock(state: NodeMaterialBuildState): this;
  59221. }
  59222. }
  59223. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  59224. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59225. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59226. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59227. import { Scene } from "babylonjs/scene";
  59228. /**
  59229. * block used to Generate a Worley Noise 3D Noise Pattern
  59230. */
  59231. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  59232. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  59233. manhattanDistance: boolean;
  59234. /**
  59235. * Creates a new WorleyNoise3DBlock
  59236. * @param name defines the block name
  59237. */
  59238. constructor(name: string);
  59239. /**
  59240. * Gets the current class name
  59241. * @returns the class name
  59242. */
  59243. getClassName(): string;
  59244. /**
  59245. * Gets the position input component
  59246. */
  59247. readonly position: NodeMaterialConnectionPoint;
  59248. /**
  59249. * Gets the jitter input component
  59250. */
  59251. readonly jitter: NodeMaterialConnectionPoint;
  59252. /**
  59253. * Gets the output component
  59254. */
  59255. readonly output: NodeMaterialConnectionPoint;
  59256. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  59257. /**
  59258. * Exposes the properties to the UI?
  59259. */
  59260. protected _dumpPropertiesCode(): string;
  59261. /**
  59262. * Exposes the properties to the Seralize?
  59263. */
  59264. serialize(): any;
  59265. /**
  59266. * Exposes the properties to the deseralize?
  59267. */
  59268. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  59269. }
  59270. }
  59271. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  59272. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59273. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59274. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59275. /**
  59276. * block used to Generate a Simplex Perlin 3d Noise Pattern
  59277. */
  59278. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  59279. /**
  59280. * Creates a new SimplexPerlin3DBlock
  59281. * @param name defines the block name
  59282. */
  59283. constructor(name: string);
  59284. /**
  59285. * Gets the current class name
  59286. * @returns the class name
  59287. */
  59288. getClassName(): string;
  59289. /**
  59290. * Gets the position operand input component
  59291. */
  59292. readonly position: NodeMaterialConnectionPoint;
  59293. /**
  59294. * Gets the output component
  59295. */
  59296. readonly output: NodeMaterialConnectionPoint;
  59297. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  59298. }
  59299. }
  59300. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  59301. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59302. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59303. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59304. /**
  59305. * Block used to blend normals
  59306. */
  59307. export class NormalBlendBlock extends NodeMaterialBlock {
  59308. /**
  59309. * Creates a new NormalBlendBlock
  59310. * @param name defines the block name
  59311. */
  59312. constructor(name: string);
  59313. /**
  59314. * Gets the current class name
  59315. * @returns the class name
  59316. */
  59317. getClassName(): string;
  59318. /**
  59319. * Gets the first input component
  59320. */
  59321. readonly input0: NodeMaterialConnectionPoint;
  59322. /**
  59323. * Gets the second input component
  59324. */
  59325. readonly input1: NodeMaterialConnectionPoint;
  59326. /**
  59327. * Gets the output component
  59328. */
  59329. readonly output: NodeMaterialConnectionPoint;
  59330. protected _buildBlock(state: NodeMaterialBuildState): this;
  59331. }
  59332. }
  59333. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  59334. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59335. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59336. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59337. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  59338. /**
  59339. * Block used to rotate a 2d vector by a given angle
  59340. */
  59341. export class Rotate2dBlock extends NodeMaterialBlock {
  59342. /**
  59343. * Creates a new Rotate2dBlock
  59344. * @param name defines the block name
  59345. */
  59346. constructor(name: string);
  59347. /**
  59348. * Gets the current class name
  59349. * @returns the class name
  59350. */
  59351. getClassName(): string;
  59352. /**
  59353. * Gets the input vector
  59354. */
  59355. readonly input: NodeMaterialConnectionPoint;
  59356. /**
  59357. * Gets the input angle
  59358. */
  59359. readonly angle: NodeMaterialConnectionPoint;
  59360. /**
  59361. * Gets the output component
  59362. */
  59363. readonly output: NodeMaterialConnectionPoint;
  59364. autoConfigure(material: NodeMaterial): void;
  59365. protected _buildBlock(state: NodeMaterialBuildState): this;
  59366. }
  59367. }
  59368. declare module "babylonjs/Materials/Node/Blocks/index" {
  59369. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  59370. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  59371. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  59372. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  59373. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  59374. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  59375. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  59376. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  59377. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  59378. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  59379. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  59380. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  59381. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  59382. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  59383. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  59384. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  59385. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  59386. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  59387. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  59388. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  59389. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  59390. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  59391. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  59392. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  59393. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  59394. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  59395. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  59396. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  59397. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  59398. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  59399. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  59400. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  59401. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  59402. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  59403. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  59404. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  59405. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  59406. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  59407. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  59408. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  59409. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  59410. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  59411. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  59412. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  59413. }
  59414. declare module "babylonjs/Materials/Node/Optimizers/index" {
  59415. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  59416. }
  59417. declare module "babylonjs/Materials/Node/index" {
  59418. export * from "babylonjs/Materials/Node/Enums/index";
  59419. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59420. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  59421. export * from "babylonjs/Materials/Node/nodeMaterial";
  59422. export * from "babylonjs/Materials/Node/Blocks/index";
  59423. export * from "babylonjs/Materials/Node/Optimizers/index";
  59424. }
  59425. declare module "babylonjs/Materials/effectRenderer" {
  59426. import { Nullable } from "babylonjs/types";
  59427. import { Texture } from "babylonjs/Materials/Textures/texture";
  59428. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59429. import { Viewport } from "babylonjs/Maths/math.viewport";
  59430. import { Observable } from "babylonjs/Misc/observable";
  59431. import { Effect } from "babylonjs/Materials/effect";
  59432. import "babylonjs/Engines/Extensions/engine.renderTarget";
  59433. import "babylonjs/Shaders/postprocess.vertex";
  59434. /**
  59435. * Effect Render Options
  59436. */
  59437. export interface IEffectRendererOptions {
  59438. /**
  59439. * Defines the vertices positions.
  59440. */
  59441. positions?: number[];
  59442. /**
  59443. * Defines the indices.
  59444. */
  59445. indices?: number[];
  59446. }
  59447. /**
  59448. * Helper class to render one or more effects
  59449. */
  59450. export class EffectRenderer {
  59451. private engine;
  59452. private static _DefaultOptions;
  59453. private _vertexBuffers;
  59454. private _indexBuffer;
  59455. private _ringBufferIndex;
  59456. private _ringScreenBuffer;
  59457. private _fullscreenViewport;
  59458. private _getNextFrameBuffer;
  59459. /**
  59460. * Creates an effect renderer
  59461. * @param engine the engine to use for rendering
  59462. * @param options defines the options of the effect renderer
  59463. */
  59464. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  59465. /**
  59466. * Sets the current viewport in normalized coordinates 0-1
  59467. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  59468. */
  59469. setViewport(viewport?: Viewport): void;
  59470. /**
  59471. * Binds the embedded attributes buffer to the effect.
  59472. * @param effect Defines the effect to bind the attributes for
  59473. */
  59474. bindBuffers(effect: Effect): void;
  59475. /**
  59476. * Sets the current effect wrapper to use during draw.
  59477. * The effect needs to be ready before calling this api.
  59478. * This also sets the default full screen position attribute.
  59479. * @param effectWrapper Defines the effect to draw with
  59480. */
  59481. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  59482. /**
  59483. * Draws a full screen quad.
  59484. */
  59485. draw(): void;
  59486. /**
  59487. * renders one or more effects to a specified texture
  59488. * @param effectWrappers list of effects to renderer
  59489. * @param outputTexture texture to draw to, if null it will render to the screen
  59490. */
  59491. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  59492. /**
  59493. * Disposes of the effect renderer
  59494. */
  59495. dispose(): void;
  59496. }
  59497. /**
  59498. * Options to create an EffectWrapper
  59499. */
  59500. interface EffectWrapperCreationOptions {
  59501. /**
  59502. * Engine to use to create the effect
  59503. */
  59504. engine: ThinEngine;
  59505. /**
  59506. * Fragment shader for the effect
  59507. */
  59508. fragmentShader: string;
  59509. /**
  59510. * Vertex shader for the effect
  59511. */
  59512. vertexShader?: string;
  59513. /**
  59514. * Attributes to use in the shader
  59515. */
  59516. attributeNames?: Array<string>;
  59517. /**
  59518. * Uniforms to use in the shader
  59519. */
  59520. uniformNames?: Array<string>;
  59521. /**
  59522. * Texture sampler names to use in the shader
  59523. */
  59524. samplerNames?: Array<string>;
  59525. /**
  59526. * The friendly name of the effect displayed in Spector.
  59527. */
  59528. name?: string;
  59529. }
  59530. /**
  59531. * Wraps an effect to be used for rendering
  59532. */
  59533. export class EffectWrapper {
  59534. /**
  59535. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  59536. */
  59537. onApplyObservable: Observable<{}>;
  59538. /**
  59539. * The underlying effect
  59540. */
  59541. effect: Effect;
  59542. /**
  59543. * Creates an effect to be renderer
  59544. * @param creationOptions options to create the effect
  59545. */
  59546. constructor(creationOptions: EffectWrapperCreationOptions);
  59547. /**
  59548. * Disposes of the effect wrapper
  59549. */
  59550. dispose(): void;
  59551. }
  59552. }
  59553. declare module "babylonjs/Materials/index" {
  59554. export * from "babylonjs/Materials/Background/index";
  59555. export * from "babylonjs/Materials/colorCurves";
  59556. export * from "babylonjs/Materials/iEffectFallbacks";
  59557. export * from "babylonjs/Materials/effectFallbacks";
  59558. export * from "babylonjs/Materials/effect";
  59559. export * from "babylonjs/Materials/fresnelParameters";
  59560. export * from "babylonjs/Materials/imageProcessingConfiguration";
  59561. export * from "babylonjs/Materials/material";
  59562. export * from "babylonjs/Materials/materialDefines";
  59563. export * from "babylonjs/Materials/materialHelper";
  59564. export * from "babylonjs/Materials/multiMaterial";
  59565. export * from "babylonjs/Materials/PBR/index";
  59566. export * from "babylonjs/Materials/pushMaterial";
  59567. export * from "babylonjs/Materials/shaderMaterial";
  59568. export * from "babylonjs/Materials/standardMaterial";
  59569. export * from "babylonjs/Materials/Textures/index";
  59570. export * from "babylonjs/Materials/uniformBuffer";
  59571. export * from "babylonjs/Materials/materialFlags";
  59572. export * from "babylonjs/Materials/Node/index";
  59573. export * from "babylonjs/Materials/effectRenderer";
  59574. }
  59575. declare module "babylonjs/Maths/index" {
  59576. export * from "babylonjs/Maths/math.scalar";
  59577. export * from "babylonjs/Maths/math";
  59578. export * from "babylonjs/Maths/sphericalPolynomial";
  59579. }
  59580. declare module "babylonjs/Misc/workerPool" {
  59581. import { IDisposable } from "babylonjs/scene";
  59582. /**
  59583. * Helper class to push actions to a pool of workers.
  59584. */
  59585. export class WorkerPool implements IDisposable {
  59586. private _workerInfos;
  59587. private _pendingActions;
  59588. /**
  59589. * Constructor
  59590. * @param workers Array of workers to use for actions
  59591. */
  59592. constructor(workers: Array<Worker>);
  59593. /**
  59594. * Terminates all workers and clears any pending actions.
  59595. */
  59596. dispose(): void;
  59597. /**
  59598. * Pushes an action to the worker pool. If all the workers are active, the action will be
  59599. * pended until a worker has completed its action.
  59600. * @param action The action to perform. Call onComplete when the action is complete.
  59601. */
  59602. push(action: (worker: Worker, onComplete: () => void) => void): void;
  59603. private _execute;
  59604. }
  59605. }
  59606. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  59607. import { IDisposable } from "babylonjs/scene";
  59608. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59609. /**
  59610. * Configuration for Draco compression
  59611. */
  59612. export interface IDracoCompressionConfiguration {
  59613. /**
  59614. * Configuration for the decoder.
  59615. */
  59616. decoder: {
  59617. /**
  59618. * The url to the WebAssembly module.
  59619. */
  59620. wasmUrl?: string;
  59621. /**
  59622. * The url to the WebAssembly binary.
  59623. */
  59624. wasmBinaryUrl?: string;
  59625. /**
  59626. * The url to the fallback JavaScript module.
  59627. */
  59628. fallbackUrl?: string;
  59629. };
  59630. }
  59631. /**
  59632. * Draco compression (https://google.github.io/draco/)
  59633. *
  59634. * This class wraps the Draco module.
  59635. *
  59636. * **Encoder**
  59637. *
  59638. * The encoder is not currently implemented.
  59639. *
  59640. * **Decoder**
  59641. *
  59642. * 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.
  59643. *
  59644. * To update the configuration, use the following code:
  59645. * ```javascript
  59646. * DracoCompression.Configuration = {
  59647. * decoder: {
  59648. * wasmUrl: "<url to the WebAssembly library>",
  59649. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  59650. * fallbackUrl: "<url to the fallback JavaScript library>",
  59651. * }
  59652. * };
  59653. * ```
  59654. *
  59655. * 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.
  59656. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  59657. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  59658. *
  59659. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  59660. * ```javascript
  59661. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  59662. * ```
  59663. *
  59664. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  59665. */
  59666. export class DracoCompression implements IDisposable {
  59667. private _workerPoolPromise?;
  59668. private _decoderModulePromise?;
  59669. /**
  59670. * The configuration. Defaults to the following urls:
  59671. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  59672. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  59673. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  59674. */
  59675. static Configuration: IDracoCompressionConfiguration;
  59676. /**
  59677. * Returns true if the decoder configuration is available.
  59678. */
  59679. static readonly DecoderAvailable: boolean;
  59680. /**
  59681. * Default number of workers to create when creating the draco compression object.
  59682. */
  59683. static DefaultNumWorkers: number;
  59684. private static GetDefaultNumWorkers;
  59685. private static _Default;
  59686. /**
  59687. * Default instance for the draco compression object.
  59688. */
  59689. static readonly Default: DracoCompression;
  59690. /**
  59691. * Constructor
  59692. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  59693. */
  59694. constructor(numWorkers?: number);
  59695. /**
  59696. * Stop all async operations and release resources.
  59697. */
  59698. dispose(): void;
  59699. /**
  59700. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  59701. * @returns a promise that resolves when ready
  59702. */
  59703. whenReadyAsync(): Promise<void>;
  59704. /**
  59705. * Decode Draco compressed mesh data to vertex data.
  59706. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  59707. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  59708. * @returns A promise that resolves with the decoded vertex data
  59709. */
  59710. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  59711. [kind: string]: number;
  59712. }): Promise<VertexData>;
  59713. }
  59714. }
  59715. declare module "babylonjs/Meshes/Compression/index" {
  59716. export * from "babylonjs/Meshes/Compression/dracoCompression";
  59717. }
  59718. declare module "babylonjs/Meshes/csg" {
  59719. import { Nullable } from "babylonjs/types";
  59720. import { Scene } from "babylonjs/scene";
  59721. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59722. import { Mesh } from "babylonjs/Meshes/mesh";
  59723. import { Material } from "babylonjs/Materials/material";
  59724. /**
  59725. * Class for building Constructive Solid Geometry
  59726. */
  59727. export class CSG {
  59728. private polygons;
  59729. /**
  59730. * The world matrix
  59731. */
  59732. matrix: Matrix;
  59733. /**
  59734. * Stores the position
  59735. */
  59736. position: Vector3;
  59737. /**
  59738. * Stores the rotation
  59739. */
  59740. rotation: Vector3;
  59741. /**
  59742. * Stores the rotation quaternion
  59743. */
  59744. rotationQuaternion: Nullable<Quaternion>;
  59745. /**
  59746. * Stores the scaling vector
  59747. */
  59748. scaling: Vector3;
  59749. /**
  59750. * Convert the Mesh to CSG
  59751. * @param mesh The Mesh to convert to CSG
  59752. * @returns A new CSG from the Mesh
  59753. */
  59754. static FromMesh(mesh: Mesh): CSG;
  59755. /**
  59756. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  59757. * @param polygons Polygons used to construct a CSG solid
  59758. */
  59759. private static FromPolygons;
  59760. /**
  59761. * Clones, or makes a deep copy, of the CSG
  59762. * @returns A new CSG
  59763. */
  59764. clone(): CSG;
  59765. /**
  59766. * Unions this CSG with another CSG
  59767. * @param csg The CSG to union against this CSG
  59768. * @returns The unioned CSG
  59769. */
  59770. union(csg: CSG): CSG;
  59771. /**
  59772. * Unions this CSG with another CSG in place
  59773. * @param csg The CSG to union against this CSG
  59774. */
  59775. unionInPlace(csg: CSG): void;
  59776. /**
  59777. * Subtracts this CSG with another CSG
  59778. * @param csg The CSG to subtract against this CSG
  59779. * @returns A new CSG
  59780. */
  59781. subtract(csg: CSG): CSG;
  59782. /**
  59783. * Subtracts this CSG with another CSG in place
  59784. * @param csg The CSG to subtact against this CSG
  59785. */
  59786. subtractInPlace(csg: CSG): void;
  59787. /**
  59788. * Intersect this CSG with another CSG
  59789. * @param csg The CSG to intersect against this CSG
  59790. * @returns A new CSG
  59791. */
  59792. intersect(csg: CSG): CSG;
  59793. /**
  59794. * Intersects this CSG with another CSG in place
  59795. * @param csg The CSG to intersect against this CSG
  59796. */
  59797. intersectInPlace(csg: CSG): void;
  59798. /**
  59799. * Return a new CSG solid with solid and empty space switched. This solid is
  59800. * not modified.
  59801. * @returns A new CSG solid with solid and empty space switched
  59802. */
  59803. inverse(): CSG;
  59804. /**
  59805. * Inverses the CSG in place
  59806. */
  59807. inverseInPlace(): void;
  59808. /**
  59809. * This is used to keep meshes transformations so they can be restored
  59810. * when we build back a Babylon Mesh
  59811. * NB : All CSG operations are performed in world coordinates
  59812. * @param csg The CSG to copy the transform attributes from
  59813. * @returns This CSG
  59814. */
  59815. copyTransformAttributes(csg: CSG): CSG;
  59816. /**
  59817. * Build Raw mesh from CSG
  59818. * Coordinates here are in world space
  59819. * @param name The name of the mesh geometry
  59820. * @param scene The Scene
  59821. * @param keepSubMeshes Specifies if the submeshes should be kept
  59822. * @returns A new Mesh
  59823. */
  59824. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59825. /**
  59826. * Build Mesh from CSG taking material and transforms into account
  59827. * @param name The name of the Mesh
  59828. * @param material The material of the Mesh
  59829. * @param scene The Scene
  59830. * @param keepSubMeshes Specifies if submeshes should be kept
  59831. * @returns The new Mesh
  59832. */
  59833. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59834. }
  59835. }
  59836. declare module "babylonjs/Meshes/trailMesh" {
  59837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59838. import { Mesh } from "babylonjs/Meshes/mesh";
  59839. import { Scene } from "babylonjs/scene";
  59840. /**
  59841. * Class used to create a trail following a mesh
  59842. */
  59843. export class TrailMesh extends Mesh {
  59844. private _generator;
  59845. private _autoStart;
  59846. private _running;
  59847. private _diameter;
  59848. private _length;
  59849. private _sectionPolygonPointsCount;
  59850. private _sectionVectors;
  59851. private _sectionNormalVectors;
  59852. private _beforeRenderObserver;
  59853. /**
  59854. * @constructor
  59855. * @param name The value used by scene.getMeshByName() to do a lookup.
  59856. * @param generator The mesh to generate a trail.
  59857. * @param scene The scene to add this mesh to.
  59858. * @param diameter Diameter of trailing mesh. Default is 1.
  59859. * @param length Length of trailing mesh. Default is 60.
  59860. * @param autoStart Automatically start trailing mesh. Default true.
  59861. */
  59862. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  59863. /**
  59864. * "TrailMesh"
  59865. * @returns "TrailMesh"
  59866. */
  59867. getClassName(): string;
  59868. private _createMesh;
  59869. /**
  59870. * Start trailing mesh.
  59871. */
  59872. start(): void;
  59873. /**
  59874. * Stop trailing mesh.
  59875. */
  59876. stop(): void;
  59877. /**
  59878. * Update trailing mesh geometry.
  59879. */
  59880. update(): void;
  59881. /**
  59882. * Returns a new TrailMesh object.
  59883. * @param name is a string, the name given to the new mesh
  59884. * @param newGenerator use new generator object for cloned trail mesh
  59885. * @returns a new mesh
  59886. */
  59887. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  59888. /**
  59889. * Serializes this trail mesh
  59890. * @param serializationObject object to write serialization to
  59891. */
  59892. serialize(serializationObject: any): void;
  59893. /**
  59894. * Parses a serialized trail mesh
  59895. * @param parsedMesh the serialized mesh
  59896. * @param scene the scene to create the trail mesh in
  59897. * @returns the created trail mesh
  59898. */
  59899. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  59900. }
  59901. }
  59902. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  59903. import { Nullable } from "babylonjs/types";
  59904. import { Scene } from "babylonjs/scene";
  59905. import { Vector4 } from "babylonjs/Maths/math.vector";
  59906. import { Color4 } from "babylonjs/Maths/math.color";
  59907. import { Mesh } from "babylonjs/Meshes/mesh";
  59908. /**
  59909. * Class containing static functions to help procedurally build meshes
  59910. */
  59911. export class TiledBoxBuilder {
  59912. /**
  59913. * Creates a box mesh
  59914. * 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)
  59915. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59916. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59917. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59918. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59919. * @param name defines the name of the mesh
  59920. * @param options defines the options used to create the mesh
  59921. * @param scene defines the hosting scene
  59922. * @returns the box mesh
  59923. */
  59924. static CreateTiledBox(name: string, options: {
  59925. pattern?: number;
  59926. width?: number;
  59927. height?: number;
  59928. depth?: number;
  59929. tileSize?: number;
  59930. tileWidth?: number;
  59931. tileHeight?: number;
  59932. alignHorizontal?: number;
  59933. alignVertical?: number;
  59934. faceUV?: Vector4[];
  59935. faceColors?: Color4[];
  59936. sideOrientation?: number;
  59937. updatable?: boolean;
  59938. }, scene?: Nullable<Scene>): Mesh;
  59939. }
  59940. }
  59941. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  59942. import { Vector4 } from "babylonjs/Maths/math.vector";
  59943. import { Mesh } from "babylonjs/Meshes/mesh";
  59944. /**
  59945. * Class containing static functions to help procedurally build meshes
  59946. */
  59947. export class TorusKnotBuilder {
  59948. /**
  59949. * Creates a torus knot mesh
  59950. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59951. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59952. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59953. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59954. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59955. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59956. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59957. * @param name defines the name of the mesh
  59958. * @param options defines the options used to create the mesh
  59959. * @param scene defines the hosting scene
  59960. * @returns the torus knot mesh
  59961. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59962. */
  59963. static CreateTorusKnot(name: string, options: {
  59964. radius?: number;
  59965. tube?: number;
  59966. radialSegments?: number;
  59967. tubularSegments?: number;
  59968. p?: number;
  59969. q?: number;
  59970. updatable?: boolean;
  59971. sideOrientation?: number;
  59972. frontUVs?: Vector4;
  59973. backUVs?: Vector4;
  59974. }, scene: any): Mesh;
  59975. }
  59976. }
  59977. declare module "babylonjs/Meshes/polygonMesh" {
  59978. import { Scene } from "babylonjs/scene";
  59979. import { Vector2 } from "babylonjs/Maths/math.vector";
  59980. import { Mesh } from "babylonjs/Meshes/mesh";
  59981. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59982. import { Path2 } from "babylonjs/Maths/math.path";
  59983. /**
  59984. * Polygon
  59985. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  59986. */
  59987. export class Polygon {
  59988. /**
  59989. * Creates a rectangle
  59990. * @param xmin bottom X coord
  59991. * @param ymin bottom Y coord
  59992. * @param xmax top X coord
  59993. * @param ymax top Y coord
  59994. * @returns points that make the resulting rectation
  59995. */
  59996. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  59997. /**
  59998. * Creates a circle
  59999. * @param radius radius of circle
  60000. * @param cx scale in x
  60001. * @param cy scale in y
  60002. * @param numberOfSides number of sides that make up the circle
  60003. * @returns points that make the resulting circle
  60004. */
  60005. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  60006. /**
  60007. * Creates a polygon from input string
  60008. * @param input Input polygon data
  60009. * @returns the parsed points
  60010. */
  60011. static Parse(input: string): Vector2[];
  60012. /**
  60013. * Starts building a polygon from x and y coordinates
  60014. * @param x x coordinate
  60015. * @param y y coordinate
  60016. * @returns the started path2
  60017. */
  60018. static StartingAt(x: number, y: number): Path2;
  60019. }
  60020. /**
  60021. * Builds a polygon
  60022. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  60023. */
  60024. export class PolygonMeshBuilder {
  60025. private _points;
  60026. private _outlinepoints;
  60027. private _holes;
  60028. private _name;
  60029. private _scene;
  60030. private _epoints;
  60031. private _eholes;
  60032. private _addToepoint;
  60033. /**
  60034. * Babylon reference to the earcut plugin.
  60035. */
  60036. bjsEarcut: any;
  60037. /**
  60038. * Creates a PolygonMeshBuilder
  60039. * @param name name of the builder
  60040. * @param contours Path of the polygon
  60041. * @param scene scene to add to when creating the mesh
  60042. * @param earcutInjection can be used to inject your own earcut reference
  60043. */
  60044. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  60045. /**
  60046. * Adds a whole within the polygon
  60047. * @param hole Array of points defining the hole
  60048. * @returns this
  60049. */
  60050. addHole(hole: Vector2[]): PolygonMeshBuilder;
  60051. /**
  60052. * Creates the polygon
  60053. * @param updatable If the mesh should be updatable
  60054. * @param depth The depth of the mesh created
  60055. * @returns the created mesh
  60056. */
  60057. build(updatable?: boolean, depth?: number): Mesh;
  60058. /**
  60059. * Creates the polygon
  60060. * @param depth The depth of the mesh created
  60061. * @returns the created VertexData
  60062. */
  60063. buildVertexData(depth?: number): VertexData;
  60064. /**
  60065. * Adds a side to the polygon
  60066. * @param positions points that make the polygon
  60067. * @param normals normals of the polygon
  60068. * @param uvs uvs of the polygon
  60069. * @param indices indices of the polygon
  60070. * @param bounds bounds of the polygon
  60071. * @param points points of the polygon
  60072. * @param depth depth of the polygon
  60073. * @param flip flip of the polygon
  60074. */
  60075. private addSide;
  60076. }
  60077. }
  60078. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  60079. import { Scene } from "babylonjs/scene";
  60080. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  60081. import { Color4 } from "babylonjs/Maths/math.color";
  60082. import { Mesh } from "babylonjs/Meshes/mesh";
  60083. import { Nullable } from "babylonjs/types";
  60084. /**
  60085. * Class containing static functions to help procedurally build meshes
  60086. */
  60087. export class PolygonBuilder {
  60088. /**
  60089. * Creates a polygon mesh
  60090. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60091. * * 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
  60092. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60093. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60094. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60095. * * Remember you can only change the shape positions, not their number when updating a polygon
  60096. * @param name defines the name of the mesh
  60097. * @param options defines the options used to create the mesh
  60098. * @param scene defines the hosting scene
  60099. * @param earcutInjection can be used to inject your own earcut reference
  60100. * @returns the polygon mesh
  60101. */
  60102. static CreatePolygon(name: string, options: {
  60103. shape: Vector3[];
  60104. holes?: Vector3[][];
  60105. depth?: number;
  60106. faceUV?: Vector4[];
  60107. faceColors?: Color4[];
  60108. updatable?: boolean;
  60109. sideOrientation?: number;
  60110. frontUVs?: Vector4;
  60111. backUVs?: Vector4;
  60112. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60113. /**
  60114. * Creates an extruded polygon mesh, with depth in the Y direction.
  60115. * * 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)
  60116. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60117. * @param name defines the name of the mesh
  60118. * @param options defines the options used to create the mesh
  60119. * @param scene defines the hosting scene
  60120. * @param earcutInjection can be used to inject your own earcut reference
  60121. * @returns the polygon mesh
  60122. */
  60123. static ExtrudePolygon(name: string, options: {
  60124. shape: Vector3[];
  60125. holes?: Vector3[][];
  60126. depth?: number;
  60127. faceUV?: Vector4[];
  60128. faceColors?: Color4[];
  60129. updatable?: boolean;
  60130. sideOrientation?: number;
  60131. frontUVs?: Vector4;
  60132. backUVs?: Vector4;
  60133. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60134. }
  60135. }
  60136. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  60137. import { Scene } from "babylonjs/scene";
  60138. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  60139. import { Mesh } from "babylonjs/Meshes/mesh";
  60140. import { Nullable } from "babylonjs/types";
  60141. /**
  60142. * Class containing static functions to help procedurally build meshes
  60143. */
  60144. export class LatheBuilder {
  60145. /**
  60146. * Creates lathe mesh.
  60147. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60148. * * 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
  60149. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60150. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60151. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60152. * * 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
  60153. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60154. * * 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
  60155. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60156. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60157. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60158. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60159. * @param name defines the name of the mesh
  60160. * @param options defines the options used to create the mesh
  60161. * @param scene defines the hosting scene
  60162. * @returns the lathe mesh
  60163. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60164. */
  60165. static CreateLathe(name: string, options: {
  60166. shape: Vector3[];
  60167. radius?: number;
  60168. tessellation?: number;
  60169. clip?: number;
  60170. arc?: number;
  60171. closed?: boolean;
  60172. updatable?: boolean;
  60173. sideOrientation?: number;
  60174. frontUVs?: Vector4;
  60175. backUVs?: Vector4;
  60176. cap?: number;
  60177. invertUV?: boolean;
  60178. }, scene?: Nullable<Scene>): Mesh;
  60179. }
  60180. }
  60181. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  60182. import { Nullable } from "babylonjs/types";
  60183. import { Scene } from "babylonjs/scene";
  60184. import { Vector4 } from "babylonjs/Maths/math.vector";
  60185. import { Mesh } from "babylonjs/Meshes/mesh";
  60186. /**
  60187. * Class containing static functions to help procedurally build meshes
  60188. */
  60189. export class TiledPlaneBuilder {
  60190. /**
  60191. * Creates a tiled plane mesh
  60192. * * The parameter `pattern` will, depending on value, do nothing or
  60193. * * * flip (reflect about central vertical) alternate tiles across and up
  60194. * * * flip every tile on alternate rows
  60195. * * * rotate (180 degs) alternate tiles across and up
  60196. * * * rotate every tile on alternate rows
  60197. * * * flip and rotate alternate tiles across and up
  60198. * * * flip and rotate every tile on alternate rows
  60199. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  60200. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  60201. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60202. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60203. * * 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)
  60204. * * 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)
  60205. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  60206. * @param name defines the name of the mesh
  60207. * @param options defines the options used to create the mesh
  60208. * @param scene defines the hosting scene
  60209. * @returns the box mesh
  60210. */
  60211. static CreateTiledPlane(name: string, options: {
  60212. pattern?: number;
  60213. tileSize?: number;
  60214. tileWidth?: number;
  60215. tileHeight?: number;
  60216. size?: number;
  60217. width?: number;
  60218. height?: number;
  60219. alignHorizontal?: number;
  60220. alignVertical?: number;
  60221. sideOrientation?: number;
  60222. frontUVs?: Vector4;
  60223. backUVs?: Vector4;
  60224. updatable?: boolean;
  60225. }, scene?: Nullable<Scene>): Mesh;
  60226. }
  60227. }
  60228. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  60229. import { Nullable } from "babylonjs/types";
  60230. import { Scene } from "babylonjs/scene";
  60231. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  60232. import { Mesh } from "babylonjs/Meshes/mesh";
  60233. /**
  60234. * Class containing static functions to help procedurally build meshes
  60235. */
  60236. export class TubeBuilder {
  60237. /**
  60238. * Creates a tube mesh.
  60239. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60240. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60241. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60242. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60243. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60244. * * 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)
  60245. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60246. * * 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
  60247. * * 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
  60248. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60249. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60250. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60251. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60252. * @param name defines the name of the mesh
  60253. * @param options defines the options used to create the mesh
  60254. * @param scene defines the hosting scene
  60255. * @returns the tube mesh
  60256. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60257. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60258. */
  60259. static CreateTube(name: string, options: {
  60260. path: Vector3[];
  60261. radius?: number;
  60262. tessellation?: number;
  60263. radiusFunction?: {
  60264. (i: number, distance: number): number;
  60265. };
  60266. cap?: number;
  60267. arc?: number;
  60268. updatable?: boolean;
  60269. sideOrientation?: number;
  60270. frontUVs?: Vector4;
  60271. backUVs?: Vector4;
  60272. instance?: Mesh;
  60273. invertUV?: boolean;
  60274. }, scene?: Nullable<Scene>): Mesh;
  60275. }
  60276. }
  60277. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  60278. import { Scene } from "babylonjs/scene";
  60279. import { Vector4 } from "babylonjs/Maths/math.vector";
  60280. import { Mesh } from "babylonjs/Meshes/mesh";
  60281. import { Nullable } from "babylonjs/types";
  60282. /**
  60283. * Class containing static functions to help procedurally build meshes
  60284. */
  60285. export class IcoSphereBuilder {
  60286. /**
  60287. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  60288. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  60289. * * 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`)
  60290. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  60291. * * 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
  60292. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60293. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60294. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60295. * @param name defines the name of the mesh
  60296. * @param options defines the options used to create the mesh
  60297. * @param scene defines the hosting scene
  60298. * @returns the icosahedron mesh
  60299. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  60300. */
  60301. static CreateIcoSphere(name: string, options: {
  60302. radius?: number;
  60303. radiusX?: number;
  60304. radiusY?: number;
  60305. radiusZ?: number;
  60306. flat?: boolean;
  60307. subdivisions?: number;
  60308. sideOrientation?: number;
  60309. frontUVs?: Vector4;
  60310. backUVs?: Vector4;
  60311. updatable?: boolean;
  60312. }, scene?: Nullable<Scene>): Mesh;
  60313. }
  60314. }
  60315. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  60316. import { Vector3 } from "babylonjs/Maths/math.vector";
  60317. import { Mesh } from "babylonjs/Meshes/mesh";
  60318. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60319. /**
  60320. * Class containing static functions to help procedurally build meshes
  60321. */
  60322. export class DecalBuilder {
  60323. /**
  60324. * Creates a decal mesh.
  60325. * 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
  60326. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  60327. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  60328. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  60329. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  60330. * @param name defines the name of the mesh
  60331. * @param sourceMesh defines the mesh where the decal must be applied
  60332. * @param options defines the options used to create the mesh
  60333. * @param scene defines the hosting scene
  60334. * @returns the decal mesh
  60335. * @see https://doc.babylonjs.com/how_to/decals
  60336. */
  60337. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  60338. position?: Vector3;
  60339. normal?: Vector3;
  60340. size?: Vector3;
  60341. angle?: number;
  60342. }): Mesh;
  60343. }
  60344. }
  60345. declare module "babylonjs/Meshes/meshBuilder" {
  60346. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  60347. import { Nullable } from "babylonjs/types";
  60348. import { Scene } from "babylonjs/scene";
  60349. import { Mesh } from "babylonjs/Meshes/mesh";
  60350. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  60351. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  60352. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60353. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  60354. import { Plane } from "babylonjs/Maths/math.plane";
  60355. /**
  60356. * Class containing static functions to help procedurally build meshes
  60357. */
  60358. export class MeshBuilder {
  60359. /**
  60360. * Creates a box mesh
  60361. * * The parameter `size` sets the size (float) of each box side (default 1)
  60362. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  60363. * * 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)
  60364. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60365. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60366. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60367. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60368. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  60369. * @param name defines the name of the mesh
  60370. * @param options defines the options used to create the mesh
  60371. * @param scene defines the hosting scene
  60372. * @returns the box mesh
  60373. */
  60374. static CreateBox(name: string, options: {
  60375. size?: number;
  60376. width?: number;
  60377. height?: number;
  60378. depth?: number;
  60379. faceUV?: Vector4[];
  60380. faceColors?: Color4[];
  60381. sideOrientation?: number;
  60382. frontUVs?: Vector4;
  60383. backUVs?: Vector4;
  60384. updatable?: boolean;
  60385. }, scene?: Nullable<Scene>): Mesh;
  60386. /**
  60387. * Creates a tiled box mesh
  60388. * * faceTiles sets the pattern, tile size and number of tiles for a face
  60389. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60390. * @param name defines the name of the mesh
  60391. * @param options defines the options used to create the mesh
  60392. * @param scene defines the hosting scene
  60393. * @returns the tiled box mesh
  60394. */
  60395. static CreateTiledBox(name: string, options: {
  60396. pattern?: number;
  60397. size?: number;
  60398. width?: number;
  60399. height?: number;
  60400. depth: number;
  60401. tileSize?: number;
  60402. tileWidth?: number;
  60403. tileHeight?: number;
  60404. faceUV?: Vector4[];
  60405. faceColors?: Color4[];
  60406. alignHorizontal?: number;
  60407. alignVertical?: number;
  60408. sideOrientation?: number;
  60409. updatable?: boolean;
  60410. }, scene?: Nullable<Scene>): Mesh;
  60411. /**
  60412. * Creates a sphere mesh
  60413. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  60414. * * 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`)
  60415. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  60416. * * 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
  60417. * * 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)
  60418. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60419. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60420. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60421. * @param name defines the name of the mesh
  60422. * @param options defines the options used to create the mesh
  60423. * @param scene defines the hosting scene
  60424. * @returns the sphere mesh
  60425. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  60426. */
  60427. static CreateSphere(name: string, options: {
  60428. segments?: number;
  60429. diameter?: number;
  60430. diameterX?: number;
  60431. diameterY?: number;
  60432. diameterZ?: number;
  60433. arc?: number;
  60434. slice?: number;
  60435. sideOrientation?: number;
  60436. frontUVs?: Vector4;
  60437. backUVs?: Vector4;
  60438. updatable?: boolean;
  60439. }, scene?: Nullable<Scene>): Mesh;
  60440. /**
  60441. * Creates a plane polygonal mesh. By default, this is a disc
  60442. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  60443. * * 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
  60444. * * 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
  60445. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60446. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60447. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60448. * @param name defines the name of the mesh
  60449. * @param options defines the options used to create the mesh
  60450. * @param scene defines the hosting scene
  60451. * @returns the plane polygonal mesh
  60452. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  60453. */
  60454. static CreateDisc(name: string, options: {
  60455. radius?: number;
  60456. tessellation?: number;
  60457. arc?: number;
  60458. updatable?: boolean;
  60459. sideOrientation?: number;
  60460. frontUVs?: Vector4;
  60461. backUVs?: Vector4;
  60462. }, scene?: Nullable<Scene>): Mesh;
  60463. /**
  60464. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  60465. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  60466. * * 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`)
  60467. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  60468. * * 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
  60469. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60470. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60471. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60472. * @param name defines the name of the mesh
  60473. * @param options defines the options used to create the mesh
  60474. * @param scene defines the hosting scene
  60475. * @returns the icosahedron mesh
  60476. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  60477. */
  60478. static CreateIcoSphere(name: string, options: {
  60479. radius?: number;
  60480. radiusX?: number;
  60481. radiusY?: number;
  60482. radiusZ?: number;
  60483. flat?: boolean;
  60484. subdivisions?: number;
  60485. sideOrientation?: number;
  60486. frontUVs?: Vector4;
  60487. backUVs?: Vector4;
  60488. updatable?: boolean;
  60489. }, scene?: Nullable<Scene>): Mesh;
  60490. /**
  60491. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60492. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  60493. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  60494. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  60495. * * 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
  60496. * * 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
  60497. * * 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
  60498. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60499. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60500. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60501. * * 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
  60502. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  60503. * * 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
  60504. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  60505. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60506. * @param name defines the name of the mesh
  60507. * @param options defines the options used to create the mesh
  60508. * @param scene defines the hosting scene
  60509. * @returns the ribbon mesh
  60510. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  60511. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60512. */
  60513. static CreateRibbon(name: string, options: {
  60514. pathArray: Vector3[][];
  60515. closeArray?: boolean;
  60516. closePath?: boolean;
  60517. offset?: number;
  60518. updatable?: boolean;
  60519. sideOrientation?: number;
  60520. frontUVs?: Vector4;
  60521. backUVs?: Vector4;
  60522. instance?: Mesh;
  60523. invertUV?: boolean;
  60524. uvs?: Vector2[];
  60525. colors?: Color4[];
  60526. }, scene?: Nullable<Scene>): Mesh;
  60527. /**
  60528. * Creates a cylinder or a cone mesh
  60529. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  60530. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  60531. * * 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.
  60532. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  60533. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  60534. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  60535. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  60536. * * 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).
  60537. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  60538. * * 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).
  60539. * * 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
  60540. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  60541. * * 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
  60542. * * 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.
  60543. * * If `enclose` is false, a ring surface is one element.
  60544. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  60545. * * 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
  60546. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60547. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60548. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60549. * @param name defines the name of the mesh
  60550. * @param options defines the options used to create the mesh
  60551. * @param scene defines the hosting scene
  60552. * @returns the cylinder mesh
  60553. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  60554. */
  60555. static CreateCylinder(name: string, options: {
  60556. height?: number;
  60557. diameterTop?: number;
  60558. diameterBottom?: number;
  60559. diameter?: number;
  60560. tessellation?: number;
  60561. subdivisions?: number;
  60562. arc?: number;
  60563. faceColors?: Color4[];
  60564. faceUV?: Vector4[];
  60565. updatable?: boolean;
  60566. hasRings?: boolean;
  60567. enclose?: boolean;
  60568. cap?: number;
  60569. sideOrientation?: number;
  60570. frontUVs?: Vector4;
  60571. backUVs?: Vector4;
  60572. }, scene?: Nullable<Scene>): Mesh;
  60573. /**
  60574. * Creates a torus mesh
  60575. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  60576. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  60577. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  60578. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60579. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60580. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60581. * @param name defines the name of the mesh
  60582. * @param options defines the options used to create the mesh
  60583. * @param scene defines the hosting scene
  60584. * @returns the torus mesh
  60585. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  60586. */
  60587. static CreateTorus(name: string, options: {
  60588. diameter?: number;
  60589. thickness?: number;
  60590. tessellation?: number;
  60591. updatable?: boolean;
  60592. sideOrientation?: number;
  60593. frontUVs?: Vector4;
  60594. backUVs?: Vector4;
  60595. }, scene?: Nullable<Scene>): Mesh;
  60596. /**
  60597. * Creates a torus knot mesh
  60598. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  60599. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  60600. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  60601. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  60602. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60603. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60604. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60605. * @param name defines the name of the mesh
  60606. * @param options defines the options used to create the mesh
  60607. * @param scene defines the hosting scene
  60608. * @returns the torus knot mesh
  60609. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  60610. */
  60611. static CreateTorusKnot(name: string, options: {
  60612. radius?: number;
  60613. tube?: number;
  60614. radialSegments?: number;
  60615. tubularSegments?: number;
  60616. p?: number;
  60617. q?: number;
  60618. updatable?: boolean;
  60619. sideOrientation?: number;
  60620. frontUVs?: Vector4;
  60621. backUVs?: Vector4;
  60622. }, scene?: Nullable<Scene>): Mesh;
  60623. /**
  60624. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  60625. * * 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
  60626. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  60627. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  60628. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  60629. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  60630. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  60631. * * 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
  60632. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  60633. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60634. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  60635. * @param name defines the name of the new line system
  60636. * @param options defines the options used to create the line system
  60637. * @param scene defines the hosting scene
  60638. * @returns a new line system mesh
  60639. */
  60640. static CreateLineSystem(name: string, options: {
  60641. lines: Vector3[][];
  60642. updatable?: boolean;
  60643. instance?: Nullable<LinesMesh>;
  60644. colors?: Nullable<Color4[][]>;
  60645. useVertexAlpha?: boolean;
  60646. }, scene: Nullable<Scene>): LinesMesh;
  60647. /**
  60648. * Creates a line mesh
  60649. * 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
  60650. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60651. * * The parameter `points` is an array successive Vector3
  60652. * * 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
  60653. * * The optional parameter `colors` is an array of successive Color4, one per line point
  60654. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  60655. * * When updating an instance, remember that only point positions can change, not the number of points
  60656. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60657. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  60658. * @param name defines the name of the new line system
  60659. * @param options defines the options used to create the line system
  60660. * @param scene defines the hosting scene
  60661. * @returns a new line mesh
  60662. */
  60663. static CreateLines(name: string, options: {
  60664. points: Vector3[];
  60665. updatable?: boolean;
  60666. instance?: Nullable<LinesMesh>;
  60667. colors?: Color4[];
  60668. useVertexAlpha?: boolean;
  60669. }, scene?: Nullable<Scene>): LinesMesh;
  60670. /**
  60671. * Creates a dashed line mesh
  60672. * * 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
  60673. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60674. * * The parameter `points` is an array successive Vector3
  60675. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  60676. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  60677. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  60678. * * 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
  60679. * * When updating an instance, remember that only point positions can change, not the number of points
  60680. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60681. * @param name defines the name of the mesh
  60682. * @param options defines the options used to create the mesh
  60683. * @param scene defines the hosting scene
  60684. * @returns the dashed line mesh
  60685. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  60686. */
  60687. static CreateDashedLines(name: string, options: {
  60688. points: Vector3[];
  60689. dashSize?: number;
  60690. gapSize?: number;
  60691. dashNb?: number;
  60692. updatable?: boolean;
  60693. instance?: LinesMesh;
  60694. }, scene?: Nullable<Scene>): LinesMesh;
  60695. /**
  60696. * 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.
  60697. * * 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.
  60698. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60699. * * 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.
  60700. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  60701. * * 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
  60702. * * 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
  60703. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  60704. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60705. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60706. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  60707. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60708. * @param name defines the name of the mesh
  60709. * @param options defines the options used to create the mesh
  60710. * @param scene defines the hosting scene
  60711. * @returns the extruded shape mesh
  60712. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60713. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60714. */
  60715. static ExtrudeShape(name: string, options: {
  60716. shape: Vector3[];
  60717. path: Vector3[];
  60718. scale?: number;
  60719. rotation?: number;
  60720. cap?: number;
  60721. updatable?: boolean;
  60722. sideOrientation?: number;
  60723. frontUVs?: Vector4;
  60724. backUVs?: Vector4;
  60725. instance?: Mesh;
  60726. invertUV?: boolean;
  60727. }, scene?: Nullable<Scene>): Mesh;
  60728. /**
  60729. * Creates an custom extruded shape mesh.
  60730. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  60731. * * 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.
  60732. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60733. * * 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
  60734. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  60735. * * 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
  60736. * * It must returns a float value that will be the scale value applied to the shape on each path point
  60737. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  60738. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  60739. * * 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
  60740. * * 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
  60741. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  60742. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60743. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60744. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60745. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60746. * @param name defines the name of the mesh
  60747. * @param options defines the options used to create the mesh
  60748. * @param scene defines the hosting scene
  60749. * @returns the custom extruded shape mesh
  60750. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  60751. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60752. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60753. */
  60754. static ExtrudeShapeCustom(name: string, options: {
  60755. shape: Vector3[];
  60756. path: Vector3[];
  60757. scaleFunction?: any;
  60758. rotationFunction?: any;
  60759. ribbonCloseArray?: boolean;
  60760. ribbonClosePath?: boolean;
  60761. cap?: number;
  60762. updatable?: boolean;
  60763. sideOrientation?: number;
  60764. frontUVs?: Vector4;
  60765. backUVs?: Vector4;
  60766. instance?: Mesh;
  60767. invertUV?: boolean;
  60768. }, scene?: Nullable<Scene>): Mesh;
  60769. /**
  60770. * Creates lathe mesh.
  60771. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60772. * * 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
  60773. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60774. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60775. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60776. * * 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
  60777. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60778. * * 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
  60779. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60780. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60781. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60782. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60783. * @param name defines the name of the mesh
  60784. * @param options defines the options used to create the mesh
  60785. * @param scene defines the hosting scene
  60786. * @returns the lathe mesh
  60787. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60788. */
  60789. static CreateLathe(name: string, options: {
  60790. shape: Vector3[];
  60791. radius?: number;
  60792. tessellation?: number;
  60793. clip?: number;
  60794. arc?: number;
  60795. closed?: boolean;
  60796. updatable?: boolean;
  60797. sideOrientation?: number;
  60798. frontUVs?: Vector4;
  60799. backUVs?: Vector4;
  60800. cap?: number;
  60801. invertUV?: boolean;
  60802. }, scene?: Nullable<Scene>): Mesh;
  60803. /**
  60804. * Creates a tiled plane mesh
  60805. * * You can set a limited pattern arrangement with the tiles
  60806. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60807. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60808. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60809. * @param name defines the name of the mesh
  60810. * @param options defines the options used to create the mesh
  60811. * @param scene defines the hosting scene
  60812. * @returns the plane mesh
  60813. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60814. */
  60815. static CreateTiledPlane(name: string, options: {
  60816. pattern?: number;
  60817. tileSize?: number;
  60818. tileWidth?: number;
  60819. tileHeight?: number;
  60820. size?: number;
  60821. width?: number;
  60822. height?: number;
  60823. alignHorizontal?: number;
  60824. alignVertical?: number;
  60825. sideOrientation?: number;
  60826. frontUVs?: Vector4;
  60827. backUVs?: Vector4;
  60828. updatable?: boolean;
  60829. }, scene?: Nullable<Scene>): Mesh;
  60830. /**
  60831. * Creates a plane mesh
  60832. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  60833. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  60834. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  60835. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60836. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60837. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60838. * @param name defines the name of the mesh
  60839. * @param options defines the options used to create the mesh
  60840. * @param scene defines the hosting scene
  60841. * @returns the plane mesh
  60842. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60843. */
  60844. static CreatePlane(name: string, options: {
  60845. size?: number;
  60846. width?: number;
  60847. height?: number;
  60848. sideOrientation?: number;
  60849. frontUVs?: Vector4;
  60850. backUVs?: Vector4;
  60851. updatable?: boolean;
  60852. sourcePlane?: Plane;
  60853. }, scene?: Nullable<Scene>): Mesh;
  60854. /**
  60855. * Creates a ground mesh
  60856. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  60857. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  60858. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60859. * @param name defines the name of the mesh
  60860. * @param options defines the options used to create the mesh
  60861. * @param scene defines the hosting scene
  60862. * @returns the ground mesh
  60863. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  60864. */
  60865. static CreateGround(name: string, options: {
  60866. width?: number;
  60867. height?: number;
  60868. subdivisions?: number;
  60869. subdivisionsX?: number;
  60870. subdivisionsY?: number;
  60871. updatable?: boolean;
  60872. }, scene?: Nullable<Scene>): Mesh;
  60873. /**
  60874. * Creates a tiled ground mesh
  60875. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  60876. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  60877. * * 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
  60878. * * 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
  60879. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60880. * @param name defines the name of the mesh
  60881. * @param options defines the options used to create the mesh
  60882. * @param scene defines the hosting scene
  60883. * @returns the tiled ground mesh
  60884. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  60885. */
  60886. static CreateTiledGround(name: string, options: {
  60887. xmin: number;
  60888. zmin: number;
  60889. xmax: number;
  60890. zmax: number;
  60891. subdivisions?: {
  60892. w: number;
  60893. h: number;
  60894. };
  60895. precision?: {
  60896. w: number;
  60897. h: number;
  60898. };
  60899. updatable?: boolean;
  60900. }, scene?: Nullable<Scene>): Mesh;
  60901. /**
  60902. * Creates a ground mesh from a height map
  60903. * * The parameter `url` sets the URL of the height map image resource.
  60904. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  60905. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  60906. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  60907. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  60908. * * 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.
  60909. * * 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).
  60910. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  60911. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60912. * @param name defines the name of the mesh
  60913. * @param url defines the url to the height map
  60914. * @param options defines the options used to create the mesh
  60915. * @param scene defines the hosting scene
  60916. * @returns the ground mesh
  60917. * @see https://doc.babylonjs.com/babylon101/height_map
  60918. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  60919. */
  60920. static CreateGroundFromHeightMap(name: string, url: string, options: {
  60921. width?: number;
  60922. height?: number;
  60923. subdivisions?: number;
  60924. minHeight?: number;
  60925. maxHeight?: number;
  60926. colorFilter?: Color3;
  60927. alphaFilter?: number;
  60928. updatable?: boolean;
  60929. onReady?: (mesh: GroundMesh) => void;
  60930. }, scene?: Nullable<Scene>): GroundMesh;
  60931. /**
  60932. * Creates a polygon mesh
  60933. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60934. * * 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
  60935. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60936. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60937. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60938. * * Remember you can only change the shape positions, not their number when updating a polygon
  60939. * @param name defines the name of the mesh
  60940. * @param options defines the options used to create the mesh
  60941. * @param scene defines the hosting scene
  60942. * @param earcutInjection can be used to inject your own earcut reference
  60943. * @returns the polygon mesh
  60944. */
  60945. static CreatePolygon(name: string, options: {
  60946. shape: Vector3[];
  60947. holes?: Vector3[][];
  60948. depth?: number;
  60949. faceUV?: Vector4[];
  60950. faceColors?: Color4[];
  60951. updatable?: boolean;
  60952. sideOrientation?: number;
  60953. frontUVs?: Vector4;
  60954. backUVs?: Vector4;
  60955. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60956. /**
  60957. * Creates an extruded polygon mesh, with depth in the Y direction.
  60958. * * 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)
  60959. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60960. * @param name defines the name of the mesh
  60961. * @param options defines the options used to create the mesh
  60962. * @param scene defines the hosting scene
  60963. * @param earcutInjection can be used to inject your own earcut reference
  60964. * @returns the polygon mesh
  60965. */
  60966. static ExtrudePolygon(name: string, options: {
  60967. shape: Vector3[];
  60968. holes?: Vector3[][];
  60969. depth?: number;
  60970. faceUV?: Vector4[];
  60971. faceColors?: Color4[];
  60972. updatable?: boolean;
  60973. sideOrientation?: number;
  60974. frontUVs?: Vector4;
  60975. backUVs?: Vector4;
  60976. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60977. /**
  60978. * Creates a tube mesh.
  60979. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60980. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60981. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60982. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60983. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60984. * * 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)
  60985. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60986. * * 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
  60987. * * 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
  60988. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60989. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60990. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60992. * @param name defines the name of the mesh
  60993. * @param options defines the options used to create the mesh
  60994. * @param scene defines the hosting scene
  60995. * @returns the tube mesh
  60996. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60997. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60998. */
  60999. static CreateTube(name: string, options: {
  61000. path: Vector3[];
  61001. radius?: number;
  61002. tessellation?: number;
  61003. radiusFunction?: {
  61004. (i: number, distance: number): number;
  61005. };
  61006. cap?: number;
  61007. arc?: number;
  61008. updatable?: boolean;
  61009. sideOrientation?: number;
  61010. frontUVs?: Vector4;
  61011. backUVs?: Vector4;
  61012. instance?: Mesh;
  61013. invertUV?: boolean;
  61014. }, scene?: Nullable<Scene>): Mesh;
  61015. /**
  61016. * Creates a polyhedron mesh
  61017. * * 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
  61018. * * The parameter `size` (positive float, default 1) sets the polygon size
  61019. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  61020. * * 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`
  61021. * * 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
  61022. * * 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)`)
  61023. * * 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
  61024. * * 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
  61025. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  61026. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  61027. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  61028. * @param name defines the name of the mesh
  61029. * @param options defines the options used to create the mesh
  61030. * @param scene defines the hosting scene
  61031. * @returns the polyhedron mesh
  61032. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  61033. */
  61034. static CreatePolyhedron(name: string, options: {
  61035. type?: number;
  61036. size?: number;
  61037. sizeX?: number;
  61038. sizeY?: number;
  61039. sizeZ?: number;
  61040. custom?: any;
  61041. faceUV?: Vector4[];
  61042. faceColors?: Color4[];
  61043. flat?: boolean;
  61044. updatable?: boolean;
  61045. sideOrientation?: number;
  61046. frontUVs?: Vector4;
  61047. backUVs?: Vector4;
  61048. }, scene?: Nullable<Scene>): Mesh;
  61049. /**
  61050. * Creates a decal mesh.
  61051. * 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
  61052. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  61053. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  61054. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  61055. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  61056. * @param name defines the name of the mesh
  61057. * @param sourceMesh defines the mesh where the decal must be applied
  61058. * @param options defines the options used to create the mesh
  61059. * @param scene defines the hosting scene
  61060. * @returns the decal mesh
  61061. * @see https://doc.babylonjs.com/how_to/decals
  61062. */
  61063. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  61064. position?: Vector3;
  61065. normal?: Vector3;
  61066. size?: Vector3;
  61067. angle?: number;
  61068. }): Mesh;
  61069. }
  61070. }
  61071. declare module "babylonjs/Meshes/meshSimplification" {
  61072. import { Mesh } from "babylonjs/Meshes/mesh";
  61073. /**
  61074. * A simplifier interface for future simplification implementations
  61075. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61076. */
  61077. export interface ISimplifier {
  61078. /**
  61079. * Simplification of a given mesh according to the given settings.
  61080. * Since this requires computation, it is assumed that the function runs async.
  61081. * @param settings The settings of the simplification, including quality and distance
  61082. * @param successCallback A callback that will be called after the mesh was simplified.
  61083. * @param errorCallback in case of an error, this callback will be called. optional.
  61084. */
  61085. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  61086. }
  61087. /**
  61088. * Expected simplification settings.
  61089. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  61090. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61091. */
  61092. export interface ISimplificationSettings {
  61093. /**
  61094. * Gets or sets the expected quality
  61095. */
  61096. quality: number;
  61097. /**
  61098. * Gets or sets the distance when this optimized version should be used
  61099. */
  61100. distance: number;
  61101. /**
  61102. * Gets an already optimized mesh
  61103. */
  61104. optimizeMesh?: boolean;
  61105. }
  61106. /**
  61107. * Class used to specify simplification options
  61108. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61109. */
  61110. export class SimplificationSettings implements ISimplificationSettings {
  61111. /** expected quality */
  61112. quality: number;
  61113. /** distance when this optimized version should be used */
  61114. distance: number;
  61115. /** already optimized mesh */
  61116. optimizeMesh?: boolean | undefined;
  61117. /**
  61118. * Creates a SimplificationSettings
  61119. * @param quality expected quality
  61120. * @param distance distance when this optimized version should be used
  61121. * @param optimizeMesh already optimized mesh
  61122. */
  61123. constructor(
  61124. /** expected quality */
  61125. quality: number,
  61126. /** distance when this optimized version should be used */
  61127. distance: number,
  61128. /** already optimized mesh */
  61129. optimizeMesh?: boolean | undefined);
  61130. }
  61131. /**
  61132. * Interface used to define a simplification task
  61133. */
  61134. export interface ISimplificationTask {
  61135. /**
  61136. * Array of settings
  61137. */
  61138. settings: Array<ISimplificationSettings>;
  61139. /**
  61140. * Simplification type
  61141. */
  61142. simplificationType: SimplificationType;
  61143. /**
  61144. * Mesh to simplify
  61145. */
  61146. mesh: Mesh;
  61147. /**
  61148. * Callback called on success
  61149. */
  61150. successCallback?: () => void;
  61151. /**
  61152. * Defines if parallel processing can be used
  61153. */
  61154. parallelProcessing: boolean;
  61155. }
  61156. /**
  61157. * Queue used to order the simplification tasks
  61158. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61159. */
  61160. export class SimplificationQueue {
  61161. private _simplificationArray;
  61162. /**
  61163. * Gets a boolean indicating that the process is still running
  61164. */
  61165. running: boolean;
  61166. /**
  61167. * Creates a new queue
  61168. */
  61169. constructor();
  61170. /**
  61171. * Adds a new simplification task
  61172. * @param task defines a task to add
  61173. */
  61174. addTask(task: ISimplificationTask): void;
  61175. /**
  61176. * Execute next task
  61177. */
  61178. executeNext(): void;
  61179. /**
  61180. * Execute a simplification task
  61181. * @param task defines the task to run
  61182. */
  61183. runSimplification(task: ISimplificationTask): void;
  61184. private getSimplifier;
  61185. }
  61186. /**
  61187. * The implemented types of simplification
  61188. * At the moment only Quadratic Error Decimation is implemented
  61189. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61190. */
  61191. export enum SimplificationType {
  61192. /** Quadratic error decimation */
  61193. QUADRATIC = 0
  61194. }
  61195. }
  61196. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  61197. import { Scene } from "babylonjs/scene";
  61198. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  61199. import { ISceneComponent } from "babylonjs/sceneComponent";
  61200. module "babylonjs/scene" {
  61201. interface Scene {
  61202. /** @hidden (Backing field) */
  61203. _simplificationQueue: SimplificationQueue;
  61204. /**
  61205. * Gets or sets the simplification queue attached to the scene
  61206. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61207. */
  61208. simplificationQueue: SimplificationQueue;
  61209. }
  61210. }
  61211. module "babylonjs/Meshes/mesh" {
  61212. interface Mesh {
  61213. /**
  61214. * Simplify the mesh according to the given array of settings.
  61215. * Function will return immediately and will simplify async
  61216. * @param settings a collection of simplification settings
  61217. * @param parallelProcessing should all levels calculate parallel or one after the other
  61218. * @param simplificationType the type of simplification to run
  61219. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  61220. * @returns the current mesh
  61221. */
  61222. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  61223. }
  61224. }
  61225. /**
  61226. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  61227. * created in a scene
  61228. */
  61229. export class SimplicationQueueSceneComponent implements ISceneComponent {
  61230. /**
  61231. * The component name helpfull to identify the component in the list of scene components.
  61232. */
  61233. readonly name: string;
  61234. /**
  61235. * The scene the component belongs to.
  61236. */
  61237. scene: Scene;
  61238. /**
  61239. * Creates a new instance of the component for the given scene
  61240. * @param scene Defines the scene to register the component in
  61241. */
  61242. constructor(scene: Scene);
  61243. /**
  61244. * Registers the component in a given scene
  61245. */
  61246. register(): void;
  61247. /**
  61248. * Rebuilds the elements related to this component in case of
  61249. * context lost for instance.
  61250. */
  61251. rebuild(): void;
  61252. /**
  61253. * Disposes the component and the associated ressources
  61254. */
  61255. dispose(): void;
  61256. private _beforeCameraUpdate;
  61257. }
  61258. }
  61259. declare module "babylonjs/Meshes/Builders/index" {
  61260. export * from "babylonjs/Meshes/Builders/boxBuilder";
  61261. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  61262. export * from "babylonjs/Meshes/Builders/discBuilder";
  61263. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  61264. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  61265. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  61266. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  61267. export * from "babylonjs/Meshes/Builders/torusBuilder";
  61268. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  61269. export * from "babylonjs/Meshes/Builders/linesBuilder";
  61270. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  61271. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  61272. export * from "babylonjs/Meshes/Builders/latheBuilder";
  61273. export * from "babylonjs/Meshes/Builders/planeBuilder";
  61274. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  61275. export * from "babylonjs/Meshes/Builders/groundBuilder";
  61276. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  61277. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  61278. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  61279. export * from "babylonjs/Meshes/Builders/decalBuilder";
  61280. }
  61281. declare module "babylonjs/Meshes/index" {
  61282. export * from "babylonjs/Meshes/abstractMesh";
  61283. export * from "babylonjs/Meshes/buffer";
  61284. export * from "babylonjs/Meshes/Compression/index";
  61285. export * from "babylonjs/Meshes/csg";
  61286. export * from "babylonjs/Meshes/geometry";
  61287. export * from "babylonjs/Meshes/groundMesh";
  61288. export * from "babylonjs/Meshes/trailMesh";
  61289. export * from "babylonjs/Meshes/instancedMesh";
  61290. export * from "babylonjs/Meshes/linesMesh";
  61291. export * from "babylonjs/Meshes/mesh";
  61292. export * from "babylonjs/Meshes/mesh.vertexData";
  61293. export * from "babylonjs/Meshes/meshBuilder";
  61294. export * from "babylonjs/Meshes/meshSimplification";
  61295. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  61296. export * from "babylonjs/Meshes/polygonMesh";
  61297. export * from "babylonjs/Meshes/subMesh";
  61298. export * from "babylonjs/Meshes/meshLODLevel";
  61299. export * from "babylonjs/Meshes/transformNode";
  61300. export * from "babylonjs/Meshes/Builders/index";
  61301. export * from "babylonjs/Meshes/dataBuffer";
  61302. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  61303. }
  61304. declare module "babylonjs/Morph/index" {
  61305. export * from "babylonjs/Morph/morphTarget";
  61306. export * from "babylonjs/Morph/morphTargetManager";
  61307. }
  61308. declare module "babylonjs/Navigation/INavigationEngine" {
  61309. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61310. import { Vector3 } from "babylonjs/Maths/math";
  61311. import { Mesh } from "babylonjs/Meshes/mesh";
  61312. import { Scene } from "babylonjs/scene";
  61313. /**
  61314. * Navigation plugin interface to add navigation constrained by a navigation mesh
  61315. */
  61316. export interface INavigationEnginePlugin {
  61317. /**
  61318. * plugin name
  61319. */
  61320. name: string;
  61321. /**
  61322. * Creates a navigation mesh
  61323. * @param meshes array of all the geometry used to compute the navigatio mesh
  61324. * @param parameters bunch of parameters used to filter geometry
  61325. */
  61326. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  61327. /**
  61328. * Create a navigation mesh debug mesh
  61329. * @param scene is where the mesh will be added
  61330. * @returns debug display mesh
  61331. */
  61332. createDebugNavMesh(scene: Scene): Mesh;
  61333. /**
  61334. * Get a navigation mesh constrained position, closest to the parameter position
  61335. * @param position world position
  61336. * @returns the closest point to position constrained by the navigation mesh
  61337. */
  61338. getClosestPoint(position: Vector3): Vector3;
  61339. /**
  61340. * Get a navigation mesh constrained position, within a particular radius
  61341. * @param position world position
  61342. * @param maxRadius the maximum distance to the constrained world position
  61343. * @returns the closest point to position constrained by the navigation mesh
  61344. */
  61345. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  61346. /**
  61347. * Compute the final position from a segment made of destination-position
  61348. * @param position world position
  61349. * @param destination world position
  61350. * @returns the resulting point along the navmesh
  61351. */
  61352. moveAlong(position: Vector3, destination: Vector3): Vector3;
  61353. /**
  61354. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  61355. * @param start world position
  61356. * @param end world position
  61357. * @returns array containing world position composing the path
  61358. */
  61359. computePath(start: Vector3, end: Vector3): Vector3[];
  61360. /**
  61361. * If this plugin is supported
  61362. * @returns true if plugin is supported
  61363. */
  61364. isSupported(): boolean;
  61365. /**
  61366. * Create a new Crowd so you can add agents
  61367. * @param maxAgents the maximum agent count in the crowd
  61368. * @param maxAgentRadius the maximum radius an agent can have
  61369. * @param scene to attach the crowd to
  61370. * @returns the crowd you can add agents to
  61371. */
  61372. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61373. /**
  61374. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61375. * The queries will try to find a solution within those bounds
  61376. * default is (1,1,1)
  61377. * @param extent x,y,z value that define the extent around the queries point of reference
  61378. */
  61379. setDefaultQueryExtent(extent: Vector3): void;
  61380. /**
  61381. * Get the Bounding box extent specified by setDefaultQueryExtent
  61382. * @returns the box extent values
  61383. */
  61384. getDefaultQueryExtent(): Vector3;
  61385. /**
  61386. * Release all resources
  61387. */
  61388. dispose(): void;
  61389. }
  61390. /**
  61391. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  61392. */
  61393. export interface ICrowd {
  61394. /**
  61395. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61396. * You can attach anything to that node. The node position is updated in the scene update tick.
  61397. * @param pos world position that will be constrained by the navigation mesh
  61398. * @param parameters agent parameters
  61399. * @param transform hooked to the agent that will be update by the scene
  61400. * @returns agent index
  61401. */
  61402. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61403. /**
  61404. * Returns the agent position in world space
  61405. * @param index agent index returned by addAgent
  61406. * @returns world space position
  61407. */
  61408. getAgentPosition(index: number): Vector3;
  61409. /**
  61410. * Gets the agent velocity in world space
  61411. * @param index agent index returned by addAgent
  61412. * @returns world space velocity
  61413. */
  61414. getAgentVelocity(index: number): Vector3;
  61415. /**
  61416. * remove a particular agent previously created
  61417. * @param index agent index returned by addAgent
  61418. */
  61419. removeAgent(index: number): void;
  61420. /**
  61421. * get the list of all agents attached to this crowd
  61422. * @returns list of agent indices
  61423. */
  61424. getAgents(): number[];
  61425. /**
  61426. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61427. * @param deltaTime in seconds
  61428. */
  61429. update(deltaTime: number): void;
  61430. /**
  61431. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61432. * @param index agent index returned by addAgent
  61433. * @param destination targeted world position
  61434. */
  61435. agentGoto(index: number, destination: Vector3): void;
  61436. /**
  61437. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61438. * The queries will try to find a solution within those bounds
  61439. * default is (1,1,1)
  61440. * @param extent x,y,z value that define the extent around the queries point of reference
  61441. */
  61442. setDefaultQueryExtent(extent: Vector3): void;
  61443. /**
  61444. * Get the Bounding box extent specified by setDefaultQueryExtent
  61445. * @returns the box extent values
  61446. */
  61447. getDefaultQueryExtent(): Vector3;
  61448. /**
  61449. * Release all resources
  61450. */
  61451. dispose(): void;
  61452. }
  61453. /**
  61454. * Configures an agent
  61455. */
  61456. export interface IAgentParameters {
  61457. /**
  61458. * Agent radius. [Limit: >= 0]
  61459. */
  61460. radius: number;
  61461. /**
  61462. * Agent height. [Limit: > 0]
  61463. */
  61464. height: number;
  61465. /**
  61466. * Maximum allowed acceleration. [Limit: >= 0]
  61467. */
  61468. maxAcceleration: number;
  61469. /**
  61470. * Maximum allowed speed. [Limit: >= 0]
  61471. */
  61472. maxSpeed: number;
  61473. /**
  61474. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  61475. */
  61476. collisionQueryRange: number;
  61477. /**
  61478. * The path visibility optimization range. [Limit: > 0]
  61479. */
  61480. pathOptimizationRange: number;
  61481. /**
  61482. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  61483. */
  61484. separationWeight: number;
  61485. }
  61486. /**
  61487. * Configures the navigation mesh creation
  61488. */
  61489. export interface INavMeshParameters {
  61490. /**
  61491. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  61492. */
  61493. cs: number;
  61494. /**
  61495. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  61496. */
  61497. ch: number;
  61498. /**
  61499. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  61500. */
  61501. walkableSlopeAngle: number;
  61502. /**
  61503. * Minimum floor to 'ceiling' height that will still allow the floor area to
  61504. * be considered walkable. [Limit: >= 3] [Units: vx]
  61505. */
  61506. walkableHeight: number;
  61507. /**
  61508. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  61509. */
  61510. walkableClimb: number;
  61511. /**
  61512. * The distance to erode/shrink the walkable area of the heightfield away from
  61513. * obstructions. [Limit: >=0] [Units: vx]
  61514. */
  61515. walkableRadius: number;
  61516. /**
  61517. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  61518. */
  61519. maxEdgeLen: number;
  61520. /**
  61521. * The maximum distance a simplfied contour's border edges should deviate
  61522. * the original raw contour. [Limit: >=0] [Units: vx]
  61523. */
  61524. maxSimplificationError: number;
  61525. /**
  61526. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  61527. */
  61528. minRegionArea: number;
  61529. /**
  61530. * Any regions with a span count smaller than this value will, if possible,
  61531. * be merged with larger regions. [Limit: >=0] [Units: vx]
  61532. */
  61533. mergeRegionArea: number;
  61534. /**
  61535. * The maximum number of vertices allowed for polygons generated during the
  61536. * contour to polygon conversion process. [Limit: >= 3]
  61537. */
  61538. maxVertsPerPoly: number;
  61539. /**
  61540. * Sets the sampling distance to use when generating the detail mesh.
  61541. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  61542. */
  61543. detailSampleDist: number;
  61544. /**
  61545. * The maximum distance the detail mesh surface should deviate from heightfield
  61546. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  61547. */
  61548. detailSampleMaxError: number;
  61549. }
  61550. }
  61551. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  61552. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  61553. import { Mesh } from "babylonjs/Meshes/mesh";
  61554. import { Scene } from "babylonjs/scene";
  61555. import { Vector3 } from "babylonjs/Maths/math";
  61556. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61557. /**
  61558. * RecastJS navigation plugin
  61559. */
  61560. export class RecastJSPlugin implements INavigationEnginePlugin {
  61561. /**
  61562. * Reference to the Recast library
  61563. */
  61564. bjsRECAST: any;
  61565. /**
  61566. * plugin name
  61567. */
  61568. name: string;
  61569. /**
  61570. * the first navmesh created. We might extend this to support multiple navmeshes
  61571. */
  61572. navMesh: any;
  61573. /**
  61574. * Initializes the recastJS plugin
  61575. * @param recastInjection can be used to inject your own recast reference
  61576. */
  61577. constructor(recastInjection?: any);
  61578. /**
  61579. * Creates a navigation mesh
  61580. * @param meshes array of all the geometry used to compute the navigatio mesh
  61581. * @param parameters bunch of parameters used to filter geometry
  61582. */
  61583. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  61584. /**
  61585. * Create a navigation mesh debug mesh
  61586. * @param scene is where the mesh will be added
  61587. * @returns debug display mesh
  61588. */
  61589. createDebugNavMesh(scene: Scene): Mesh;
  61590. /**
  61591. * Get a navigation mesh constrained position, closest to the parameter position
  61592. * @param position world position
  61593. * @returns the closest point to position constrained by the navigation mesh
  61594. */
  61595. getClosestPoint(position: Vector3): Vector3;
  61596. /**
  61597. * Get a navigation mesh constrained position, within a particular radius
  61598. * @param position world position
  61599. * @param maxRadius the maximum distance to the constrained world position
  61600. * @returns the closest point to position constrained by the navigation mesh
  61601. */
  61602. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  61603. /**
  61604. * Compute the final position from a segment made of destination-position
  61605. * @param position world position
  61606. * @param destination world position
  61607. * @returns the resulting point along the navmesh
  61608. */
  61609. moveAlong(position: Vector3, destination: Vector3): Vector3;
  61610. /**
  61611. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  61612. * @param start world position
  61613. * @param end world position
  61614. * @returns array containing world position composing the path
  61615. */
  61616. computePath(start: Vector3, end: Vector3): Vector3[];
  61617. /**
  61618. * Create a new Crowd so you can add agents
  61619. * @param maxAgents the maximum agent count in the crowd
  61620. * @param maxAgentRadius the maximum radius an agent can have
  61621. * @param scene to attach the crowd to
  61622. * @returns the crowd you can add agents to
  61623. */
  61624. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61625. /**
  61626. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61627. * The queries will try to find a solution within those bounds
  61628. * default is (1,1,1)
  61629. * @param extent x,y,z value that define the extent around the queries point of reference
  61630. */
  61631. setDefaultQueryExtent(extent: Vector3): void;
  61632. /**
  61633. * Get the Bounding box extent specified by setDefaultQueryExtent
  61634. * @returns the box extent values
  61635. */
  61636. getDefaultQueryExtent(): Vector3;
  61637. /**
  61638. * Disposes
  61639. */
  61640. dispose(): void;
  61641. /**
  61642. * If this plugin is supported
  61643. * @returns true if plugin is supported
  61644. */
  61645. isSupported(): boolean;
  61646. }
  61647. /**
  61648. * Recast detour crowd implementation
  61649. */
  61650. export class RecastJSCrowd implements ICrowd {
  61651. /**
  61652. * Recast/detour plugin
  61653. */
  61654. bjsRECASTPlugin: RecastJSPlugin;
  61655. /**
  61656. * Link to the detour crowd
  61657. */
  61658. recastCrowd: any;
  61659. /**
  61660. * One transform per agent
  61661. */
  61662. transforms: TransformNode[];
  61663. /**
  61664. * All agents created
  61665. */
  61666. agents: number[];
  61667. /**
  61668. * Link to the scene is kept to unregister the crowd from the scene
  61669. */
  61670. private _scene;
  61671. /**
  61672. * Observer for crowd updates
  61673. */
  61674. private _onBeforeAnimationsObserver;
  61675. /**
  61676. * Constructor
  61677. * @param plugin recastJS plugin
  61678. * @param maxAgents the maximum agent count in the crowd
  61679. * @param maxAgentRadius the maximum radius an agent can have
  61680. * @param scene to attach the crowd to
  61681. * @returns the crowd you can add agents to
  61682. */
  61683. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  61684. /**
  61685. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61686. * You can attach anything to that node. The node position is updated in the scene update tick.
  61687. * @param pos world position that will be constrained by the navigation mesh
  61688. * @param parameters agent parameters
  61689. * @param transform hooked to the agent that will be update by the scene
  61690. * @returns agent index
  61691. */
  61692. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61693. /**
  61694. * Returns the agent position in world space
  61695. * @param index agent index returned by addAgent
  61696. * @returns world space position
  61697. */
  61698. getAgentPosition(index: number): Vector3;
  61699. /**
  61700. * Returns the agent velocity in world space
  61701. * @param index agent index returned by addAgent
  61702. * @returns world space velocity
  61703. */
  61704. getAgentVelocity(index: number): Vector3;
  61705. /**
  61706. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61707. * @param index agent index returned by addAgent
  61708. * @param destination targeted world position
  61709. */
  61710. agentGoto(index: number, destination: Vector3): void;
  61711. /**
  61712. * remove a particular agent previously created
  61713. * @param index agent index returned by addAgent
  61714. */
  61715. removeAgent(index: number): void;
  61716. /**
  61717. * get the list of all agents attached to this crowd
  61718. * @returns list of agent indices
  61719. */
  61720. getAgents(): number[];
  61721. /**
  61722. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61723. * @param deltaTime in seconds
  61724. */
  61725. update(deltaTime: number): void;
  61726. /**
  61727. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61728. * The queries will try to find a solution within those bounds
  61729. * default is (1,1,1)
  61730. * @param extent x,y,z value that define the extent around the queries point of reference
  61731. */
  61732. setDefaultQueryExtent(extent: Vector3): void;
  61733. /**
  61734. * Get the Bounding box extent specified by setDefaultQueryExtent
  61735. * @returns the box extent values
  61736. */
  61737. getDefaultQueryExtent(): Vector3;
  61738. /**
  61739. * Release all resources
  61740. */
  61741. dispose(): void;
  61742. }
  61743. }
  61744. declare module "babylonjs/Navigation/Plugins/index" {
  61745. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  61746. }
  61747. declare module "babylonjs/Navigation/index" {
  61748. export * from "babylonjs/Navigation/INavigationEngine";
  61749. export * from "babylonjs/Navigation/Plugins/index";
  61750. }
  61751. declare module "babylonjs/Offline/database" {
  61752. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  61753. /**
  61754. * Class used to enable access to IndexedDB
  61755. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  61756. */
  61757. export class Database implements IOfflineProvider {
  61758. private _callbackManifestChecked;
  61759. private _currentSceneUrl;
  61760. private _db;
  61761. private _enableSceneOffline;
  61762. private _enableTexturesOffline;
  61763. private _manifestVersionFound;
  61764. private _mustUpdateRessources;
  61765. private _hasReachedQuota;
  61766. private _isSupported;
  61767. private _idbFactory;
  61768. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  61769. private static IsUASupportingBlobStorage;
  61770. /**
  61771. * Gets a boolean indicating if Database storate is enabled (off by default)
  61772. */
  61773. static IDBStorageEnabled: boolean;
  61774. /**
  61775. * Gets a boolean indicating if scene must be saved in the database
  61776. */
  61777. readonly enableSceneOffline: boolean;
  61778. /**
  61779. * Gets a boolean indicating if textures must be saved in the database
  61780. */
  61781. readonly enableTexturesOffline: boolean;
  61782. /**
  61783. * Creates a new Database
  61784. * @param urlToScene defines the url to load the scene
  61785. * @param callbackManifestChecked defines the callback to use when manifest is checked
  61786. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  61787. */
  61788. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  61789. private static _ParseURL;
  61790. private static _ReturnFullUrlLocation;
  61791. private _checkManifestFile;
  61792. /**
  61793. * Open the database and make it available
  61794. * @param successCallback defines the callback to call on success
  61795. * @param errorCallback defines the callback to call on error
  61796. */
  61797. open(successCallback: () => void, errorCallback: () => void): void;
  61798. /**
  61799. * Loads an image from the database
  61800. * @param url defines the url to load from
  61801. * @param image defines the target DOM image
  61802. */
  61803. loadImage(url: string, image: HTMLImageElement): void;
  61804. private _loadImageFromDBAsync;
  61805. private _saveImageIntoDBAsync;
  61806. private _checkVersionFromDB;
  61807. private _loadVersionFromDBAsync;
  61808. private _saveVersionIntoDBAsync;
  61809. /**
  61810. * Loads a file from database
  61811. * @param url defines the URL to load from
  61812. * @param sceneLoaded defines a callback to call on success
  61813. * @param progressCallBack defines a callback to call when progress changed
  61814. * @param errorCallback defines a callback to call on error
  61815. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  61816. */
  61817. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  61818. private _loadFileAsync;
  61819. private _saveFileAsync;
  61820. /**
  61821. * Validates if xhr data is correct
  61822. * @param xhr defines the request to validate
  61823. * @param dataType defines the expected data type
  61824. * @returns true if data is correct
  61825. */
  61826. private static _ValidateXHRData;
  61827. }
  61828. }
  61829. declare module "babylonjs/Offline/index" {
  61830. export * from "babylonjs/Offline/database";
  61831. export * from "babylonjs/Offline/IOfflineProvider";
  61832. }
  61833. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  61834. /** @hidden */
  61835. export var gpuUpdateParticlesPixelShader: {
  61836. name: string;
  61837. shader: string;
  61838. };
  61839. }
  61840. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  61841. /** @hidden */
  61842. export var gpuUpdateParticlesVertexShader: {
  61843. name: string;
  61844. shader: string;
  61845. };
  61846. }
  61847. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  61848. /** @hidden */
  61849. export var clipPlaneFragmentDeclaration2: {
  61850. name: string;
  61851. shader: string;
  61852. };
  61853. }
  61854. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  61855. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  61856. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  61857. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61858. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  61859. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  61860. /** @hidden */
  61861. export var gpuRenderParticlesPixelShader: {
  61862. name: string;
  61863. shader: string;
  61864. };
  61865. }
  61866. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  61867. /** @hidden */
  61868. export var clipPlaneVertexDeclaration2: {
  61869. name: string;
  61870. shader: string;
  61871. };
  61872. }
  61873. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  61874. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  61875. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  61876. /** @hidden */
  61877. export var gpuRenderParticlesVertexShader: {
  61878. name: string;
  61879. shader: string;
  61880. };
  61881. }
  61882. declare module "babylonjs/Particles/gpuParticleSystem" {
  61883. import { Nullable } from "babylonjs/types";
  61884. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  61885. import { Observable } from "babylonjs/Misc/observable";
  61886. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61887. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61888. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  61889. import { Scene, IDisposable } from "babylonjs/scene";
  61890. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  61891. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  61892. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  61893. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  61894. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  61895. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  61896. /**
  61897. * This represents a GPU particle system in Babylon
  61898. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  61899. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  61900. */
  61901. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  61902. /**
  61903. * The layer mask we are rendering the particles through.
  61904. */
  61905. layerMask: number;
  61906. private _capacity;
  61907. private _activeCount;
  61908. private _currentActiveCount;
  61909. private _accumulatedCount;
  61910. private _renderEffect;
  61911. private _updateEffect;
  61912. private _buffer0;
  61913. private _buffer1;
  61914. private _spriteBuffer;
  61915. private _updateVAO;
  61916. private _renderVAO;
  61917. private _targetIndex;
  61918. private _sourceBuffer;
  61919. private _targetBuffer;
  61920. private _engine;
  61921. private _currentRenderId;
  61922. private _started;
  61923. private _stopped;
  61924. private _timeDelta;
  61925. private _randomTexture;
  61926. private _randomTexture2;
  61927. private _attributesStrideSize;
  61928. private _updateEffectOptions;
  61929. private _randomTextureSize;
  61930. private _actualFrame;
  61931. private readonly _rawTextureWidth;
  61932. /**
  61933. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  61934. */
  61935. static readonly IsSupported: boolean;
  61936. /**
  61937. * An event triggered when the system is disposed.
  61938. */
  61939. onDisposeObservable: Observable<GPUParticleSystem>;
  61940. /**
  61941. * Gets the maximum number of particles active at the same time.
  61942. * @returns The max number of active particles.
  61943. */
  61944. getCapacity(): number;
  61945. /**
  61946. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  61947. * to override the particles.
  61948. */
  61949. forceDepthWrite: boolean;
  61950. /**
  61951. * Gets or set the number of active particles
  61952. */
  61953. activeParticleCount: number;
  61954. private _preWarmDone;
  61955. /**
  61956. * Is this system ready to be used/rendered
  61957. * @return true if the system is ready
  61958. */
  61959. isReady(): boolean;
  61960. /**
  61961. * Gets if the system has been started. (Note: this will still be true after stop is called)
  61962. * @returns True if it has been started, otherwise false.
  61963. */
  61964. isStarted(): boolean;
  61965. /**
  61966. * Starts the particle system and begins to emit
  61967. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  61968. */
  61969. start(delay?: number): void;
  61970. /**
  61971. * Stops the particle system.
  61972. */
  61973. stop(): void;
  61974. /**
  61975. * Remove all active particles
  61976. */
  61977. reset(): void;
  61978. /**
  61979. * Returns the string "GPUParticleSystem"
  61980. * @returns a string containing the class name
  61981. */
  61982. getClassName(): string;
  61983. private _colorGradientsTexture;
  61984. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  61985. /**
  61986. * Adds a new color gradient
  61987. * @param gradient defines the gradient to use (between 0 and 1)
  61988. * @param color1 defines the color to affect to the specified gradient
  61989. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  61990. * @returns the current particle system
  61991. */
  61992. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  61993. /**
  61994. * Remove a specific color gradient
  61995. * @param gradient defines the gradient to remove
  61996. * @returns the current particle system
  61997. */
  61998. removeColorGradient(gradient: number): GPUParticleSystem;
  61999. private _angularSpeedGradientsTexture;
  62000. private _sizeGradientsTexture;
  62001. private _velocityGradientsTexture;
  62002. private _limitVelocityGradientsTexture;
  62003. private _dragGradientsTexture;
  62004. private _addFactorGradient;
  62005. /**
  62006. * Adds a new size gradient
  62007. * @param gradient defines the gradient to use (between 0 and 1)
  62008. * @param factor defines the size factor to affect to the specified gradient
  62009. * @returns the current particle system
  62010. */
  62011. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  62012. /**
  62013. * Remove a specific size gradient
  62014. * @param gradient defines the gradient to remove
  62015. * @returns the current particle system
  62016. */
  62017. removeSizeGradient(gradient: number): GPUParticleSystem;
  62018. /**
  62019. * Adds a new angular speed gradient
  62020. * @param gradient defines the gradient to use (between 0 and 1)
  62021. * @param factor defines the angular speed to affect to the specified gradient
  62022. * @returns the current particle system
  62023. */
  62024. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  62025. /**
  62026. * Remove a specific angular speed gradient
  62027. * @param gradient defines the gradient to remove
  62028. * @returns the current particle system
  62029. */
  62030. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  62031. /**
  62032. * Adds a new velocity gradient
  62033. * @param gradient defines the gradient to use (between 0 and 1)
  62034. * @param factor defines the velocity to affect to the specified gradient
  62035. * @returns the current particle system
  62036. */
  62037. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  62038. /**
  62039. * Remove a specific velocity gradient
  62040. * @param gradient defines the gradient to remove
  62041. * @returns the current particle system
  62042. */
  62043. removeVelocityGradient(gradient: number): GPUParticleSystem;
  62044. /**
  62045. * Adds a new limit velocity gradient
  62046. * @param gradient defines the gradient to use (between 0 and 1)
  62047. * @param factor defines the limit velocity value to affect to the specified gradient
  62048. * @returns the current particle system
  62049. */
  62050. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  62051. /**
  62052. * Remove a specific limit velocity gradient
  62053. * @param gradient defines the gradient to remove
  62054. * @returns the current particle system
  62055. */
  62056. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  62057. /**
  62058. * Adds a new drag gradient
  62059. * @param gradient defines the gradient to use (between 0 and 1)
  62060. * @param factor defines the drag value to affect to the specified gradient
  62061. * @returns the current particle system
  62062. */
  62063. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  62064. /**
  62065. * Remove a specific drag gradient
  62066. * @param gradient defines the gradient to remove
  62067. * @returns the current particle system
  62068. */
  62069. removeDragGradient(gradient: number): GPUParticleSystem;
  62070. /**
  62071. * Not supported by GPUParticleSystem
  62072. * @param gradient defines the gradient to use (between 0 and 1)
  62073. * @param factor defines the emit rate value to affect to the specified gradient
  62074. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  62075. * @returns the current particle system
  62076. */
  62077. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  62078. /**
  62079. * Not supported by GPUParticleSystem
  62080. * @param gradient defines the gradient to remove
  62081. * @returns the current particle system
  62082. */
  62083. removeEmitRateGradient(gradient: number): IParticleSystem;
  62084. /**
  62085. * Not supported by GPUParticleSystem
  62086. * @param gradient defines the gradient to use (between 0 and 1)
  62087. * @param factor defines the start size value to affect to the specified gradient
  62088. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  62089. * @returns the current particle system
  62090. */
  62091. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  62092. /**
  62093. * Not supported by GPUParticleSystem
  62094. * @param gradient defines the gradient to remove
  62095. * @returns the current particle system
  62096. */
  62097. removeStartSizeGradient(gradient: number): IParticleSystem;
  62098. /**
  62099. * Not supported by GPUParticleSystem
  62100. * @param gradient defines the gradient to use (between 0 and 1)
  62101. * @param min defines the color remap minimal range
  62102. * @param max defines the color remap maximal range
  62103. * @returns the current particle system
  62104. */
  62105. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  62106. /**
  62107. * Not supported by GPUParticleSystem
  62108. * @param gradient defines the gradient to remove
  62109. * @returns the current particle system
  62110. */
  62111. removeColorRemapGradient(): IParticleSystem;
  62112. /**
  62113. * Not supported by GPUParticleSystem
  62114. * @param gradient defines the gradient to use (between 0 and 1)
  62115. * @param min defines the alpha remap minimal range
  62116. * @param max defines the alpha remap maximal range
  62117. * @returns the current particle system
  62118. */
  62119. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  62120. /**
  62121. * Not supported by GPUParticleSystem
  62122. * @param gradient defines the gradient to remove
  62123. * @returns the current particle system
  62124. */
  62125. removeAlphaRemapGradient(): IParticleSystem;
  62126. /**
  62127. * Not supported by GPUParticleSystem
  62128. * @param gradient defines the gradient to use (between 0 and 1)
  62129. * @param color defines the color to affect to the specified gradient
  62130. * @returns the current particle system
  62131. */
  62132. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  62133. /**
  62134. * Not supported by GPUParticleSystem
  62135. * @param gradient defines the gradient to remove
  62136. * @returns the current particle system
  62137. */
  62138. removeRampGradient(): IParticleSystem;
  62139. /**
  62140. * Not supported by GPUParticleSystem
  62141. * @returns the list of ramp gradients
  62142. */
  62143. getRampGradients(): Nullable<Array<Color3Gradient>>;
  62144. /**
  62145. * Not supported by GPUParticleSystem
  62146. * Gets or sets a boolean indicating that ramp gradients must be used
  62147. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  62148. */
  62149. useRampGradients: boolean;
  62150. /**
  62151. * Not supported by GPUParticleSystem
  62152. * @param gradient defines the gradient to use (between 0 and 1)
  62153. * @param factor defines the life time factor to affect to the specified gradient
  62154. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  62155. * @returns the current particle system
  62156. */
  62157. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  62158. /**
  62159. * Not supported by GPUParticleSystem
  62160. * @param gradient defines the gradient to remove
  62161. * @returns the current particle system
  62162. */
  62163. removeLifeTimeGradient(gradient: number): IParticleSystem;
  62164. /**
  62165. * Instantiates a GPU particle system.
  62166. * 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.
  62167. * @param name The name of the particle system
  62168. * @param options The options used to create the system
  62169. * @param scene The scene the particle system belongs to
  62170. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  62171. */
  62172. constructor(name: string, options: Partial<{
  62173. capacity: number;
  62174. randomTextureSize: number;
  62175. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  62176. protected _reset(): void;
  62177. private _createUpdateVAO;
  62178. private _createRenderVAO;
  62179. private _initialize;
  62180. /** @hidden */
  62181. _recreateUpdateEffect(): void;
  62182. /** @hidden */
  62183. _recreateRenderEffect(): void;
  62184. /**
  62185. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  62186. * @param preWarm defines if we are in the pre-warmimg phase
  62187. */
  62188. animate(preWarm?: boolean): void;
  62189. private _createFactorGradientTexture;
  62190. private _createSizeGradientTexture;
  62191. private _createAngularSpeedGradientTexture;
  62192. private _createVelocityGradientTexture;
  62193. private _createLimitVelocityGradientTexture;
  62194. private _createDragGradientTexture;
  62195. private _createColorGradientTexture;
  62196. /**
  62197. * Renders the particle system in its current state
  62198. * @param preWarm defines if the system should only update the particles but not render them
  62199. * @returns the current number of particles
  62200. */
  62201. render(preWarm?: boolean): number;
  62202. /**
  62203. * Rebuilds the particle system
  62204. */
  62205. rebuild(): void;
  62206. private _releaseBuffers;
  62207. private _releaseVAOs;
  62208. /**
  62209. * Disposes the particle system and free the associated resources
  62210. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  62211. */
  62212. dispose(disposeTexture?: boolean): void;
  62213. /**
  62214. * Clones the particle system.
  62215. * @param name The name of the cloned object
  62216. * @param newEmitter The new emitter to use
  62217. * @returns the cloned particle system
  62218. */
  62219. clone(name: string, newEmitter: any): GPUParticleSystem;
  62220. /**
  62221. * Serializes the particle system to a JSON object.
  62222. * @returns the JSON object
  62223. */
  62224. serialize(): any;
  62225. /**
  62226. * Parses a JSON object to create a GPU particle system.
  62227. * @param parsedParticleSystem The JSON object to parse
  62228. * @param scene The scene to create the particle system in
  62229. * @param rootUrl The root url to use to load external dependencies like texture
  62230. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  62231. * @returns the parsed GPU particle system
  62232. */
  62233. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  62234. }
  62235. }
  62236. declare module "babylonjs/Particles/particleSystemSet" {
  62237. import { Nullable } from "babylonjs/types";
  62238. import { Color3 } from "babylonjs/Maths/math.color";
  62239. import { TransformNode } from "babylonjs/Meshes/transformNode";
  62240. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62241. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62242. import { Scene, IDisposable } from "babylonjs/scene";
  62243. /**
  62244. * Represents a set of particle systems working together to create a specific effect
  62245. */
  62246. export class ParticleSystemSet implements IDisposable {
  62247. /**
  62248. * Gets or sets base Assets URL
  62249. */
  62250. static BaseAssetsUrl: string;
  62251. private _emitterCreationOptions;
  62252. private _emitterNode;
  62253. /**
  62254. * Gets the particle system list
  62255. */
  62256. systems: IParticleSystem[];
  62257. /**
  62258. * Gets the emitter node used with this set
  62259. */
  62260. readonly emitterNode: Nullable<TransformNode>;
  62261. /**
  62262. * Creates a new emitter mesh as a sphere
  62263. * @param options defines the options used to create the sphere
  62264. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  62265. * @param scene defines the hosting scene
  62266. */
  62267. setEmitterAsSphere(options: {
  62268. diameter: number;
  62269. segments: number;
  62270. color: Color3;
  62271. }, renderingGroupId: number, scene: Scene): void;
  62272. /**
  62273. * Starts all particle systems of the set
  62274. * @param emitter defines an optional mesh to use as emitter for the particle systems
  62275. */
  62276. start(emitter?: AbstractMesh): void;
  62277. /**
  62278. * Release all associated resources
  62279. */
  62280. dispose(): void;
  62281. /**
  62282. * Serialize the set into a JSON compatible object
  62283. * @returns a JSON compatible representation of the set
  62284. */
  62285. serialize(): any;
  62286. /**
  62287. * Parse a new ParticleSystemSet from a serialized source
  62288. * @param data defines a JSON compatible representation of the set
  62289. * @param scene defines the hosting scene
  62290. * @param gpu defines if we want GPU particles or CPU particles
  62291. * @returns a new ParticleSystemSet
  62292. */
  62293. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  62294. }
  62295. }
  62296. declare module "babylonjs/Particles/particleHelper" {
  62297. import { Nullable } from "babylonjs/types";
  62298. import { Scene } from "babylonjs/scene";
  62299. import { Vector3 } from "babylonjs/Maths/math.vector";
  62300. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62301. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62302. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  62303. /**
  62304. * This class is made for on one-liner static method to help creating particle system set.
  62305. */
  62306. export class ParticleHelper {
  62307. /**
  62308. * Gets or sets base Assets URL
  62309. */
  62310. static BaseAssetsUrl: string;
  62311. /**
  62312. * Create a default particle system that you can tweak
  62313. * @param emitter defines the emitter to use
  62314. * @param capacity defines the system capacity (default is 500 particles)
  62315. * @param scene defines the hosting scene
  62316. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  62317. * @returns the new Particle system
  62318. */
  62319. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  62320. /**
  62321. * This is the main static method (one-liner) of this helper to create different particle systems
  62322. * @param type This string represents the type to the particle system to create
  62323. * @param scene The scene where the particle system should live
  62324. * @param gpu If the system will use gpu
  62325. * @returns the ParticleSystemSet created
  62326. */
  62327. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  62328. /**
  62329. * Static function used to export a particle system to a ParticleSystemSet variable.
  62330. * Please note that the emitter shape is not exported
  62331. * @param systems defines the particle systems to export
  62332. * @returns the created particle system set
  62333. */
  62334. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  62335. }
  62336. }
  62337. declare module "babylonjs/Particles/particleSystemComponent" {
  62338. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62339. import { Effect } from "babylonjs/Materials/effect";
  62340. import "babylonjs/Shaders/particles.vertex";
  62341. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  62342. module "babylonjs/Engines/engine" {
  62343. interface Engine {
  62344. /**
  62345. * Create an effect to use with particle systems.
  62346. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  62347. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  62348. * @param uniformsNames defines a list of attribute names
  62349. * @param samplers defines an array of string used to represent textures
  62350. * @param defines defines the string containing the defines to use to compile the shaders
  62351. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  62352. * @param onCompiled defines a function to call when the effect creation is successful
  62353. * @param onError defines a function to call when the effect creation has failed
  62354. * @returns the new Effect
  62355. */
  62356. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  62357. }
  62358. }
  62359. module "babylonjs/Meshes/mesh" {
  62360. interface Mesh {
  62361. /**
  62362. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  62363. * @returns an array of IParticleSystem
  62364. */
  62365. getEmittedParticleSystems(): IParticleSystem[];
  62366. /**
  62367. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  62368. * @returns an array of IParticleSystem
  62369. */
  62370. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  62371. }
  62372. }
  62373. /**
  62374. * @hidden
  62375. */
  62376. export var _IDoNeedToBeInTheBuild: number;
  62377. }
  62378. declare module "babylonjs/Particles/pointsCloudSystem" {
  62379. import { Color4 } from "babylonjs/Maths/math";
  62380. import { Mesh } from "babylonjs/Meshes/mesh";
  62381. import { Scene, IDisposable } from "babylonjs/scene";
  62382. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  62383. /** Defines the 4 color options */
  62384. export enum PointColor {
  62385. /** color value */
  62386. Color = 2,
  62387. /** uv value */
  62388. UV = 1,
  62389. /** random value */
  62390. Random = 0,
  62391. /** stated value */
  62392. Stated = 3
  62393. }
  62394. /**
  62395. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  62396. * As it is just a mesh, the PointCloudSystem has all the same properties as any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  62397. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  62398. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  62399. *
  62400. * Full documentation here : TO BE ENTERED
  62401. */
  62402. export class PointsCloudSystem implements IDisposable {
  62403. /**
  62404. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  62405. * Example : var p = SPS.particles[i];
  62406. */
  62407. particles: CloudPoint[];
  62408. /**
  62409. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  62410. */
  62411. nbParticles: number;
  62412. /**
  62413. * This a counter for your own usage. It's not set by any SPS functions.
  62414. */
  62415. counter: number;
  62416. /**
  62417. * The PCS name. This name is also given to the underlying mesh.
  62418. */
  62419. name: string;
  62420. /**
  62421. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  62422. */
  62423. mesh: Mesh;
  62424. /**
  62425. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  62426. * Please read :
  62427. */
  62428. vars: any;
  62429. /**
  62430. * @hidden
  62431. */
  62432. _size: number;
  62433. private _scene;
  62434. private _promises;
  62435. private _positions;
  62436. private _indices;
  62437. private _normals;
  62438. private _colors;
  62439. private _uvs;
  62440. private _indices32;
  62441. private _positions32;
  62442. private _colors32;
  62443. private _uvs32;
  62444. private _updatable;
  62445. private _isVisibilityBoxLocked;
  62446. private _alwaysVisible;
  62447. private _groups;
  62448. private _groupCounter;
  62449. private _computeParticleColor;
  62450. private _computeParticleTexture;
  62451. private _computeParticleRotation;
  62452. private _computeBoundingBox;
  62453. private _isReady;
  62454. /**
  62455. * Creates a PCS (Points Cloud System) object
  62456. * @param name (String) is the PCS name, this will be the underlying mesh name
  62457. * @param pointSize (number) is the size for each point
  62458. * @param scene (Scene) is the scene in which the PCS is added
  62459. * @param options defines the options of the PCS e.g.
  62460. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  62461. */
  62462. constructor(name: string, pointSize: number, scene: Scene, options?: {
  62463. updatable?: boolean;
  62464. });
  62465. /**
  62466. * Builds the PCS underlying mesh. Returns a standard Mesh.
  62467. * If no points were added to the PCS, the returned mesh is just a single point.
  62468. * @returns a promise for the created mesh
  62469. */
  62470. buildMeshAsync(): Promise<Mesh>;
  62471. /**
  62472. * @hidden
  62473. */
  62474. private _buildMesh;
  62475. private _addParticle;
  62476. private _randomUnitVector;
  62477. private _getColorIndicesForCoord;
  62478. private _setPointsColorOrUV;
  62479. private _colorFromTexture;
  62480. private _calculateDensity;
  62481. /**
  62482. * Adds points to the PCS in random positions within a unit sphere
  62483. * @param nb (positive integer) the number of particles to be created from this model
  62484. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  62485. * @returns the number of groups in the system
  62486. */
  62487. addPoints(nb: number, pointFunction?: any): number;
  62488. /**
  62489. * Adds points to the PCS from the surface of the model shape
  62490. * @param mesh is any Mesh object that will be used as a surface model for the points
  62491. * @param nb (positive integer) the number of particles to be created from this model
  62492. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  62493. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  62494. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  62495. * @returns the number of groups in the system
  62496. */
  62497. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  62498. /**
  62499. * Adds points to the PCS inside the model shape
  62500. * @param mesh is any Mesh object that will be used as a surface model for the points
  62501. * @param nb (positive integer) the number of particles to be created from this model
  62502. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  62503. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  62504. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  62505. * @returns the number of groups in the system
  62506. */
  62507. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  62508. /**
  62509. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  62510. * This method calls `updateParticle()` for each particle of the SPS.
  62511. * For an animated SPS, it is usually called within the render loop.
  62512. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  62513. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  62514. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  62515. * @returns the PCS.
  62516. */
  62517. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  62518. /**
  62519. * Disposes the PCS.
  62520. */
  62521. dispose(): void;
  62522. /**
  62523. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  62524. * doc :
  62525. * @returns the PCS.
  62526. */
  62527. refreshVisibleSize(): PointsCloudSystem;
  62528. /**
  62529. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  62530. * @param size the size (float) of the visibility box
  62531. * note : this doesn't lock the PCS mesh bounding box.
  62532. * doc :
  62533. */
  62534. setVisibilityBox(size: number): void;
  62535. /**
  62536. * Gets whether the PCS is always visible or not
  62537. * doc :
  62538. */
  62539. /**
  62540. * Sets the PCS as always visible or not
  62541. * doc :
  62542. */
  62543. isAlwaysVisible: boolean;
  62544. /**
  62545. * Tells to `setParticles()` to compute the particle rotations or not
  62546. * Default value : false. The PCS is faster when it's set to false
  62547. * Note : particle rotations are only applied to parent particles
  62548. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  62549. */
  62550. computeParticleRotation: boolean;
  62551. /**
  62552. * Tells to `setParticles()` to compute the particle colors or not.
  62553. * Default value : true. The PCS is faster when it's set to false.
  62554. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  62555. */
  62556. /**
  62557. * Gets if `setParticles()` computes the particle colors or not.
  62558. * Default value : false. The PCS is faster when it's set to false.
  62559. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  62560. */
  62561. computeParticleColor: boolean;
  62562. /**
  62563. * Gets if `setParticles()` computes the particle textures or not.
  62564. * Default value : false. The PCS is faster when it's set to false.
  62565. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  62566. */
  62567. computeParticleTexture: boolean;
  62568. /**
  62569. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  62570. */
  62571. /**
  62572. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  62573. */
  62574. computeBoundingBox: boolean;
  62575. /**
  62576. * This function does nothing. It may be overwritten to set all the particle first values.
  62577. * The PCS doesn't call this function, you may have to call it by your own.
  62578. * doc :
  62579. */
  62580. initParticles(): void;
  62581. /**
  62582. * This function does nothing. It may be overwritten to recycle a particle
  62583. * The PCS doesn't call this function, you can to call it
  62584. * doc :
  62585. * @param particle The particle to recycle
  62586. * @returns the recycled particle
  62587. */
  62588. recycleParticle(particle: CloudPoint): CloudPoint;
  62589. /**
  62590. * Updates a particle : this function should be overwritten by the user.
  62591. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  62592. * doc :
  62593. * @example : just set a particle position or velocity and recycle conditions
  62594. * @param particle The particle to update
  62595. * @returns the updated particle
  62596. */
  62597. updateParticle(particle: CloudPoint): CloudPoint;
  62598. /**
  62599. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  62600. * This does nothing and may be overwritten by the user.
  62601. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  62602. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  62603. * @param update the boolean update value actually passed to setParticles()
  62604. */
  62605. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  62606. /**
  62607. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  62608. * This will be passed three parameters.
  62609. * This does nothing and may be overwritten by the user.
  62610. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  62611. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  62612. * @param update the boolean update value actually passed to setParticles()
  62613. */
  62614. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  62615. }
  62616. }
  62617. declare module "babylonjs/Particles/cloudPoint" {
  62618. import { Nullable } from "babylonjs/types";
  62619. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  62620. import { Mesh } from "babylonjs/Meshes/mesh";
  62621. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62622. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  62623. /**
  62624. * Represents one particle of a points cloud system.
  62625. */
  62626. export class CloudPoint {
  62627. /**
  62628. * particle global index
  62629. */
  62630. idx: number;
  62631. /**
  62632. * The color of the particle
  62633. */
  62634. color: Nullable<Color4>;
  62635. /**
  62636. * The world space position of the particle.
  62637. */
  62638. position: Vector3;
  62639. /**
  62640. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  62641. */
  62642. rotation: Vector3;
  62643. /**
  62644. * The world space rotation quaternion of the particle.
  62645. */
  62646. rotationQuaternion: Nullable<Quaternion>;
  62647. /**
  62648. * The uv of the particle.
  62649. */
  62650. uv: Nullable<Vector2>;
  62651. /**
  62652. * The current speed of the particle.
  62653. */
  62654. velocity: Vector3;
  62655. /**
  62656. * The pivot point in the particle local space.
  62657. */
  62658. pivot: Vector3;
  62659. /**
  62660. * Must the particle be translated from its pivot point in its local space ?
  62661. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  62662. * Default : false
  62663. */
  62664. translateFromPivot: boolean;
  62665. /**
  62666. * Index of this particle in the global "positions" array (Internal use)
  62667. * @hidden
  62668. */
  62669. _pos: number;
  62670. /**
  62671. * @hidden Index of this particle in the global "indices" array (Internal use)
  62672. */
  62673. _ind: number;
  62674. /**
  62675. * Group this particle belongs to
  62676. */
  62677. _group: PointsGroup;
  62678. /**
  62679. * Group id of this particle
  62680. */
  62681. groupId: number;
  62682. /**
  62683. * Index of the particle in its group id (Internal use)
  62684. */
  62685. idxInGroup: number;
  62686. /**
  62687. * @hidden Particle BoundingInfo object (Internal use)
  62688. */
  62689. _boundingInfo: BoundingInfo;
  62690. /**
  62691. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  62692. */
  62693. _pcs: PointsCloudSystem;
  62694. /**
  62695. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  62696. */
  62697. _stillInvisible: boolean;
  62698. /**
  62699. * @hidden Last computed particle rotation matrix
  62700. */
  62701. _rotationMatrix: number[];
  62702. /**
  62703. * Parent particle Id, if any.
  62704. * Default null.
  62705. */
  62706. parentId: Nullable<number>;
  62707. /**
  62708. * @hidden Internal global position in the PCS.
  62709. */
  62710. _globalPosition: Vector3;
  62711. /**
  62712. * Creates a Point Cloud object.
  62713. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  62714. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  62715. * @param group (PointsGroup) is the group the particle belongs to
  62716. * @param groupId (integer) is the group identifier in the PCS.
  62717. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  62718. * @param pcs defines the PCS it is associated to
  62719. */
  62720. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  62721. /**
  62722. * get point size
  62723. */
  62724. /**
  62725. * Set point size
  62726. */
  62727. size: Vector3;
  62728. /**
  62729. * Legacy support, changed quaternion to rotationQuaternion
  62730. */
  62731. /**
  62732. * Legacy support, changed quaternion to rotationQuaternion
  62733. */
  62734. quaternion: Nullable<Quaternion>;
  62735. /**
  62736. * Returns a boolean. True if the particle intersects a mesh, else false
  62737. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  62738. * @param target is the object (point or mesh) what the intersection is computed against
  62739. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  62740. * @returns true if it intersects
  62741. */
  62742. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  62743. /**
  62744. * get the rotation matrix of the particle
  62745. * @hidden
  62746. */
  62747. getRotationMatrix(m: Matrix): void;
  62748. }
  62749. /**
  62750. * Represents a group of points in a points cloud system
  62751. * * PCS internal tool, don't use it manually.
  62752. */
  62753. export class PointsGroup {
  62754. /**
  62755. * The group id
  62756. * @hidden
  62757. */
  62758. groupID: number;
  62759. /**
  62760. * image data for group (internal use)
  62761. * @hidden
  62762. */
  62763. _groupImageData: Nullable<ArrayBufferView>;
  62764. /**
  62765. * Image Width (internal use)
  62766. * @hidden
  62767. */
  62768. _groupImgWidth: number;
  62769. /**
  62770. * Image Height (internal use)
  62771. * @hidden
  62772. */
  62773. _groupImgHeight: number;
  62774. /**
  62775. * Custom position function (internal use)
  62776. * @hidden
  62777. */
  62778. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  62779. /**
  62780. * density per facet for surface points
  62781. * @hidden
  62782. */
  62783. _groupDensity: number[];
  62784. /**
  62785. * Only when points are colored by texture carries pointer to texture list array
  62786. * @hidden
  62787. */
  62788. _textureNb: number;
  62789. /**
  62790. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  62791. * PCS internal tool, don't use it manually.
  62792. * @hidden
  62793. */
  62794. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  62795. }
  62796. }
  62797. declare module "babylonjs/Particles/index" {
  62798. export * from "babylonjs/Particles/baseParticleSystem";
  62799. export * from "babylonjs/Particles/EmitterTypes/index";
  62800. export * from "babylonjs/Particles/gpuParticleSystem";
  62801. export * from "babylonjs/Particles/IParticleSystem";
  62802. export * from "babylonjs/Particles/particle";
  62803. export * from "babylonjs/Particles/particleHelper";
  62804. export * from "babylonjs/Particles/particleSystem";
  62805. export * from "babylonjs/Particles/particleSystemComponent";
  62806. export * from "babylonjs/Particles/particleSystemSet";
  62807. export * from "babylonjs/Particles/solidParticle";
  62808. export * from "babylonjs/Particles/solidParticleSystem";
  62809. export * from "babylonjs/Particles/cloudPoint";
  62810. export * from "babylonjs/Particles/pointsCloudSystem";
  62811. export * from "babylonjs/Particles/subEmitter";
  62812. }
  62813. declare module "babylonjs/Physics/physicsEngineComponent" {
  62814. import { Nullable } from "babylonjs/types";
  62815. import { Observable, Observer } from "babylonjs/Misc/observable";
  62816. import { Vector3 } from "babylonjs/Maths/math.vector";
  62817. import { Mesh } from "babylonjs/Meshes/mesh";
  62818. import { ISceneComponent } from "babylonjs/sceneComponent";
  62819. import { Scene } from "babylonjs/scene";
  62820. import { Node } from "babylonjs/node";
  62821. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62822. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62823. module "babylonjs/scene" {
  62824. interface Scene {
  62825. /** @hidden (Backing field) */
  62826. _physicsEngine: Nullable<IPhysicsEngine>;
  62827. /**
  62828. * Gets the current physics engine
  62829. * @returns a IPhysicsEngine or null if none attached
  62830. */
  62831. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  62832. /**
  62833. * Enables physics to the current scene
  62834. * @param gravity defines the scene's gravity for the physics engine
  62835. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  62836. * @return a boolean indicating if the physics engine was initialized
  62837. */
  62838. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  62839. /**
  62840. * Disables and disposes the physics engine associated with the scene
  62841. */
  62842. disablePhysicsEngine(): void;
  62843. /**
  62844. * Gets a boolean indicating if there is an active physics engine
  62845. * @returns a boolean indicating if there is an active physics engine
  62846. */
  62847. isPhysicsEnabled(): boolean;
  62848. /**
  62849. * Deletes a physics compound impostor
  62850. * @param compound defines the compound to delete
  62851. */
  62852. deleteCompoundImpostor(compound: any): void;
  62853. /**
  62854. * An event triggered when physic simulation is about to be run
  62855. */
  62856. onBeforePhysicsObservable: Observable<Scene>;
  62857. /**
  62858. * An event triggered when physic simulation has been done
  62859. */
  62860. onAfterPhysicsObservable: Observable<Scene>;
  62861. }
  62862. }
  62863. module "babylonjs/Meshes/abstractMesh" {
  62864. interface AbstractMesh {
  62865. /** @hidden */
  62866. _physicsImpostor: Nullable<PhysicsImpostor>;
  62867. /**
  62868. * Gets or sets impostor used for physic simulation
  62869. * @see http://doc.babylonjs.com/features/physics_engine
  62870. */
  62871. physicsImpostor: Nullable<PhysicsImpostor>;
  62872. /**
  62873. * Gets the current physics impostor
  62874. * @see http://doc.babylonjs.com/features/physics_engine
  62875. * @returns a physics impostor or null
  62876. */
  62877. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  62878. /** Apply a physic impulse to the mesh
  62879. * @param force defines the force to apply
  62880. * @param contactPoint defines where to apply the force
  62881. * @returns the current mesh
  62882. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  62883. */
  62884. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  62885. /**
  62886. * Creates a physic joint between two meshes
  62887. * @param otherMesh defines the other mesh to use
  62888. * @param pivot1 defines the pivot to use on this mesh
  62889. * @param pivot2 defines the pivot to use on the other mesh
  62890. * @param options defines additional options (can be plugin dependent)
  62891. * @returns the current mesh
  62892. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  62893. */
  62894. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  62895. /** @hidden */
  62896. _disposePhysicsObserver: Nullable<Observer<Node>>;
  62897. }
  62898. }
  62899. /**
  62900. * Defines the physics engine scene component responsible to manage a physics engine
  62901. */
  62902. export class PhysicsEngineSceneComponent implements ISceneComponent {
  62903. /**
  62904. * The component name helpful to identify the component in the list of scene components.
  62905. */
  62906. readonly name: string;
  62907. /**
  62908. * The scene the component belongs to.
  62909. */
  62910. scene: Scene;
  62911. /**
  62912. * Creates a new instance of the component for the given scene
  62913. * @param scene Defines the scene to register the component in
  62914. */
  62915. constructor(scene: Scene);
  62916. /**
  62917. * Registers the component in a given scene
  62918. */
  62919. register(): void;
  62920. /**
  62921. * Rebuilds the elements related to this component in case of
  62922. * context lost for instance.
  62923. */
  62924. rebuild(): void;
  62925. /**
  62926. * Disposes the component and the associated ressources
  62927. */
  62928. dispose(): void;
  62929. }
  62930. }
  62931. declare module "babylonjs/Physics/physicsHelper" {
  62932. import { Nullable } from "babylonjs/types";
  62933. import { Vector3 } from "babylonjs/Maths/math.vector";
  62934. import { Mesh } from "babylonjs/Meshes/mesh";
  62935. import { Scene } from "babylonjs/scene";
  62936. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62937. /**
  62938. * A helper for physics simulations
  62939. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62940. */
  62941. export class PhysicsHelper {
  62942. private _scene;
  62943. private _physicsEngine;
  62944. /**
  62945. * Initializes the Physics helper
  62946. * @param scene Babylon.js scene
  62947. */
  62948. constructor(scene: Scene);
  62949. /**
  62950. * Applies a radial explosion impulse
  62951. * @param origin the origin of the explosion
  62952. * @param radiusOrEventOptions the radius or the options of radial explosion
  62953. * @param strength the explosion strength
  62954. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62955. * @returns A physics radial explosion event, or null
  62956. */
  62957. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62958. /**
  62959. * Applies a radial explosion force
  62960. * @param origin the origin of the explosion
  62961. * @param radiusOrEventOptions the radius or the options of radial explosion
  62962. * @param strength the explosion strength
  62963. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62964. * @returns A physics radial explosion event, or null
  62965. */
  62966. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62967. /**
  62968. * Creates a gravitational field
  62969. * @param origin the origin of the explosion
  62970. * @param radiusOrEventOptions the radius or the options of radial explosion
  62971. * @param strength the explosion strength
  62972. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62973. * @returns A physics gravitational field event, or null
  62974. */
  62975. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  62976. /**
  62977. * Creates a physics updraft event
  62978. * @param origin the origin of the updraft
  62979. * @param radiusOrEventOptions the radius or the options of the updraft
  62980. * @param strength the strength of the updraft
  62981. * @param height the height of the updraft
  62982. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  62983. * @returns A physics updraft event, or null
  62984. */
  62985. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  62986. /**
  62987. * Creates a physics vortex event
  62988. * @param origin the of the vortex
  62989. * @param radiusOrEventOptions the radius or the options of the vortex
  62990. * @param strength the strength of the vortex
  62991. * @param height the height of the vortex
  62992. * @returns a Physics vortex event, or null
  62993. * A physics vortex event or null
  62994. */
  62995. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  62996. }
  62997. /**
  62998. * Represents a physics radial explosion event
  62999. */
  63000. class PhysicsRadialExplosionEvent {
  63001. private _scene;
  63002. private _options;
  63003. private _sphere;
  63004. private _dataFetched;
  63005. /**
  63006. * Initializes a radial explosioin event
  63007. * @param _scene BabylonJS scene
  63008. * @param _options The options for the vortex event
  63009. */
  63010. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  63011. /**
  63012. * Returns the data related to the radial explosion event (sphere).
  63013. * @returns The radial explosion event data
  63014. */
  63015. getData(): PhysicsRadialExplosionEventData;
  63016. /**
  63017. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  63018. * @param impostor A physics imposter
  63019. * @param origin the origin of the explosion
  63020. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  63021. */
  63022. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  63023. /**
  63024. * Triggers affecterd impostors callbacks
  63025. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  63026. */
  63027. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  63028. /**
  63029. * Disposes the sphere.
  63030. * @param force Specifies if the sphere should be disposed by force
  63031. */
  63032. dispose(force?: boolean): void;
  63033. /*** Helpers ***/
  63034. private _prepareSphere;
  63035. private _intersectsWithSphere;
  63036. }
  63037. /**
  63038. * Represents a gravitational field event
  63039. */
  63040. class PhysicsGravitationalFieldEvent {
  63041. private _physicsHelper;
  63042. private _scene;
  63043. private _origin;
  63044. private _options;
  63045. private _tickCallback;
  63046. private _sphere;
  63047. private _dataFetched;
  63048. /**
  63049. * Initializes the physics gravitational field event
  63050. * @param _physicsHelper A physics helper
  63051. * @param _scene BabylonJS scene
  63052. * @param _origin The origin position of the gravitational field event
  63053. * @param _options The options for the vortex event
  63054. */
  63055. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  63056. /**
  63057. * Returns the data related to the gravitational field event (sphere).
  63058. * @returns A gravitational field event
  63059. */
  63060. getData(): PhysicsGravitationalFieldEventData;
  63061. /**
  63062. * Enables the gravitational field.
  63063. */
  63064. enable(): void;
  63065. /**
  63066. * Disables the gravitational field.
  63067. */
  63068. disable(): void;
  63069. /**
  63070. * Disposes the sphere.
  63071. * @param force The force to dispose from the gravitational field event
  63072. */
  63073. dispose(force?: boolean): void;
  63074. private _tick;
  63075. }
  63076. /**
  63077. * Represents a physics updraft event
  63078. */
  63079. class PhysicsUpdraftEvent {
  63080. private _scene;
  63081. private _origin;
  63082. private _options;
  63083. private _physicsEngine;
  63084. private _originTop;
  63085. private _originDirection;
  63086. private _tickCallback;
  63087. private _cylinder;
  63088. private _cylinderPosition;
  63089. private _dataFetched;
  63090. /**
  63091. * Initializes the physics updraft event
  63092. * @param _scene BabylonJS scene
  63093. * @param _origin The origin position of the updraft
  63094. * @param _options The options for the updraft event
  63095. */
  63096. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  63097. /**
  63098. * Returns the data related to the updraft event (cylinder).
  63099. * @returns A physics updraft event
  63100. */
  63101. getData(): PhysicsUpdraftEventData;
  63102. /**
  63103. * Enables the updraft.
  63104. */
  63105. enable(): void;
  63106. /**
  63107. * Disables the updraft.
  63108. */
  63109. disable(): void;
  63110. /**
  63111. * Disposes the cylinder.
  63112. * @param force Specifies if the updraft should be disposed by force
  63113. */
  63114. dispose(force?: boolean): void;
  63115. private getImpostorHitData;
  63116. private _tick;
  63117. /*** Helpers ***/
  63118. private _prepareCylinder;
  63119. private _intersectsWithCylinder;
  63120. }
  63121. /**
  63122. * Represents a physics vortex event
  63123. */
  63124. class PhysicsVortexEvent {
  63125. private _scene;
  63126. private _origin;
  63127. private _options;
  63128. private _physicsEngine;
  63129. private _originTop;
  63130. private _tickCallback;
  63131. private _cylinder;
  63132. private _cylinderPosition;
  63133. private _dataFetched;
  63134. /**
  63135. * Initializes the physics vortex event
  63136. * @param _scene The BabylonJS scene
  63137. * @param _origin The origin position of the vortex
  63138. * @param _options The options for the vortex event
  63139. */
  63140. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  63141. /**
  63142. * Returns the data related to the vortex event (cylinder).
  63143. * @returns The physics vortex event data
  63144. */
  63145. getData(): PhysicsVortexEventData;
  63146. /**
  63147. * Enables the vortex.
  63148. */
  63149. enable(): void;
  63150. /**
  63151. * Disables the cortex.
  63152. */
  63153. disable(): void;
  63154. /**
  63155. * Disposes the sphere.
  63156. * @param force
  63157. */
  63158. dispose(force?: boolean): void;
  63159. private getImpostorHitData;
  63160. private _tick;
  63161. /*** Helpers ***/
  63162. private _prepareCylinder;
  63163. private _intersectsWithCylinder;
  63164. }
  63165. /**
  63166. * Options fot the radial explosion event
  63167. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63168. */
  63169. export class PhysicsRadialExplosionEventOptions {
  63170. /**
  63171. * The radius of the sphere for the radial explosion.
  63172. */
  63173. radius: number;
  63174. /**
  63175. * The strenth of the explosion.
  63176. */
  63177. strength: number;
  63178. /**
  63179. * The strenght of the force in correspondence to the distance of the affected object
  63180. */
  63181. falloff: PhysicsRadialImpulseFalloff;
  63182. /**
  63183. * Sphere options for the radial explosion.
  63184. */
  63185. sphere: {
  63186. segments: number;
  63187. diameter: number;
  63188. };
  63189. /**
  63190. * Sphere options for the radial explosion.
  63191. */
  63192. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  63193. }
  63194. /**
  63195. * Options fot the updraft event
  63196. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63197. */
  63198. export class PhysicsUpdraftEventOptions {
  63199. /**
  63200. * The radius of the cylinder for the vortex
  63201. */
  63202. radius: number;
  63203. /**
  63204. * The strenth of the updraft.
  63205. */
  63206. strength: number;
  63207. /**
  63208. * The height of the cylinder for the updraft.
  63209. */
  63210. height: number;
  63211. /**
  63212. * The mode for the the updraft.
  63213. */
  63214. updraftMode: PhysicsUpdraftMode;
  63215. }
  63216. /**
  63217. * Options fot the vortex event
  63218. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63219. */
  63220. export class PhysicsVortexEventOptions {
  63221. /**
  63222. * The radius of the cylinder for the vortex
  63223. */
  63224. radius: number;
  63225. /**
  63226. * The strenth of the vortex.
  63227. */
  63228. strength: number;
  63229. /**
  63230. * The height of the cylinder for the vortex.
  63231. */
  63232. height: number;
  63233. /**
  63234. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  63235. */
  63236. centripetalForceThreshold: number;
  63237. /**
  63238. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  63239. */
  63240. centripetalForceMultiplier: number;
  63241. /**
  63242. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  63243. */
  63244. centrifugalForceMultiplier: number;
  63245. /**
  63246. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  63247. */
  63248. updraftForceMultiplier: number;
  63249. }
  63250. /**
  63251. * The strenght of the force in correspondence to the distance of the affected object
  63252. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63253. */
  63254. export enum PhysicsRadialImpulseFalloff {
  63255. /** Defines that impulse is constant in strength across it's whole radius */
  63256. Constant = 0,
  63257. /** Defines that impulse gets weaker if it's further from the origin */
  63258. Linear = 1
  63259. }
  63260. /**
  63261. * The strength of the force in correspondence to the distance of the affected object
  63262. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63263. */
  63264. export enum PhysicsUpdraftMode {
  63265. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  63266. Center = 0,
  63267. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  63268. Perpendicular = 1
  63269. }
  63270. /**
  63271. * Interface for a physics hit data
  63272. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63273. */
  63274. export interface PhysicsHitData {
  63275. /**
  63276. * The force applied at the contact point
  63277. */
  63278. force: Vector3;
  63279. /**
  63280. * The contact point
  63281. */
  63282. contactPoint: Vector3;
  63283. /**
  63284. * The distance from the origin to the contact point
  63285. */
  63286. distanceFromOrigin: number;
  63287. }
  63288. /**
  63289. * Interface for radial explosion event data
  63290. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63291. */
  63292. export interface PhysicsRadialExplosionEventData {
  63293. /**
  63294. * A sphere used for the radial explosion event
  63295. */
  63296. sphere: Mesh;
  63297. }
  63298. /**
  63299. * Interface for gravitational field event data
  63300. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63301. */
  63302. export interface PhysicsGravitationalFieldEventData {
  63303. /**
  63304. * A sphere mesh used for the gravitational field event
  63305. */
  63306. sphere: Mesh;
  63307. }
  63308. /**
  63309. * Interface for updraft event data
  63310. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63311. */
  63312. export interface PhysicsUpdraftEventData {
  63313. /**
  63314. * A cylinder used for the updraft event
  63315. */
  63316. cylinder: Mesh;
  63317. }
  63318. /**
  63319. * Interface for vortex event data
  63320. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63321. */
  63322. export interface PhysicsVortexEventData {
  63323. /**
  63324. * A cylinder used for the vortex event
  63325. */
  63326. cylinder: Mesh;
  63327. }
  63328. /**
  63329. * Interface for an affected physics impostor
  63330. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63331. */
  63332. export interface PhysicsAffectedImpostorWithData {
  63333. /**
  63334. * The impostor affected by the effect
  63335. */
  63336. impostor: PhysicsImpostor;
  63337. /**
  63338. * The data about the hit/horce from the explosion
  63339. */
  63340. hitData: PhysicsHitData;
  63341. }
  63342. }
  63343. declare module "babylonjs/Physics/Plugins/index" {
  63344. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  63345. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  63346. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  63347. }
  63348. declare module "babylonjs/Physics/index" {
  63349. export * from "babylonjs/Physics/IPhysicsEngine";
  63350. export * from "babylonjs/Physics/physicsEngine";
  63351. export * from "babylonjs/Physics/physicsEngineComponent";
  63352. export * from "babylonjs/Physics/physicsHelper";
  63353. export * from "babylonjs/Physics/physicsImpostor";
  63354. export * from "babylonjs/Physics/physicsJoint";
  63355. export * from "babylonjs/Physics/Plugins/index";
  63356. }
  63357. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  63358. /** @hidden */
  63359. export var blackAndWhitePixelShader: {
  63360. name: string;
  63361. shader: string;
  63362. };
  63363. }
  63364. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  63365. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63366. import { Camera } from "babylonjs/Cameras/camera";
  63367. import { Engine } from "babylonjs/Engines/engine";
  63368. import "babylonjs/Shaders/blackAndWhite.fragment";
  63369. /**
  63370. * Post process used to render in black and white
  63371. */
  63372. export class BlackAndWhitePostProcess extends PostProcess {
  63373. /**
  63374. * Linear about to convert he result to black and white (default: 1)
  63375. */
  63376. degree: number;
  63377. /**
  63378. * Creates a black and white post process
  63379. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  63380. * @param name The name of the effect.
  63381. * @param options The required width/height ratio to downsize to before computing the render pass.
  63382. * @param camera The camera to apply the render pass to.
  63383. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63384. * @param engine The engine which the post process will be applied. (default: current engine)
  63385. * @param reusable If the post process can be reused on the same frame. (default: false)
  63386. */
  63387. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63388. }
  63389. }
  63390. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  63391. import { Nullable } from "babylonjs/types";
  63392. import { Camera } from "babylonjs/Cameras/camera";
  63393. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63394. import { Engine } from "babylonjs/Engines/engine";
  63395. /**
  63396. * This represents a set of one or more post processes in Babylon.
  63397. * A post process can be used to apply a shader to a texture after it is rendered.
  63398. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63399. */
  63400. export class PostProcessRenderEffect {
  63401. private _postProcesses;
  63402. private _getPostProcesses;
  63403. private _singleInstance;
  63404. private _cameras;
  63405. private _indicesForCamera;
  63406. /**
  63407. * Name of the effect
  63408. * @hidden
  63409. */
  63410. _name: string;
  63411. /**
  63412. * Instantiates a post process render effect.
  63413. * A post process can be used to apply a shader to a texture after it is rendered.
  63414. * @param engine The engine the effect is tied to
  63415. * @param name The name of the effect
  63416. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  63417. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  63418. */
  63419. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  63420. /**
  63421. * Checks if all the post processes in the effect are supported.
  63422. */
  63423. readonly isSupported: boolean;
  63424. /**
  63425. * Updates the current state of the effect
  63426. * @hidden
  63427. */
  63428. _update(): void;
  63429. /**
  63430. * Attaches the effect on cameras
  63431. * @param cameras The camera to attach to.
  63432. * @hidden
  63433. */
  63434. _attachCameras(cameras: Camera): void;
  63435. /**
  63436. * Attaches the effect on cameras
  63437. * @param cameras The camera to attach to.
  63438. * @hidden
  63439. */
  63440. _attachCameras(cameras: Camera[]): void;
  63441. /**
  63442. * Detaches the effect on cameras
  63443. * @param cameras The camera to detatch from.
  63444. * @hidden
  63445. */
  63446. _detachCameras(cameras: Camera): void;
  63447. /**
  63448. * Detatches the effect on cameras
  63449. * @param cameras The camera to detatch from.
  63450. * @hidden
  63451. */
  63452. _detachCameras(cameras: Camera[]): void;
  63453. /**
  63454. * Enables the effect on given cameras
  63455. * @param cameras The camera to enable.
  63456. * @hidden
  63457. */
  63458. _enable(cameras: Camera): void;
  63459. /**
  63460. * Enables the effect on given cameras
  63461. * @param cameras The camera to enable.
  63462. * @hidden
  63463. */
  63464. _enable(cameras: Nullable<Camera[]>): void;
  63465. /**
  63466. * Disables the effect on the given cameras
  63467. * @param cameras The camera to disable.
  63468. * @hidden
  63469. */
  63470. _disable(cameras: Camera): void;
  63471. /**
  63472. * Disables the effect on the given cameras
  63473. * @param cameras The camera to disable.
  63474. * @hidden
  63475. */
  63476. _disable(cameras: Nullable<Camera[]>): void;
  63477. /**
  63478. * Gets a list of the post processes contained in the effect.
  63479. * @param camera The camera to get the post processes on.
  63480. * @returns The list of the post processes in the effect.
  63481. */
  63482. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  63483. }
  63484. }
  63485. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  63486. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63487. /** @hidden */
  63488. export var extractHighlightsPixelShader: {
  63489. name: string;
  63490. shader: string;
  63491. };
  63492. }
  63493. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  63494. import { Nullable } from "babylonjs/types";
  63495. import { Camera } from "babylonjs/Cameras/camera";
  63496. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63497. import { Engine } from "babylonjs/Engines/engine";
  63498. import "babylonjs/Shaders/extractHighlights.fragment";
  63499. /**
  63500. * 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.
  63501. */
  63502. export class ExtractHighlightsPostProcess extends PostProcess {
  63503. /**
  63504. * The luminance threshold, pixels below this value will be set to black.
  63505. */
  63506. threshold: number;
  63507. /** @hidden */
  63508. _exposure: number;
  63509. /**
  63510. * Post process which has the input texture to be used when performing highlight extraction
  63511. * @hidden
  63512. */
  63513. _inputPostProcess: Nullable<PostProcess>;
  63514. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63515. }
  63516. }
  63517. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  63518. /** @hidden */
  63519. export var bloomMergePixelShader: {
  63520. name: string;
  63521. shader: string;
  63522. };
  63523. }
  63524. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  63525. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63526. import { Nullable } from "babylonjs/types";
  63527. import { Engine } from "babylonjs/Engines/engine";
  63528. import { Camera } from "babylonjs/Cameras/camera";
  63529. import "babylonjs/Shaders/bloomMerge.fragment";
  63530. /**
  63531. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63532. */
  63533. export class BloomMergePostProcess extends PostProcess {
  63534. /** Weight of the bloom to be added to the original input. */
  63535. weight: number;
  63536. /**
  63537. * Creates a new instance of @see BloomMergePostProcess
  63538. * @param name The name of the effect.
  63539. * @param originalFromInput Post process which's input will be used for the merge.
  63540. * @param blurred Blurred highlights post process which's output will be used.
  63541. * @param weight Weight of the bloom to be added to the original input.
  63542. * @param options The required width/height ratio to downsize to before computing the render pass.
  63543. * @param camera The camera to apply the render pass to.
  63544. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63545. * @param engine The engine which the post process will be applied. (default: current engine)
  63546. * @param reusable If the post process can be reused on the same frame. (default: false)
  63547. * @param textureType Type of textures used when performing the post process. (default: 0)
  63548. * @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)
  63549. */
  63550. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  63551. /** Weight of the bloom to be added to the original input. */
  63552. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63553. }
  63554. }
  63555. declare module "babylonjs/PostProcesses/bloomEffect" {
  63556. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63557. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63558. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  63559. import { Camera } from "babylonjs/Cameras/camera";
  63560. import { Scene } from "babylonjs/scene";
  63561. /**
  63562. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  63563. */
  63564. export class BloomEffect extends PostProcessRenderEffect {
  63565. private bloomScale;
  63566. /**
  63567. * @hidden Internal
  63568. */
  63569. _effects: Array<PostProcess>;
  63570. /**
  63571. * @hidden Internal
  63572. */
  63573. _downscale: ExtractHighlightsPostProcess;
  63574. private _blurX;
  63575. private _blurY;
  63576. private _merge;
  63577. /**
  63578. * The luminance threshold to find bright areas of the image to bloom.
  63579. */
  63580. threshold: number;
  63581. /**
  63582. * The strength of the bloom.
  63583. */
  63584. weight: number;
  63585. /**
  63586. * Specifies the size of the bloom blur kernel, relative to the final output size
  63587. */
  63588. kernel: number;
  63589. /**
  63590. * Creates a new instance of @see BloomEffect
  63591. * @param scene The scene the effect belongs to.
  63592. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  63593. * @param bloomKernel The size of the kernel to be used when applying the blur.
  63594. * @param bloomWeight The the strength of bloom.
  63595. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63596. * @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)
  63597. */
  63598. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  63599. /**
  63600. * Disposes each of the internal effects for a given camera.
  63601. * @param camera The camera to dispose the effect on.
  63602. */
  63603. disposeEffects(camera: Camera): void;
  63604. /**
  63605. * @hidden Internal
  63606. */
  63607. _updateEffects(): void;
  63608. /**
  63609. * Internal
  63610. * @returns if all the contained post processes are ready.
  63611. * @hidden
  63612. */
  63613. _isReady(): boolean;
  63614. }
  63615. }
  63616. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  63617. /** @hidden */
  63618. export var chromaticAberrationPixelShader: {
  63619. name: string;
  63620. shader: string;
  63621. };
  63622. }
  63623. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  63624. import { Vector2 } from "babylonjs/Maths/math.vector";
  63625. import { Nullable } from "babylonjs/types";
  63626. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63627. import { Camera } from "babylonjs/Cameras/camera";
  63628. import { Engine } from "babylonjs/Engines/engine";
  63629. import "babylonjs/Shaders/chromaticAberration.fragment";
  63630. /**
  63631. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  63632. */
  63633. export class ChromaticAberrationPostProcess extends PostProcess {
  63634. /**
  63635. * The amount of seperation of rgb channels (default: 30)
  63636. */
  63637. aberrationAmount: number;
  63638. /**
  63639. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  63640. */
  63641. radialIntensity: number;
  63642. /**
  63643. * 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))
  63644. */
  63645. direction: Vector2;
  63646. /**
  63647. * 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))
  63648. */
  63649. centerPosition: Vector2;
  63650. /**
  63651. * Creates a new instance ChromaticAberrationPostProcess
  63652. * @param name The name of the effect.
  63653. * @param screenWidth The width of the screen to apply the effect on.
  63654. * @param screenHeight The height of the screen to apply the effect on.
  63655. * @param options The required width/height ratio to downsize to before computing the render pass.
  63656. * @param camera The camera to apply the render pass to.
  63657. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63658. * @param engine The engine which the post process will be applied. (default: current engine)
  63659. * @param reusable If the post process can be reused on the same frame. (default: false)
  63660. * @param textureType Type of textures used when performing the post process. (default: 0)
  63661. * @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)
  63662. */
  63663. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63664. }
  63665. }
  63666. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  63667. /** @hidden */
  63668. export var circleOfConfusionPixelShader: {
  63669. name: string;
  63670. shader: string;
  63671. };
  63672. }
  63673. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  63674. import { Nullable } from "babylonjs/types";
  63675. import { Engine } from "babylonjs/Engines/engine";
  63676. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63677. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63678. import { Camera } from "babylonjs/Cameras/camera";
  63679. import "babylonjs/Shaders/circleOfConfusion.fragment";
  63680. /**
  63681. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  63682. */
  63683. export class CircleOfConfusionPostProcess extends PostProcess {
  63684. /**
  63685. * 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.
  63686. */
  63687. lensSize: number;
  63688. /**
  63689. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63690. */
  63691. fStop: number;
  63692. /**
  63693. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63694. */
  63695. focusDistance: number;
  63696. /**
  63697. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  63698. */
  63699. focalLength: number;
  63700. private _depthTexture;
  63701. /**
  63702. * Creates a new instance CircleOfConfusionPostProcess
  63703. * @param name The name of the effect.
  63704. * @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.
  63705. * @param options The required width/height ratio to downsize to before computing the render pass.
  63706. * @param camera The camera to apply the render pass to.
  63707. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63708. * @param engine The engine which the post process will be applied. (default: current engine)
  63709. * @param reusable If the post process can be reused on the same frame. (default: false)
  63710. * @param textureType Type of textures used when performing the post process. (default: 0)
  63711. * @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)
  63712. */
  63713. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63714. /**
  63715. * 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.
  63716. */
  63717. depthTexture: RenderTargetTexture;
  63718. }
  63719. }
  63720. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  63721. /** @hidden */
  63722. export var colorCorrectionPixelShader: {
  63723. name: string;
  63724. shader: string;
  63725. };
  63726. }
  63727. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  63728. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63729. import { Engine } from "babylonjs/Engines/engine";
  63730. import { Camera } from "babylonjs/Cameras/camera";
  63731. import "babylonjs/Shaders/colorCorrection.fragment";
  63732. /**
  63733. *
  63734. * This post-process allows the modification of rendered colors by using
  63735. * a 'look-up table' (LUT). This effect is also called Color Grading.
  63736. *
  63737. * The object needs to be provided an url to a texture containing the color
  63738. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  63739. * Use an image editing software to tweak the LUT to match your needs.
  63740. *
  63741. * For an example of a color LUT, see here:
  63742. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  63743. * For explanations on color grading, see here:
  63744. * @see http://udn.epicgames.com/Three/ColorGrading.html
  63745. *
  63746. */
  63747. export class ColorCorrectionPostProcess extends PostProcess {
  63748. private _colorTableTexture;
  63749. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63750. }
  63751. }
  63752. declare module "babylonjs/Shaders/convolution.fragment" {
  63753. /** @hidden */
  63754. export var convolutionPixelShader: {
  63755. name: string;
  63756. shader: string;
  63757. };
  63758. }
  63759. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  63760. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63761. import { Nullable } from "babylonjs/types";
  63762. import { Camera } from "babylonjs/Cameras/camera";
  63763. import { Engine } from "babylonjs/Engines/engine";
  63764. import "babylonjs/Shaders/convolution.fragment";
  63765. /**
  63766. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  63767. * input texture to perform effects such as edge detection or sharpening
  63768. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63769. */
  63770. export class ConvolutionPostProcess extends PostProcess {
  63771. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63772. kernel: number[];
  63773. /**
  63774. * Creates a new instance ConvolutionPostProcess
  63775. * @param name The name of the effect.
  63776. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  63777. * @param options The required width/height ratio to downsize to before computing the render pass.
  63778. * @param camera The camera to apply the render pass to.
  63779. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63780. * @param engine The engine which the post process will be applied. (default: current engine)
  63781. * @param reusable If the post process can be reused on the same frame. (default: false)
  63782. * @param textureType Type of textures used when performing the post process. (default: 0)
  63783. */
  63784. constructor(name: string,
  63785. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63786. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63787. /**
  63788. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63789. */
  63790. static EdgeDetect0Kernel: number[];
  63791. /**
  63792. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63793. */
  63794. static EdgeDetect1Kernel: number[];
  63795. /**
  63796. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63797. */
  63798. static EdgeDetect2Kernel: number[];
  63799. /**
  63800. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63801. */
  63802. static SharpenKernel: number[];
  63803. /**
  63804. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63805. */
  63806. static EmbossKernel: number[];
  63807. /**
  63808. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63809. */
  63810. static GaussianKernel: number[];
  63811. }
  63812. }
  63813. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  63814. import { Nullable } from "babylonjs/types";
  63815. import { Vector2 } from "babylonjs/Maths/math.vector";
  63816. import { Camera } from "babylonjs/Cameras/camera";
  63817. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63818. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  63819. import { Engine } from "babylonjs/Engines/engine";
  63820. import { Scene } from "babylonjs/scene";
  63821. /**
  63822. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  63823. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  63824. * based on samples that have a large difference in distance than the center pixel.
  63825. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  63826. */
  63827. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  63828. direction: Vector2;
  63829. /**
  63830. * Creates a new instance CircleOfConfusionPostProcess
  63831. * @param name The name of the effect.
  63832. * @param scene The scene the effect belongs to.
  63833. * @param direction The direction the blur should be applied.
  63834. * @param kernel The size of the kernel used to blur.
  63835. * @param options The required width/height ratio to downsize to before computing the render pass.
  63836. * @param camera The camera to apply the render pass to.
  63837. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  63838. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  63839. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63840. * @param engine The engine which the post process will be applied. (default: current engine)
  63841. * @param reusable If the post process can be reused on the same frame. (default: false)
  63842. * @param textureType Type of textures used when performing the post process. (default: 0)
  63843. * @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)
  63844. */
  63845. 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);
  63846. }
  63847. }
  63848. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  63849. /** @hidden */
  63850. export var depthOfFieldMergePixelShader: {
  63851. name: string;
  63852. shader: string;
  63853. };
  63854. }
  63855. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  63856. import { Nullable } from "babylonjs/types";
  63857. import { Camera } from "babylonjs/Cameras/camera";
  63858. import { Effect } from "babylonjs/Materials/effect";
  63859. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63860. import { Engine } from "babylonjs/Engines/engine";
  63861. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  63862. /**
  63863. * Options to be set when merging outputs from the default pipeline.
  63864. */
  63865. export class DepthOfFieldMergePostProcessOptions {
  63866. /**
  63867. * The original image to merge on top of
  63868. */
  63869. originalFromInput: PostProcess;
  63870. /**
  63871. * Parameters to perform the merge of the depth of field effect
  63872. */
  63873. depthOfField?: {
  63874. circleOfConfusion: PostProcess;
  63875. blurSteps: Array<PostProcess>;
  63876. };
  63877. /**
  63878. * Parameters to perform the merge of bloom effect
  63879. */
  63880. bloom?: {
  63881. blurred: PostProcess;
  63882. weight: number;
  63883. };
  63884. }
  63885. /**
  63886. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63887. */
  63888. export class DepthOfFieldMergePostProcess extends PostProcess {
  63889. private blurSteps;
  63890. /**
  63891. * Creates a new instance of DepthOfFieldMergePostProcess
  63892. * @param name The name of the effect.
  63893. * @param originalFromInput Post process which's input will be used for the merge.
  63894. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  63895. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  63896. * @param options The required width/height ratio to downsize to before computing the render pass.
  63897. * @param camera The camera to apply the render pass to.
  63898. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63899. * @param engine The engine which the post process will be applied. (default: current engine)
  63900. * @param reusable If the post process can be reused on the same frame. (default: false)
  63901. * @param textureType Type of textures used when performing the post process. (default: 0)
  63902. * @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)
  63903. */
  63904. 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);
  63905. /**
  63906. * Updates the effect with the current post process compile time values and recompiles the shader.
  63907. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  63908. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  63909. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  63910. * @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
  63911. * @param onCompiled Called when the shader has been compiled.
  63912. * @param onError Called if there is an error when compiling a shader.
  63913. */
  63914. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  63915. }
  63916. }
  63917. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  63918. import { Nullable } from "babylonjs/types";
  63919. import { Camera } from "babylonjs/Cameras/camera";
  63920. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63921. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63922. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63923. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  63924. import { Scene } from "babylonjs/scene";
  63925. /**
  63926. * Specifies the level of max blur that should be applied when using the depth of field effect
  63927. */
  63928. export enum DepthOfFieldEffectBlurLevel {
  63929. /**
  63930. * Subtle blur
  63931. */
  63932. Low = 0,
  63933. /**
  63934. * Medium blur
  63935. */
  63936. Medium = 1,
  63937. /**
  63938. * Large blur
  63939. */
  63940. High = 2
  63941. }
  63942. /**
  63943. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  63944. */
  63945. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  63946. private _circleOfConfusion;
  63947. /**
  63948. * @hidden Internal, blurs from high to low
  63949. */
  63950. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  63951. private _depthOfFieldBlurY;
  63952. private _dofMerge;
  63953. /**
  63954. * @hidden Internal post processes in depth of field effect
  63955. */
  63956. _effects: Array<PostProcess>;
  63957. /**
  63958. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  63959. */
  63960. focalLength: number;
  63961. /**
  63962. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63963. */
  63964. fStop: number;
  63965. /**
  63966. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63967. */
  63968. focusDistance: number;
  63969. /**
  63970. * 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.
  63971. */
  63972. lensSize: number;
  63973. /**
  63974. * Creates a new instance DepthOfFieldEffect
  63975. * @param scene The scene the effect belongs to.
  63976. * @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.
  63977. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63978. * @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)
  63979. */
  63980. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  63981. /**
  63982. * Get the current class name of the current effet
  63983. * @returns "DepthOfFieldEffect"
  63984. */
  63985. getClassName(): string;
  63986. /**
  63987. * 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.
  63988. */
  63989. depthTexture: RenderTargetTexture;
  63990. /**
  63991. * Disposes each of the internal effects for a given camera.
  63992. * @param camera The camera to dispose the effect on.
  63993. */
  63994. disposeEffects(camera: Camera): void;
  63995. /**
  63996. * @hidden Internal
  63997. */
  63998. _updateEffects(): void;
  63999. /**
  64000. * Internal
  64001. * @returns if all the contained post processes are ready.
  64002. * @hidden
  64003. */
  64004. _isReady(): boolean;
  64005. }
  64006. }
  64007. declare module "babylonjs/Shaders/displayPass.fragment" {
  64008. /** @hidden */
  64009. export var displayPassPixelShader: {
  64010. name: string;
  64011. shader: string;
  64012. };
  64013. }
  64014. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  64015. import { Nullable } from "babylonjs/types";
  64016. import { Camera } from "babylonjs/Cameras/camera";
  64017. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64018. import { Engine } from "babylonjs/Engines/engine";
  64019. import "babylonjs/Shaders/displayPass.fragment";
  64020. /**
  64021. * DisplayPassPostProcess which produces an output the same as it's input
  64022. */
  64023. export class DisplayPassPostProcess extends PostProcess {
  64024. /**
  64025. * Creates the DisplayPassPostProcess
  64026. * @param name The name of the effect.
  64027. * @param options The required width/height ratio to downsize to before computing the render pass.
  64028. * @param camera The camera to apply the render pass to.
  64029. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64030. * @param engine The engine which the post process will be applied. (default: current engine)
  64031. * @param reusable If the post process can be reused on the same frame. (default: false)
  64032. */
  64033. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  64034. }
  64035. }
  64036. declare module "babylonjs/Shaders/filter.fragment" {
  64037. /** @hidden */
  64038. export var filterPixelShader: {
  64039. name: string;
  64040. shader: string;
  64041. };
  64042. }
  64043. declare module "babylonjs/PostProcesses/filterPostProcess" {
  64044. import { Nullable } from "babylonjs/types";
  64045. import { Matrix } from "babylonjs/Maths/math.vector";
  64046. import { Camera } from "babylonjs/Cameras/camera";
  64047. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64048. import { Engine } from "babylonjs/Engines/engine";
  64049. import "babylonjs/Shaders/filter.fragment";
  64050. /**
  64051. * Applies a kernel filter to the image
  64052. */
  64053. export class FilterPostProcess extends PostProcess {
  64054. /** The matrix to be applied to the image */
  64055. kernelMatrix: Matrix;
  64056. /**
  64057. *
  64058. * @param name The name of the effect.
  64059. * @param kernelMatrix The matrix to be applied to the image
  64060. * @param options The required width/height ratio to downsize to before computing the render pass.
  64061. * @param camera The camera to apply the render pass to.
  64062. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64063. * @param engine The engine which the post process will be applied. (default: current engine)
  64064. * @param reusable If the post process can be reused on the same frame. (default: false)
  64065. */
  64066. constructor(name: string,
  64067. /** The matrix to be applied to the image */
  64068. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  64069. }
  64070. }
  64071. declare module "babylonjs/Shaders/fxaa.fragment" {
  64072. /** @hidden */
  64073. export var fxaaPixelShader: {
  64074. name: string;
  64075. shader: string;
  64076. };
  64077. }
  64078. declare module "babylonjs/Shaders/fxaa.vertex" {
  64079. /** @hidden */
  64080. export var fxaaVertexShader: {
  64081. name: string;
  64082. shader: string;
  64083. };
  64084. }
  64085. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  64086. import { Nullable } from "babylonjs/types";
  64087. import { Camera } from "babylonjs/Cameras/camera";
  64088. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64089. import { Engine } from "babylonjs/Engines/engine";
  64090. import "babylonjs/Shaders/fxaa.fragment";
  64091. import "babylonjs/Shaders/fxaa.vertex";
  64092. /**
  64093. * Fxaa post process
  64094. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  64095. */
  64096. export class FxaaPostProcess extends PostProcess {
  64097. /** @hidden */
  64098. texelWidth: number;
  64099. /** @hidden */
  64100. texelHeight: number;
  64101. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  64102. private _getDefines;
  64103. }
  64104. }
  64105. declare module "babylonjs/Shaders/grain.fragment" {
  64106. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  64107. /** @hidden */
  64108. export var grainPixelShader: {
  64109. name: string;
  64110. shader: string;
  64111. };
  64112. }
  64113. declare module "babylonjs/PostProcesses/grainPostProcess" {
  64114. import { Nullable } from "babylonjs/types";
  64115. import { Camera } from "babylonjs/Cameras/camera";
  64116. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64117. import { Engine } from "babylonjs/Engines/engine";
  64118. import "babylonjs/Shaders/grain.fragment";
  64119. /**
  64120. * The GrainPostProcess adds noise to the image at mid luminance levels
  64121. */
  64122. export class GrainPostProcess extends PostProcess {
  64123. /**
  64124. * The intensity of the grain added (default: 30)
  64125. */
  64126. intensity: number;
  64127. /**
  64128. * If the grain should be randomized on every frame
  64129. */
  64130. animated: boolean;
  64131. /**
  64132. * Creates a new instance of @see GrainPostProcess
  64133. * @param name The name of the effect.
  64134. * @param options The required width/height ratio to downsize to before computing the render pass.
  64135. * @param camera The camera to apply the render pass to.
  64136. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64137. * @param engine The engine which the post process will be applied. (default: current engine)
  64138. * @param reusable If the post process can be reused on the same frame. (default: false)
  64139. * @param textureType Type of textures used when performing the post process. (default: 0)
  64140. * @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)
  64141. */
  64142. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64143. }
  64144. }
  64145. declare module "babylonjs/Shaders/highlights.fragment" {
  64146. /** @hidden */
  64147. export var highlightsPixelShader: {
  64148. name: string;
  64149. shader: string;
  64150. };
  64151. }
  64152. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  64153. import { Nullable } from "babylonjs/types";
  64154. import { Camera } from "babylonjs/Cameras/camera";
  64155. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64156. import { Engine } from "babylonjs/Engines/engine";
  64157. import "babylonjs/Shaders/highlights.fragment";
  64158. /**
  64159. * Extracts highlights from the image
  64160. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  64161. */
  64162. export class HighlightsPostProcess extends PostProcess {
  64163. /**
  64164. * Extracts highlights from the image
  64165. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  64166. * @param name The name of the effect.
  64167. * @param options The required width/height ratio to downsize to before computing the render pass.
  64168. * @param camera The camera to apply the render pass to.
  64169. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64170. * @param engine The engine which the post process will be applied. (default: current engine)
  64171. * @param reusable If the post process can be reused on the same frame. (default: false)
  64172. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  64173. */
  64174. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  64175. }
  64176. }
  64177. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  64178. /** @hidden */
  64179. export var mrtFragmentDeclaration: {
  64180. name: string;
  64181. shader: string;
  64182. };
  64183. }
  64184. declare module "babylonjs/Shaders/geometry.fragment" {
  64185. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  64186. /** @hidden */
  64187. export var geometryPixelShader: {
  64188. name: string;
  64189. shader: string;
  64190. };
  64191. }
  64192. declare module "babylonjs/Shaders/geometry.vertex" {
  64193. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  64194. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  64195. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  64196. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  64197. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  64198. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  64199. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  64200. /** @hidden */
  64201. export var geometryVertexShader: {
  64202. name: string;
  64203. shader: string;
  64204. };
  64205. }
  64206. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  64207. import { Matrix } from "babylonjs/Maths/math.vector";
  64208. import { SubMesh } from "babylonjs/Meshes/subMesh";
  64209. import { Mesh } from "babylonjs/Meshes/mesh";
  64210. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  64211. import { Effect } from "babylonjs/Materials/effect";
  64212. import { Scene } from "babylonjs/scene";
  64213. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64214. import "babylonjs/Shaders/geometry.fragment";
  64215. import "babylonjs/Shaders/geometry.vertex";
  64216. /** @hidden */
  64217. interface ISavedTransformationMatrix {
  64218. world: Matrix;
  64219. viewProjection: Matrix;
  64220. }
  64221. /**
  64222. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  64223. */
  64224. export class GeometryBufferRenderer {
  64225. /**
  64226. * Constant used to retrieve the position texture index in the G-Buffer textures array
  64227. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  64228. */
  64229. static readonly POSITION_TEXTURE_TYPE: number;
  64230. /**
  64231. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  64232. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  64233. */
  64234. static readonly VELOCITY_TEXTURE_TYPE: number;
  64235. /**
  64236. * Dictionary used to store the previous transformation matrices of each rendered mesh
  64237. * in order to compute objects velocities when enableVelocity is set to "true"
  64238. * @hidden
  64239. */
  64240. _previousTransformationMatrices: {
  64241. [index: number]: ISavedTransformationMatrix;
  64242. };
  64243. /**
  64244. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  64245. * in order to compute objects velocities when enableVelocity is set to "true"
  64246. * @hidden
  64247. */
  64248. _previousBonesTransformationMatrices: {
  64249. [index: number]: Float32Array;
  64250. };
  64251. /**
  64252. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  64253. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  64254. */
  64255. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  64256. private _scene;
  64257. private _multiRenderTarget;
  64258. private _ratio;
  64259. private _enablePosition;
  64260. private _enableVelocity;
  64261. private _positionIndex;
  64262. private _velocityIndex;
  64263. protected _effect: Effect;
  64264. protected _cachedDefines: string;
  64265. /**
  64266. * Set the render list (meshes to be rendered) used in the G buffer.
  64267. */
  64268. renderList: Mesh[];
  64269. /**
  64270. * Gets wether or not G buffer are supported by the running hardware.
  64271. * This requires draw buffer supports
  64272. */
  64273. readonly isSupported: boolean;
  64274. /**
  64275. * Returns the index of the given texture type in the G-Buffer textures array
  64276. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  64277. * @returns the index of the given texture type in the G-Buffer textures array
  64278. */
  64279. getTextureIndex(textureType: number): number;
  64280. /**
  64281. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  64282. */
  64283. /**
  64284. * Sets whether or not objects positions are enabled for the G buffer.
  64285. */
  64286. enablePosition: boolean;
  64287. /**
  64288. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  64289. */
  64290. /**
  64291. * Sets wether or not objects velocities are enabled for the G buffer.
  64292. */
  64293. enableVelocity: boolean;
  64294. /**
  64295. * Gets the scene associated with the buffer.
  64296. */
  64297. readonly scene: Scene;
  64298. /**
  64299. * Gets the ratio used by the buffer during its creation.
  64300. * How big is the buffer related to the main canvas.
  64301. */
  64302. readonly ratio: number;
  64303. /** @hidden */
  64304. static _SceneComponentInitialization: (scene: Scene) => void;
  64305. /**
  64306. * Creates a new G Buffer for the scene
  64307. * @param scene The scene the buffer belongs to
  64308. * @param ratio How big is the buffer related to the main canvas.
  64309. */
  64310. constructor(scene: Scene, ratio?: number);
  64311. /**
  64312. * Checks wether everything is ready to render a submesh to the G buffer.
  64313. * @param subMesh the submesh to check readiness for
  64314. * @param useInstances is the mesh drawn using instance or not
  64315. * @returns true if ready otherwise false
  64316. */
  64317. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  64318. /**
  64319. * Gets the current underlying G Buffer.
  64320. * @returns the buffer
  64321. */
  64322. getGBuffer(): MultiRenderTarget;
  64323. /**
  64324. * Gets the number of samples used to render the buffer (anti aliasing).
  64325. */
  64326. /**
  64327. * Sets the number of samples used to render the buffer (anti aliasing).
  64328. */
  64329. samples: number;
  64330. /**
  64331. * Disposes the renderer and frees up associated resources.
  64332. */
  64333. dispose(): void;
  64334. protected _createRenderTargets(): void;
  64335. private _copyBonesTransformationMatrices;
  64336. }
  64337. }
  64338. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  64339. import { Nullable } from "babylonjs/types";
  64340. import { Scene } from "babylonjs/scene";
  64341. import { ISceneComponent } from "babylonjs/sceneComponent";
  64342. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  64343. module "babylonjs/scene" {
  64344. interface Scene {
  64345. /** @hidden (Backing field) */
  64346. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  64347. /**
  64348. * Gets or Sets the current geometry buffer associated to the scene.
  64349. */
  64350. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  64351. /**
  64352. * Enables a GeometryBufferRender and associates it with the scene
  64353. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  64354. * @returns the GeometryBufferRenderer
  64355. */
  64356. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  64357. /**
  64358. * Disables the GeometryBufferRender associated with the scene
  64359. */
  64360. disableGeometryBufferRenderer(): void;
  64361. }
  64362. }
  64363. /**
  64364. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  64365. * in several rendering techniques.
  64366. */
  64367. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  64368. /**
  64369. * The component name helpful to identify the component in the list of scene components.
  64370. */
  64371. readonly name: string;
  64372. /**
  64373. * The scene the component belongs to.
  64374. */
  64375. scene: Scene;
  64376. /**
  64377. * Creates a new instance of the component for the given scene
  64378. * @param scene Defines the scene to register the component in
  64379. */
  64380. constructor(scene: Scene);
  64381. /**
  64382. * Registers the component in a given scene
  64383. */
  64384. register(): void;
  64385. /**
  64386. * Rebuilds the elements related to this component in case of
  64387. * context lost for instance.
  64388. */
  64389. rebuild(): void;
  64390. /**
  64391. * Disposes the component and the associated ressources
  64392. */
  64393. dispose(): void;
  64394. private _gatherRenderTargets;
  64395. }
  64396. }
  64397. declare module "babylonjs/Shaders/motionBlur.fragment" {
  64398. /** @hidden */
  64399. export var motionBlurPixelShader: {
  64400. name: string;
  64401. shader: string;
  64402. };
  64403. }
  64404. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  64405. import { Nullable } from "babylonjs/types";
  64406. import { Camera } from "babylonjs/Cameras/camera";
  64407. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64408. import { Scene } from "babylonjs/scene";
  64409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64410. import "babylonjs/Animations/animatable";
  64411. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  64412. import "babylonjs/Shaders/motionBlur.fragment";
  64413. import { Engine } from "babylonjs/Engines/engine";
  64414. /**
  64415. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  64416. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  64417. * As an example, all you have to do is to create the post-process:
  64418. * var mb = new BABYLON.MotionBlurPostProcess(
  64419. * 'mb', // The name of the effect.
  64420. * scene, // The scene containing the objects to blur according to their velocity.
  64421. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  64422. * camera // The camera to apply the render pass to.
  64423. * );
  64424. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  64425. */
  64426. export class MotionBlurPostProcess extends PostProcess {
  64427. /**
  64428. * Defines how much the image is blurred by the movement. Default value is equal to 1
  64429. */
  64430. motionStrength: number;
  64431. /**
  64432. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  64433. */
  64434. /**
  64435. * Sets the number of iterations to be used for motion blur quality
  64436. */
  64437. motionBlurSamples: number;
  64438. private _motionBlurSamples;
  64439. private _geometryBufferRenderer;
  64440. /**
  64441. * Creates a new instance MotionBlurPostProcess
  64442. * @param name The name of the effect.
  64443. * @param scene The scene containing the objects to blur according to their velocity.
  64444. * @param options The required width/height ratio to downsize to before computing the render pass.
  64445. * @param camera The camera to apply the render pass to.
  64446. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64447. * @param engine The engine which the post process will be applied. (default: current engine)
  64448. * @param reusable If the post process can be reused on the same frame. (default: false)
  64449. * @param textureType Type of textures used when performing the post process. (default: 0)
  64450. * @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)
  64451. */
  64452. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64453. /**
  64454. * Excludes the given skinned mesh from computing bones velocities.
  64455. * 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.
  64456. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  64457. */
  64458. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  64459. /**
  64460. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  64461. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  64462. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  64463. */
  64464. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  64465. /**
  64466. * Disposes the post process.
  64467. * @param camera The camera to dispose the post process on.
  64468. */
  64469. dispose(camera?: Camera): void;
  64470. }
  64471. }
  64472. declare module "babylonjs/Shaders/refraction.fragment" {
  64473. /** @hidden */
  64474. export var refractionPixelShader: {
  64475. name: string;
  64476. shader: string;
  64477. };
  64478. }
  64479. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  64480. import { Color3 } from "babylonjs/Maths/math.color";
  64481. import { Camera } from "babylonjs/Cameras/camera";
  64482. import { Texture } from "babylonjs/Materials/Textures/texture";
  64483. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64484. import { Engine } from "babylonjs/Engines/engine";
  64485. import "babylonjs/Shaders/refraction.fragment";
  64486. /**
  64487. * Post process which applies a refractin texture
  64488. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  64489. */
  64490. export class RefractionPostProcess extends PostProcess {
  64491. /** the base color of the refraction (used to taint the rendering) */
  64492. color: Color3;
  64493. /** simulated refraction depth */
  64494. depth: number;
  64495. /** the coefficient of the base color (0 to remove base color tainting) */
  64496. colorLevel: number;
  64497. private _refTexture;
  64498. private _ownRefractionTexture;
  64499. /**
  64500. * Gets or sets the refraction texture
  64501. * Please note that you are responsible for disposing the texture if you set it manually
  64502. */
  64503. refractionTexture: Texture;
  64504. /**
  64505. * Initializes the RefractionPostProcess
  64506. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  64507. * @param name The name of the effect.
  64508. * @param refractionTextureUrl Url of the refraction texture to use
  64509. * @param color the base color of the refraction (used to taint the rendering)
  64510. * @param depth simulated refraction depth
  64511. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  64512. * @param camera The camera to apply the render pass to.
  64513. * @param options The required width/height ratio to downsize to before computing the render pass.
  64514. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64515. * @param engine The engine which the post process will be applied. (default: current engine)
  64516. * @param reusable If the post process can be reused on the same frame. (default: false)
  64517. */
  64518. constructor(name: string, refractionTextureUrl: string,
  64519. /** the base color of the refraction (used to taint the rendering) */
  64520. color: Color3,
  64521. /** simulated refraction depth */
  64522. depth: number,
  64523. /** the coefficient of the base color (0 to remove base color tainting) */
  64524. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  64525. /**
  64526. * Disposes of the post process
  64527. * @param camera Camera to dispose post process on
  64528. */
  64529. dispose(camera: Camera): void;
  64530. }
  64531. }
  64532. declare module "babylonjs/Shaders/sharpen.fragment" {
  64533. /** @hidden */
  64534. export var sharpenPixelShader: {
  64535. name: string;
  64536. shader: string;
  64537. };
  64538. }
  64539. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  64540. import { Nullable } from "babylonjs/types";
  64541. import { Camera } from "babylonjs/Cameras/camera";
  64542. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64543. import "babylonjs/Shaders/sharpen.fragment";
  64544. import { Engine } from "babylonjs/Engines/engine";
  64545. /**
  64546. * The SharpenPostProcess applies a sharpen kernel to every pixel
  64547. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  64548. */
  64549. export class SharpenPostProcess extends PostProcess {
  64550. /**
  64551. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  64552. */
  64553. colorAmount: number;
  64554. /**
  64555. * How much sharpness should be applied (default: 0.3)
  64556. */
  64557. edgeAmount: number;
  64558. /**
  64559. * Creates a new instance ConvolutionPostProcess
  64560. * @param name The name of the effect.
  64561. * @param options The required width/height ratio to downsize to before computing the render pass.
  64562. * @param camera The camera to apply the render pass to.
  64563. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64564. * @param engine The engine which the post process will be applied. (default: current engine)
  64565. * @param reusable If the post process can be reused on the same frame. (default: false)
  64566. * @param textureType Type of textures used when performing the post process. (default: 0)
  64567. * @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)
  64568. */
  64569. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64570. }
  64571. }
  64572. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  64573. import { Nullable } from "babylonjs/types";
  64574. import { Camera } from "babylonjs/Cameras/camera";
  64575. import { Engine } from "babylonjs/Engines/engine";
  64576. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  64577. import { IInspectable } from "babylonjs/Misc/iInspectable";
  64578. /**
  64579. * PostProcessRenderPipeline
  64580. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64581. */
  64582. export class PostProcessRenderPipeline {
  64583. private engine;
  64584. private _renderEffects;
  64585. private _renderEffectsForIsolatedPass;
  64586. /**
  64587. * List of inspectable custom properties (used by the Inspector)
  64588. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  64589. */
  64590. inspectableCustomProperties: IInspectable[];
  64591. /**
  64592. * @hidden
  64593. */
  64594. protected _cameras: Camera[];
  64595. /** @hidden */
  64596. _name: string;
  64597. /**
  64598. * Gets pipeline name
  64599. */
  64600. readonly name: string;
  64601. /** Gets the list of attached cameras */
  64602. readonly cameras: Camera[];
  64603. /**
  64604. * Initializes a PostProcessRenderPipeline
  64605. * @param engine engine to add the pipeline to
  64606. * @param name name of the pipeline
  64607. */
  64608. constructor(engine: Engine, name: string);
  64609. /**
  64610. * Gets the class name
  64611. * @returns "PostProcessRenderPipeline"
  64612. */
  64613. getClassName(): string;
  64614. /**
  64615. * If all the render effects in the pipeline are supported
  64616. */
  64617. readonly isSupported: boolean;
  64618. /**
  64619. * Adds an effect to the pipeline
  64620. * @param renderEffect the effect to add
  64621. */
  64622. addEffect(renderEffect: PostProcessRenderEffect): void;
  64623. /** @hidden */
  64624. _rebuild(): void;
  64625. /** @hidden */
  64626. _enableEffect(renderEffectName: string, cameras: Camera): void;
  64627. /** @hidden */
  64628. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  64629. /** @hidden */
  64630. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64631. /** @hidden */
  64632. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64633. /** @hidden */
  64634. _attachCameras(cameras: Camera, unique: boolean): void;
  64635. /** @hidden */
  64636. _attachCameras(cameras: Camera[], unique: boolean): void;
  64637. /** @hidden */
  64638. _detachCameras(cameras: Camera): void;
  64639. /** @hidden */
  64640. _detachCameras(cameras: Nullable<Camera[]>): void;
  64641. /** @hidden */
  64642. _update(): void;
  64643. /** @hidden */
  64644. _reset(): void;
  64645. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  64646. /**
  64647. * Disposes of the pipeline
  64648. */
  64649. dispose(): void;
  64650. }
  64651. }
  64652. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  64653. import { Camera } from "babylonjs/Cameras/camera";
  64654. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64655. /**
  64656. * PostProcessRenderPipelineManager class
  64657. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64658. */
  64659. export class PostProcessRenderPipelineManager {
  64660. private _renderPipelines;
  64661. /**
  64662. * Initializes a PostProcessRenderPipelineManager
  64663. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64664. */
  64665. constructor();
  64666. /**
  64667. * Gets the list of supported render pipelines
  64668. */
  64669. readonly supportedPipelines: PostProcessRenderPipeline[];
  64670. /**
  64671. * Adds a pipeline to the manager
  64672. * @param renderPipeline The pipeline to add
  64673. */
  64674. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  64675. /**
  64676. * Attaches a camera to the pipeline
  64677. * @param renderPipelineName The name of the pipeline to attach to
  64678. * @param cameras the camera to attach
  64679. * @param unique if the camera can be attached multiple times to the pipeline
  64680. */
  64681. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  64682. /**
  64683. * Detaches a camera from the pipeline
  64684. * @param renderPipelineName The name of the pipeline to detach from
  64685. * @param cameras the camera to detach
  64686. */
  64687. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  64688. /**
  64689. * Enables an effect by name on a pipeline
  64690. * @param renderPipelineName the name of the pipeline to enable the effect in
  64691. * @param renderEffectName the name of the effect to enable
  64692. * @param cameras the cameras that the effect should be enabled on
  64693. */
  64694. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64695. /**
  64696. * Disables an effect by name on a pipeline
  64697. * @param renderPipelineName the name of the pipeline to disable the effect in
  64698. * @param renderEffectName the name of the effect to disable
  64699. * @param cameras the cameras that the effect should be disabled on
  64700. */
  64701. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64702. /**
  64703. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  64704. */
  64705. update(): void;
  64706. /** @hidden */
  64707. _rebuild(): void;
  64708. /**
  64709. * Disposes of the manager and pipelines
  64710. */
  64711. dispose(): void;
  64712. }
  64713. }
  64714. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  64715. import { ISceneComponent } from "babylonjs/sceneComponent";
  64716. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  64717. import { Scene } from "babylonjs/scene";
  64718. module "babylonjs/scene" {
  64719. interface Scene {
  64720. /** @hidden (Backing field) */
  64721. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64722. /**
  64723. * Gets the postprocess render pipeline manager
  64724. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64725. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64726. */
  64727. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64728. }
  64729. }
  64730. /**
  64731. * Defines the Render Pipeline scene component responsible to rendering pipelines
  64732. */
  64733. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  64734. /**
  64735. * The component name helpfull to identify the component in the list of scene components.
  64736. */
  64737. readonly name: string;
  64738. /**
  64739. * The scene the component belongs to.
  64740. */
  64741. scene: Scene;
  64742. /**
  64743. * Creates a new instance of the component for the given scene
  64744. * @param scene Defines the scene to register the component in
  64745. */
  64746. constructor(scene: Scene);
  64747. /**
  64748. * Registers the component in a given scene
  64749. */
  64750. register(): void;
  64751. /**
  64752. * Rebuilds the elements related to this component in case of
  64753. * context lost for instance.
  64754. */
  64755. rebuild(): void;
  64756. /**
  64757. * Disposes the component and the associated ressources
  64758. */
  64759. dispose(): void;
  64760. private _gatherRenderTargets;
  64761. }
  64762. }
  64763. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  64764. import { Nullable } from "babylonjs/types";
  64765. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64766. import { Camera } from "babylonjs/Cameras/camera";
  64767. import { IDisposable } from "babylonjs/scene";
  64768. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  64769. import { Scene } from "babylonjs/scene";
  64770. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  64771. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  64772. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  64773. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  64774. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64775. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64776. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  64777. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64778. import { Animation } from "babylonjs/Animations/animation";
  64779. /**
  64780. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  64781. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64782. */
  64783. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64784. private _scene;
  64785. private _camerasToBeAttached;
  64786. /**
  64787. * ID of the sharpen post process,
  64788. */
  64789. private readonly SharpenPostProcessId;
  64790. /**
  64791. * @ignore
  64792. * ID of the image processing post process;
  64793. */
  64794. readonly ImageProcessingPostProcessId: string;
  64795. /**
  64796. * @ignore
  64797. * ID of the Fast Approximate Anti-Aliasing post process;
  64798. */
  64799. readonly FxaaPostProcessId: string;
  64800. /**
  64801. * ID of the chromatic aberration post process,
  64802. */
  64803. private readonly ChromaticAberrationPostProcessId;
  64804. /**
  64805. * ID of the grain post process
  64806. */
  64807. private readonly GrainPostProcessId;
  64808. /**
  64809. * Sharpen post process which will apply a sharpen convolution to enhance edges
  64810. */
  64811. sharpen: SharpenPostProcess;
  64812. private _sharpenEffect;
  64813. private bloom;
  64814. /**
  64815. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  64816. */
  64817. depthOfField: DepthOfFieldEffect;
  64818. /**
  64819. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64820. */
  64821. fxaa: FxaaPostProcess;
  64822. /**
  64823. * Image post processing pass used to perform operations such as tone mapping or color grading.
  64824. */
  64825. imageProcessing: ImageProcessingPostProcess;
  64826. /**
  64827. * Chromatic aberration post process which will shift rgb colors in the image
  64828. */
  64829. chromaticAberration: ChromaticAberrationPostProcess;
  64830. private _chromaticAberrationEffect;
  64831. /**
  64832. * Grain post process which add noise to the image
  64833. */
  64834. grain: GrainPostProcess;
  64835. private _grainEffect;
  64836. /**
  64837. * Glow post process which adds a glow to emissive areas of the image
  64838. */
  64839. private _glowLayer;
  64840. /**
  64841. * Animations which can be used to tweak settings over a period of time
  64842. */
  64843. animations: Animation[];
  64844. private _imageProcessingConfigurationObserver;
  64845. private _sharpenEnabled;
  64846. private _bloomEnabled;
  64847. private _depthOfFieldEnabled;
  64848. private _depthOfFieldBlurLevel;
  64849. private _fxaaEnabled;
  64850. private _imageProcessingEnabled;
  64851. private _defaultPipelineTextureType;
  64852. private _bloomScale;
  64853. private _chromaticAberrationEnabled;
  64854. private _grainEnabled;
  64855. private _buildAllowed;
  64856. /**
  64857. * Gets active scene
  64858. */
  64859. readonly scene: Scene;
  64860. /**
  64861. * Enable or disable the sharpen process from the pipeline
  64862. */
  64863. sharpenEnabled: boolean;
  64864. private _resizeObserver;
  64865. private _hardwareScaleLevel;
  64866. private _bloomKernel;
  64867. /**
  64868. * Specifies the size of the bloom blur kernel, relative to the final output size
  64869. */
  64870. bloomKernel: number;
  64871. /**
  64872. * Specifies the weight of the bloom in the final rendering
  64873. */
  64874. private _bloomWeight;
  64875. /**
  64876. * Specifies the luma threshold for the area that will be blurred by the bloom
  64877. */
  64878. private _bloomThreshold;
  64879. private _hdr;
  64880. /**
  64881. * The strength of the bloom.
  64882. */
  64883. bloomWeight: number;
  64884. /**
  64885. * The strength of the bloom.
  64886. */
  64887. bloomThreshold: number;
  64888. /**
  64889. * The scale of the bloom, lower value will provide better performance.
  64890. */
  64891. bloomScale: number;
  64892. /**
  64893. * Enable or disable the bloom from the pipeline
  64894. */
  64895. bloomEnabled: boolean;
  64896. private _rebuildBloom;
  64897. /**
  64898. * If the depth of field is enabled.
  64899. */
  64900. depthOfFieldEnabled: boolean;
  64901. /**
  64902. * Blur level of the depth of field effect. (Higher blur will effect performance)
  64903. */
  64904. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  64905. /**
  64906. * If the anti aliasing is enabled.
  64907. */
  64908. fxaaEnabled: boolean;
  64909. private _samples;
  64910. /**
  64911. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  64912. */
  64913. samples: number;
  64914. /**
  64915. * If image processing is enabled.
  64916. */
  64917. imageProcessingEnabled: boolean;
  64918. /**
  64919. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  64920. */
  64921. glowLayerEnabled: boolean;
  64922. /**
  64923. * Gets the glow layer (or null if not defined)
  64924. */
  64925. readonly glowLayer: Nullable<GlowLayer>;
  64926. /**
  64927. * Enable or disable the chromaticAberration process from the pipeline
  64928. */
  64929. chromaticAberrationEnabled: boolean;
  64930. /**
  64931. * Enable or disable the grain process from the pipeline
  64932. */
  64933. grainEnabled: boolean;
  64934. /**
  64935. * @constructor
  64936. * @param name - The rendering pipeline name (default: "")
  64937. * @param hdr - If high dynamic range textures should be used (default: true)
  64938. * @param scene - The scene linked to this pipeline (default: the last created scene)
  64939. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  64940. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  64941. */
  64942. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  64943. /**
  64944. * Get the class name
  64945. * @returns "DefaultRenderingPipeline"
  64946. */
  64947. getClassName(): string;
  64948. /**
  64949. * Force the compilation of the entire pipeline.
  64950. */
  64951. prepare(): void;
  64952. private _hasCleared;
  64953. private _prevPostProcess;
  64954. private _prevPrevPostProcess;
  64955. private _setAutoClearAndTextureSharing;
  64956. private _depthOfFieldSceneObserver;
  64957. private _buildPipeline;
  64958. private _disposePostProcesses;
  64959. /**
  64960. * Adds a camera to the pipeline
  64961. * @param camera the camera to be added
  64962. */
  64963. addCamera(camera: Camera): void;
  64964. /**
  64965. * Removes a camera from the pipeline
  64966. * @param camera the camera to remove
  64967. */
  64968. removeCamera(camera: Camera): void;
  64969. /**
  64970. * Dispose of the pipeline and stop all post processes
  64971. */
  64972. dispose(): void;
  64973. /**
  64974. * Serialize the rendering pipeline (Used when exporting)
  64975. * @returns the serialized object
  64976. */
  64977. serialize(): any;
  64978. /**
  64979. * Parse the serialized pipeline
  64980. * @param source Source pipeline.
  64981. * @param scene The scene to load the pipeline to.
  64982. * @param rootUrl The URL of the serialized pipeline.
  64983. * @returns An instantiated pipeline from the serialized object.
  64984. */
  64985. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  64986. }
  64987. }
  64988. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  64989. /** @hidden */
  64990. export var lensHighlightsPixelShader: {
  64991. name: string;
  64992. shader: string;
  64993. };
  64994. }
  64995. declare module "babylonjs/Shaders/depthOfField.fragment" {
  64996. /** @hidden */
  64997. export var depthOfFieldPixelShader: {
  64998. name: string;
  64999. shader: string;
  65000. };
  65001. }
  65002. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  65003. import { Camera } from "babylonjs/Cameras/camera";
  65004. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65005. import { Scene } from "babylonjs/scene";
  65006. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65007. import "babylonjs/Shaders/chromaticAberration.fragment";
  65008. import "babylonjs/Shaders/lensHighlights.fragment";
  65009. import "babylonjs/Shaders/depthOfField.fragment";
  65010. /**
  65011. * BABYLON.JS Chromatic Aberration GLSL Shader
  65012. * Author: Olivier Guyot
  65013. * Separates very slightly R, G and B colors on the edges of the screen
  65014. * Inspired by Francois Tarlier & Martins Upitis
  65015. */
  65016. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  65017. /**
  65018. * @ignore
  65019. * The chromatic aberration PostProcess id in the pipeline
  65020. */
  65021. LensChromaticAberrationEffect: string;
  65022. /**
  65023. * @ignore
  65024. * The highlights enhancing PostProcess id in the pipeline
  65025. */
  65026. HighlightsEnhancingEffect: string;
  65027. /**
  65028. * @ignore
  65029. * The depth-of-field PostProcess id in the pipeline
  65030. */
  65031. LensDepthOfFieldEffect: string;
  65032. private _scene;
  65033. private _depthTexture;
  65034. private _grainTexture;
  65035. private _chromaticAberrationPostProcess;
  65036. private _highlightsPostProcess;
  65037. private _depthOfFieldPostProcess;
  65038. private _edgeBlur;
  65039. private _grainAmount;
  65040. private _chromaticAberration;
  65041. private _distortion;
  65042. private _highlightsGain;
  65043. private _highlightsThreshold;
  65044. private _dofDistance;
  65045. private _dofAperture;
  65046. private _dofDarken;
  65047. private _dofPentagon;
  65048. private _blurNoise;
  65049. /**
  65050. * @constructor
  65051. *
  65052. * Effect parameters are as follow:
  65053. * {
  65054. * chromatic_aberration: number; // from 0 to x (1 for realism)
  65055. * edge_blur: number; // from 0 to x (1 for realism)
  65056. * distortion: number; // from 0 to x (1 for realism)
  65057. * grain_amount: number; // from 0 to 1
  65058. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  65059. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  65060. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  65061. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  65062. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  65063. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  65064. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  65065. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  65066. * }
  65067. * Note: if an effect parameter is unset, effect is disabled
  65068. *
  65069. * @param name The rendering pipeline name
  65070. * @param parameters - An object containing all parameters (see above)
  65071. * @param scene The scene linked to this pipeline
  65072. * @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)
  65073. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65074. */
  65075. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  65076. /**
  65077. * Get the class name
  65078. * @returns "LensRenderingPipeline"
  65079. */
  65080. getClassName(): string;
  65081. /**
  65082. * Gets associated scene
  65083. */
  65084. readonly scene: Scene;
  65085. /**
  65086. * Gets or sets the edge blur
  65087. */
  65088. edgeBlur: number;
  65089. /**
  65090. * Gets or sets the grain amount
  65091. */
  65092. grainAmount: number;
  65093. /**
  65094. * Gets or sets the chromatic aberration amount
  65095. */
  65096. chromaticAberration: number;
  65097. /**
  65098. * Gets or sets the depth of field aperture
  65099. */
  65100. dofAperture: number;
  65101. /**
  65102. * Gets or sets the edge distortion
  65103. */
  65104. edgeDistortion: number;
  65105. /**
  65106. * Gets or sets the depth of field distortion
  65107. */
  65108. dofDistortion: number;
  65109. /**
  65110. * Gets or sets the darken out of focus amount
  65111. */
  65112. darkenOutOfFocus: number;
  65113. /**
  65114. * Gets or sets a boolean indicating if blur noise is enabled
  65115. */
  65116. blurNoise: boolean;
  65117. /**
  65118. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  65119. */
  65120. pentagonBokeh: boolean;
  65121. /**
  65122. * Gets or sets the highlight grain amount
  65123. */
  65124. highlightsGain: number;
  65125. /**
  65126. * Gets or sets the highlight threshold
  65127. */
  65128. highlightsThreshold: number;
  65129. /**
  65130. * Sets the amount of blur at the edges
  65131. * @param amount blur amount
  65132. */
  65133. setEdgeBlur(amount: number): void;
  65134. /**
  65135. * Sets edge blur to 0
  65136. */
  65137. disableEdgeBlur(): void;
  65138. /**
  65139. * Sets the amout of grain
  65140. * @param amount Amount of grain
  65141. */
  65142. setGrainAmount(amount: number): void;
  65143. /**
  65144. * Set grain amount to 0
  65145. */
  65146. disableGrain(): void;
  65147. /**
  65148. * Sets the chromatic aberration amount
  65149. * @param amount amount of chromatic aberration
  65150. */
  65151. setChromaticAberration(amount: number): void;
  65152. /**
  65153. * Sets chromatic aberration amount to 0
  65154. */
  65155. disableChromaticAberration(): void;
  65156. /**
  65157. * Sets the EdgeDistortion amount
  65158. * @param amount amount of EdgeDistortion
  65159. */
  65160. setEdgeDistortion(amount: number): void;
  65161. /**
  65162. * Sets edge distortion to 0
  65163. */
  65164. disableEdgeDistortion(): void;
  65165. /**
  65166. * Sets the FocusDistance amount
  65167. * @param amount amount of FocusDistance
  65168. */
  65169. setFocusDistance(amount: number): void;
  65170. /**
  65171. * Disables depth of field
  65172. */
  65173. disableDepthOfField(): void;
  65174. /**
  65175. * Sets the Aperture amount
  65176. * @param amount amount of Aperture
  65177. */
  65178. setAperture(amount: number): void;
  65179. /**
  65180. * Sets the DarkenOutOfFocus amount
  65181. * @param amount amount of DarkenOutOfFocus
  65182. */
  65183. setDarkenOutOfFocus(amount: number): void;
  65184. private _pentagonBokehIsEnabled;
  65185. /**
  65186. * Creates a pentagon bokeh effect
  65187. */
  65188. enablePentagonBokeh(): void;
  65189. /**
  65190. * Disables the pentagon bokeh effect
  65191. */
  65192. disablePentagonBokeh(): void;
  65193. /**
  65194. * Enables noise blur
  65195. */
  65196. enableNoiseBlur(): void;
  65197. /**
  65198. * Disables noise blur
  65199. */
  65200. disableNoiseBlur(): void;
  65201. /**
  65202. * Sets the HighlightsGain amount
  65203. * @param amount amount of HighlightsGain
  65204. */
  65205. setHighlightsGain(amount: number): void;
  65206. /**
  65207. * Sets the HighlightsThreshold amount
  65208. * @param amount amount of HighlightsThreshold
  65209. */
  65210. setHighlightsThreshold(amount: number): void;
  65211. /**
  65212. * Disables highlights
  65213. */
  65214. disableHighlights(): void;
  65215. /**
  65216. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  65217. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  65218. */
  65219. dispose(disableDepthRender?: boolean): void;
  65220. private _createChromaticAberrationPostProcess;
  65221. private _createHighlightsPostProcess;
  65222. private _createDepthOfFieldPostProcess;
  65223. private _createGrainTexture;
  65224. }
  65225. }
  65226. declare module "babylonjs/Shaders/ssao2.fragment" {
  65227. /** @hidden */
  65228. export var ssao2PixelShader: {
  65229. name: string;
  65230. shader: string;
  65231. };
  65232. }
  65233. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  65234. /** @hidden */
  65235. export var ssaoCombinePixelShader: {
  65236. name: string;
  65237. shader: string;
  65238. };
  65239. }
  65240. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  65241. import { Camera } from "babylonjs/Cameras/camera";
  65242. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65243. import { Scene } from "babylonjs/scene";
  65244. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65245. import "babylonjs/Shaders/ssao2.fragment";
  65246. import "babylonjs/Shaders/ssaoCombine.fragment";
  65247. /**
  65248. * Render pipeline to produce ssao effect
  65249. */
  65250. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  65251. /**
  65252. * @ignore
  65253. * The PassPostProcess id in the pipeline that contains the original scene color
  65254. */
  65255. SSAOOriginalSceneColorEffect: string;
  65256. /**
  65257. * @ignore
  65258. * The SSAO PostProcess id in the pipeline
  65259. */
  65260. SSAORenderEffect: string;
  65261. /**
  65262. * @ignore
  65263. * The horizontal blur PostProcess id in the pipeline
  65264. */
  65265. SSAOBlurHRenderEffect: string;
  65266. /**
  65267. * @ignore
  65268. * The vertical blur PostProcess id in the pipeline
  65269. */
  65270. SSAOBlurVRenderEffect: string;
  65271. /**
  65272. * @ignore
  65273. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  65274. */
  65275. SSAOCombineRenderEffect: string;
  65276. /**
  65277. * The output strength of the SSAO post-process. Default value is 1.0.
  65278. */
  65279. totalStrength: number;
  65280. /**
  65281. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  65282. */
  65283. maxZ: number;
  65284. /**
  65285. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  65286. */
  65287. minZAspect: number;
  65288. private _samples;
  65289. /**
  65290. * Number of samples used for the SSAO calculations. Default value is 8
  65291. */
  65292. samples: number;
  65293. private _textureSamples;
  65294. /**
  65295. * Number of samples to use for antialiasing
  65296. */
  65297. textureSamples: number;
  65298. /**
  65299. * Ratio object used for SSAO ratio and blur ratio
  65300. */
  65301. private _ratio;
  65302. /**
  65303. * Dynamically generated sphere sampler.
  65304. */
  65305. private _sampleSphere;
  65306. /**
  65307. * Blur filter offsets
  65308. */
  65309. private _samplerOffsets;
  65310. private _expensiveBlur;
  65311. /**
  65312. * If bilateral blur should be used
  65313. */
  65314. expensiveBlur: boolean;
  65315. /**
  65316. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  65317. */
  65318. radius: number;
  65319. /**
  65320. * The base color of the SSAO post-process
  65321. * The final result is "base + ssao" between [0, 1]
  65322. */
  65323. base: number;
  65324. /**
  65325. * Support test.
  65326. */
  65327. static readonly IsSupported: boolean;
  65328. private _scene;
  65329. private _depthTexture;
  65330. private _normalTexture;
  65331. private _randomTexture;
  65332. private _originalColorPostProcess;
  65333. private _ssaoPostProcess;
  65334. private _blurHPostProcess;
  65335. private _blurVPostProcess;
  65336. private _ssaoCombinePostProcess;
  65337. /**
  65338. * Gets active scene
  65339. */
  65340. readonly scene: Scene;
  65341. /**
  65342. * @constructor
  65343. * @param name The rendering pipeline name
  65344. * @param scene The scene linked to this pipeline
  65345. * @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 }
  65346. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65347. */
  65348. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  65349. /**
  65350. * Get the class name
  65351. * @returns "SSAO2RenderingPipeline"
  65352. */
  65353. getClassName(): string;
  65354. /**
  65355. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  65356. */
  65357. dispose(disableGeometryBufferRenderer?: boolean): void;
  65358. private _createBlurPostProcess;
  65359. /** @hidden */
  65360. _rebuild(): void;
  65361. private _bits;
  65362. private _radicalInverse_VdC;
  65363. private _hammersley;
  65364. private _hemisphereSample_uniform;
  65365. private _generateHemisphere;
  65366. private _createSSAOPostProcess;
  65367. private _createSSAOCombinePostProcess;
  65368. private _createRandomTexture;
  65369. /**
  65370. * Serialize the rendering pipeline (Used when exporting)
  65371. * @returns the serialized object
  65372. */
  65373. serialize(): any;
  65374. /**
  65375. * Parse the serialized pipeline
  65376. * @param source Source pipeline.
  65377. * @param scene The scene to load the pipeline to.
  65378. * @param rootUrl The URL of the serialized pipeline.
  65379. * @returns An instantiated pipeline from the serialized object.
  65380. */
  65381. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  65382. }
  65383. }
  65384. declare module "babylonjs/Shaders/ssao.fragment" {
  65385. /** @hidden */
  65386. export var ssaoPixelShader: {
  65387. name: string;
  65388. shader: string;
  65389. };
  65390. }
  65391. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  65392. import { Camera } from "babylonjs/Cameras/camera";
  65393. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65394. import { Scene } from "babylonjs/scene";
  65395. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65396. import "babylonjs/Shaders/ssao.fragment";
  65397. import "babylonjs/Shaders/ssaoCombine.fragment";
  65398. /**
  65399. * Render pipeline to produce ssao effect
  65400. */
  65401. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  65402. /**
  65403. * @ignore
  65404. * The PassPostProcess id in the pipeline that contains the original scene color
  65405. */
  65406. SSAOOriginalSceneColorEffect: string;
  65407. /**
  65408. * @ignore
  65409. * The SSAO PostProcess id in the pipeline
  65410. */
  65411. SSAORenderEffect: string;
  65412. /**
  65413. * @ignore
  65414. * The horizontal blur PostProcess id in the pipeline
  65415. */
  65416. SSAOBlurHRenderEffect: string;
  65417. /**
  65418. * @ignore
  65419. * The vertical blur PostProcess id in the pipeline
  65420. */
  65421. SSAOBlurVRenderEffect: string;
  65422. /**
  65423. * @ignore
  65424. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  65425. */
  65426. SSAOCombineRenderEffect: string;
  65427. /**
  65428. * The output strength of the SSAO post-process. Default value is 1.0.
  65429. */
  65430. totalStrength: number;
  65431. /**
  65432. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  65433. */
  65434. radius: number;
  65435. /**
  65436. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  65437. * Must not be equal to fallOff and superior to fallOff.
  65438. * Default value is 0.0075
  65439. */
  65440. area: number;
  65441. /**
  65442. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  65443. * Must not be equal to area and inferior to area.
  65444. * Default value is 0.000001
  65445. */
  65446. fallOff: number;
  65447. /**
  65448. * The base color of the SSAO post-process
  65449. * The final result is "base + ssao" between [0, 1]
  65450. */
  65451. base: number;
  65452. private _scene;
  65453. private _depthTexture;
  65454. private _randomTexture;
  65455. private _originalColorPostProcess;
  65456. private _ssaoPostProcess;
  65457. private _blurHPostProcess;
  65458. private _blurVPostProcess;
  65459. private _ssaoCombinePostProcess;
  65460. private _firstUpdate;
  65461. /**
  65462. * Gets active scene
  65463. */
  65464. readonly scene: Scene;
  65465. /**
  65466. * @constructor
  65467. * @param name - The rendering pipeline name
  65468. * @param scene - The scene linked to this pipeline
  65469. * @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 }
  65470. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  65471. */
  65472. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  65473. /**
  65474. * Get the class name
  65475. * @returns "SSAORenderingPipeline"
  65476. */
  65477. getClassName(): string;
  65478. /**
  65479. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  65480. */
  65481. dispose(disableDepthRender?: boolean): void;
  65482. private _createBlurPostProcess;
  65483. /** @hidden */
  65484. _rebuild(): void;
  65485. private _createSSAOPostProcess;
  65486. private _createSSAOCombinePostProcess;
  65487. private _createRandomTexture;
  65488. }
  65489. }
  65490. declare module "babylonjs/Shaders/standard.fragment" {
  65491. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  65492. /** @hidden */
  65493. export var standardPixelShader: {
  65494. name: string;
  65495. shader: string;
  65496. };
  65497. }
  65498. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  65499. import { Nullable } from "babylonjs/types";
  65500. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  65501. import { Camera } from "babylonjs/Cameras/camera";
  65502. import { Texture } from "babylonjs/Materials/Textures/texture";
  65503. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65504. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65505. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  65506. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  65507. import { IDisposable } from "babylonjs/scene";
  65508. import { SpotLight } from "babylonjs/Lights/spotLight";
  65509. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  65510. import { Scene } from "babylonjs/scene";
  65511. import { Animation } from "babylonjs/Animations/animation";
  65512. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65513. import "babylonjs/Shaders/standard.fragment";
  65514. /**
  65515. * Standard rendering pipeline
  65516. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65517. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  65518. */
  65519. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  65520. /**
  65521. * Public members
  65522. */
  65523. /**
  65524. * Post-process which contains the original scene color before the pipeline applies all the effects
  65525. */
  65526. originalPostProcess: Nullable<PostProcess>;
  65527. /**
  65528. * Post-process used to down scale an image x4
  65529. */
  65530. downSampleX4PostProcess: Nullable<PostProcess>;
  65531. /**
  65532. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  65533. */
  65534. brightPassPostProcess: Nullable<PostProcess>;
  65535. /**
  65536. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  65537. */
  65538. blurHPostProcesses: PostProcess[];
  65539. /**
  65540. * Post-process array storing all the vertical blur post-processes used by the pipeline
  65541. */
  65542. blurVPostProcesses: PostProcess[];
  65543. /**
  65544. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  65545. */
  65546. textureAdderPostProcess: Nullable<PostProcess>;
  65547. /**
  65548. * Post-process used to create volumetric lighting effect
  65549. */
  65550. volumetricLightPostProcess: Nullable<PostProcess>;
  65551. /**
  65552. * Post-process used to smooth the previous volumetric light post-process on the X axis
  65553. */
  65554. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  65555. /**
  65556. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  65557. */
  65558. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  65559. /**
  65560. * Post-process used to merge the volumetric light effect and the real scene color
  65561. */
  65562. volumetricLightMergePostProces: Nullable<PostProcess>;
  65563. /**
  65564. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  65565. */
  65566. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  65567. /**
  65568. * Base post-process used to calculate the average luminance of the final image for HDR
  65569. */
  65570. luminancePostProcess: Nullable<PostProcess>;
  65571. /**
  65572. * Post-processes used to create down sample post-processes in order to get
  65573. * the average luminance of the final image for HDR
  65574. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  65575. */
  65576. luminanceDownSamplePostProcesses: PostProcess[];
  65577. /**
  65578. * Post-process used to create a HDR effect (light adaptation)
  65579. */
  65580. hdrPostProcess: Nullable<PostProcess>;
  65581. /**
  65582. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  65583. */
  65584. textureAdderFinalPostProcess: Nullable<PostProcess>;
  65585. /**
  65586. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  65587. */
  65588. lensFlareFinalPostProcess: Nullable<PostProcess>;
  65589. /**
  65590. * Post-process used to merge the final HDR post-process and the real scene color
  65591. */
  65592. hdrFinalPostProcess: Nullable<PostProcess>;
  65593. /**
  65594. * Post-process used to create a lens flare effect
  65595. */
  65596. lensFlarePostProcess: Nullable<PostProcess>;
  65597. /**
  65598. * Post-process that merges the result of the lens flare post-process and the real scene color
  65599. */
  65600. lensFlareComposePostProcess: Nullable<PostProcess>;
  65601. /**
  65602. * Post-process used to create a motion blur effect
  65603. */
  65604. motionBlurPostProcess: Nullable<PostProcess>;
  65605. /**
  65606. * Post-process used to create a depth of field effect
  65607. */
  65608. depthOfFieldPostProcess: Nullable<PostProcess>;
  65609. /**
  65610. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  65611. */
  65612. fxaaPostProcess: Nullable<FxaaPostProcess>;
  65613. /**
  65614. * Represents the brightness threshold in order to configure the illuminated surfaces
  65615. */
  65616. brightThreshold: number;
  65617. /**
  65618. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  65619. */
  65620. blurWidth: number;
  65621. /**
  65622. * Sets if the blur for highlighted surfaces must be only horizontal
  65623. */
  65624. horizontalBlur: boolean;
  65625. /**
  65626. * Gets the overall exposure used by the pipeline
  65627. */
  65628. /**
  65629. * Sets the overall exposure used by the pipeline
  65630. */
  65631. exposure: number;
  65632. /**
  65633. * Texture used typically to simulate "dirty" on camera lens
  65634. */
  65635. lensTexture: Nullable<Texture>;
  65636. /**
  65637. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  65638. */
  65639. volumetricLightCoefficient: number;
  65640. /**
  65641. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  65642. */
  65643. volumetricLightPower: number;
  65644. /**
  65645. * Used the set the blur intensity to smooth the volumetric lights
  65646. */
  65647. volumetricLightBlurScale: number;
  65648. /**
  65649. * Light (spot or directional) used to generate the volumetric lights rays
  65650. * The source light must have a shadow generate so the pipeline can get its
  65651. * depth map
  65652. */
  65653. sourceLight: Nullable<SpotLight | DirectionalLight>;
  65654. /**
  65655. * For eye adaptation, represents the minimum luminance the eye can see
  65656. */
  65657. hdrMinimumLuminance: number;
  65658. /**
  65659. * For eye adaptation, represents the decrease luminance speed
  65660. */
  65661. hdrDecreaseRate: number;
  65662. /**
  65663. * For eye adaptation, represents the increase luminance speed
  65664. */
  65665. hdrIncreaseRate: number;
  65666. /**
  65667. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65668. */
  65669. /**
  65670. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65671. */
  65672. hdrAutoExposure: boolean;
  65673. /**
  65674. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  65675. */
  65676. lensColorTexture: Nullable<Texture>;
  65677. /**
  65678. * The overall strengh for the lens flare effect
  65679. */
  65680. lensFlareStrength: number;
  65681. /**
  65682. * Dispersion coefficient for lens flare ghosts
  65683. */
  65684. lensFlareGhostDispersal: number;
  65685. /**
  65686. * Main lens flare halo width
  65687. */
  65688. lensFlareHaloWidth: number;
  65689. /**
  65690. * Based on the lens distortion effect, defines how much the lens flare result
  65691. * is distorted
  65692. */
  65693. lensFlareDistortionStrength: number;
  65694. /**
  65695. * Configures the blur intensity used for for lens flare (halo)
  65696. */
  65697. lensFlareBlurWidth: number;
  65698. /**
  65699. * Lens star texture must be used to simulate rays on the flares and is available
  65700. * in the documentation
  65701. */
  65702. lensStarTexture: Nullable<Texture>;
  65703. /**
  65704. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  65705. * flare effect by taking account of the dirt texture
  65706. */
  65707. lensFlareDirtTexture: Nullable<Texture>;
  65708. /**
  65709. * Represents the focal length for the depth of field effect
  65710. */
  65711. depthOfFieldDistance: number;
  65712. /**
  65713. * Represents the blur intensity for the blurred part of the depth of field effect
  65714. */
  65715. depthOfFieldBlurWidth: number;
  65716. /**
  65717. * Gets how much the image is blurred by the movement while using the motion blur post-process
  65718. */
  65719. /**
  65720. * Sets how much the image is blurred by the movement while using the motion blur post-process
  65721. */
  65722. motionStrength: number;
  65723. /**
  65724. * Gets wether or not the motion blur post-process is object based or screen based.
  65725. */
  65726. /**
  65727. * Sets wether or not the motion blur post-process should be object based or screen based
  65728. */
  65729. objectBasedMotionBlur: boolean;
  65730. /**
  65731. * List of animations for the pipeline (IAnimatable implementation)
  65732. */
  65733. animations: Animation[];
  65734. /**
  65735. * Private members
  65736. */
  65737. private _scene;
  65738. private _currentDepthOfFieldSource;
  65739. private _basePostProcess;
  65740. private _fixedExposure;
  65741. private _currentExposure;
  65742. private _hdrAutoExposure;
  65743. private _hdrCurrentLuminance;
  65744. private _motionStrength;
  65745. private _isObjectBasedMotionBlur;
  65746. private _floatTextureType;
  65747. private _camerasToBeAttached;
  65748. private _ratio;
  65749. private _bloomEnabled;
  65750. private _depthOfFieldEnabled;
  65751. private _vlsEnabled;
  65752. private _lensFlareEnabled;
  65753. private _hdrEnabled;
  65754. private _motionBlurEnabled;
  65755. private _fxaaEnabled;
  65756. private _motionBlurSamples;
  65757. private _volumetricLightStepsCount;
  65758. private _samples;
  65759. /**
  65760. * @ignore
  65761. * Specifies if the bloom pipeline is enabled
  65762. */
  65763. BloomEnabled: boolean;
  65764. /**
  65765. * @ignore
  65766. * Specifies if the depth of field pipeline is enabed
  65767. */
  65768. DepthOfFieldEnabled: boolean;
  65769. /**
  65770. * @ignore
  65771. * Specifies if the lens flare pipeline is enabed
  65772. */
  65773. LensFlareEnabled: boolean;
  65774. /**
  65775. * @ignore
  65776. * Specifies if the HDR pipeline is enabled
  65777. */
  65778. HDREnabled: boolean;
  65779. /**
  65780. * @ignore
  65781. * Specifies if the volumetric lights scattering effect is enabled
  65782. */
  65783. VLSEnabled: boolean;
  65784. /**
  65785. * @ignore
  65786. * Specifies if the motion blur effect is enabled
  65787. */
  65788. MotionBlurEnabled: boolean;
  65789. /**
  65790. * Specifies if anti-aliasing is enabled
  65791. */
  65792. fxaaEnabled: boolean;
  65793. /**
  65794. * Specifies the number of steps used to calculate the volumetric lights
  65795. * Typically in interval [50, 200]
  65796. */
  65797. volumetricLightStepsCount: number;
  65798. /**
  65799. * Specifies the number of samples used for the motion blur effect
  65800. * Typically in interval [16, 64]
  65801. */
  65802. motionBlurSamples: number;
  65803. /**
  65804. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  65805. */
  65806. samples: number;
  65807. /**
  65808. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65809. * @constructor
  65810. * @param name The rendering pipeline name
  65811. * @param scene The scene linked to this pipeline
  65812. * @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)
  65813. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  65814. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65815. */
  65816. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  65817. private _buildPipeline;
  65818. private _createDownSampleX4PostProcess;
  65819. private _createBrightPassPostProcess;
  65820. private _createBlurPostProcesses;
  65821. private _createTextureAdderPostProcess;
  65822. private _createVolumetricLightPostProcess;
  65823. private _createLuminancePostProcesses;
  65824. private _createHdrPostProcess;
  65825. private _createLensFlarePostProcess;
  65826. private _createDepthOfFieldPostProcess;
  65827. private _createMotionBlurPostProcess;
  65828. private _getDepthTexture;
  65829. private _disposePostProcesses;
  65830. /**
  65831. * Dispose of the pipeline and stop all post processes
  65832. */
  65833. dispose(): void;
  65834. /**
  65835. * Serialize the rendering pipeline (Used when exporting)
  65836. * @returns the serialized object
  65837. */
  65838. serialize(): any;
  65839. /**
  65840. * Parse the serialized pipeline
  65841. * @param source Source pipeline.
  65842. * @param scene The scene to load the pipeline to.
  65843. * @param rootUrl The URL of the serialized pipeline.
  65844. * @returns An instantiated pipeline from the serialized object.
  65845. */
  65846. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  65847. /**
  65848. * Luminance steps
  65849. */
  65850. static LuminanceSteps: number;
  65851. }
  65852. }
  65853. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  65854. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  65855. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  65856. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  65857. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  65858. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  65859. }
  65860. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  65861. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  65862. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  65863. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65864. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  65865. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65866. }
  65867. declare module "babylonjs/Shaders/tonemap.fragment" {
  65868. /** @hidden */
  65869. export var tonemapPixelShader: {
  65870. name: string;
  65871. shader: string;
  65872. };
  65873. }
  65874. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  65875. import { Camera } from "babylonjs/Cameras/camera";
  65876. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65877. import "babylonjs/Shaders/tonemap.fragment";
  65878. import { Engine } from "babylonjs/Engines/engine";
  65879. /** Defines operator used for tonemapping */
  65880. export enum TonemappingOperator {
  65881. /** Hable */
  65882. Hable = 0,
  65883. /** Reinhard */
  65884. Reinhard = 1,
  65885. /** HejiDawson */
  65886. HejiDawson = 2,
  65887. /** Photographic */
  65888. Photographic = 3
  65889. }
  65890. /**
  65891. * Defines a post process to apply tone mapping
  65892. */
  65893. export class TonemapPostProcess extends PostProcess {
  65894. private _operator;
  65895. /** Defines the required exposure adjustement */
  65896. exposureAdjustment: number;
  65897. /**
  65898. * Creates a new TonemapPostProcess
  65899. * @param name defines the name of the postprocess
  65900. * @param _operator defines the operator to use
  65901. * @param exposureAdjustment defines the required exposure adjustement
  65902. * @param camera defines the camera to use (can be null)
  65903. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  65904. * @param engine defines the hosting engine (can be ignore if camera is set)
  65905. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65906. */
  65907. constructor(name: string, _operator: TonemappingOperator,
  65908. /** Defines the required exposure adjustement */
  65909. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  65910. }
  65911. }
  65912. declare module "babylonjs/Shaders/depth.vertex" {
  65913. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65914. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65915. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65916. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65917. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65918. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65919. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65920. /** @hidden */
  65921. export var depthVertexShader: {
  65922. name: string;
  65923. shader: string;
  65924. };
  65925. }
  65926. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  65927. /** @hidden */
  65928. export var volumetricLightScatteringPixelShader: {
  65929. name: string;
  65930. shader: string;
  65931. };
  65932. }
  65933. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  65934. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65935. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65936. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65937. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65938. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65939. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65940. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65941. /** @hidden */
  65942. export var volumetricLightScatteringPassVertexShader: {
  65943. name: string;
  65944. shader: string;
  65945. };
  65946. }
  65947. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  65948. /** @hidden */
  65949. export var volumetricLightScatteringPassPixelShader: {
  65950. name: string;
  65951. shader: string;
  65952. };
  65953. }
  65954. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  65955. import { Vector3 } from "babylonjs/Maths/math.vector";
  65956. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65957. import { Mesh } from "babylonjs/Meshes/mesh";
  65958. import { Camera } from "babylonjs/Cameras/camera";
  65959. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65960. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65961. import { Scene } from "babylonjs/scene";
  65962. import "babylonjs/Meshes/Builders/planeBuilder";
  65963. import "babylonjs/Shaders/depth.vertex";
  65964. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  65965. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  65966. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  65967. import { Engine } from "babylonjs/Engines/engine";
  65968. /**
  65969. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  65970. */
  65971. export class VolumetricLightScatteringPostProcess extends PostProcess {
  65972. private _volumetricLightScatteringPass;
  65973. private _volumetricLightScatteringRTT;
  65974. private _viewPort;
  65975. private _screenCoordinates;
  65976. private _cachedDefines;
  65977. /**
  65978. * If not undefined, the mesh position is computed from the attached node position
  65979. */
  65980. attachedNode: {
  65981. position: Vector3;
  65982. };
  65983. /**
  65984. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  65985. */
  65986. customMeshPosition: Vector3;
  65987. /**
  65988. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  65989. */
  65990. useCustomMeshPosition: boolean;
  65991. /**
  65992. * If the post-process should inverse the light scattering direction
  65993. */
  65994. invert: boolean;
  65995. /**
  65996. * The internal mesh used by the post-process
  65997. */
  65998. mesh: Mesh;
  65999. /**
  66000. * @hidden
  66001. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  66002. */
  66003. useDiffuseColor: boolean;
  66004. /**
  66005. * Array containing the excluded meshes not rendered in the internal pass
  66006. */
  66007. excludedMeshes: AbstractMesh[];
  66008. /**
  66009. * Controls the overall intensity of the post-process
  66010. */
  66011. exposure: number;
  66012. /**
  66013. * Dissipates each sample's contribution in range [0, 1]
  66014. */
  66015. decay: number;
  66016. /**
  66017. * Controls the overall intensity of each sample
  66018. */
  66019. weight: number;
  66020. /**
  66021. * Controls the density of each sample
  66022. */
  66023. density: number;
  66024. /**
  66025. * @constructor
  66026. * @param name The post-process name
  66027. * @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)
  66028. * @param camera The camera that the post-process will be attached to
  66029. * @param mesh The mesh used to create the light scattering
  66030. * @param samples The post-process quality, default 100
  66031. * @param samplingModeThe post-process filtering mode
  66032. * @param engine The babylon engine
  66033. * @param reusable If the post-process is reusable
  66034. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  66035. */
  66036. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  66037. /**
  66038. * Returns the string "VolumetricLightScatteringPostProcess"
  66039. * @returns "VolumetricLightScatteringPostProcess"
  66040. */
  66041. getClassName(): string;
  66042. private _isReady;
  66043. /**
  66044. * Sets the new light position for light scattering effect
  66045. * @param position The new custom light position
  66046. */
  66047. setCustomMeshPosition(position: Vector3): void;
  66048. /**
  66049. * Returns the light position for light scattering effect
  66050. * @return Vector3 The custom light position
  66051. */
  66052. getCustomMeshPosition(): Vector3;
  66053. /**
  66054. * Disposes the internal assets and detaches the post-process from the camera
  66055. */
  66056. dispose(camera: Camera): void;
  66057. /**
  66058. * Returns the render target texture used by the post-process
  66059. * @return the render target texture used by the post-process
  66060. */
  66061. getPass(): RenderTargetTexture;
  66062. private _meshExcluded;
  66063. private _createPass;
  66064. private _updateMeshScreenCoordinates;
  66065. /**
  66066. * Creates a default mesh for the Volumeric Light Scattering post-process
  66067. * @param name The mesh name
  66068. * @param scene The scene where to create the mesh
  66069. * @return the default mesh
  66070. */
  66071. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  66072. }
  66073. }
  66074. declare module "babylonjs/PostProcesses/index" {
  66075. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  66076. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  66077. export * from "babylonjs/PostProcesses/bloomEffect";
  66078. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  66079. export * from "babylonjs/PostProcesses/blurPostProcess";
  66080. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  66081. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  66082. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  66083. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  66084. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  66085. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  66086. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  66087. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  66088. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  66089. export * from "babylonjs/PostProcesses/filterPostProcess";
  66090. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  66091. export * from "babylonjs/PostProcesses/grainPostProcess";
  66092. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  66093. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  66094. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  66095. export * from "babylonjs/PostProcesses/passPostProcess";
  66096. export * from "babylonjs/PostProcesses/postProcess";
  66097. export * from "babylonjs/PostProcesses/postProcessManager";
  66098. export * from "babylonjs/PostProcesses/refractionPostProcess";
  66099. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  66100. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  66101. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  66102. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  66103. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  66104. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  66105. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  66106. }
  66107. declare module "babylonjs/Probes/index" {
  66108. export * from "babylonjs/Probes/reflectionProbe";
  66109. }
  66110. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  66111. import { Scene } from "babylonjs/scene";
  66112. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66113. import { SmartArray } from "babylonjs/Misc/smartArray";
  66114. import { ISceneComponent } from "babylonjs/sceneComponent";
  66115. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  66116. import "babylonjs/Meshes/Builders/boxBuilder";
  66117. import "babylonjs/Shaders/color.fragment";
  66118. import "babylonjs/Shaders/color.vertex";
  66119. import { Color3 } from "babylonjs/Maths/math.color";
  66120. module "babylonjs/scene" {
  66121. interface Scene {
  66122. /** @hidden (Backing field) */
  66123. _boundingBoxRenderer: BoundingBoxRenderer;
  66124. /** @hidden (Backing field) */
  66125. _forceShowBoundingBoxes: boolean;
  66126. /**
  66127. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  66128. */
  66129. forceShowBoundingBoxes: boolean;
  66130. /**
  66131. * Gets the bounding box renderer associated with the scene
  66132. * @returns a BoundingBoxRenderer
  66133. */
  66134. getBoundingBoxRenderer(): BoundingBoxRenderer;
  66135. }
  66136. }
  66137. module "babylonjs/Meshes/abstractMesh" {
  66138. interface AbstractMesh {
  66139. /** @hidden (Backing field) */
  66140. _showBoundingBox: boolean;
  66141. /**
  66142. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  66143. */
  66144. showBoundingBox: boolean;
  66145. }
  66146. }
  66147. /**
  66148. * Component responsible of rendering the bounding box of the meshes in a scene.
  66149. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  66150. */
  66151. export class BoundingBoxRenderer implements ISceneComponent {
  66152. /**
  66153. * The component name helpfull to identify the component in the list of scene components.
  66154. */
  66155. readonly name: string;
  66156. /**
  66157. * The scene the component belongs to.
  66158. */
  66159. scene: Scene;
  66160. /**
  66161. * Color of the bounding box lines placed in front of an object
  66162. */
  66163. frontColor: Color3;
  66164. /**
  66165. * Color of the bounding box lines placed behind an object
  66166. */
  66167. backColor: Color3;
  66168. /**
  66169. * Defines if the renderer should show the back lines or not
  66170. */
  66171. showBackLines: boolean;
  66172. /**
  66173. * @hidden
  66174. */
  66175. renderList: SmartArray<BoundingBox>;
  66176. private _colorShader;
  66177. private _vertexBuffers;
  66178. private _indexBuffer;
  66179. private _fillIndexBuffer;
  66180. private _fillIndexData;
  66181. /**
  66182. * Instantiates a new bounding box renderer in a scene.
  66183. * @param scene the scene the renderer renders in
  66184. */
  66185. constructor(scene: Scene);
  66186. /**
  66187. * Registers the component in a given scene
  66188. */
  66189. register(): void;
  66190. private _evaluateSubMesh;
  66191. private _activeMesh;
  66192. private _prepareRessources;
  66193. private _createIndexBuffer;
  66194. /**
  66195. * Rebuilds the elements related to this component in case of
  66196. * context lost for instance.
  66197. */
  66198. rebuild(): void;
  66199. /**
  66200. * @hidden
  66201. */
  66202. reset(): void;
  66203. /**
  66204. * Render the bounding boxes of a specific rendering group
  66205. * @param renderingGroupId defines the rendering group to render
  66206. */
  66207. render(renderingGroupId: number): void;
  66208. /**
  66209. * In case of occlusion queries, we can render the occlusion bounding box through this method
  66210. * @param mesh Define the mesh to render the occlusion bounding box for
  66211. */
  66212. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  66213. /**
  66214. * Dispose and release the resources attached to this renderer.
  66215. */
  66216. dispose(): void;
  66217. }
  66218. }
  66219. declare module "babylonjs/Shaders/depth.fragment" {
  66220. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  66221. /** @hidden */
  66222. export var depthPixelShader: {
  66223. name: string;
  66224. shader: string;
  66225. };
  66226. }
  66227. declare module "babylonjs/Rendering/depthRenderer" {
  66228. import { Nullable } from "babylonjs/types";
  66229. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66230. import { Scene } from "babylonjs/scene";
  66231. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  66232. import { Camera } from "babylonjs/Cameras/camera";
  66233. import "babylonjs/Shaders/depth.fragment";
  66234. import "babylonjs/Shaders/depth.vertex";
  66235. /**
  66236. * This represents a depth renderer in Babylon.
  66237. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  66238. */
  66239. export class DepthRenderer {
  66240. private _scene;
  66241. private _depthMap;
  66242. private _effect;
  66243. private readonly _storeNonLinearDepth;
  66244. private readonly _clearColor;
  66245. /** Get if the depth renderer is using packed depth or not */
  66246. readonly isPacked: boolean;
  66247. private _cachedDefines;
  66248. private _camera;
  66249. /**
  66250. * Specifiess that the depth renderer will only be used within
  66251. * the camera it is created for.
  66252. * This can help forcing its rendering during the camera processing.
  66253. */
  66254. useOnlyInActiveCamera: boolean;
  66255. /** @hidden */
  66256. static _SceneComponentInitialization: (scene: Scene) => void;
  66257. /**
  66258. * Instantiates a depth renderer
  66259. * @param scene The scene the renderer belongs to
  66260. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  66261. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  66262. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  66263. */
  66264. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  66265. /**
  66266. * Creates the depth rendering effect and checks if the effect is ready.
  66267. * @param subMesh The submesh to be used to render the depth map of
  66268. * @param useInstances If multiple world instances should be used
  66269. * @returns if the depth renderer is ready to render the depth map
  66270. */
  66271. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  66272. /**
  66273. * Gets the texture which the depth map will be written to.
  66274. * @returns The depth map texture
  66275. */
  66276. getDepthMap(): RenderTargetTexture;
  66277. /**
  66278. * Disposes of the depth renderer.
  66279. */
  66280. dispose(): void;
  66281. }
  66282. }
  66283. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  66284. import { Nullable } from "babylonjs/types";
  66285. import { Scene } from "babylonjs/scene";
  66286. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  66287. import { Camera } from "babylonjs/Cameras/camera";
  66288. import { ISceneComponent } from "babylonjs/sceneComponent";
  66289. module "babylonjs/scene" {
  66290. interface Scene {
  66291. /** @hidden (Backing field) */
  66292. _depthRenderer: {
  66293. [id: string]: DepthRenderer;
  66294. };
  66295. /**
  66296. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  66297. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  66298. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  66299. * @returns the created depth renderer
  66300. */
  66301. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  66302. /**
  66303. * Disables a depth renderer for a given camera
  66304. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  66305. */
  66306. disableDepthRenderer(camera?: Nullable<Camera>): void;
  66307. }
  66308. }
  66309. /**
  66310. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  66311. * in several rendering techniques.
  66312. */
  66313. export class DepthRendererSceneComponent implements ISceneComponent {
  66314. /**
  66315. * The component name helpfull to identify the component in the list of scene components.
  66316. */
  66317. readonly name: string;
  66318. /**
  66319. * The scene the component belongs to.
  66320. */
  66321. scene: Scene;
  66322. /**
  66323. * Creates a new instance of the component for the given scene
  66324. * @param scene Defines the scene to register the component in
  66325. */
  66326. constructor(scene: Scene);
  66327. /**
  66328. * Registers the component in a given scene
  66329. */
  66330. register(): void;
  66331. /**
  66332. * Rebuilds the elements related to this component in case of
  66333. * context lost for instance.
  66334. */
  66335. rebuild(): void;
  66336. /**
  66337. * Disposes the component and the associated ressources
  66338. */
  66339. dispose(): void;
  66340. private _gatherRenderTargets;
  66341. private _gatherActiveCameraRenderTargets;
  66342. }
  66343. }
  66344. declare module "babylonjs/Shaders/outline.fragment" {
  66345. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  66346. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  66347. /** @hidden */
  66348. export var outlinePixelShader: {
  66349. name: string;
  66350. shader: string;
  66351. };
  66352. }
  66353. declare module "babylonjs/Shaders/outline.vertex" {
  66354. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  66355. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  66356. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  66357. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  66358. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  66359. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  66360. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  66361. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  66362. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  66363. /** @hidden */
  66364. export var outlineVertexShader: {
  66365. name: string;
  66366. shader: string;
  66367. };
  66368. }
  66369. declare module "babylonjs/Rendering/outlineRenderer" {
  66370. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66371. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  66372. import { Scene } from "babylonjs/scene";
  66373. import { ISceneComponent } from "babylonjs/sceneComponent";
  66374. import "babylonjs/Shaders/outline.fragment";
  66375. import "babylonjs/Shaders/outline.vertex";
  66376. module "babylonjs/scene" {
  66377. interface Scene {
  66378. /** @hidden */
  66379. _outlineRenderer: OutlineRenderer;
  66380. /**
  66381. * Gets the outline renderer associated with the scene
  66382. * @returns a OutlineRenderer
  66383. */
  66384. getOutlineRenderer(): OutlineRenderer;
  66385. }
  66386. }
  66387. module "babylonjs/Meshes/abstractMesh" {
  66388. interface AbstractMesh {
  66389. /** @hidden (Backing field) */
  66390. _renderOutline: boolean;
  66391. /**
  66392. * Gets or sets a boolean indicating if the outline must be rendered as well
  66393. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  66394. */
  66395. renderOutline: boolean;
  66396. /** @hidden (Backing field) */
  66397. _renderOverlay: boolean;
  66398. /**
  66399. * Gets or sets a boolean indicating if the overlay must be rendered as well
  66400. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  66401. */
  66402. renderOverlay: boolean;
  66403. }
  66404. }
  66405. /**
  66406. * This class is responsible to draw bothe outline/overlay of meshes.
  66407. * It should not be used directly but through the available method on mesh.
  66408. */
  66409. export class OutlineRenderer implements ISceneComponent {
  66410. /**
  66411. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  66412. */
  66413. private static _StencilReference;
  66414. /**
  66415. * The name of the component. Each component must have a unique name.
  66416. */
  66417. name: string;
  66418. /**
  66419. * The scene the component belongs to.
  66420. */
  66421. scene: Scene;
  66422. /**
  66423. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  66424. */
  66425. zOffset: number;
  66426. private _engine;
  66427. private _effect;
  66428. private _cachedDefines;
  66429. private _savedDepthWrite;
  66430. /**
  66431. * Instantiates a new outline renderer. (There could be only one per scene).
  66432. * @param scene Defines the scene it belongs to
  66433. */
  66434. constructor(scene: Scene);
  66435. /**
  66436. * Register the component to one instance of a scene.
  66437. */
  66438. register(): void;
  66439. /**
  66440. * Rebuilds the elements related to this component in case of
  66441. * context lost for instance.
  66442. */
  66443. rebuild(): void;
  66444. /**
  66445. * Disposes the component and the associated ressources.
  66446. */
  66447. dispose(): void;
  66448. /**
  66449. * Renders the outline in the canvas.
  66450. * @param subMesh Defines the sumesh to render
  66451. * @param batch Defines the batch of meshes in case of instances
  66452. * @param useOverlay Defines if the rendering is for the overlay or the outline
  66453. */
  66454. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  66455. /**
  66456. * Returns whether or not the outline renderer is ready for a given submesh.
  66457. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  66458. * @param subMesh Defines the submesh to check readyness for
  66459. * @param useInstances Defines wheter wee are trying to render instances or not
  66460. * @returns true if ready otherwise false
  66461. */
  66462. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  66463. private _beforeRenderingMesh;
  66464. private _afterRenderingMesh;
  66465. }
  66466. }
  66467. declare module "babylonjs/Rendering/index" {
  66468. export * from "babylonjs/Rendering/boundingBoxRenderer";
  66469. export * from "babylonjs/Rendering/depthRenderer";
  66470. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  66471. export * from "babylonjs/Rendering/edgesRenderer";
  66472. export * from "babylonjs/Rendering/geometryBufferRenderer";
  66473. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  66474. export * from "babylonjs/Rendering/outlineRenderer";
  66475. export * from "babylonjs/Rendering/renderingGroup";
  66476. export * from "babylonjs/Rendering/renderingManager";
  66477. export * from "babylonjs/Rendering/utilityLayerRenderer";
  66478. }
  66479. declare module "babylonjs/Sprites/spritePackedManager" {
  66480. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  66481. import { Scene } from "babylonjs/scene";
  66482. /**
  66483. * Class used to manage multiple sprites of different sizes on the same spritesheet
  66484. * @see http://doc.babylonjs.com/babylon101/sprites
  66485. */
  66486. export class SpritePackedManager extends SpriteManager {
  66487. /** defines the packed manager's name */
  66488. name: string;
  66489. /**
  66490. * Creates a new sprite manager from a packed sprite sheet
  66491. * @param name defines the manager's name
  66492. * @param imgUrl defines the sprite sheet url
  66493. * @param capacity defines the maximum allowed number of sprites
  66494. * @param scene defines the hosting scene
  66495. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  66496. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  66497. * @param samplingMode defines the smapling mode to use with spritesheet
  66498. * @param fromPacked set to true; do not alter
  66499. */
  66500. constructor(
  66501. /** defines the packed manager's name */
  66502. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  66503. }
  66504. }
  66505. declare module "babylonjs/Sprites/index" {
  66506. export * from "babylonjs/Sprites/sprite";
  66507. export * from "babylonjs/Sprites/spriteManager";
  66508. export * from "babylonjs/Sprites/spritePackedManager";
  66509. export * from "babylonjs/Sprites/spriteSceneComponent";
  66510. }
  66511. declare module "babylonjs/States/index" {
  66512. export * from "babylonjs/States/alphaCullingState";
  66513. export * from "babylonjs/States/depthCullingState";
  66514. export * from "babylonjs/States/stencilState";
  66515. }
  66516. declare module "babylonjs/Misc/assetsManager" {
  66517. import { Scene } from "babylonjs/scene";
  66518. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66519. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  66520. import { Skeleton } from "babylonjs/Bones/skeleton";
  66521. import { Observable } from "babylonjs/Misc/observable";
  66522. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  66523. import { Texture } from "babylonjs/Materials/Textures/texture";
  66524. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  66525. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  66526. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  66527. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  66528. /**
  66529. * Defines the list of states available for a task inside a AssetsManager
  66530. */
  66531. export enum AssetTaskState {
  66532. /**
  66533. * Initialization
  66534. */
  66535. INIT = 0,
  66536. /**
  66537. * Running
  66538. */
  66539. RUNNING = 1,
  66540. /**
  66541. * Done
  66542. */
  66543. DONE = 2,
  66544. /**
  66545. * Error
  66546. */
  66547. ERROR = 3
  66548. }
  66549. /**
  66550. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  66551. */
  66552. export abstract class AbstractAssetTask {
  66553. /**
  66554. * Task name
  66555. */ name: string;
  66556. /**
  66557. * Callback called when the task is successful
  66558. */
  66559. onSuccess: (task: any) => void;
  66560. /**
  66561. * Callback called when the task is not successful
  66562. */
  66563. onError: (task: any, message?: string, exception?: any) => void;
  66564. /**
  66565. * Creates a new AssetsManager
  66566. * @param name defines the name of the task
  66567. */
  66568. constructor(
  66569. /**
  66570. * Task name
  66571. */ name: string);
  66572. private _isCompleted;
  66573. private _taskState;
  66574. private _errorObject;
  66575. /**
  66576. * Get if the task is completed
  66577. */
  66578. readonly isCompleted: boolean;
  66579. /**
  66580. * Gets the current state of the task
  66581. */
  66582. readonly taskState: AssetTaskState;
  66583. /**
  66584. * Gets the current error object (if task is in error)
  66585. */
  66586. readonly errorObject: {
  66587. message?: string;
  66588. exception?: any;
  66589. };
  66590. /**
  66591. * Internal only
  66592. * @hidden
  66593. */
  66594. _setErrorObject(message?: string, exception?: any): void;
  66595. /**
  66596. * Execute the current task
  66597. * @param scene defines the scene where you want your assets to be loaded
  66598. * @param onSuccess is a callback called when the task is successfully executed
  66599. * @param onError is a callback called if an error occurs
  66600. */
  66601. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66602. /**
  66603. * Execute the current task
  66604. * @param scene defines the scene where you want your assets to be loaded
  66605. * @param onSuccess is a callback called when the task is successfully executed
  66606. * @param onError is a callback called if an error occurs
  66607. */
  66608. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66609. /**
  66610. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  66611. * This can be used with failed tasks that have the reason for failure fixed.
  66612. */
  66613. reset(): void;
  66614. private onErrorCallback;
  66615. private onDoneCallback;
  66616. }
  66617. /**
  66618. * Define the interface used by progress events raised during assets loading
  66619. */
  66620. export interface IAssetsProgressEvent {
  66621. /**
  66622. * Defines the number of remaining tasks to process
  66623. */
  66624. remainingCount: number;
  66625. /**
  66626. * Defines the total number of tasks
  66627. */
  66628. totalCount: number;
  66629. /**
  66630. * Defines the task that was just processed
  66631. */
  66632. task: AbstractAssetTask;
  66633. }
  66634. /**
  66635. * Class used to share progress information about assets loading
  66636. */
  66637. export class AssetsProgressEvent implements IAssetsProgressEvent {
  66638. /**
  66639. * Defines the number of remaining tasks to process
  66640. */
  66641. remainingCount: number;
  66642. /**
  66643. * Defines the total number of tasks
  66644. */
  66645. totalCount: number;
  66646. /**
  66647. * Defines the task that was just processed
  66648. */
  66649. task: AbstractAssetTask;
  66650. /**
  66651. * Creates a AssetsProgressEvent
  66652. * @param remainingCount defines the number of remaining tasks to process
  66653. * @param totalCount defines the total number of tasks
  66654. * @param task defines the task that was just processed
  66655. */
  66656. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  66657. }
  66658. /**
  66659. * Define a task used by AssetsManager to load meshes
  66660. */
  66661. export class MeshAssetTask extends AbstractAssetTask {
  66662. /**
  66663. * Defines the name of the task
  66664. */
  66665. name: string;
  66666. /**
  66667. * Defines the list of mesh's names you want to load
  66668. */
  66669. meshesNames: any;
  66670. /**
  66671. * Defines the root url to use as a base to load your meshes and associated resources
  66672. */
  66673. rootUrl: string;
  66674. /**
  66675. * Defines the filename of the scene to load from
  66676. */
  66677. sceneFilename: string;
  66678. /**
  66679. * Gets the list of loaded meshes
  66680. */
  66681. loadedMeshes: Array<AbstractMesh>;
  66682. /**
  66683. * Gets the list of loaded particle systems
  66684. */
  66685. loadedParticleSystems: Array<IParticleSystem>;
  66686. /**
  66687. * Gets the list of loaded skeletons
  66688. */
  66689. loadedSkeletons: Array<Skeleton>;
  66690. /**
  66691. * Gets the list of loaded animation groups
  66692. */
  66693. loadedAnimationGroups: Array<AnimationGroup>;
  66694. /**
  66695. * Callback called when the task is successful
  66696. */
  66697. onSuccess: (task: MeshAssetTask) => void;
  66698. /**
  66699. * Callback called when the task is successful
  66700. */
  66701. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  66702. /**
  66703. * Creates a new MeshAssetTask
  66704. * @param name defines the name of the task
  66705. * @param meshesNames defines the list of mesh's names you want to load
  66706. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  66707. * @param sceneFilename defines the filename of the scene to load from
  66708. */
  66709. constructor(
  66710. /**
  66711. * Defines the name of the task
  66712. */
  66713. name: string,
  66714. /**
  66715. * Defines the list of mesh's names you want to load
  66716. */
  66717. meshesNames: any,
  66718. /**
  66719. * Defines the root url to use as a base to load your meshes and associated resources
  66720. */
  66721. rootUrl: string,
  66722. /**
  66723. * Defines the filename of the scene to load from
  66724. */
  66725. sceneFilename: string);
  66726. /**
  66727. * Execute the current task
  66728. * @param scene defines the scene where you want your assets to be loaded
  66729. * @param onSuccess is a callback called when the task is successfully executed
  66730. * @param onError is a callback called if an error occurs
  66731. */
  66732. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66733. }
  66734. /**
  66735. * Define a task used by AssetsManager to load text content
  66736. */
  66737. export class TextFileAssetTask extends AbstractAssetTask {
  66738. /**
  66739. * Defines the name of the task
  66740. */
  66741. name: string;
  66742. /**
  66743. * Defines the location of the file to load
  66744. */
  66745. url: string;
  66746. /**
  66747. * Gets the loaded text string
  66748. */
  66749. text: string;
  66750. /**
  66751. * Callback called when the task is successful
  66752. */
  66753. onSuccess: (task: TextFileAssetTask) => void;
  66754. /**
  66755. * Callback called when the task is successful
  66756. */
  66757. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  66758. /**
  66759. * Creates a new TextFileAssetTask object
  66760. * @param name defines the name of the task
  66761. * @param url defines the location of the file to load
  66762. */
  66763. constructor(
  66764. /**
  66765. * Defines the name of the task
  66766. */
  66767. name: string,
  66768. /**
  66769. * Defines the location of the file to load
  66770. */
  66771. url: string);
  66772. /**
  66773. * Execute the current task
  66774. * @param scene defines the scene where you want your assets to be loaded
  66775. * @param onSuccess is a callback called when the task is successfully executed
  66776. * @param onError is a callback called if an error occurs
  66777. */
  66778. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66779. }
  66780. /**
  66781. * Define a task used by AssetsManager to load binary data
  66782. */
  66783. export class BinaryFileAssetTask extends AbstractAssetTask {
  66784. /**
  66785. * Defines the name of the task
  66786. */
  66787. name: string;
  66788. /**
  66789. * Defines the location of the file to load
  66790. */
  66791. url: string;
  66792. /**
  66793. * Gets the lodaded data (as an array buffer)
  66794. */
  66795. data: ArrayBuffer;
  66796. /**
  66797. * Callback called when the task is successful
  66798. */
  66799. onSuccess: (task: BinaryFileAssetTask) => void;
  66800. /**
  66801. * Callback called when the task is successful
  66802. */
  66803. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  66804. /**
  66805. * Creates a new BinaryFileAssetTask object
  66806. * @param name defines the name of the new task
  66807. * @param url defines the location of the file to load
  66808. */
  66809. constructor(
  66810. /**
  66811. * Defines the name of the task
  66812. */
  66813. name: string,
  66814. /**
  66815. * Defines the location of the file to load
  66816. */
  66817. url: string);
  66818. /**
  66819. * Execute the current task
  66820. * @param scene defines the scene where you want your assets to be loaded
  66821. * @param onSuccess is a callback called when the task is successfully executed
  66822. * @param onError is a callback called if an error occurs
  66823. */
  66824. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66825. }
  66826. /**
  66827. * Define a task used by AssetsManager to load images
  66828. */
  66829. export class ImageAssetTask extends AbstractAssetTask {
  66830. /**
  66831. * Defines the name of the task
  66832. */
  66833. name: string;
  66834. /**
  66835. * Defines the location of the image to load
  66836. */
  66837. url: string;
  66838. /**
  66839. * Gets the loaded images
  66840. */
  66841. image: HTMLImageElement;
  66842. /**
  66843. * Callback called when the task is successful
  66844. */
  66845. onSuccess: (task: ImageAssetTask) => void;
  66846. /**
  66847. * Callback called when the task is successful
  66848. */
  66849. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  66850. /**
  66851. * Creates a new ImageAssetTask
  66852. * @param name defines the name of the task
  66853. * @param url defines the location of the image to load
  66854. */
  66855. constructor(
  66856. /**
  66857. * Defines the name of the task
  66858. */
  66859. name: string,
  66860. /**
  66861. * Defines the location of the image to load
  66862. */
  66863. url: string);
  66864. /**
  66865. * Execute the current task
  66866. * @param scene defines the scene where you want your assets to be loaded
  66867. * @param onSuccess is a callback called when the task is successfully executed
  66868. * @param onError is a callback called if an error occurs
  66869. */
  66870. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66871. }
  66872. /**
  66873. * Defines the interface used by texture loading tasks
  66874. */
  66875. export interface ITextureAssetTask<TEX extends BaseTexture> {
  66876. /**
  66877. * Gets the loaded texture
  66878. */
  66879. texture: TEX;
  66880. }
  66881. /**
  66882. * Define a task used by AssetsManager to load 2D textures
  66883. */
  66884. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  66885. /**
  66886. * Defines the name of the task
  66887. */
  66888. name: string;
  66889. /**
  66890. * Defines the location of the file to load
  66891. */
  66892. url: string;
  66893. /**
  66894. * Defines if mipmap should not be generated (default is false)
  66895. */
  66896. noMipmap?: boolean | undefined;
  66897. /**
  66898. * Defines if texture must be inverted on Y axis (default is false)
  66899. */
  66900. invertY?: boolean | undefined;
  66901. /**
  66902. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66903. */
  66904. samplingMode: number;
  66905. /**
  66906. * Gets the loaded texture
  66907. */
  66908. texture: Texture;
  66909. /**
  66910. * Callback called when the task is successful
  66911. */
  66912. onSuccess: (task: TextureAssetTask) => void;
  66913. /**
  66914. * Callback called when the task is successful
  66915. */
  66916. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  66917. /**
  66918. * Creates a new TextureAssetTask object
  66919. * @param name defines the name of the task
  66920. * @param url defines the location of the file to load
  66921. * @param noMipmap defines if mipmap should not be generated (default is false)
  66922. * @param invertY defines if texture must be inverted on Y axis (default is false)
  66923. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66924. */
  66925. constructor(
  66926. /**
  66927. * Defines the name of the task
  66928. */
  66929. name: string,
  66930. /**
  66931. * Defines the location of the file to load
  66932. */
  66933. url: string,
  66934. /**
  66935. * Defines if mipmap should not be generated (default is false)
  66936. */
  66937. noMipmap?: boolean | undefined,
  66938. /**
  66939. * Defines if texture must be inverted on Y axis (default is false)
  66940. */
  66941. invertY?: boolean | undefined,
  66942. /**
  66943. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66944. */
  66945. samplingMode?: number);
  66946. /**
  66947. * Execute the current task
  66948. * @param scene defines the scene where you want your assets to be loaded
  66949. * @param onSuccess is a callback called when the task is successfully executed
  66950. * @param onError is a callback called if an error occurs
  66951. */
  66952. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66953. }
  66954. /**
  66955. * Define a task used by AssetsManager to load cube textures
  66956. */
  66957. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  66958. /**
  66959. * Defines the name of the task
  66960. */
  66961. name: string;
  66962. /**
  66963. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66964. */
  66965. url: string;
  66966. /**
  66967. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66968. */
  66969. extensions?: string[] | undefined;
  66970. /**
  66971. * Defines if mipmaps should not be generated (default is false)
  66972. */
  66973. noMipmap?: boolean | undefined;
  66974. /**
  66975. * Defines the explicit list of files (undefined by default)
  66976. */
  66977. files?: string[] | undefined;
  66978. /**
  66979. * Gets the loaded texture
  66980. */
  66981. texture: CubeTexture;
  66982. /**
  66983. * Callback called when the task is successful
  66984. */
  66985. onSuccess: (task: CubeTextureAssetTask) => void;
  66986. /**
  66987. * Callback called when the task is successful
  66988. */
  66989. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  66990. /**
  66991. * Creates a new CubeTextureAssetTask
  66992. * @param name defines the name of the task
  66993. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66994. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66995. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66996. * @param files defines the explicit list of files (undefined by default)
  66997. */
  66998. constructor(
  66999. /**
  67000. * Defines the name of the task
  67001. */
  67002. name: string,
  67003. /**
  67004. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  67005. */
  67006. url: string,
  67007. /**
  67008. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  67009. */
  67010. extensions?: string[] | undefined,
  67011. /**
  67012. * Defines if mipmaps should not be generated (default is false)
  67013. */
  67014. noMipmap?: boolean | undefined,
  67015. /**
  67016. * Defines the explicit list of files (undefined by default)
  67017. */
  67018. files?: string[] | undefined);
  67019. /**
  67020. * Execute the current task
  67021. * @param scene defines the scene where you want your assets to be loaded
  67022. * @param onSuccess is a callback called when the task is successfully executed
  67023. * @param onError is a callback called if an error occurs
  67024. */
  67025. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  67026. }
  67027. /**
  67028. * Define a task used by AssetsManager to load HDR cube textures
  67029. */
  67030. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  67031. /**
  67032. * Defines the name of the task
  67033. */
  67034. name: string;
  67035. /**
  67036. * Defines the location of the file to load
  67037. */
  67038. url: string;
  67039. /**
  67040. * Defines the desired size (the more it increases the longer the generation will be)
  67041. */
  67042. size: number;
  67043. /**
  67044. * Defines if mipmaps should not be generated (default is false)
  67045. */
  67046. noMipmap: boolean;
  67047. /**
  67048. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  67049. */
  67050. generateHarmonics: boolean;
  67051. /**
  67052. * 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)
  67053. */
  67054. gammaSpace: boolean;
  67055. /**
  67056. * Internal Use Only
  67057. */
  67058. reserved: boolean;
  67059. /**
  67060. * Gets the loaded texture
  67061. */
  67062. texture: HDRCubeTexture;
  67063. /**
  67064. * Callback called when the task is successful
  67065. */
  67066. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  67067. /**
  67068. * Callback called when the task is successful
  67069. */
  67070. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  67071. /**
  67072. * Creates a new HDRCubeTextureAssetTask object
  67073. * @param name defines the name of the task
  67074. * @param url defines the location of the file to load
  67075. * @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.
  67076. * @param noMipmap defines if mipmaps should not be generated (default is false)
  67077. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  67078. * @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)
  67079. * @param reserved Internal use only
  67080. */
  67081. constructor(
  67082. /**
  67083. * Defines the name of the task
  67084. */
  67085. name: string,
  67086. /**
  67087. * Defines the location of the file to load
  67088. */
  67089. url: string,
  67090. /**
  67091. * Defines the desired size (the more it increases the longer the generation will be)
  67092. */
  67093. size: number,
  67094. /**
  67095. * Defines if mipmaps should not be generated (default is false)
  67096. */
  67097. noMipmap?: boolean,
  67098. /**
  67099. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  67100. */
  67101. generateHarmonics?: boolean,
  67102. /**
  67103. * 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)
  67104. */
  67105. gammaSpace?: boolean,
  67106. /**
  67107. * Internal Use Only
  67108. */
  67109. reserved?: boolean);
  67110. /**
  67111. * Execute the current task
  67112. * @param scene defines the scene where you want your assets to be loaded
  67113. * @param onSuccess is a callback called when the task is successfully executed
  67114. * @param onError is a callback called if an error occurs
  67115. */
  67116. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  67117. }
  67118. /**
  67119. * Define a task used by AssetsManager to load Equirectangular cube textures
  67120. */
  67121. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  67122. /**
  67123. * Defines the name of the task
  67124. */
  67125. name: string;
  67126. /**
  67127. * Defines the location of the file to load
  67128. */
  67129. url: string;
  67130. /**
  67131. * Defines the desired size (the more it increases the longer the generation will be)
  67132. */
  67133. size: number;
  67134. /**
  67135. * Defines if mipmaps should not be generated (default is false)
  67136. */
  67137. noMipmap: boolean;
  67138. /**
  67139. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  67140. * but the standard material would require them in Gamma space) (default is true)
  67141. */
  67142. gammaSpace: boolean;
  67143. /**
  67144. * Gets the loaded texture
  67145. */
  67146. texture: EquiRectangularCubeTexture;
  67147. /**
  67148. * Callback called when the task is successful
  67149. */
  67150. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  67151. /**
  67152. * Callback called when the task is successful
  67153. */
  67154. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  67155. /**
  67156. * Creates a new EquiRectangularCubeTextureAssetTask object
  67157. * @param name defines the name of the task
  67158. * @param url defines the location of the file to load
  67159. * @param size defines the desired size (the more it increases the longer the generation will be)
  67160. * If the size is omitted this implies you are using a preprocessed cubemap.
  67161. * @param noMipmap defines if mipmaps should not be generated (default is false)
  67162. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  67163. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  67164. * (default is true)
  67165. */
  67166. constructor(
  67167. /**
  67168. * Defines the name of the task
  67169. */
  67170. name: string,
  67171. /**
  67172. * Defines the location of the file to load
  67173. */
  67174. url: string,
  67175. /**
  67176. * Defines the desired size (the more it increases the longer the generation will be)
  67177. */
  67178. size: number,
  67179. /**
  67180. * Defines if mipmaps should not be generated (default is false)
  67181. */
  67182. noMipmap?: boolean,
  67183. /**
  67184. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  67185. * but the standard material would require them in Gamma space) (default is true)
  67186. */
  67187. gammaSpace?: boolean);
  67188. /**
  67189. * Execute the current task
  67190. * @param scene defines the scene where you want your assets to be loaded
  67191. * @param onSuccess is a callback called when the task is successfully executed
  67192. * @param onError is a callback called if an error occurs
  67193. */
  67194. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  67195. }
  67196. /**
  67197. * This class can be used to easily import assets into a scene
  67198. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  67199. */
  67200. export class AssetsManager {
  67201. private _scene;
  67202. private _isLoading;
  67203. protected _tasks: AbstractAssetTask[];
  67204. protected _waitingTasksCount: number;
  67205. protected _totalTasksCount: number;
  67206. /**
  67207. * Callback called when all tasks are processed
  67208. */
  67209. onFinish: (tasks: AbstractAssetTask[]) => void;
  67210. /**
  67211. * Callback called when a task is successful
  67212. */
  67213. onTaskSuccess: (task: AbstractAssetTask) => void;
  67214. /**
  67215. * Callback called when a task had an error
  67216. */
  67217. onTaskError: (task: AbstractAssetTask) => void;
  67218. /**
  67219. * Callback called when a task is done (whatever the result is)
  67220. */
  67221. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  67222. /**
  67223. * Observable called when all tasks are processed
  67224. */
  67225. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  67226. /**
  67227. * Observable called when a task had an error
  67228. */
  67229. onTaskErrorObservable: Observable<AbstractAssetTask>;
  67230. /**
  67231. * Observable called when all tasks were executed
  67232. */
  67233. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  67234. /**
  67235. * Observable called when a task is done (whatever the result is)
  67236. */
  67237. onProgressObservable: Observable<IAssetsProgressEvent>;
  67238. /**
  67239. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  67240. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  67241. */
  67242. useDefaultLoadingScreen: boolean;
  67243. /**
  67244. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  67245. * when all assets have been downloaded.
  67246. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  67247. */
  67248. autoHideLoadingUI: boolean;
  67249. /**
  67250. * Creates a new AssetsManager
  67251. * @param scene defines the scene to work on
  67252. */
  67253. constructor(scene: Scene);
  67254. /**
  67255. * Add a MeshAssetTask to the list of active tasks
  67256. * @param taskName defines the name of the new task
  67257. * @param meshesNames defines the name of meshes to load
  67258. * @param rootUrl defines the root url to use to locate files
  67259. * @param sceneFilename defines the filename of the scene file
  67260. * @returns a new MeshAssetTask object
  67261. */
  67262. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  67263. /**
  67264. * Add a TextFileAssetTask to the list of active tasks
  67265. * @param taskName defines the name of the new task
  67266. * @param url defines the url of the file to load
  67267. * @returns a new TextFileAssetTask object
  67268. */
  67269. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  67270. /**
  67271. * Add a BinaryFileAssetTask to the list of active tasks
  67272. * @param taskName defines the name of the new task
  67273. * @param url defines the url of the file to load
  67274. * @returns a new BinaryFileAssetTask object
  67275. */
  67276. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  67277. /**
  67278. * Add a ImageAssetTask to the list of active tasks
  67279. * @param taskName defines the name of the new task
  67280. * @param url defines the url of the file to load
  67281. * @returns a new ImageAssetTask object
  67282. */
  67283. addImageTask(taskName: string, url: string): ImageAssetTask;
  67284. /**
  67285. * Add a TextureAssetTask to the list of active tasks
  67286. * @param taskName defines the name of the new task
  67287. * @param url defines the url of the file to load
  67288. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67289. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  67290. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  67291. * @returns a new TextureAssetTask object
  67292. */
  67293. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  67294. /**
  67295. * Add a CubeTextureAssetTask to the list of active tasks
  67296. * @param taskName defines the name of the new task
  67297. * @param url defines the url of the file to load
  67298. * @param extensions defines the extension to use to load the cube map (can be null)
  67299. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67300. * @param files defines the list of files to load (can be null)
  67301. * @returns a new CubeTextureAssetTask object
  67302. */
  67303. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  67304. /**
  67305. *
  67306. * Add a HDRCubeTextureAssetTask to the list of active tasks
  67307. * @param taskName defines the name of the new task
  67308. * @param url defines the url of the file to load
  67309. * @param size defines the size you want for the cubemap (can be null)
  67310. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67311. * @param generateHarmonics defines if you want to automatically generate (true by default)
  67312. * @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)
  67313. * @param reserved Internal use only
  67314. * @returns a new HDRCubeTextureAssetTask object
  67315. */
  67316. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  67317. /**
  67318. *
  67319. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  67320. * @param taskName defines the name of the new task
  67321. * @param url defines the url of the file to load
  67322. * @param size defines the size you want for the cubemap (can be null)
  67323. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67324. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  67325. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  67326. * @returns a new EquiRectangularCubeTextureAssetTask object
  67327. */
  67328. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  67329. /**
  67330. * Remove a task from the assets manager.
  67331. * @param task the task to remove
  67332. */
  67333. removeTask(task: AbstractAssetTask): void;
  67334. private _decreaseWaitingTasksCount;
  67335. private _runTask;
  67336. /**
  67337. * Reset the AssetsManager and remove all tasks
  67338. * @return the current instance of the AssetsManager
  67339. */
  67340. reset(): AssetsManager;
  67341. /**
  67342. * Start the loading process
  67343. * @return the current instance of the AssetsManager
  67344. */
  67345. load(): AssetsManager;
  67346. /**
  67347. * Start the loading process as an async operation
  67348. * @return a promise returning the list of failed tasks
  67349. */
  67350. loadAsync(): Promise<void>;
  67351. }
  67352. }
  67353. declare module "babylonjs/Misc/deferred" {
  67354. /**
  67355. * Wrapper class for promise with external resolve and reject.
  67356. */
  67357. export class Deferred<T> {
  67358. /**
  67359. * The promise associated with this deferred object.
  67360. */
  67361. readonly promise: Promise<T>;
  67362. private _resolve;
  67363. private _reject;
  67364. /**
  67365. * The resolve method of the promise associated with this deferred object.
  67366. */
  67367. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  67368. /**
  67369. * The reject method of the promise associated with this deferred object.
  67370. */
  67371. readonly reject: (reason?: any) => void;
  67372. /**
  67373. * Constructor for this deferred object.
  67374. */
  67375. constructor();
  67376. }
  67377. }
  67378. declare module "babylonjs/Misc/meshExploder" {
  67379. import { Mesh } from "babylonjs/Meshes/mesh";
  67380. /**
  67381. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  67382. */
  67383. export class MeshExploder {
  67384. private _centerMesh;
  67385. private _meshes;
  67386. private _meshesOrigins;
  67387. private _toCenterVectors;
  67388. private _scaledDirection;
  67389. private _newPosition;
  67390. private _centerPosition;
  67391. /**
  67392. * Explodes meshes from a center mesh.
  67393. * @param meshes The meshes to explode.
  67394. * @param centerMesh The mesh to be center of explosion.
  67395. */
  67396. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  67397. private _setCenterMesh;
  67398. /**
  67399. * Get class name
  67400. * @returns "MeshExploder"
  67401. */
  67402. getClassName(): string;
  67403. /**
  67404. * "Exploded meshes"
  67405. * @returns Array of meshes with the centerMesh at index 0.
  67406. */
  67407. getMeshes(): Array<Mesh>;
  67408. /**
  67409. * Explodes meshes giving a specific direction
  67410. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  67411. */
  67412. explode(direction?: number): void;
  67413. }
  67414. }
  67415. declare module "babylonjs/Misc/filesInput" {
  67416. import { Engine } from "babylonjs/Engines/engine";
  67417. import { Scene } from "babylonjs/scene";
  67418. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  67419. /**
  67420. * Class used to help managing file picking and drag'n'drop
  67421. */
  67422. export class FilesInput {
  67423. /**
  67424. * List of files ready to be loaded
  67425. */
  67426. static readonly FilesToLoad: {
  67427. [key: string]: File;
  67428. };
  67429. /**
  67430. * Callback called when a file is processed
  67431. */
  67432. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  67433. private _engine;
  67434. private _currentScene;
  67435. private _sceneLoadedCallback;
  67436. private _progressCallback;
  67437. private _additionalRenderLoopLogicCallback;
  67438. private _textureLoadingCallback;
  67439. private _startingProcessingFilesCallback;
  67440. private _onReloadCallback;
  67441. private _errorCallback;
  67442. private _elementToMonitor;
  67443. private _sceneFileToLoad;
  67444. private _filesToLoad;
  67445. /**
  67446. * Creates a new FilesInput
  67447. * @param engine defines the rendering engine
  67448. * @param scene defines the hosting scene
  67449. * @param sceneLoadedCallback callback called when scene is loaded
  67450. * @param progressCallback callback called to track progress
  67451. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  67452. * @param textureLoadingCallback callback called when a texture is loading
  67453. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  67454. * @param onReloadCallback callback called when a reload is requested
  67455. * @param errorCallback callback call if an error occurs
  67456. */
  67457. 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);
  67458. private _dragEnterHandler;
  67459. private _dragOverHandler;
  67460. private _dropHandler;
  67461. /**
  67462. * Calls this function to listen to drag'n'drop events on a specific DOM element
  67463. * @param elementToMonitor defines the DOM element to track
  67464. */
  67465. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  67466. /**
  67467. * Release all associated resources
  67468. */
  67469. dispose(): void;
  67470. private renderFunction;
  67471. private drag;
  67472. private drop;
  67473. private _traverseFolder;
  67474. private _processFiles;
  67475. /**
  67476. * Load files from a drop event
  67477. * @param event defines the drop event to use as source
  67478. */
  67479. loadFiles(event: any): void;
  67480. private _processReload;
  67481. /**
  67482. * Reload the current scene from the loaded files
  67483. */
  67484. reload(): void;
  67485. }
  67486. }
  67487. declare module "babylonjs/Misc/HighDynamicRange/index" {
  67488. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  67489. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  67490. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  67491. }
  67492. declare module "babylonjs/Misc/sceneOptimizer" {
  67493. import { Scene, IDisposable } from "babylonjs/scene";
  67494. import { Observable } from "babylonjs/Misc/observable";
  67495. /**
  67496. * Defines the root class used to create scene optimization to use with SceneOptimizer
  67497. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67498. */
  67499. export class SceneOptimization {
  67500. /**
  67501. * Defines the priority of this optimization (0 by default which means first in the list)
  67502. */
  67503. priority: number;
  67504. /**
  67505. * Gets a string describing the action executed by the current optimization
  67506. * @returns description string
  67507. */
  67508. getDescription(): string;
  67509. /**
  67510. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67511. * @param scene defines the current scene where to apply this optimization
  67512. * @param optimizer defines the current optimizer
  67513. * @returns true if everything that can be done was applied
  67514. */
  67515. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67516. /**
  67517. * Creates the SceneOptimization object
  67518. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67519. * @param desc defines the description associated with the optimization
  67520. */
  67521. constructor(
  67522. /**
  67523. * Defines the priority of this optimization (0 by default which means first in the list)
  67524. */
  67525. priority?: number);
  67526. }
  67527. /**
  67528. * Defines an optimization used to reduce the size of render target textures
  67529. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67530. */
  67531. export class TextureOptimization extends SceneOptimization {
  67532. /**
  67533. * Defines the priority of this optimization (0 by default which means first in the list)
  67534. */
  67535. priority: number;
  67536. /**
  67537. * 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
  67538. */
  67539. maximumSize: number;
  67540. /**
  67541. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67542. */
  67543. step: number;
  67544. /**
  67545. * Gets a string describing the action executed by the current optimization
  67546. * @returns description string
  67547. */
  67548. getDescription(): string;
  67549. /**
  67550. * Creates the TextureOptimization object
  67551. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67552. * @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
  67553. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67554. */
  67555. constructor(
  67556. /**
  67557. * Defines the priority of this optimization (0 by default which means first in the list)
  67558. */
  67559. priority?: number,
  67560. /**
  67561. * 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
  67562. */
  67563. maximumSize?: number,
  67564. /**
  67565. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67566. */
  67567. step?: number);
  67568. /**
  67569. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67570. * @param scene defines the current scene where to apply this optimization
  67571. * @param optimizer defines the current optimizer
  67572. * @returns true if everything that can be done was applied
  67573. */
  67574. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67575. }
  67576. /**
  67577. * Defines an optimization used to increase or decrease the rendering resolution
  67578. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67579. */
  67580. export class HardwareScalingOptimization extends SceneOptimization {
  67581. /**
  67582. * Defines the priority of this optimization (0 by default which means first in the list)
  67583. */
  67584. priority: number;
  67585. /**
  67586. * Defines the maximum scale to use (2 by default)
  67587. */
  67588. maximumScale: number;
  67589. /**
  67590. * Defines the step to use between two passes (0.5 by default)
  67591. */
  67592. step: number;
  67593. private _currentScale;
  67594. private _directionOffset;
  67595. /**
  67596. * Gets a string describing the action executed by the current optimization
  67597. * @return description string
  67598. */
  67599. getDescription(): string;
  67600. /**
  67601. * Creates the HardwareScalingOptimization object
  67602. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67603. * @param maximumScale defines the maximum scale to use (2 by default)
  67604. * @param step defines the step to use between two passes (0.5 by default)
  67605. */
  67606. constructor(
  67607. /**
  67608. * Defines the priority of this optimization (0 by default which means first in the list)
  67609. */
  67610. priority?: number,
  67611. /**
  67612. * Defines the maximum scale to use (2 by default)
  67613. */
  67614. maximumScale?: number,
  67615. /**
  67616. * Defines the step to use between two passes (0.5 by default)
  67617. */
  67618. step?: number);
  67619. /**
  67620. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67621. * @param scene defines the current scene where to apply this optimization
  67622. * @param optimizer defines the current optimizer
  67623. * @returns true if everything that can be done was applied
  67624. */
  67625. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67626. }
  67627. /**
  67628. * Defines an optimization used to remove shadows
  67629. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67630. */
  67631. export class ShadowsOptimization extends SceneOptimization {
  67632. /**
  67633. * Gets a string describing the action executed by the current optimization
  67634. * @return description string
  67635. */
  67636. getDescription(): string;
  67637. /**
  67638. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67639. * @param scene defines the current scene where to apply this optimization
  67640. * @param optimizer defines the current optimizer
  67641. * @returns true if everything that can be done was applied
  67642. */
  67643. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67644. }
  67645. /**
  67646. * Defines an optimization used to turn post-processes off
  67647. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67648. */
  67649. export class PostProcessesOptimization extends SceneOptimization {
  67650. /**
  67651. * Gets a string describing the action executed by the current optimization
  67652. * @return description string
  67653. */
  67654. getDescription(): string;
  67655. /**
  67656. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67657. * @param scene defines the current scene where to apply this optimization
  67658. * @param optimizer defines the current optimizer
  67659. * @returns true if everything that can be done was applied
  67660. */
  67661. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67662. }
  67663. /**
  67664. * Defines an optimization used to turn lens flares off
  67665. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67666. */
  67667. export class LensFlaresOptimization extends SceneOptimization {
  67668. /**
  67669. * Gets a string describing the action executed by the current optimization
  67670. * @return description string
  67671. */
  67672. getDescription(): string;
  67673. /**
  67674. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67675. * @param scene defines the current scene where to apply this optimization
  67676. * @param optimizer defines the current optimizer
  67677. * @returns true if everything that can be done was applied
  67678. */
  67679. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67680. }
  67681. /**
  67682. * Defines an optimization based on user defined callback.
  67683. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67684. */
  67685. export class CustomOptimization extends SceneOptimization {
  67686. /**
  67687. * Callback called to apply the custom optimization.
  67688. */
  67689. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  67690. /**
  67691. * Callback called to get custom description
  67692. */
  67693. onGetDescription: () => string;
  67694. /**
  67695. * Gets a string describing the action executed by the current optimization
  67696. * @returns description string
  67697. */
  67698. getDescription(): string;
  67699. /**
  67700. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67701. * @param scene defines the current scene where to apply this optimization
  67702. * @param optimizer defines the current optimizer
  67703. * @returns true if everything that can be done was applied
  67704. */
  67705. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67706. }
  67707. /**
  67708. * Defines an optimization used to turn particles off
  67709. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67710. */
  67711. export class ParticlesOptimization extends SceneOptimization {
  67712. /**
  67713. * Gets a string describing the action executed by the current optimization
  67714. * @return description string
  67715. */
  67716. getDescription(): string;
  67717. /**
  67718. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67719. * @param scene defines the current scene where to apply this optimization
  67720. * @param optimizer defines the current optimizer
  67721. * @returns true if everything that can be done was applied
  67722. */
  67723. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67724. }
  67725. /**
  67726. * Defines an optimization used to turn render targets off
  67727. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67728. */
  67729. export class RenderTargetsOptimization extends SceneOptimization {
  67730. /**
  67731. * Gets a string describing the action executed by the current optimization
  67732. * @return description string
  67733. */
  67734. getDescription(): string;
  67735. /**
  67736. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67737. * @param scene defines the current scene where to apply this optimization
  67738. * @param optimizer defines the current optimizer
  67739. * @returns true if everything that can be done was applied
  67740. */
  67741. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67742. }
  67743. /**
  67744. * Defines an optimization used to merge meshes with compatible materials
  67745. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67746. */
  67747. export class MergeMeshesOptimization extends SceneOptimization {
  67748. private static _UpdateSelectionTree;
  67749. /**
  67750. * Gets or sets a boolean which defines if optimization octree has to be updated
  67751. */
  67752. /**
  67753. * Gets or sets a boolean which defines if optimization octree has to be updated
  67754. */
  67755. static UpdateSelectionTree: boolean;
  67756. /**
  67757. * Gets a string describing the action executed by the current optimization
  67758. * @return description string
  67759. */
  67760. getDescription(): string;
  67761. private _canBeMerged;
  67762. /**
  67763. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67764. * @param scene defines the current scene where to apply this optimization
  67765. * @param optimizer defines the current optimizer
  67766. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  67767. * @returns true if everything that can be done was applied
  67768. */
  67769. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  67770. }
  67771. /**
  67772. * Defines a list of options used by SceneOptimizer
  67773. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67774. */
  67775. export class SceneOptimizerOptions {
  67776. /**
  67777. * Defines the target frame rate to reach (60 by default)
  67778. */
  67779. targetFrameRate: number;
  67780. /**
  67781. * Defines the interval between two checkes (2000ms by default)
  67782. */
  67783. trackerDuration: number;
  67784. /**
  67785. * Gets the list of optimizations to apply
  67786. */
  67787. optimizations: SceneOptimization[];
  67788. /**
  67789. * Creates a new list of options used by SceneOptimizer
  67790. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  67791. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  67792. */
  67793. constructor(
  67794. /**
  67795. * Defines the target frame rate to reach (60 by default)
  67796. */
  67797. targetFrameRate?: number,
  67798. /**
  67799. * Defines the interval between two checkes (2000ms by default)
  67800. */
  67801. trackerDuration?: number);
  67802. /**
  67803. * Add a new optimization
  67804. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  67805. * @returns the current SceneOptimizerOptions
  67806. */
  67807. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  67808. /**
  67809. * Add a new custom optimization
  67810. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  67811. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  67812. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67813. * @returns the current SceneOptimizerOptions
  67814. */
  67815. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  67816. /**
  67817. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  67818. * @param targetFrameRate defines the target frame rate (60 by default)
  67819. * @returns a SceneOptimizerOptions object
  67820. */
  67821. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67822. /**
  67823. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  67824. * @param targetFrameRate defines the target frame rate (60 by default)
  67825. * @returns a SceneOptimizerOptions object
  67826. */
  67827. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67828. /**
  67829. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  67830. * @param targetFrameRate defines the target frame rate (60 by default)
  67831. * @returns a SceneOptimizerOptions object
  67832. */
  67833. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67834. }
  67835. /**
  67836. * Class used to run optimizations in order to reach a target frame rate
  67837. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67838. */
  67839. export class SceneOptimizer implements IDisposable {
  67840. private _isRunning;
  67841. private _options;
  67842. private _scene;
  67843. private _currentPriorityLevel;
  67844. private _targetFrameRate;
  67845. private _trackerDuration;
  67846. private _currentFrameRate;
  67847. private _sceneDisposeObserver;
  67848. private _improvementMode;
  67849. /**
  67850. * Defines an observable called when the optimizer reaches the target frame rate
  67851. */
  67852. onSuccessObservable: Observable<SceneOptimizer>;
  67853. /**
  67854. * Defines an observable called when the optimizer enables an optimization
  67855. */
  67856. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  67857. /**
  67858. * Defines an observable called when the optimizer is not able to reach the target frame rate
  67859. */
  67860. onFailureObservable: Observable<SceneOptimizer>;
  67861. /**
  67862. * Gets a boolean indicating if the optimizer is in improvement mode
  67863. */
  67864. readonly isInImprovementMode: boolean;
  67865. /**
  67866. * Gets the current priority level (0 at start)
  67867. */
  67868. readonly currentPriorityLevel: number;
  67869. /**
  67870. * Gets the current frame rate checked by the SceneOptimizer
  67871. */
  67872. readonly currentFrameRate: number;
  67873. /**
  67874. * Gets or sets the current target frame rate (60 by default)
  67875. */
  67876. /**
  67877. * Gets or sets the current target frame rate (60 by default)
  67878. */
  67879. targetFrameRate: number;
  67880. /**
  67881. * Gets or sets the current interval between two checks (every 2000ms by default)
  67882. */
  67883. /**
  67884. * Gets or sets the current interval between two checks (every 2000ms by default)
  67885. */
  67886. trackerDuration: number;
  67887. /**
  67888. * Gets the list of active optimizations
  67889. */
  67890. readonly optimizations: SceneOptimization[];
  67891. /**
  67892. * Creates a new SceneOptimizer
  67893. * @param scene defines the scene to work on
  67894. * @param options defines the options to use with the SceneOptimizer
  67895. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  67896. * @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)
  67897. */
  67898. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  67899. /**
  67900. * Stops the current optimizer
  67901. */
  67902. stop(): void;
  67903. /**
  67904. * Reset the optimizer to initial step (current priority level = 0)
  67905. */
  67906. reset(): void;
  67907. /**
  67908. * Start the optimizer. By default it will try to reach a specific framerate
  67909. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  67910. */
  67911. start(): void;
  67912. private _checkCurrentState;
  67913. /**
  67914. * Release all resources
  67915. */
  67916. dispose(): void;
  67917. /**
  67918. * Helper function to create a SceneOptimizer with one single line of code
  67919. * @param scene defines the scene to work on
  67920. * @param options defines the options to use with the SceneOptimizer
  67921. * @param onSuccess defines a callback to call on success
  67922. * @param onFailure defines a callback to call on failure
  67923. * @returns the new SceneOptimizer object
  67924. */
  67925. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  67926. }
  67927. }
  67928. declare module "babylonjs/Misc/sceneSerializer" {
  67929. import { Scene } from "babylonjs/scene";
  67930. /**
  67931. * Class used to serialize a scene into a string
  67932. */
  67933. export class SceneSerializer {
  67934. /**
  67935. * Clear cache used by a previous serialization
  67936. */
  67937. static ClearCache(): void;
  67938. /**
  67939. * Serialize a scene into a JSON compatible object
  67940. * @param scene defines the scene to serialize
  67941. * @returns a JSON compatible object
  67942. */
  67943. static Serialize(scene: Scene): any;
  67944. /**
  67945. * Serialize a mesh into a JSON compatible object
  67946. * @param toSerialize defines the mesh to serialize
  67947. * @param withParents defines if parents must be serialized as well
  67948. * @param withChildren defines if children must be serialized as well
  67949. * @returns a JSON compatible object
  67950. */
  67951. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  67952. }
  67953. }
  67954. declare module "babylonjs/Misc/textureTools" {
  67955. import { Texture } from "babylonjs/Materials/Textures/texture";
  67956. /**
  67957. * Class used to host texture specific utilities
  67958. */
  67959. export class TextureTools {
  67960. /**
  67961. * Uses the GPU to create a copy texture rescaled at a given size
  67962. * @param texture Texture to copy from
  67963. * @param width defines the desired width
  67964. * @param height defines the desired height
  67965. * @param useBilinearMode defines if bilinear mode has to be used
  67966. * @return the generated texture
  67967. */
  67968. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  67969. }
  67970. }
  67971. declare module "babylonjs/Misc/videoRecorder" {
  67972. import { Nullable } from "babylonjs/types";
  67973. import { Engine } from "babylonjs/Engines/engine";
  67974. /**
  67975. * This represents the different options available for the video capture.
  67976. */
  67977. export interface VideoRecorderOptions {
  67978. /** Defines the mime type of the video. */
  67979. mimeType: string;
  67980. /** Defines the FPS the video should be recorded at. */
  67981. fps: number;
  67982. /** Defines the chunk size for the recording data. */
  67983. recordChunckSize: number;
  67984. /** The audio tracks to attach to the recording. */
  67985. audioTracks?: MediaStreamTrack[];
  67986. }
  67987. /**
  67988. * This can help with recording videos from BabylonJS.
  67989. * This is based on the available WebRTC functionalities of the browser.
  67990. *
  67991. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  67992. */
  67993. export class VideoRecorder {
  67994. private static readonly _defaultOptions;
  67995. /**
  67996. * Returns whether or not the VideoRecorder is available in your browser.
  67997. * @param engine Defines the Babylon Engine.
  67998. * @returns true if supported otherwise false.
  67999. */
  68000. static IsSupported(engine: Engine): boolean;
  68001. private readonly _options;
  68002. private _canvas;
  68003. private _mediaRecorder;
  68004. private _recordedChunks;
  68005. private _fileName;
  68006. private _resolve;
  68007. private _reject;
  68008. /**
  68009. * True when a recording is already in progress.
  68010. */
  68011. readonly isRecording: boolean;
  68012. /**
  68013. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  68014. * @param engine Defines the BabylonJS Engine you wish to record.
  68015. * @param options Defines options that can be used to customize the capture.
  68016. */
  68017. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  68018. /**
  68019. * Stops the current recording before the default capture timeout passed in the startRecording function.
  68020. */
  68021. stopRecording(): void;
  68022. /**
  68023. * Starts recording the canvas for a max duration specified in parameters.
  68024. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  68025. * If null no automatic download will start and you can rely on the promise to get the data back.
  68026. * @param maxDuration Defines the maximum recording time in seconds.
  68027. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  68028. * @return A promise callback at the end of the recording with the video data in Blob.
  68029. */
  68030. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  68031. /**
  68032. * Releases internal resources used during the recording.
  68033. */
  68034. dispose(): void;
  68035. private _handleDataAvailable;
  68036. private _handleError;
  68037. private _handleStop;
  68038. }
  68039. }
  68040. declare module "babylonjs/Misc/screenshotTools" {
  68041. import { Camera } from "babylonjs/Cameras/camera";
  68042. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  68043. import { Engine } from "babylonjs/Engines/engine";
  68044. /**
  68045. * Class containing a set of static utilities functions for screenshots
  68046. */
  68047. export class ScreenshotTools {
  68048. /**
  68049. * Captures a screenshot of the current rendering
  68050. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  68051. * @param engine defines the rendering engine
  68052. * @param camera defines the source camera
  68053. * @param size This parameter can be set to a single number or to an object with the
  68054. * following (optional) properties: precision, width, height. If a single number is passed,
  68055. * it will be used for both width and height. If an object is passed, the screenshot size
  68056. * will be derived from the parameters. The precision property is a multiplier allowing
  68057. * rendering at a higher or lower resolution
  68058. * @param successCallback defines the callback receives a single parameter which contains the
  68059. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  68060. * src parameter of an <img> to display it
  68061. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  68062. * Check your browser for supported MIME types
  68063. */
  68064. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  68065. /**
  68066. * Captures a screenshot of the current rendering
  68067. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  68068. * @param engine defines the rendering engine
  68069. * @param camera defines the source camera
  68070. * @param size This parameter can be set to a single number or to an object with the
  68071. * following (optional) properties: precision, width, height. If a single number is passed,
  68072. * it will be used for both width and height. If an object is passed, the screenshot size
  68073. * will be derived from the parameters. The precision property is a multiplier allowing
  68074. * rendering at a higher or lower resolution
  68075. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  68076. * Check your browser for supported MIME types
  68077. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  68078. * to the src parameter of an <img> to display it
  68079. */
  68080. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  68081. /**
  68082. * Generates an image screenshot from the specified camera.
  68083. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  68084. * @param engine The engine to use for rendering
  68085. * @param camera The camera to use for rendering
  68086. * @param size This parameter can be set to a single number or to an object with the
  68087. * following (optional) properties: precision, width, height. If a single number is passed,
  68088. * it will be used for both width and height. If an object is passed, the screenshot size
  68089. * will be derived from the parameters. The precision property is a multiplier allowing
  68090. * rendering at a higher or lower resolution
  68091. * @param successCallback The callback receives a single parameter which contains the
  68092. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  68093. * src parameter of an <img> to display it
  68094. * @param mimeType The MIME type of the screenshot image (default: image/png).
  68095. * Check your browser for supported MIME types
  68096. * @param samples Texture samples (default: 1)
  68097. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  68098. * @param fileName A name for for the downloaded file.
  68099. */
  68100. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  68101. /**
  68102. * Generates an image screenshot from the specified camera.
  68103. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  68104. * @param engine The engine to use for rendering
  68105. * @param camera The camera to use for rendering
  68106. * @param size This parameter can be set to a single number or to an object with the
  68107. * following (optional) properties: precision, width, height. If a single number is passed,
  68108. * it will be used for both width and height. If an object is passed, the screenshot size
  68109. * will be derived from the parameters. The precision property is a multiplier allowing
  68110. * rendering at a higher or lower resolution
  68111. * @param mimeType The MIME type of the screenshot image (default: image/png).
  68112. * Check your browser for supported MIME types
  68113. * @param samples Texture samples (default: 1)
  68114. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  68115. * @param fileName A name for for the downloaded file.
  68116. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  68117. * to the src parameter of an <img> to display it
  68118. */
  68119. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  68120. /**
  68121. * Gets height and width for screenshot size
  68122. * @private
  68123. */
  68124. private static _getScreenshotSize;
  68125. }
  68126. }
  68127. declare module "babylonjs/Misc/dataReader" {
  68128. /**
  68129. * Interface for a data buffer
  68130. */
  68131. export interface IDataBuffer {
  68132. /**
  68133. * Reads bytes from the data buffer.
  68134. * @param byteOffset The byte offset to read
  68135. * @param byteLength The byte length to read
  68136. * @returns A promise that resolves when the bytes are read
  68137. */
  68138. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  68139. /**
  68140. * The byte length of the buffer.
  68141. */
  68142. readonly byteLength: number;
  68143. }
  68144. /**
  68145. * Utility class for reading from a data buffer
  68146. */
  68147. export class DataReader {
  68148. /**
  68149. * The data buffer associated with this data reader.
  68150. */
  68151. readonly buffer: IDataBuffer;
  68152. /**
  68153. * The current byte offset from the beginning of the data buffer.
  68154. */
  68155. byteOffset: number;
  68156. private _dataView;
  68157. private _dataByteOffset;
  68158. /**
  68159. * Constructor
  68160. * @param buffer The buffer to read
  68161. */
  68162. constructor(buffer: IDataBuffer);
  68163. /**
  68164. * Loads the given byte length.
  68165. * @param byteLength The byte length to load
  68166. * @returns A promise that resolves when the load is complete
  68167. */
  68168. loadAsync(byteLength: number): Promise<void>;
  68169. /**
  68170. * Read a unsigned 32-bit integer from the currently loaded data range.
  68171. * @returns The 32-bit integer read
  68172. */
  68173. readUint32(): number;
  68174. /**
  68175. * Read a byte array from the currently loaded data range.
  68176. * @param byteLength The byte length to read
  68177. * @returns The byte array read
  68178. */
  68179. readUint8Array(byteLength: number): Uint8Array;
  68180. /**
  68181. * Read a string from the currently loaded data range.
  68182. * @param byteLength The byte length to read
  68183. * @returns The string read
  68184. */
  68185. readString(byteLength: number): string;
  68186. /**
  68187. * Skips the given byte length the currently loaded data range.
  68188. * @param byteLength The byte length to skip
  68189. */
  68190. skipBytes(byteLength: number): void;
  68191. }
  68192. }
  68193. declare module "babylonjs/Misc/index" {
  68194. export * from "babylonjs/Misc/andOrNotEvaluator";
  68195. export * from "babylonjs/Misc/assetsManager";
  68196. export * from "babylonjs/Misc/dds";
  68197. export * from "babylonjs/Misc/decorators";
  68198. export * from "babylonjs/Misc/deferred";
  68199. export * from "babylonjs/Misc/environmentTextureTools";
  68200. export * from "babylonjs/Misc/meshExploder";
  68201. export * from "babylonjs/Misc/filesInput";
  68202. export * from "babylonjs/Misc/HighDynamicRange/index";
  68203. export * from "babylonjs/Misc/khronosTextureContainer";
  68204. export * from "babylonjs/Misc/observable";
  68205. export * from "babylonjs/Misc/performanceMonitor";
  68206. export * from "babylonjs/Misc/promise";
  68207. export * from "babylonjs/Misc/sceneOptimizer";
  68208. export * from "babylonjs/Misc/sceneSerializer";
  68209. export * from "babylonjs/Misc/smartArray";
  68210. export * from "babylonjs/Misc/stringDictionary";
  68211. export * from "babylonjs/Misc/tags";
  68212. export * from "babylonjs/Misc/textureTools";
  68213. export * from "babylonjs/Misc/tga";
  68214. export * from "babylonjs/Misc/tools";
  68215. export * from "babylonjs/Misc/videoRecorder";
  68216. export * from "babylonjs/Misc/virtualJoystick";
  68217. export * from "babylonjs/Misc/workerPool";
  68218. export * from "babylonjs/Misc/logger";
  68219. export * from "babylonjs/Misc/typeStore";
  68220. export * from "babylonjs/Misc/filesInputStore";
  68221. export * from "babylonjs/Misc/deepCopier";
  68222. export * from "babylonjs/Misc/pivotTools";
  68223. export * from "babylonjs/Misc/precisionDate";
  68224. export * from "babylonjs/Misc/screenshotTools";
  68225. export * from "babylonjs/Misc/typeStore";
  68226. export * from "babylonjs/Misc/webRequest";
  68227. export * from "babylonjs/Misc/iInspectable";
  68228. export * from "babylonjs/Misc/brdfTextureTools";
  68229. export * from "babylonjs/Misc/rgbdTextureTools";
  68230. export * from "babylonjs/Misc/gradients";
  68231. export * from "babylonjs/Misc/perfCounter";
  68232. export * from "babylonjs/Misc/fileRequest";
  68233. export * from "babylonjs/Misc/customAnimationFrameRequester";
  68234. export * from "babylonjs/Misc/retryStrategy";
  68235. export * from "babylonjs/Misc/interfaces/screenshotSize";
  68236. export * from "babylonjs/Misc/canvasGenerator";
  68237. export * from "babylonjs/Misc/fileTools";
  68238. export * from "babylonjs/Misc/stringTools";
  68239. export * from "babylonjs/Misc/dataReader";
  68240. }
  68241. declare module "babylonjs/index" {
  68242. export * from "babylonjs/abstractScene";
  68243. export * from "babylonjs/Actions/index";
  68244. export * from "babylonjs/Animations/index";
  68245. export * from "babylonjs/assetContainer";
  68246. export * from "babylonjs/Audio/index";
  68247. export * from "babylonjs/Behaviors/index";
  68248. export * from "babylonjs/Bones/index";
  68249. export * from "babylonjs/Cameras/index";
  68250. export * from "babylonjs/Collisions/index";
  68251. export * from "babylonjs/Culling/index";
  68252. export * from "babylonjs/Debug/index";
  68253. export * from "babylonjs/Engines/index";
  68254. export * from "babylonjs/Events/index";
  68255. export * from "babylonjs/Gamepads/index";
  68256. export * from "babylonjs/Gizmos/index";
  68257. export * from "babylonjs/Helpers/index";
  68258. export * from "babylonjs/Instrumentation/index";
  68259. export * from "babylonjs/Layers/index";
  68260. export * from "babylonjs/LensFlares/index";
  68261. export * from "babylonjs/Lights/index";
  68262. export * from "babylonjs/Loading/index";
  68263. export * from "babylonjs/Materials/index";
  68264. export * from "babylonjs/Maths/index";
  68265. export * from "babylonjs/Meshes/index";
  68266. export * from "babylonjs/Morph/index";
  68267. export * from "babylonjs/Navigation/index";
  68268. export * from "babylonjs/node";
  68269. export * from "babylonjs/Offline/index";
  68270. export * from "babylonjs/Particles/index";
  68271. export * from "babylonjs/Physics/index";
  68272. export * from "babylonjs/PostProcesses/index";
  68273. export * from "babylonjs/Probes/index";
  68274. export * from "babylonjs/Rendering/index";
  68275. export * from "babylonjs/scene";
  68276. export * from "babylonjs/sceneComponent";
  68277. export * from "babylonjs/Sprites/index";
  68278. export * from "babylonjs/States/index";
  68279. export * from "babylonjs/Misc/index";
  68280. export * from "babylonjs/types";
  68281. }
  68282. declare module "babylonjs/Animations/pathCursor" {
  68283. import { Vector3 } from "babylonjs/Maths/math.vector";
  68284. import { Path2 } from "babylonjs/Maths/math.path";
  68285. /**
  68286. * A cursor which tracks a point on a path
  68287. */
  68288. export class PathCursor {
  68289. private path;
  68290. /**
  68291. * Stores path cursor callbacks for when an onchange event is triggered
  68292. */
  68293. private _onchange;
  68294. /**
  68295. * The value of the path cursor
  68296. */
  68297. value: number;
  68298. /**
  68299. * The animation array of the path cursor
  68300. */
  68301. animations: Animation[];
  68302. /**
  68303. * Initializes the path cursor
  68304. * @param path The path to track
  68305. */
  68306. constructor(path: Path2);
  68307. /**
  68308. * Gets the cursor point on the path
  68309. * @returns A point on the path cursor at the cursor location
  68310. */
  68311. getPoint(): Vector3;
  68312. /**
  68313. * Moves the cursor ahead by the step amount
  68314. * @param step The amount to move the cursor forward
  68315. * @returns This path cursor
  68316. */
  68317. moveAhead(step?: number): PathCursor;
  68318. /**
  68319. * Moves the cursor behind by the step amount
  68320. * @param step The amount to move the cursor back
  68321. * @returns This path cursor
  68322. */
  68323. moveBack(step?: number): PathCursor;
  68324. /**
  68325. * Moves the cursor by the step amount
  68326. * If the step amount is greater than one, an exception is thrown
  68327. * @param step The amount to move the cursor
  68328. * @returns This path cursor
  68329. */
  68330. move(step: number): PathCursor;
  68331. /**
  68332. * Ensures that the value is limited between zero and one
  68333. * @returns This path cursor
  68334. */
  68335. private ensureLimits;
  68336. /**
  68337. * Runs onchange callbacks on change (used by the animation engine)
  68338. * @returns This path cursor
  68339. */
  68340. private raiseOnChange;
  68341. /**
  68342. * Executes a function on change
  68343. * @param f A path cursor onchange callback
  68344. * @returns This path cursor
  68345. */
  68346. onchange(f: (cursor: PathCursor) => void): PathCursor;
  68347. }
  68348. }
  68349. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  68350. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  68351. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  68352. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  68353. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  68354. }
  68355. declare module "babylonjs/Engines/Processors/Expressions/index" {
  68356. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  68357. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  68358. }
  68359. declare module "babylonjs/Engines/Processors/index" {
  68360. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  68361. export * from "babylonjs/Engines/Processors/Expressions/index";
  68362. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  68363. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  68364. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  68365. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  68366. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  68367. export * from "babylonjs/Engines/Processors/shaderProcessor";
  68368. }
  68369. declare module "babylonjs/Legacy/legacy" {
  68370. import * as Babylon from "babylonjs/index";
  68371. export * from "babylonjs/index";
  68372. }
  68373. declare module "babylonjs/Shaders/blur.fragment" {
  68374. /** @hidden */
  68375. export var blurPixelShader: {
  68376. name: string;
  68377. shader: string;
  68378. };
  68379. }
  68380. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  68381. /** @hidden */
  68382. export var pointCloudVertexDeclaration: {
  68383. name: string;
  68384. shader: string;
  68385. };
  68386. }
  68387. declare module "babylonjs" {
  68388. export * from "babylonjs/Legacy/legacy";
  68389. }
  68390. declare module BABYLON {
  68391. /** Alias type for value that can be null */
  68392. export type Nullable<T> = T | null;
  68393. /**
  68394. * Alias type for number that are floats
  68395. * @ignorenaming
  68396. */
  68397. export type float = number;
  68398. /**
  68399. * Alias type for number that are doubles.
  68400. * @ignorenaming
  68401. */
  68402. export type double = number;
  68403. /**
  68404. * Alias type for number that are integer
  68405. * @ignorenaming
  68406. */
  68407. export type int = number;
  68408. /** Alias type for number array or Float32Array */
  68409. export type FloatArray = number[] | Float32Array;
  68410. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  68411. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  68412. /**
  68413. * Alias for types that can be used by a Buffer or VertexBuffer.
  68414. */
  68415. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  68416. /**
  68417. * Alias type for primitive types
  68418. * @ignorenaming
  68419. */
  68420. type Primitive = undefined | null | boolean | string | number | Function;
  68421. /**
  68422. * Type modifier to make all the properties of an object Readonly
  68423. */
  68424. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  68425. /**
  68426. * Type modifier to make all the properties of an object Readonly recursively
  68427. */
  68428. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  68429. /**
  68430. * Type modifier to make object properties readonly.
  68431. */
  68432. export type DeepImmutableObject<T> = {
  68433. readonly [K in keyof T]: DeepImmutable<T[K]>;
  68434. };
  68435. /** @hidden */
  68436. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  68437. }
  68438. }
  68439. declare module BABYLON {
  68440. /**
  68441. * A class serves as a medium between the observable and its observers
  68442. */
  68443. export class EventState {
  68444. /**
  68445. * Create a new EventState
  68446. * @param mask defines the mask associated with this state
  68447. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68448. * @param target defines the original target of the state
  68449. * @param currentTarget defines the current target of the state
  68450. */
  68451. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  68452. /**
  68453. * Initialize the current event state
  68454. * @param mask defines the mask associated with this state
  68455. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68456. * @param target defines the original target of the state
  68457. * @param currentTarget defines the current target of the state
  68458. * @returns the current event state
  68459. */
  68460. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  68461. /**
  68462. * An Observer can set this property to true to prevent subsequent observers of being notified
  68463. */
  68464. skipNextObservers: boolean;
  68465. /**
  68466. * Get the mask value that were used to trigger the event corresponding to this EventState object
  68467. */
  68468. mask: number;
  68469. /**
  68470. * The object that originally notified the event
  68471. */
  68472. target?: any;
  68473. /**
  68474. * The current object in the bubbling phase
  68475. */
  68476. currentTarget?: any;
  68477. /**
  68478. * This will be populated with the return value of the last function that was executed.
  68479. * If it is the first function in the callback chain it will be the event data.
  68480. */
  68481. lastReturnValue?: any;
  68482. }
  68483. /**
  68484. * Represent an Observer registered to a given Observable object.
  68485. */
  68486. export class Observer<T> {
  68487. /**
  68488. * Defines the callback to call when the observer is notified
  68489. */
  68490. callback: (eventData: T, eventState: EventState) => void;
  68491. /**
  68492. * Defines the mask of the observer (used to filter notifications)
  68493. */
  68494. mask: number;
  68495. /**
  68496. * Defines the current scope used to restore the JS context
  68497. */
  68498. scope: any;
  68499. /** @hidden */
  68500. _willBeUnregistered: boolean;
  68501. /**
  68502. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  68503. */
  68504. unregisterOnNextCall: boolean;
  68505. /**
  68506. * Creates a new observer
  68507. * @param callback defines the callback to call when the observer is notified
  68508. * @param mask defines the mask of the observer (used to filter notifications)
  68509. * @param scope defines the current scope used to restore the JS context
  68510. */
  68511. constructor(
  68512. /**
  68513. * Defines the callback to call when the observer is notified
  68514. */
  68515. callback: (eventData: T, eventState: EventState) => void,
  68516. /**
  68517. * Defines the mask of the observer (used to filter notifications)
  68518. */
  68519. mask: number,
  68520. /**
  68521. * Defines the current scope used to restore the JS context
  68522. */
  68523. scope?: any);
  68524. }
  68525. /**
  68526. * Represent a list of observers registered to multiple Observables object.
  68527. */
  68528. export class MultiObserver<T> {
  68529. private _observers;
  68530. private _observables;
  68531. /**
  68532. * Release associated resources
  68533. */
  68534. dispose(): void;
  68535. /**
  68536. * Raise a callback when one of the observable will notify
  68537. * @param observables defines a list of observables to watch
  68538. * @param callback defines the callback to call on notification
  68539. * @param mask defines the mask used to filter notifications
  68540. * @param scope defines the current scope used to restore the JS context
  68541. * @returns the new MultiObserver
  68542. */
  68543. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  68544. }
  68545. /**
  68546. * The Observable class is a simple implementation of the Observable pattern.
  68547. *
  68548. * 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.
  68549. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  68550. * 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).
  68551. * 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.
  68552. */
  68553. export class Observable<T> {
  68554. private _observers;
  68555. private _eventState;
  68556. private _onObserverAdded;
  68557. /**
  68558. * Gets the list of observers
  68559. */
  68560. readonly observers: Array<Observer<T>>;
  68561. /**
  68562. * Creates a new observable
  68563. * @param onObserverAdded defines a callback to call when a new observer is added
  68564. */
  68565. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  68566. /**
  68567. * Create a new Observer with the specified callback
  68568. * @param callback the callback that will be executed for that Observer
  68569. * @param mask the mask used to filter observers
  68570. * @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.
  68571. * @param scope optional scope for the callback to be called from
  68572. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  68573. * @returns the new observer created for the callback
  68574. */
  68575. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  68576. /**
  68577. * Create a new Observer with the specified callback and unregisters after the next notification
  68578. * @param callback the callback that will be executed for that Observer
  68579. * @returns the new observer created for the callback
  68580. */
  68581. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  68582. /**
  68583. * Remove an Observer from the Observable object
  68584. * @param observer the instance of the Observer to remove
  68585. * @returns false if it doesn't belong to this Observable
  68586. */
  68587. remove(observer: Nullable<Observer<T>>): boolean;
  68588. /**
  68589. * Remove a callback from the Observable object
  68590. * @param callback the callback to remove
  68591. * @param scope optional scope. If used only the callbacks with this scope will be removed
  68592. * @returns false if it doesn't belong to this Observable
  68593. */
  68594. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  68595. private _deferUnregister;
  68596. private _remove;
  68597. /**
  68598. * Moves the observable to the top of the observer list making it get called first when notified
  68599. * @param observer the observer to move
  68600. */
  68601. makeObserverTopPriority(observer: Observer<T>): void;
  68602. /**
  68603. * Moves the observable to the bottom of the observer list making it get called last when notified
  68604. * @param observer the observer to move
  68605. */
  68606. makeObserverBottomPriority(observer: Observer<T>): void;
  68607. /**
  68608. * Notify all Observers by calling their respective callback with the given data
  68609. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  68610. * @param eventData defines the data to send to all observers
  68611. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  68612. * @param target defines the original target of the state
  68613. * @param currentTarget defines the current target of the state
  68614. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  68615. */
  68616. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  68617. /**
  68618. * Calling this will execute each callback, expecting it to be a promise or return a value.
  68619. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  68620. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  68621. * and it is crucial that all callbacks will be executed.
  68622. * The order of the callbacks is kept, callbacks are not executed parallel.
  68623. *
  68624. * @param eventData The data to be sent to each callback
  68625. * @param mask is used to filter observers defaults to -1
  68626. * @param target defines the callback target (see EventState)
  68627. * @param currentTarget defines he current object in the bubbling phase
  68628. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  68629. */
  68630. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  68631. /**
  68632. * Notify a specific observer
  68633. * @param observer defines the observer to notify
  68634. * @param eventData defines the data to be sent to each callback
  68635. * @param mask is used to filter observers defaults to -1
  68636. */
  68637. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  68638. /**
  68639. * Gets a boolean indicating if the observable has at least one observer
  68640. * @returns true is the Observable has at least one Observer registered
  68641. */
  68642. hasObservers(): boolean;
  68643. /**
  68644. * Clear the list of observers
  68645. */
  68646. clear(): void;
  68647. /**
  68648. * Clone the current observable
  68649. * @returns a new observable
  68650. */
  68651. clone(): Observable<T>;
  68652. /**
  68653. * Does this observable handles observer registered with a given mask
  68654. * @param mask defines the mask to be tested
  68655. * @return whether or not one observer registered with the given mask is handeled
  68656. **/
  68657. hasSpecificMask(mask?: number): boolean;
  68658. }
  68659. }
  68660. declare module BABYLON {
  68661. /**
  68662. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  68663. * Babylon.js
  68664. */
  68665. export class DomManagement {
  68666. /**
  68667. * Checks if the window object exists
  68668. * @returns true if the window object exists
  68669. */
  68670. static IsWindowObjectExist(): boolean;
  68671. /**
  68672. * Checks if the navigator object exists
  68673. * @returns true if the navigator object exists
  68674. */
  68675. static IsNavigatorAvailable(): boolean;
  68676. /**
  68677. * Extracts text content from a DOM element hierarchy
  68678. * @param element defines the root element
  68679. * @returns a string
  68680. */
  68681. static GetDOMTextContent(element: HTMLElement): string;
  68682. }
  68683. }
  68684. declare module BABYLON {
  68685. /**
  68686. * Logger used througouht the application to allow configuration of
  68687. * the log level required for the messages.
  68688. */
  68689. export class Logger {
  68690. /**
  68691. * No log
  68692. */
  68693. static readonly NoneLogLevel: number;
  68694. /**
  68695. * Only message logs
  68696. */
  68697. static readonly MessageLogLevel: number;
  68698. /**
  68699. * Only warning logs
  68700. */
  68701. static readonly WarningLogLevel: number;
  68702. /**
  68703. * Only error logs
  68704. */
  68705. static readonly ErrorLogLevel: number;
  68706. /**
  68707. * All logs
  68708. */
  68709. static readonly AllLogLevel: number;
  68710. private static _LogCache;
  68711. /**
  68712. * Gets a value indicating the number of loading errors
  68713. * @ignorenaming
  68714. */
  68715. static errorsCount: number;
  68716. /**
  68717. * Callback called when a new log is added
  68718. */
  68719. static OnNewCacheEntry: (entry: string) => void;
  68720. private static _AddLogEntry;
  68721. private static _FormatMessage;
  68722. private static _LogDisabled;
  68723. private static _LogEnabled;
  68724. private static _WarnDisabled;
  68725. private static _WarnEnabled;
  68726. private static _ErrorDisabled;
  68727. private static _ErrorEnabled;
  68728. /**
  68729. * Log a message to the console
  68730. */
  68731. static Log: (message: string) => void;
  68732. /**
  68733. * Write a warning message to the console
  68734. */
  68735. static Warn: (message: string) => void;
  68736. /**
  68737. * Write an error message to the console
  68738. */
  68739. static Error: (message: string) => void;
  68740. /**
  68741. * Gets current log cache (list of logs)
  68742. */
  68743. static readonly LogCache: string;
  68744. /**
  68745. * Clears the log cache
  68746. */
  68747. static ClearLogCache(): void;
  68748. /**
  68749. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  68750. */
  68751. static LogLevels: number;
  68752. }
  68753. }
  68754. declare module BABYLON {
  68755. /** @hidden */
  68756. export class _TypeStore {
  68757. /** @hidden */
  68758. static RegisteredTypes: {
  68759. [key: string]: Object;
  68760. };
  68761. /** @hidden */
  68762. static GetClass(fqdn: string): any;
  68763. }
  68764. }
  68765. declare module BABYLON {
  68766. /**
  68767. * Helper to manipulate strings
  68768. */
  68769. export class StringTools {
  68770. /**
  68771. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  68772. * @param str Source string
  68773. * @param suffix Suffix to search for in the source string
  68774. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68775. */
  68776. static EndsWith(str: string, suffix: string): boolean;
  68777. /**
  68778. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  68779. * @param str Source string
  68780. * @param suffix Suffix to search for in the source string
  68781. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68782. */
  68783. static StartsWith(str: string, suffix: string): boolean;
  68784. /**
  68785. * Decodes a buffer into a string
  68786. * @param buffer The buffer to decode
  68787. * @returns The decoded string
  68788. */
  68789. static Decode(buffer: Uint8Array | Uint16Array): string;
  68790. /**
  68791. * Encode a buffer to a base64 string
  68792. * @param buffer defines the buffer to encode
  68793. * @returns the encoded string
  68794. */
  68795. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  68796. }
  68797. }
  68798. declare module BABYLON {
  68799. /**
  68800. * Class containing a set of static utilities functions for deep copy.
  68801. */
  68802. export class DeepCopier {
  68803. /**
  68804. * Tries to copy an object by duplicating every property
  68805. * @param source defines the source object
  68806. * @param destination defines the target object
  68807. * @param doNotCopyList defines a list of properties to avoid
  68808. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  68809. */
  68810. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  68811. }
  68812. }
  68813. declare module BABYLON {
  68814. /**
  68815. * Class containing a set of static utilities functions for precision date
  68816. */
  68817. export class PrecisionDate {
  68818. /**
  68819. * Gets either window.performance.now() if supported or Date.now() else
  68820. */
  68821. static readonly Now: number;
  68822. }
  68823. }
  68824. declare module BABYLON {
  68825. /** @hidden */
  68826. export class _DevTools {
  68827. static WarnImport(name: string): string;
  68828. }
  68829. }
  68830. declare module BABYLON {
  68831. /**
  68832. * Interface used to define the mechanism to get data from the network
  68833. */
  68834. export interface IWebRequest {
  68835. /**
  68836. * Returns client's response url
  68837. */
  68838. responseURL: string;
  68839. /**
  68840. * Returns client's status
  68841. */
  68842. status: number;
  68843. /**
  68844. * Returns client's status as a text
  68845. */
  68846. statusText: string;
  68847. }
  68848. }
  68849. declare module BABYLON {
  68850. /**
  68851. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  68852. */
  68853. export class WebRequest implements IWebRequest {
  68854. private _xhr;
  68855. /**
  68856. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  68857. * i.e. when loading files, where the server/service expects an Authorization header
  68858. */
  68859. static CustomRequestHeaders: {
  68860. [key: string]: string;
  68861. };
  68862. /**
  68863. * Add callback functions in this array to update all the requests before they get sent to the network
  68864. */
  68865. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  68866. private _injectCustomRequestHeaders;
  68867. /**
  68868. * Gets or sets a function to be called when loading progress changes
  68869. */
  68870. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  68871. /**
  68872. * Returns client's state
  68873. */
  68874. readonly readyState: number;
  68875. /**
  68876. * Returns client's status
  68877. */
  68878. readonly status: number;
  68879. /**
  68880. * Returns client's status as a text
  68881. */
  68882. readonly statusText: string;
  68883. /**
  68884. * Returns client's response
  68885. */
  68886. readonly response: any;
  68887. /**
  68888. * Returns client's response url
  68889. */
  68890. readonly responseURL: string;
  68891. /**
  68892. * Returns client's response as text
  68893. */
  68894. readonly responseText: string;
  68895. /**
  68896. * Gets or sets the expected response type
  68897. */
  68898. responseType: XMLHttpRequestResponseType;
  68899. /** @hidden */
  68900. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  68901. /** @hidden */
  68902. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  68903. /**
  68904. * Cancels any network activity
  68905. */
  68906. abort(): void;
  68907. /**
  68908. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  68909. * @param body defines an optional request body
  68910. */
  68911. send(body?: Document | BodyInit | null): void;
  68912. /**
  68913. * Sets the request method, request URL
  68914. * @param method defines the method to use (GET, POST, etc..)
  68915. * @param url defines the url to connect with
  68916. */
  68917. open(method: string, url: string): void;
  68918. /**
  68919. * Sets the value of a request header.
  68920. * @param name The name of the header whose value is to be set
  68921. * @param value The value to set as the body of the header
  68922. */
  68923. setRequestHeader(name: string, value: string): void;
  68924. /**
  68925. * Get the string containing the text of a particular header's value.
  68926. * @param name The name of the header
  68927. * @returns The string containing the text of the given header name
  68928. */
  68929. getResponseHeader(name: string): Nullable<string>;
  68930. }
  68931. }
  68932. declare module BABYLON {
  68933. /**
  68934. * File request interface
  68935. */
  68936. export interface IFileRequest {
  68937. /**
  68938. * Raised when the request is complete (success or error).
  68939. */
  68940. onCompleteObservable: Observable<IFileRequest>;
  68941. /**
  68942. * Aborts the request for a file.
  68943. */
  68944. abort: () => void;
  68945. }
  68946. }
  68947. declare module BABYLON {
  68948. /**
  68949. * Define options used to create a render target texture
  68950. */
  68951. export class RenderTargetCreationOptions {
  68952. /**
  68953. * Specifies is mipmaps must be generated
  68954. */
  68955. generateMipMaps?: boolean;
  68956. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  68957. generateDepthBuffer?: boolean;
  68958. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  68959. generateStencilBuffer?: boolean;
  68960. /** Defines texture type (int by default) */
  68961. type?: number;
  68962. /** Defines sampling mode (trilinear by default) */
  68963. samplingMode?: number;
  68964. /** Defines format (RGBA by default) */
  68965. format?: number;
  68966. }
  68967. }
  68968. declare module BABYLON {
  68969. /**
  68970. * @hidden
  68971. **/
  68972. export class _TimeToken {
  68973. _startTimeQuery: Nullable<WebGLQuery>;
  68974. _endTimeQuery: Nullable<WebGLQuery>;
  68975. _timeElapsedQuery: Nullable<WebGLQuery>;
  68976. _timeElapsedQueryEnded: boolean;
  68977. }
  68978. }
  68979. declare module BABYLON {
  68980. /** Defines the cross module used constants to avoid circular dependncies */
  68981. export class Constants {
  68982. /** Defines that alpha blending is disabled */
  68983. static readonly ALPHA_DISABLE: number;
  68984. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  68985. static readonly ALPHA_ADD: number;
  68986. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  68987. static readonly ALPHA_COMBINE: number;
  68988. /** Defines that alpha blending to DEST - SRC * DEST */
  68989. static readonly ALPHA_SUBTRACT: number;
  68990. /** Defines that alpha blending to SRC * DEST */
  68991. static readonly ALPHA_MULTIPLY: number;
  68992. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  68993. static readonly ALPHA_MAXIMIZED: number;
  68994. /** Defines that alpha blending to SRC + DEST */
  68995. static readonly ALPHA_ONEONE: number;
  68996. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  68997. static readonly ALPHA_PREMULTIPLIED: number;
  68998. /**
  68999. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  69000. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  69001. */
  69002. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  69003. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  69004. static readonly ALPHA_INTERPOLATE: number;
  69005. /**
  69006. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  69007. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  69008. */
  69009. static readonly ALPHA_SCREENMODE: number;
  69010. /**
  69011. * Defines that alpha blending to SRC + DST
  69012. * Alpha will be set to SRC ALPHA + DST ALPHA
  69013. */
  69014. static readonly ALPHA_ONEONE_ONEONE: number;
  69015. /**
  69016. * Defines that alpha blending to SRC * DST ALPHA + DST
  69017. * Alpha will be set to 0
  69018. */
  69019. static readonly ALPHA_ALPHATOCOLOR: number;
  69020. /**
  69021. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  69022. */
  69023. static readonly ALPHA_REVERSEONEMINUS: number;
  69024. /**
  69025. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  69026. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  69027. */
  69028. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  69029. /**
  69030. * Defines that alpha blending to SRC + DST
  69031. * Alpha will be set to SRC ALPHA
  69032. */
  69033. static readonly ALPHA_ONEONE_ONEZERO: number;
  69034. /** Defines that alpha blending equation a SUM */
  69035. static readonly ALPHA_EQUATION_ADD: number;
  69036. /** Defines that alpha blending equation a SUBSTRACTION */
  69037. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  69038. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  69039. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  69040. /** Defines that alpha blending equation a MAX operation */
  69041. static readonly ALPHA_EQUATION_MAX: number;
  69042. /** Defines that alpha blending equation a MIN operation */
  69043. static readonly ALPHA_EQUATION_MIN: number;
  69044. /**
  69045. * Defines that alpha blending equation a DARKEN operation:
  69046. * It takes the min of the src and sums the alpha channels.
  69047. */
  69048. static readonly ALPHA_EQUATION_DARKEN: number;
  69049. /** Defines that the ressource is not delayed*/
  69050. static readonly DELAYLOADSTATE_NONE: number;
  69051. /** Defines that the ressource was successfully delay loaded */
  69052. static readonly DELAYLOADSTATE_LOADED: number;
  69053. /** Defines that the ressource is currently delay loading */
  69054. static readonly DELAYLOADSTATE_LOADING: number;
  69055. /** Defines that the ressource is delayed and has not started loading */
  69056. static readonly DELAYLOADSTATE_NOTLOADED: number;
  69057. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  69058. static readonly NEVER: number;
  69059. /** 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 */
  69060. static readonly ALWAYS: number;
  69061. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  69062. static readonly LESS: number;
  69063. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  69064. static readonly EQUAL: number;
  69065. /** 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 */
  69066. static readonly LEQUAL: number;
  69067. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  69068. static readonly GREATER: number;
  69069. /** 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 */
  69070. static readonly GEQUAL: number;
  69071. /** 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 */
  69072. static readonly NOTEQUAL: number;
  69073. /** Passed to stencilOperation to specify that stencil value must be kept */
  69074. static readonly KEEP: number;
  69075. /** Passed to stencilOperation to specify that stencil value must be replaced */
  69076. static readonly REPLACE: number;
  69077. /** Passed to stencilOperation to specify that stencil value must be incremented */
  69078. static readonly INCR: number;
  69079. /** Passed to stencilOperation to specify that stencil value must be decremented */
  69080. static readonly DECR: number;
  69081. /** Passed to stencilOperation to specify that stencil value must be inverted */
  69082. static readonly INVERT: number;
  69083. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  69084. static readonly INCR_WRAP: number;
  69085. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  69086. static readonly DECR_WRAP: number;
  69087. /** Texture is not repeating outside of 0..1 UVs */
  69088. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  69089. /** Texture is repeating outside of 0..1 UVs */
  69090. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  69091. /** Texture is repeating and mirrored */
  69092. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  69093. /** ALPHA */
  69094. static readonly TEXTUREFORMAT_ALPHA: number;
  69095. /** LUMINANCE */
  69096. static readonly TEXTUREFORMAT_LUMINANCE: number;
  69097. /** LUMINANCE_ALPHA */
  69098. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  69099. /** RGB */
  69100. static readonly TEXTUREFORMAT_RGB: number;
  69101. /** RGBA */
  69102. static readonly TEXTUREFORMAT_RGBA: number;
  69103. /** RED */
  69104. static readonly TEXTUREFORMAT_RED: number;
  69105. /** RED (2nd reference) */
  69106. static readonly TEXTUREFORMAT_R: number;
  69107. /** RG */
  69108. static readonly TEXTUREFORMAT_RG: number;
  69109. /** RED_INTEGER */
  69110. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  69111. /** RED_INTEGER (2nd reference) */
  69112. static readonly TEXTUREFORMAT_R_INTEGER: number;
  69113. /** RG_INTEGER */
  69114. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  69115. /** RGB_INTEGER */
  69116. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  69117. /** RGBA_INTEGER */
  69118. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  69119. /** UNSIGNED_BYTE */
  69120. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  69121. /** UNSIGNED_BYTE (2nd reference) */
  69122. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  69123. /** FLOAT */
  69124. static readonly TEXTURETYPE_FLOAT: number;
  69125. /** HALF_FLOAT */
  69126. static readonly TEXTURETYPE_HALF_FLOAT: number;
  69127. /** BYTE */
  69128. static readonly TEXTURETYPE_BYTE: number;
  69129. /** SHORT */
  69130. static readonly TEXTURETYPE_SHORT: number;
  69131. /** UNSIGNED_SHORT */
  69132. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  69133. /** INT */
  69134. static readonly TEXTURETYPE_INT: number;
  69135. /** UNSIGNED_INT */
  69136. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  69137. /** UNSIGNED_SHORT_4_4_4_4 */
  69138. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  69139. /** UNSIGNED_SHORT_5_5_5_1 */
  69140. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  69141. /** UNSIGNED_SHORT_5_6_5 */
  69142. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  69143. /** UNSIGNED_INT_2_10_10_10_REV */
  69144. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  69145. /** UNSIGNED_INT_24_8 */
  69146. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  69147. /** UNSIGNED_INT_10F_11F_11F_REV */
  69148. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  69149. /** UNSIGNED_INT_5_9_9_9_REV */
  69150. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  69151. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  69152. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  69153. /** nearest is mag = nearest and min = nearest and mip = nearest */
  69154. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  69155. /** Bilinear is mag = linear and min = linear and mip = nearest */
  69156. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  69157. /** Trilinear is mag = linear and min = linear and mip = linear */
  69158. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  69159. /** nearest is mag = nearest and min = nearest and mip = linear */
  69160. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  69161. /** Bilinear is mag = linear and min = linear and mip = nearest */
  69162. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  69163. /** Trilinear is mag = linear and min = linear and mip = linear */
  69164. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  69165. /** mag = nearest and min = nearest and mip = nearest */
  69166. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  69167. /** mag = nearest and min = linear and mip = nearest */
  69168. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  69169. /** mag = nearest and min = linear and mip = linear */
  69170. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  69171. /** mag = nearest and min = linear and mip = none */
  69172. static readonly TEXTURE_NEAREST_LINEAR: number;
  69173. /** mag = nearest and min = nearest and mip = none */
  69174. static readonly TEXTURE_NEAREST_NEAREST: number;
  69175. /** mag = linear and min = nearest and mip = nearest */
  69176. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  69177. /** mag = linear and min = nearest and mip = linear */
  69178. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  69179. /** mag = linear and min = linear and mip = none */
  69180. static readonly TEXTURE_LINEAR_LINEAR: number;
  69181. /** mag = linear and min = nearest and mip = none */
  69182. static readonly TEXTURE_LINEAR_NEAREST: number;
  69183. /** Explicit coordinates mode */
  69184. static readonly TEXTURE_EXPLICIT_MODE: number;
  69185. /** Spherical coordinates mode */
  69186. static readonly TEXTURE_SPHERICAL_MODE: number;
  69187. /** Planar coordinates mode */
  69188. static readonly TEXTURE_PLANAR_MODE: number;
  69189. /** Cubic coordinates mode */
  69190. static readonly TEXTURE_CUBIC_MODE: number;
  69191. /** Projection coordinates mode */
  69192. static readonly TEXTURE_PROJECTION_MODE: number;
  69193. /** Skybox coordinates mode */
  69194. static readonly TEXTURE_SKYBOX_MODE: number;
  69195. /** Inverse Cubic coordinates mode */
  69196. static readonly TEXTURE_INVCUBIC_MODE: number;
  69197. /** Equirectangular coordinates mode */
  69198. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  69199. /** Equirectangular Fixed coordinates mode */
  69200. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  69201. /** Equirectangular Fixed Mirrored coordinates mode */
  69202. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  69203. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  69204. static readonly SCALEMODE_FLOOR: number;
  69205. /** Defines that texture rescaling will look for the nearest power of 2 size */
  69206. static readonly SCALEMODE_NEAREST: number;
  69207. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  69208. static readonly SCALEMODE_CEILING: number;
  69209. /**
  69210. * The dirty texture flag value
  69211. */
  69212. static readonly MATERIAL_TextureDirtyFlag: number;
  69213. /**
  69214. * The dirty light flag value
  69215. */
  69216. static readonly MATERIAL_LightDirtyFlag: number;
  69217. /**
  69218. * The dirty fresnel flag value
  69219. */
  69220. static readonly MATERIAL_FresnelDirtyFlag: number;
  69221. /**
  69222. * The dirty attribute flag value
  69223. */
  69224. static readonly MATERIAL_AttributesDirtyFlag: number;
  69225. /**
  69226. * The dirty misc flag value
  69227. */
  69228. static readonly MATERIAL_MiscDirtyFlag: number;
  69229. /**
  69230. * The all dirty flag value
  69231. */
  69232. static readonly MATERIAL_AllDirtyFlag: number;
  69233. /**
  69234. * Returns the triangle fill mode
  69235. */
  69236. static readonly MATERIAL_TriangleFillMode: number;
  69237. /**
  69238. * Returns the wireframe mode
  69239. */
  69240. static readonly MATERIAL_WireFrameFillMode: number;
  69241. /**
  69242. * Returns the point fill mode
  69243. */
  69244. static readonly MATERIAL_PointFillMode: number;
  69245. /**
  69246. * Returns the point list draw mode
  69247. */
  69248. static readonly MATERIAL_PointListDrawMode: number;
  69249. /**
  69250. * Returns the line list draw mode
  69251. */
  69252. static readonly MATERIAL_LineListDrawMode: number;
  69253. /**
  69254. * Returns the line loop draw mode
  69255. */
  69256. static readonly MATERIAL_LineLoopDrawMode: number;
  69257. /**
  69258. * Returns the line strip draw mode
  69259. */
  69260. static readonly MATERIAL_LineStripDrawMode: number;
  69261. /**
  69262. * Returns the triangle strip draw mode
  69263. */
  69264. static readonly MATERIAL_TriangleStripDrawMode: number;
  69265. /**
  69266. * Returns the triangle fan draw mode
  69267. */
  69268. static readonly MATERIAL_TriangleFanDrawMode: number;
  69269. /**
  69270. * Stores the clock-wise side orientation
  69271. */
  69272. static readonly MATERIAL_ClockWiseSideOrientation: number;
  69273. /**
  69274. * Stores the counter clock-wise side orientation
  69275. */
  69276. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  69277. /**
  69278. * Nothing
  69279. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69280. */
  69281. static readonly ACTION_NothingTrigger: number;
  69282. /**
  69283. * On pick
  69284. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69285. */
  69286. static readonly ACTION_OnPickTrigger: number;
  69287. /**
  69288. * On left pick
  69289. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69290. */
  69291. static readonly ACTION_OnLeftPickTrigger: number;
  69292. /**
  69293. * On right pick
  69294. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69295. */
  69296. static readonly ACTION_OnRightPickTrigger: number;
  69297. /**
  69298. * On center pick
  69299. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69300. */
  69301. static readonly ACTION_OnCenterPickTrigger: number;
  69302. /**
  69303. * On pick down
  69304. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69305. */
  69306. static readonly ACTION_OnPickDownTrigger: number;
  69307. /**
  69308. * On double pick
  69309. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69310. */
  69311. static readonly ACTION_OnDoublePickTrigger: number;
  69312. /**
  69313. * On pick up
  69314. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69315. */
  69316. static readonly ACTION_OnPickUpTrigger: number;
  69317. /**
  69318. * On pick out.
  69319. * This trigger will only be raised if you also declared a OnPickDown
  69320. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69321. */
  69322. static readonly ACTION_OnPickOutTrigger: number;
  69323. /**
  69324. * On long press
  69325. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69326. */
  69327. static readonly ACTION_OnLongPressTrigger: number;
  69328. /**
  69329. * On pointer over
  69330. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69331. */
  69332. static readonly ACTION_OnPointerOverTrigger: number;
  69333. /**
  69334. * On pointer out
  69335. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69336. */
  69337. static readonly ACTION_OnPointerOutTrigger: number;
  69338. /**
  69339. * On every frame
  69340. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69341. */
  69342. static readonly ACTION_OnEveryFrameTrigger: number;
  69343. /**
  69344. * On intersection enter
  69345. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69346. */
  69347. static readonly ACTION_OnIntersectionEnterTrigger: number;
  69348. /**
  69349. * On intersection exit
  69350. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69351. */
  69352. static readonly ACTION_OnIntersectionExitTrigger: number;
  69353. /**
  69354. * On key down
  69355. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69356. */
  69357. static readonly ACTION_OnKeyDownTrigger: number;
  69358. /**
  69359. * On key up
  69360. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69361. */
  69362. static readonly ACTION_OnKeyUpTrigger: number;
  69363. /**
  69364. * Billboard mode will only apply to Y axis
  69365. */
  69366. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  69367. /**
  69368. * Billboard mode will apply to all axes
  69369. */
  69370. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  69371. /**
  69372. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  69373. */
  69374. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  69375. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  69376. * Test order :
  69377. * Is the bounding sphere outside the frustum ?
  69378. * If not, are the bounding box vertices outside the frustum ?
  69379. * It not, then the cullable object is in the frustum.
  69380. */
  69381. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  69382. /** Culling strategy : Bounding Sphere Only.
  69383. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  69384. * It's also less accurate than the standard because some not visible objects can still be selected.
  69385. * Test : is the bounding sphere outside the frustum ?
  69386. * If not, then the cullable object is in the frustum.
  69387. */
  69388. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  69389. /** Culling strategy : Optimistic Inclusion.
  69390. * This in an inclusion test first, then the standard exclusion test.
  69391. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  69392. * 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.
  69393. * Anyway, it's as accurate as the standard strategy.
  69394. * Test :
  69395. * Is the cullable object bounding sphere center in the frustum ?
  69396. * If not, apply the default culling strategy.
  69397. */
  69398. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  69399. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  69400. * This in an inclusion test first, then the bounding sphere only exclusion test.
  69401. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  69402. * 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.
  69403. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  69404. * Test :
  69405. * Is the cullable object bounding sphere center in the frustum ?
  69406. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  69407. */
  69408. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  69409. /**
  69410. * No logging while loading
  69411. */
  69412. static readonly SCENELOADER_NO_LOGGING: number;
  69413. /**
  69414. * Minimal logging while loading
  69415. */
  69416. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  69417. /**
  69418. * Summary logging while loading
  69419. */
  69420. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  69421. /**
  69422. * Detailled logging while loading
  69423. */
  69424. static readonly SCENELOADER_DETAILED_LOGGING: number;
  69425. }
  69426. }
  69427. declare module BABYLON {
  69428. /**
  69429. * This represents the required contract to create a new type of texture loader.
  69430. */
  69431. export interface IInternalTextureLoader {
  69432. /**
  69433. * Defines wether the loader supports cascade loading the different faces.
  69434. */
  69435. supportCascades: boolean;
  69436. /**
  69437. * This returns if the loader support the current file information.
  69438. * @param extension defines the file extension of the file being loaded
  69439. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69440. * @param fallback defines the fallback internal texture if any
  69441. * @param isBase64 defines whether the texture is encoded as a base64
  69442. * @param isBuffer defines whether the texture data are stored as a buffer
  69443. * @returns true if the loader can load the specified file
  69444. */
  69445. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  69446. /**
  69447. * Transform the url before loading if required.
  69448. * @param rootUrl the url of the texture
  69449. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69450. * @returns the transformed texture
  69451. */
  69452. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  69453. /**
  69454. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  69455. * @param rootUrl the url of the texture
  69456. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69457. * @returns the fallback texture
  69458. */
  69459. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  69460. /**
  69461. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  69462. * @param data contains the texture data
  69463. * @param texture defines the BabylonJS internal texture
  69464. * @param createPolynomials will be true if polynomials have been requested
  69465. * @param onLoad defines the callback to trigger once the texture is ready
  69466. * @param onError defines the callback to trigger in case of error
  69467. */
  69468. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  69469. /**
  69470. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  69471. * @param data contains the texture data
  69472. * @param texture defines the BabylonJS internal texture
  69473. * @param callback defines the method to call once ready to upload
  69474. */
  69475. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  69476. }
  69477. }
  69478. declare module BABYLON {
  69479. /**
  69480. * Class used to store and describe the pipeline context associated with an effect
  69481. */
  69482. export interface IPipelineContext {
  69483. /**
  69484. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  69485. */
  69486. isAsync: boolean;
  69487. /**
  69488. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  69489. */
  69490. isReady: boolean;
  69491. /** @hidden */
  69492. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  69493. }
  69494. }
  69495. declare module BABYLON {
  69496. /**
  69497. * Class used to store gfx data (like WebGLBuffer)
  69498. */
  69499. export class DataBuffer {
  69500. /**
  69501. * Gets or sets the number of objects referencing this buffer
  69502. */
  69503. references: number;
  69504. /** Gets or sets the size of the underlying buffer */
  69505. capacity: number;
  69506. /**
  69507. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  69508. */
  69509. is32Bits: boolean;
  69510. /**
  69511. * Gets the underlying buffer
  69512. */
  69513. readonly underlyingResource: any;
  69514. }
  69515. }
  69516. declare module BABYLON {
  69517. /** @hidden */
  69518. export interface IShaderProcessor {
  69519. attributeProcessor?: (attribute: string) => string;
  69520. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  69521. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  69522. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  69523. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  69524. lineProcessor?: (line: string, isFragment: boolean) => string;
  69525. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  69526. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  69527. }
  69528. }
  69529. declare module BABYLON {
  69530. /** @hidden */
  69531. export interface ProcessingOptions {
  69532. defines: string[];
  69533. indexParameters: any;
  69534. isFragment: boolean;
  69535. shouldUseHighPrecisionShader: boolean;
  69536. supportsUniformBuffers: boolean;
  69537. shadersRepository: string;
  69538. includesShadersStore: {
  69539. [key: string]: string;
  69540. };
  69541. processor?: IShaderProcessor;
  69542. version: string;
  69543. platformName: string;
  69544. lookForClosingBracketForUniformBuffer?: boolean;
  69545. }
  69546. }
  69547. declare module BABYLON {
  69548. /** @hidden */
  69549. export class ShaderCodeNode {
  69550. line: string;
  69551. children: ShaderCodeNode[];
  69552. additionalDefineKey?: string;
  69553. additionalDefineValue?: string;
  69554. isValid(preprocessors: {
  69555. [key: string]: string;
  69556. }): boolean;
  69557. process(preprocessors: {
  69558. [key: string]: string;
  69559. }, options: ProcessingOptions): string;
  69560. }
  69561. }
  69562. declare module BABYLON {
  69563. /** @hidden */
  69564. export class ShaderCodeCursor {
  69565. private _lines;
  69566. lineIndex: number;
  69567. readonly currentLine: string;
  69568. readonly canRead: boolean;
  69569. lines: string[];
  69570. }
  69571. }
  69572. declare module BABYLON {
  69573. /** @hidden */
  69574. export class ShaderCodeConditionNode extends ShaderCodeNode {
  69575. process(preprocessors: {
  69576. [key: string]: string;
  69577. }, options: ProcessingOptions): string;
  69578. }
  69579. }
  69580. declare module BABYLON {
  69581. /** @hidden */
  69582. export class ShaderDefineExpression {
  69583. isTrue(preprocessors: {
  69584. [key: string]: string;
  69585. }): boolean;
  69586. }
  69587. }
  69588. declare module BABYLON {
  69589. /** @hidden */
  69590. export class ShaderCodeTestNode extends ShaderCodeNode {
  69591. testExpression: ShaderDefineExpression;
  69592. isValid(preprocessors: {
  69593. [key: string]: string;
  69594. }): boolean;
  69595. }
  69596. }
  69597. declare module BABYLON {
  69598. /** @hidden */
  69599. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  69600. define: string;
  69601. not: boolean;
  69602. constructor(define: string, not?: boolean);
  69603. isTrue(preprocessors: {
  69604. [key: string]: string;
  69605. }): boolean;
  69606. }
  69607. }
  69608. declare module BABYLON {
  69609. /** @hidden */
  69610. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  69611. leftOperand: ShaderDefineExpression;
  69612. rightOperand: ShaderDefineExpression;
  69613. isTrue(preprocessors: {
  69614. [key: string]: string;
  69615. }): boolean;
  69616. }
  69617. }
  69618. declare module BABYLON {
  69619. /** @hidden */
  69620. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  69621. leftOperand: ShaderDefineExpression;
  69622. rightOperand: ShaderDefineExpression;
  69623. isTrue(preprocessors: {
  69624. [key: string]: string;
  69625. }): boolean;
  69626. }
  69627. }
  69628. declare module BABYLON {
  69629. /** @hidden */
  69630. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  69631. define: string;
  69632. operand: string;
  69633. testValue: string;
  69634. constructor(define: string, operand: string, testValue: string);
  69635. isTrue(preprocessors: {
  69636. [key: string]: string;
  69637. }): boolean;
  69638. }
  69639. }
  69640. declare module BABYLON {
  69641. /**
  69642. * Class used to enable access to offline support
  69643. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  69644. */
  69645. export interface IOfflineProvider {
  69646. /**
  69647. * Gets a boolean indicating if scene must be saved in the database
  69648. */
  69649. enableSceneOffline: boolean;
  69650. /**
  69651. * Gets a boolean indicating if textures must be saved in the database
  69652. */
  69653. enableTexturesOffline: boolean;
  69654. /**
  69655. * Open the offline support and make it available
  69656. * @param successCallback defines the callback to call on success
  69657. * @param errorCallback defines the callback to call on error
  69658. */
  69659. open(successCallback: () => void, errorCallback: () => void): void;
  69660. /**
  69661. * Loads an image from the offline support
  69662. * @param url defines the url to load from
  69663. * @param image defines the target DOM image
  69664. */
  69665. loadImage(url: string, image: HTMLImageElement): void;
  69666. /**
  69667. * Loads a file from offline support
  69668. * @param url defines the URL to load from
  69669. * @param sceneLoaded defines a callback to call on success
  69670. * @param progressCallBack defines a callback to call when progress changed
  69671. * @param errorCallback defines a callback to call on error
  69672. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  69673. */
  69674. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  69675. }
  69676. }
  69677. declare module BABYLON {
  69678. /**
  69679. * Class used to help managing file picking and drag'n'drop
  69680. * File Storage
  69681. */
  69682. export class FilesInputStore {
  69683. /**
  69684. * List of files ready to be loaded
  69685. */
  69686. static FilesToLoad: {
  69687. [key: string]: File;
  69688. };
  69689. }
  69690. }
  69691. declare module BABYLON {
  69692. /**
  69693. * Class used to define a retry strategy when error happens while loading assets
  69694. */
  69695. export class RetryStrategy {
  69696. /**
  69697. * Function used to defines an exponential back off strategy
  69698. * @param maxRetries defines the maximum number of retries (3 by default)
  69699. * @param baseInterval defines the interval between retries
  69700. * @returns the strategy function to use
  69701. */
  69702. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  69703. }
  69704. }
  69705. declare module BABYLON {
  69706. /**
  69707. * @ignore
  69708. * Application error to support additional information when loading a file
  69709. */
  69710. export abstract class BaseError extends Error {
  69711. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  69712. }
  69713. }
  69714. declare module BABYLON {
  69715. /** @ignore */
  69716. export class LoadFileError extends BaseError {
  69717. request?: WebRequest;
  69718. file?: File;
  69719. /**
  69720. * Creates a new LoadFileError
  69721. * @param message defines the message of the error
  69722. * @param request defines the optional web request
  69723. * @param file defines the optional file
  69724. */
  69725. constructor(message: string, object?: WebRequest | File);
  69726. }
  69727. /** @ignore */
  69728. export class RequestFileError extends BaseError {
  69729. request: WebRequest;
  69730. /**
  69731. * Creates a new LoadFileError
  69732. * @param message defines the message of the error
  69733. * @param request defines the optional web request
  69734. */
  69735. constructor(message: string, request: WebRequest);
  69736. }
  69737. /** @ignore */
  69738. export class ReadFileError extends BaseError {
  69739. file: File;
  69740. /**
  69741. * Creates a new ReadFileError
  69742. * @param message defines the message of the error
  69743. * @param file defines the optional file
  69744. */
  69745. constructor(message: string, file: File);
  69746. }
  69747. /**
  69748. * @hidden
  69749. */
  69750. export class FileTools {
  69751. /**
  69752. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  69753. */
  69754. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  69755. /**
  69756. * Gets or sets the base URL to use to load assets
  69757. */
  69758. static BaseUrl: string;
  69759. /**
  69760. * Default behaviour for cors in the application.
  69761. * It can be a string if the expected behavior is identical in the entire app.
  69762. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  69763. */
  69764. static CorsBehavior: string | ((url: string | string[]) => string);
  69765. /**
  69766. * Gets or sets a function used to pre-process url before using them to load assets
  69767. */
  69768. static PreprocessUrl: (url: string) => string;
  69769. /**
  69770. * Removes unwanted characters from an url
  69771. * @param url defines the url to clean
  69772. * @returns the cleaned url
  69773. */
  69774. private static _CleanUrl;
  69775. /**
  69776. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  69777. * @param url define the url we are trying
  69778. * @param element define the dom element where to configure the cors policy
  69779. */
  69780. static SetCorsBehavior(url: string | string[], element: {
  69781. crossOrigin: string | null;
  69782. }): void;
  69783. /**
  69784. * Loads an image as an HTMLImageElement.
  69785. * @param input url string, ArrayBuffer, or Blob to load
  69786. * @param onLoad callback called when the image successfully loads
  69787. * @param onError callback called when the image fails to load
  69788. * @param offlineProvider offline provider for caching
  69789. * @param mimeType optional mime type
  69790. * @returns the HTMLImageElement of the loaded image
  69791. */
  69792. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  69793. /**
  69794. * Reads a file from a File object
  69795. * @param file defines the file to load
  69796. * @param onSuccess defines the callback to call when data is loaded
  69797. * @param onProgress defines the callback to call during loading process
  69798. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  69799. * @param onError defines the callback to call when an error occurs
  69800. * @returns a file request object
  69801. */
  69802. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  69803. /**
  69804. * Loads a file from a url
  69805. * @param url url to load
  69806. * @param onSuccess callback called when the file successfully loads
  69807. * @param onProgress callback called while file is loading (if the server supports this mode)
  69808. * @param offlineProvider defines the offline provider for caching
  69809. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69810. * @param onError callback called when the file fails to load
  69811. * @returns a file request object
  69812. */
  69813. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  69814. /**
  69815. * Loads a file
  69816. * @param url url to load
  69817. * @param onSuccess callback called when the file successfully loads
  69818. * @param onProgress callback called while file is loading (if the server supports this mode)
  69819. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69820. * @param onError callback called when the file fails to load
  69821. * @param onOpened callback called when the web request is opened
  69822. * @returns a file request object
  69823. */
  69824. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  69825. /**
  69826. * Checks if the loaded document was accessed via `file:`-Protocol.
  69827. * @returns boolean
  69828. */
  69829. static IsFileURL(): boolean;
  69830. }
  69831. }
  69832. declare module BABYLON {
  69833. /** @hidden */
  69834. export class ShaderProcessor {
  69835. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  69836. private static _ProcessPrecision;
  69837. private static _ExtractOperation;
  69838. private static _BuildSubExpression;
  69839. private static _BuildExpression;
  69840. private static _MoveCursorWithinIf;
  69841. private static _MoveCursor;
  69842. private static _EvaluatePreProcessors;
  69843. private static _PreparePreProcessors;
  69844. private static _ProcessShaderConversion;
  69845. private static _ProcessIncludes;
  69846. }
  69847. }
  69848. declare module BABYLON {
  69849. /**
  69850. * @hidden
  69851. */
  69852. export interface IColor4Like {
  69853. r: float;
  69854. g: float;
  69855. b: float;
  69856. a: float;
  69857. }
  69858. /**
  69859. * @hidden
  69860. */
  69861. export interface IColor3Like {
  69862. r: float;
  69863. g: float;
  69864. b: float;
  69865. }
  69866. /**
  69867. * @hidden
  69868. */
  69869. export interface IVector4Like {
  69870. x: float;
  69871. y: float;
  69872. z: float;
  69873. w: float;
  69874. }
  69875. /**
  69876. * @hidden
  69877. */
  69878. export interface IVector3Like {
  69879. x: float;
  69880. y: float;
  69881. z: float;
  69882. }
  69883. /**
  69884. * @hidden
  69885. */
  69886. export interface IVector2Like {
  69887. x: float;
  69888. y: float;
  69889. }
  69890. /**
  69891. * @hidden
  69892. */
  69893. export interface IMatrixLike {
  69894. toArray(): DeepImmutable<Float32Array>;
  69895. updateFlag: int;
  69896. }
  69897. /**
  69898. * @hidden
  69899. */
  69900. export interface IViewportLike {
  69901. x: float;
  69902. y: float;
  69903. width: float;
  69904. height: float;
  69905. }
  69906. /**
  69907. * @hidden
  69908. */
  69909. export interface IPlaneLike {
  69910. normal: IVector3Like;
  69911. d: float;
  69912. normalize(): void;
  69913. }
  69914. }
  69915. declare module BABYLON {
  69916. /**
  69917. * Interface used to define common properties for effect fallbacks
  69918. */
  69919. export interface IEffectFallbacks {
  69920. /**
  69921. * Removes the defines that should be removed when falling back.
  69922. * @param currentDefines defines the current define statements for the shader.
  69923. * @param effect defines the current effect we try to compile
  69924. * @returns The resulting defines with defines of the current rank removed.
  69925. */
  69926. reduce(currentDefines: string, effect: Effect): string;
  69927. /**
  69928. * Removes the fallback from the bound mesh.
  69929. */
  69930. unBindMesh(): void;
  69931. /**
  69932. * Checks to see if more fallbacks are still availible.
  69933. */
  69934. hasMoreFallbacks: boolean;
  69935. }
  69936. }
  69937. declare module BABYLON {
  69938. /**
  69939. * Class used to evalaute queries containing `and` and `or` operators
  69940. */
  69941. export class AndOrNotEvaluator {
  69942. /**
  69943. * Evaluate a query
  69944. * @param query defines the query to evaluate
  69945. * @param evaluateCallback defines the callback used to filter result
  69946. * @returns true if the query matches
  69947. */
  69948. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  69949. private static _HandleParenthesisContent;
  69950. private static _SimplifyNegation;
  69951. }
  69952. }
  69953. declare module BABYLON {
  69954. /**
  69955. * Class used to store custom tags
  69956. */
  69957. export class Tags {
  69958. /**
  69959. * Adds support for tags on the given object
  69960. * @param obj defines the object to use
  69961. */
  69962. static EnableFor(obj: any): void;
  69963. /**
  69964. * Removes tags support
  69965. * @param obj defines the object to use
  69966. */
  69967. static DisableFor(obj: any): void;
  69968. /**
  69969. * Gets a boolean indicating if the given object has tags
  69970. * @param obj defines the object to use
  69971. * @returns a boolean
  69972. */
  69973. static HasTags(obj: any): boolean;
  69974. /**
  69975. * Gets the tags available on a given object
  69976. * @param obj defines the object to use
  69977. * @param asString defines if the tags must be returned as a string instead of an array of strings
  69978. * @returns the tags
  69979. */
  69980. static GetTags(obj: any, asString?: boolean): any;
  69981. /**
  69982. * Adds tags to an object
  69983. * @param obj defines the object to use
  69984. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  69985. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  69986. */
  69987. static AddTagsTo(obj: any, tagsString: string): void;
  69988. /**
  69989. * @hidden
  69990. */
  69991. static _AddTagTo(obj: any, tag: string): void;
  69992. /**
  69993. * Removes specific tags from a specific object
  69994. * @param obj defines the object to use
  69995. * @param tagsString defines the tags to remove
  69996. */
  69997. static RemoveTagsFrom(obj: any, tagsString: string): void;
  69998. /**
  69999. * @hidden
  70000. */
  70001. static _RemoveTagFrom(obj: any, tag: string): void;
  70002. /**
  70003. * Defines if tags hosted on an object match a given query
  70004. * @param obj defines the object to use
  70005. * @param tagsQuery defines the tag query
  70006. * @returns a boolean
  70007. */
  70008. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  70009. }
  70010. }
  70011. declare module BABYLON {
  70012. /**
  70013. * Scalar computation library
  70014. */
  70015. export class Scalar {
  70016. /**
  70017. * Two pi constants convenient for computation.
  70018. */
  70019. static TwoPi: number;
  70020. /**
  70021. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  70022. * @param a number
  70023. * @param b number
  70024. * @param epsilon (default = 1.401298E-45)
  70025. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  70026. */
  70027. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  70028. /**
  70029. * Returns a string : the upper case translation of the number i to hexadecimal.
  70030. * @param i number
  70031. * @returns the upper case translation of the number i to hexadecimal.
  70032. */
  70033. static ToHex(i: number): string;
  70034. /**
  70035. * Returns -1 if value is negative and +1 is value is positive.
  70036. * @param value the value
  70037. * @returns the value itself if it's equal to zero.
  70038. */
  70039. static Sign(value: number): number;
  70040. /**
  70041. * Returns the value itself if it's between min and max.
  70042. * Returns min if the value is lower than min.
  70043. * Returns max if the value is greater than max.
  70044. * @param value the value to clmap
  70045. * @param min the min value to clamp to (default: 0)
  70046. * @param max the max value to clamp to (default: 1)
  70047. * @returns the clamped value
  70048. */
  70049. static Clamp(value: number, min?: number, max?: number): number;
  70050. /**
  70051. * the log2 of value.
  70052. * @param value the value to compute log2 of
  70053. * @returns the log2 of value.
  70054. */
  70055. static Log2(value: number): number;
  70056. /**
  70057. * Loops the value, so that it is never larger than length and never smaller than 0.
  70058. *
  70059. * This is similar to the modulo operator but it works with floating point numbers.
  70060. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  70061. * With t = 5 and length = 2.5, the result would be 0.0.
  70062. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  70063. * @param value the value
  70064. * @param length the length
  70065. * @returns the looped value
  70066. */
  70067. static Repeat(value: number, length: number): number;
  70068. /**
  70069. * Normalize the value between 0.0 and 1.0 using min and max values
  70070. * @param value value to normalize
  70071. * @param min max to normalize between
  70072. * @param max min to normalize between
  70073. * @returns the normalized value
  70074. */
  70075. static Normalize(value: number, min: number, max: number): number;
  70076. /**
  70077. * Denormalize the value from 0.0 and 1.0 using min and max values
  70078. * @param normalized value to denormalize
  70079. * @param min max to denormalize between
  70080. * @param max min to denormalize between
  70081. * @returns the denormalized value
  70082. */
  70083. static Denormalize(normalized: number, min: number, max: number): number;
  70084. /**
  70085. * Calculates the shortest difference between two given angles given in degrees.
  70086. * @param current current angle in degrees
  70087. * @param target target angle in degrees
  70088. * @returns the delta
  70089. */
  70090. static DeltaAngle(current: number, target: number): number;
  70091. /**
  70092. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  70093. * @param tx value
  70094. * @param length length
  70095. * @returns The returned value will move back and forth between 0 and length
  70096. */
  70097. static PingPong(tx: number, length: number): number;
  70098. /**
  70099. * Interpolates between min and max with smoothing at the limits.
  70100. *
  70101. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  70102. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  70103. * @param from from
  70104. * @param to to
  70105. * @param tx value
  70106. * @returns the smooth stepped value
  70107. */
  70108. static SmoothStep(from: number, to: number, tx: number): number;
  70109. /**
  70110. * Moves a value current towards target.
  70111. *
  70112. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  70113. * Negative values of maxDelta pushes the value away from target.
  70114. * @param current current value
  70115. * @param target target value
  70116. * @param maxDelta max distance to move
  70117. * @returns resulting value
  70118. */
  70119. static MoveTowards(current: number, target: number, maxDelta: number): number;
  70120. /**
  70121. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  70122. *
  70123. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  70124. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  70125. * @param current current value
  70126. * @param target target value
  70127. * @param maxDelta max distance to move
  70128. * @returns resulting angle
  70129. */
  70130. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  70131. /**
  70132. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  70133. * @param start start value
  70134. * @param end target value
  70135. * @param amount amount to lerp between
  70136. * @returns the lerped value
  70137. */
  70138. static Lerp(start: number, end: number, amount: number): number;
  70139. /**
  70140. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  70141. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  70142. * @param start start value
  70143. * @param end target value
  70144. * @param amount amount to lerp between
  70145. * @returns the lerped value
  70146. */
  70147. static LerpAngle(start: number, end: number, amount: number): number;
  70148. /**
  70149. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  70150. * @param a start value
  70151. * @param b target value
  70152. * @param value value between a and b
  70153. * @returns the inverseLerp value
  70154. */
  70155. static InverseLerp(a: number, b: number, value: number): number;
  70156. /**
  70157. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  70158. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  70159. * @param value1 spline value
  70160. * @param tangent1 spline value
  70161. * @param value2 spline value
  70162. * @param tangent2 spline value
  70163. * @param amount input value
  70164. * @returns hermite result
  70165. */
  70166. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  70167. /**
  70168. * Returns a random float number between and min and max values
  70169. * @param min min value of random
  70170. * @param max max value of random
  70171. * @returns random value
  70172. */
  70173. static RandomRange(min: number, max: number): number;
  70174. /**
  70175. * This function returns percentage of a number in a given range.
  70176. *
  70177. * RangeToPercent(40,20,60) will return 0.5 (50%)
  70178. * RangeToPercent(34,0,100) will return 0.34 (34%)
  70179. * @param number to convert to percentage
  70180. * @param min min range
  70181. * @param max max range
  70182. * @returns the percentage
  70183. */
  70184. static RangeToPercent(number: number, min: number, max: number): number;
  70185. /**
  70186. * This function returns number that corresponds to the percentage in a given range.
  70187. *
  70188. * PercentToRange(0.34,0,100) will return 34.
  70189. * @param percent to convert to number
  70190. * @param min min range
  70191. * @param max max range
  70192. * @returns the number
  70193. */
  70194. static PercentToRange(percent: number, min: number, max: number): number;
  70195. /**
  70196. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  70197. * @param angle The angle to normalize in radian.
  70198. * @return The converted angle.
  70199. */
  70200. static NormalizeRadians(angle: number): number;
  70201. }
  70202. }
  70203. declare module BABYLON {
  70204. /**
  70205. * Constant used to convert a value to gamma space
  70206. * @ignorenaming
  70207. */
  70208. export const ToGammaSpace: number;
  70209. /**
  70210. * Constant used to convert a value to linear space
  70211. * @ignorenaming
  70212. */
  70213. export const ToLinearSpace = 2.2;
  70214. /**
  70215. * Constant used to define the minimal number value in Babylon.js
  70216. * @ignorenaming
  70217. */
  70218. let Epsilon: number;
  70219. }
  70220. declare module BABYLON {
  70221. /**
  70222. * Class used to represent a viewport on screen
  70223. */
  70224. export class Viewport {
  70225. /** viewport left coordinate */
  70226. x: number;
  70227. /** viewport top coordinate */
  70228. y: number;
  70229. /**viewport width */
  70230. width: number;
  70231. /** viewport height */
  70232. height: number;
  70233. /**
  70234. * Creates a Viewport object located at (x, y) and sized (width, height)
  70235. * @param x defines viewport left coordinate
  70236. * @param y defines viewport top coordinate
  70237. * @param width defines the viewport width
  70238. * @param height defines the viewport height
  70239. */
  70240. constructor(
  70241. /** viewport left coordinate */
  70242. x: number,
  70243. /** viewport top coordinate */
  70244. y: number,
  70245. /**viewport width */
  70246. width: number,
  70247. /** viewport height */
  70248. height: number);
  70249. /**
  70250. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  70251. * @param renderWidth defines the rendering width
  70252. * @param renderHeight defines the rendering height
  70253. * @returns a new Viewport
  70254. */
  70255. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  70256. /**
  70257. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  70258. * @param renderWidth defines the rendering width
  70259. * @param renderHeight defines the rendering height
  70260. * @param ref defines the target viewport
  70261. * @returns the current viewport
  70262. */
  70263. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  70264. /**
  70265. * Returns a new Viewport copied from the current one
  70266. * @returns a new Viewport
  70267. */
  70268. clone(): Viewport;
  70269. }
  70270. }
  70271. declare module BABYLON {
  70272. /**
  70273. * Class containing a set of static utilities functions for arrays.
  70274. */
  70275. export class ArrayTools {
  70276. /**
  70277. * Returns an array of the given size filled with element built from the given constructor and the paramters
  70278. * @param size the number of element to construct and put in the array
  70279. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  70280. * @returns a new array filled with new objects
  70281. */
  70282. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  70283. }
  70284. }
  70285. declare module BABYLON {
  70286. /**
  70287. * Class representing a vector containing 2 coordinates
  70288. */
  70289. export class Vector2 {
  70290. /** defines the first coordinate */
  70291. x: number;
  70292. /** defines the second coordinate */
  70293. y: number;
  70294. /**
  70295. * Creates a new Vector2 from the given x and y coordinates
  70296. * @param x defines the first coordinate
  70297. * @param y defines the second coordinate
  70298. */
  70299. constructor(
  70300. /** defines the first coordinate */
  70301. x?: number,
  70302. /** defines the second coordinate */
  70303. y?: number);
  70304. /**
  70305. * Gets a string with the Vector2 coordinates
  70306. * @returns a string with the Vector2 coordinates
  70307. */
  70308. toString(): string;
  70309. /**
  70310. * Gets class name
  70311. * @returns the string "Vector2"
  70312. */
  70313. getClassName(): string;
  70314. /**
  70315. * Gets current vector hash code
  70316. * @returns the Vector2 hash code as a number
  70317. */
  70318. getHashCode(): number;
  70319. /**
  70320. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  70321. * @param array defines the source array
  70322. * @param index defines the offset in source array
  70323. * @returns the current Vector2
  70324. */
  70325. toArray(array: FloatArray, index?: number): Vector2;
  70326. /**
  70327. * Copy the current vector to an array
  70328. * @returns a new array with 2 elements: the Vector2 coordinates.
  70329. */
  70330. asArray(): number[];
  70331. /**
  70332. * Sets the Vector2 coordinates with the given Vector2 coordinates
  70333. * @param source defines the source Vector2
  70334. * @returns the current updated Vector2
  70335. */
  70336. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  70337. /**
  70338. * Sets the Vector2 coordinates with the given floats
  70339. * @param x defines the first coordinate
  70340. * @param y defines the second coordinate
  70341. * @returns the current updated Vector2
  70342. */
  70343. copyFromFloats(x: number, y: number): Vector2;
  70344. /**
  70345. * Sets the Vector2 coordinates with the given floats
  70346. * @param x defines the first coordinate
  70347. * @param y defines the second coordinate
  70348. * @returns the current updated Vector2
  70349. */
  70350. set(x: number, y: number): Vector2;
  70351. /**
  70352. * Add another vector with the current one
  70353. * @param otherVector defines the other vector
  70354. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  70355. */
  70356. add(otherVector: DeepImmutable<Vector2>): Vector2;
  70357. /**
  70358. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  70359. * @param otherVector defines the other vector
  70360. * @param result defines the target vector
  70361. * @returns the unmodified current Vector2
  70362. */
  70363. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70364. /**
  70365. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  70366. * @param otherVector defines the other vector
  70367. * @returns the current updated Vector2
  70368. */
  70369. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70370. /**
  70371. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  70372. * @param otherVector defines the other vector
  70373. * @returns a new Vector2
  70374. */
  70375. addVector3(otherVector: Vector3): Vector2;
  70376. /**
  70377. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  70378. * @param otherVector defines the other vector
  70379. * @returns a new Vector2
  70380. */
  70381. subtract(otherVector: Vector2): Vector2;
  70382. /**
  70383. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  70384. * @param otherVector defines the other vector
  70385. * @param result defines the target vector
  70386. * @returns the unmodified current Vector2
  70387. */
  70388. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70389. /**
  70390. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  70391. * @param otherVector defines the other vector
  70392. * @returns the current updated Vector2
  70393. */
  70394. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70395. /**
  70396. * Multiplies in place the current Vector2 coordinates by the given ones
  70397. * @param otherVector defines the other vector
  70398. * @returns the current updated Vector2
  70399. */
  70400. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70401. /**
  70402. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  70403. * @param otherVector defines the other vector
  70404. * @returns a new Vector2
  70405. */
  70406. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  70407. /**
  70408. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  70409. * @param otherVector defines the other vector
  70410. * @param result defines the target vector
  70411. * @returns the unmodified current Vector2
  70412. */
  70413. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70414. /**
  70415. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  70416. * @param x defines the first coordinate
  70417. * @param y defines the second coordinate
  70418. * @returns a new Vector2
  70419. */
  70420. multiplyByFloats(x: number, y: number): Vector2;
  70421. /**
  70422. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  70423. * @param otherVector defines the other vector
  70424. * @returns a new Vector2
  70425. */
  70426. divide(otherVector: Vector2): Vector2;
  70427. /**
  70428. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  70429. * @param otherVector defines the other vector
  70430. * @param result defines the target vector
  70431. * @returns the unmodified current Vector2
  70432. */
  70433. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70434. /**
  70435. * Divides the current Vector2 coordinates by the given ones
  70436. * @param otherVector defines the other vector
  70437. * @returns the current updated Vector2
  70438. */
  70439. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70440. /**
  70441. * Gets a new Vector2 with current Vector2 negated coordinates
  70442. * @returns a new Vector2
  70443. */
  70444. negate(): Vector2;
  70445. /**
  70446. * Multiply the Vector2 coordinates by scale
  70447. * @param scale defines the scaling factor
  70448. * @returns the current updated Vector2
  70449. */
  70450. scaleInPlace(scale: number): Vector2;
  70451. /**
  70452. * Returns a new Vector2 scaled by "scale" from the current Vector2
  70453. * @param scale defines the scaling factor
  70454. * @returns a new Vector2
  70455. */
  70456. scale(scale: number): Vector2;
  70457. /**
  70458. * Scale the current Vector2 values by a factor to a given Vector2
  70459. * @param scale defines the scale factor
  70460. * @param result defines the Vector2 object where to store the result
  70461. * @returns the unmodified current Vector2
  70462. */
  70463. scaleToRef(scale: number, result: Vector2): Vector2;
  70464. /**
  70465. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  70466. * @param scale defines the scale factor
  70467. * @param result defines the Vector2 object where to store the result
  70468. * @returns the unmodified current Vector2
  70469. */
  70470. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  70471. /**
  70472. * Gets a boolean if two vectors are equals
  70473. * @param otherVector defines the other vector
  70474. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  70475. */
  70476. equals(otherVector: DeepImmutable<Vector2>): boolean;
  70477. /**
  70478. * Gets a boolean if two vectors are equals (using an epsilon value)
  70479. * @param otherVector defines the other vector
  70480. * @param epsilon defines the minimal distance to consider equality
  70481. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  70482. */
  70483. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  70484. /**
  70485. * Gets a new Vector2 from current Vector2 floored values
  70486. * @returns a new Vector2
  70487. */
  70488. floor(): Vector2;
  70489. /**
  70490. * Gets a new Vector2 from current Vector2 floored values
  70491. * @returns a new Vector2
  70492. */
  70493. fract(): Vector2;
  70494. /**
  70495. * Gets the length of the vector
  70496. * @returns the vector length (float)
  70497. */
  70498. length(): number;
  70499. /**
  70500. * Gets the vector squared length
  70501. * @returns the vector squared length (float)
  70502. */
  70503. lengthSquared(): number;
  70504. /**
  70505. * Normalize the vector
  70506. * @returns the current updated Vector2
  70507. */
  70508. normalize(): Vector2;
  70509. /**
  70510. * Gets a new Vector2 copied from the Vector2
  70511. * @returns a new Vector2
  70512. */
  70513. clone(): Vector2;
  70514. /**
  70515. * Gets a new Vector2(0, 0)
  70516. * @returns a new Vector2
  70517. */
  70518. static Zero(): Vector2;
  70519. /**
  70520. * Gets a new Vector2(1, 1)
  70521. * @returns a new Vector2
  70522. */
  70523. static One(): Vector2;
  70524. /**
  70525. * Gets a new Vector2 set from the given index element of the given array
  70526. * @param array defines the data source
  70527. * @param offset defines the offset in the data source
  70528. * @returns a new Vector2
  70529. */
  70530. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  70531. /**
  70532. * Sets "result" from the given index element of the given array
  70533. * @param array defines the data source
  70534. * @param offset defines the offset in the data source
  70535. * @param result defines the target vector
  70536. */
  70537. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  70538. /**
  70539. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  70540. * @param value1 defines 1st point of control
  70541. * @param value2 defines 2nd point of control
  70542. * @param value3 defines 3rd point of control
  70543. * @param value4 defines 4th point of control
  70544. * @param amount defines the interpolation factor
  70545. * @returns a new Vector2
  70546. */
  70547. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  70548. /**
  70549. * 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".
  70550. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  70551. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  70552. * @param value defines the value to clamp
  70553. * @param min defines the lower limit
  70554. * @param max defines the upper limit
  70555. * @returns a new Vector2
  70556. */
  70557. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  70558. /**
  70559. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  70560. * @param value1 defines the 1st control point
  70561. * @param tangent1 defines the outgoing tangent
  70562. * @param value2 defines the 2nd control point
  70563. * @param tangent2 defines the incoming tangent
  70564. * @param amount defines the interpolation factor
  70565. * @returns a new Vector2
  70566. */
  70567. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  70568. /**
  70569. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  70570. * @param start defines the start vector
  70571. * @param end defines the end vector
  70572. * @param amount defines the interpolation factor
  70573. * @returns a new Vector2
  70574. */
  70575. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  70576. /**
  70577. * Gets the dot product of the vector "left" and the vector "right"
  70578. * @param left defines first vector
  70579. * @param right defines second vector
  70580. * @returns the dot product (float)
  70581. */
  70582. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  70583. /**
  70584. * Returns a new Vector2 equal to the normalized given vector
  70585. * @param vector defines the vector to normalize
  70586. * @returns a new Vector2
  70587. */
  70588. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  70589. /**
  70590. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  70591. * @param left defines 1st vector
  70592. * @param right defines 2nd vector
  70593. * @returns a new Vector2
  70594. */
  70595. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  70596. /**
  70597. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  70598. * @param left defines 1st vector
  70599. * @param right defines 2nd vector
  70600. * @returns a new Vector2
  70601. */
  70602. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  70603. /**
  70604. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  70605. * @param vector defines the vector to transform
  70606. * @param transformation defines the matrix to apply
  70607. * @returns a new Vector2
  70608. */
  70609. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  70610. /**
  70611. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  70612. * @param vector defines the vector to transform
  70613. * @param transformation defines the matrix to apply
  70614. * @param result defines the target vector
  70615. */
  70616. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  70617. /**
  70618. * Determines if a given vector is included in a triangle
  70619. * @param p defines the vector to test
  70620. * @param p0 defines 1st triangle point
  70621. * @param p1 defines 2nd triangle point
  70622. * @param p2 defines 3rd triangle point
  70623. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  70624. */
  70625. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  70626. /**
  70627. * Gets the distance between the vectors "value1" and "value2"
  70628. * @param value1 defines first vector
  70629. * @param value2 defines second vector
  70630. * @returns the distance between vectors
  70631. */
  70632. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70633. /**
  70634. * Returns the squared distance between the vectors "value1" and "value2"
  70635. * @param value1 defines first vector
  70636. * @param value2 defines second vector
  70637. * @returns the squared distance between vectors
  70638. */
  70639. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70640. /**
  70641. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  70642. * @param value1 defines first vector
  70643. * @param value2 defines second vector
  70644. * @returns a new Vector2
  70645. */
  70646. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  70647. /**
  70648. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  70649. * @param p defines the middle point
  70650. * @param segA defines one point of the segment
  70651. * @param segB defines the other point of the segment
  70652. * @returns the shortest distance
  70653. */
  70654. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  70655. }
  70656. /**
  70657. * Classed used to store (x,y,z) vector representation
  70658. * A Vector3 is the main object used in 3D geometry
  70659. * It can represent etiher the coordinates of a point the space, either a direction
  70660. * Reminder: js uses a left handed forward facing system
  70661. */
  70662. export class Vector3 {
  70663. /**
  70664. * Defines the first coordinates (on X axis)
  70665. */
  70666. x: number;
  70667. /**
  70668. * Defines the second coordinates (on Y axis)
  70669. */
  70670. y: number;
  70671. /**
  70672. * Defines the third coordinates (on Z axis)
  70673. */
  70674. z: number;
  70675. private static _UpReadOnly;
  70676. private static _ZeroReadOnly;
  70677. /**
  70678. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  70679. * @param x defines the first coordinates (on X axis)
  70680. * @param y defines the second coordinates (on Y axis)
  70681. * @param z defines the third coordinates (on Z axis)
  70682. */
  70683. constructor(
  70684. /**
  70685. * Defines the first coordinates (on X axis)
  70686. */
  70687. x?: number,
  70688. /**
  70689. * Defines the second coordinates (on Y axis)
  70690. */
  70691. y?: number,
  70692. /**
  70693. * Defines the third coordinates (on Z axis)
  70694. */
  70695. z?: number);
  70696. /**
  70697. * Creates a string representation of the Vector3
  70698. * @returns a string with the Vector3 coordinates.
  70699. */
  70700. toString(): string;
  70701. /**
  70702. * Gets the class name
  70703. * @returns the string "Vector3"
  70704. */
  70705. getClassName(): string;
  70706. /**
  70707. * Creates the Vector3 hash code
  70708. * @returns a number which tends to be unique between Vector3 instances
  70709. */
  70710. getHashCode(): number;
  70711. /**
  70712. * Creates an array containing three elements : the coordinates of the Vector3
  70713. * @returns a new array of numbers
  70714. */
  70715. asArray(): number[];
  70716. /**
  70717. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  70718. * @param array defines the destination array
  70719. * @param index defines the offset in the destination array
  70720. * @returns the current Vector3
  70721. */
  70722. toArray(array: FloatArray, index?: number): Vector3;
  70723. /**
  70724. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  70725. * @returns a new Quaternion object, computed from the Vector3 coordinates
  70726. */
  70727. toQuaternion(): Quaternion;
  70728. /**
  70729. * Adds the given vector to the current Vector3
  70730. * @param otherVector defines the second operand
  70731. * @returns the current updated Vector3
  70732. */
  70733. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70734. /**
  70735. * Adds the given coordinates to the current Vector3
  70736. * @param x defines the x coordinate of the operand
  70737. * @param y defines the y coordinate of the operand
  70738. * @param z defines the z coordinate of the operand
  70739. * @returns the current updated Vector3
  70740. */
  70741. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70742. /**
  70743. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  70744. * @param otherVector defines the second operand
  70745. * @returns the resulting Vector3
  70746. */
  70747. add(otherVector: DeepImmutable<Vector3>): Vector3;
  70748. /**
  70749. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  70750. * @param otherVector defines the second operand
  70751. * @param result defines the Vector3 object where to store the result
  70752. * @returns the current Vector3
  70753. */
  70754. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70755. /**
  70756. * Subtract the given vector from the current Vector3
  70757. * @param otherVector defines the second operand
  70758. * @returns the current updated Vector3
  70759. */
  70760. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70761. /**
  70762. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  70763. * @param otherVector defines the second operand
  70764. * @returns the resulting Vector3
  70765. */
  70766. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  70767. /**
  70768. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  70769. * @param otherVector defines the second operand
  70770. * @param result defines the Vector3 object where to store the result
  70771. * @returns the current Vector3
  70772. */
  70773. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70774. /**
  70775. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  70776. * @param x defines the x coordinate of the operand
  70777. * @param y defines the y coordinate of the operand
  70778. * @param z defines the z coordinate of the operand
  70779. * @returns the resulting Vector3
  70780. */
  70781. subtractFromFloats(x: number, y: number, z: number): Vector3;
  70782. /**
  70783. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  70784. * @param x defines the x coordinate of the operand
  70785. * @param y defines the y coordinate of the operand
  70786. * @param z defines the z coordinate of the operand
  70787. * @param result defines the Vector3 object where to store the result
  70788. * @returns the current Vector3
  70789. */
  70790. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  70791. /**
  70792. * Gets a new Vector3 set with the current Vector3 negated coordinates
  70793. * @returns a new Vector3
  70794. */
  70795. negate(): Vector3;
  70796. /**
  70797. * Multiplies the Vector3 coordinates by the float "scale"
  70798. * @param scale defines the multiplier factor
  70799. * @returns the current updated Vector3
  70800. */
  70801. scaleInPlace(scale: number): Vector3;
  70802. /**
  70803. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  70804. * @param scale defines the multiplier factor
  70805. * @returns a new Vector3
  70806. */
  70807. scale(scale: number): Vector3;
  70808. /**
  70809. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  70810. * @param scale defines the multiplier factor
  70811. * @param result defines the Vector3 object where to store the result
  70812. * @returns the current Vector3
  70813. */
  70814. scaleToRef(scale: number, result: Vector3): Vector3;
  70815. /**
  70816. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  70817. * @param scale defines the scale factor
  70818. * @param result defines the Vector3 object where to store the result
  70819. * @returns the unmodified current Vector3
  70820. */
  70821. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  70822. /**
  70823. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  70824. * @param otherVector defines the second operand
  70825. * @returns true if both vectors are equals
  70826. */
  70827. equals(otherVector: DeepImmutable<Vector3>): boolean;
  70828. /**
  70829. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  70830. * @param otherVector defines the second operand
  70831. * @param epsilon defines the minimal distance to define values as equals
  70832. * @returns true if both vectors are distant less than epsilon
  70833. */
  70834. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  70835. /**
  70836. * Returns true if the current Vector3 coordinates equals the given floats
  70837. * @param x defines the x coordinate of the operand
  70838. * @param y defines the y coordinate of the operand
  70839. * @param z defines the z coordinate of the operand
  70840. * @returns true if both vectors are equals
  70841. */
  70842. equalsToFloats(x: number, y: number, z: number): boolean;
  70843. /**
  70844. * Multiplies the current Vector3 coordinates by the given ones
  70845. * @param otherVector defines the second operand
  70846. * @returns the current updated Vector3
  70847. */
  70848. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70849. /**
  70850. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  70851. * @param otherVector defines the second operand
  70852. * @returns the new Vector3
  70853. */
  70854. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  70855. /**
  70856. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  70857. * @param otherVector defines the second operand
  70858. * @param result defines the Vector3 object where to store the result
  70859. * @returns the current Vector3
  70860. */
  70861. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70862. /**
  70863. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  70864. * @param x defines the x coordinate of the operand
  70865. * @param y defines the y coordinate of the operand
  70866. * @param z defines the z coordinate of the operand
  70867. * @returns the new Vector3
  70868. */
  70869. multiplyByFloats(x: number, y: number, z: number): Vector3;
  70870. /**
  70871. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  70872. * @param otherVector defines the second operand
  70873. * @returns the new Vector3
  70874. */
  70875. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  70876. /**
  70877. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  70878. * @param otherVector defines the second operand
  70879. * @param result defines the Vector3 object where to store the result
  70880. * @returns the current Vector3
  70881. */
  70882. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70883. /**
  70884. * Divides the current Vector3 coordinates by the given ones.
  70885. * @param otherVector defines the second operand
  70886. * @returns the current updated Vector3
  70887. */
  70888. divideInPlace(otherVector: Vector3): Vector3;
  70889. /**
  70890. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  70891. * @param other defines the second operand
  70892. * @returns the current updated Vector3
  70893. */
  70894. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70895. /**
  70896. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  70897. * @param other defines the second operand
  70898. * @returns the current updated Vector3
  70899. */
  70900. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70901. /**
  70902. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  70903. * @param x defines the x coordinate of the operand
  70904. * @param y defines the y coordinate of the operand
  70905. * @param z defines the z coordinate of the operand
  70906. * @returns the current updated Vector3
  70907. */
  70908. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70909. /**
  70910. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  70911. * @param x defines the x coordinate of the operand
  70912. * @param y defines the y coordinate of the operand
  70913. * @param z defines the z coordinate of the operand
  70914. * @returns the current updated Vector3
  70915. */
  70916. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70917. /**
  70918. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  70919. * Check if is non uniform within a certain amount of decimal places to account for this
  70920. * @param epsilon the amount the values can differ
  70921. * @returns if the the vector is non uniform to a certain number of decimal places
  70922. */
  70923. isNonUniformWithinEpsilon(epsilon: number): boolean;
  70924. /**
  70925. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  70926. */
  70927. readonly isNonUniform: boolean;
  70928. /**
  70929. * Gets a new Vector3 from current Vector3 floored values
  70930. * @returns a new Vector3
  70931. */
  70932. floor(): Vector3;
  70933. /**
  70934. * Gets a new Vector3 from current Vector3 floored values
  70935. * @returns a new Vector3
  70936. */
  70937. fract(): Vector3;
  70938. /**
  70939. * Gets the length of the Vector3
  70940. * @returns the length of the Vector3
  70941. */
  70942. length(): number;
  70943. /**
  70944. * Gets the squared length of the Vector3
  70945. * @returns squared length of the Vector3
  70946. */
  70947. lengthSquared(): number;
  70948. /**
  70949. * Normalize the current Vector3.
  70950. * Please note that this is an in place operation.
  70951. * @returns the current updated Vector3
  70952. */
  70953. normalize(): Vector3;
  70954. /**
  70955. * Reorders the x y z properties of the vector in place
  70956. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  70957. * @returns the current updated vector
  70958. */
  70959. reorderInPlace(order: string): this;
  70960. /**
  70961. * Rotates the vector around 0,0,0 by a quaternion
  70962. * @param quaternion the rotation quaternion
  70963. * @param result vector to store the result
  70964. * @returns the resulting vector
  70965. */
  70966. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  70967. /**
  70968. * Rotates a vector around a given point
  70969. * @param quaternion the rotation quaternion
  70970. * @param point the point to rotate around
  70971. * @param result vector to store the result
  70972. * @returns the resulting vector
  70973. */
  70974. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  70975. /**
  70976. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  70977. * The cross product is then orthogonal to both current and "other"
  70978. * @param other defines the right operand
  70979. * @returns the cross product
  70980. */
  70981. cross(other: Vector3): Vector3;
  70982. /**
  70983. * Normalize the current Vector3 with the given input length.
  70984. * Please note that this is an in place operation.
  70985. * @param len the length of the vector
  70986. * @returns the current updated Vector3
  70987. */
  70988. normalizeFromLength(len: number): Vector3;
  70989. /**
  70990. * Normalize the current Vector3 to a new vector
  70991. * @returns the new Vector3
  70992. */
  70993. normalizeToNew(): Vector3;
  70994. /**
  70995. * Normalize the current Vector3 to the reference
  70996. * @param reference define the Vector3 to update
  70997. * @returns the updated Vector3
  70998. */
  70999. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  71000. /**
  71001. * Creates a new Vector3 copied from the current Vector3
  71002. * @returns the new Vector3
  71003. */
  71004. clone(): Vector3;
  71005. /**
  71006. * Copies the given vector coordinates to the current Vector3 ones
  71007. * @param source defines the source Vector3
  71008. * @returns the current updated Vector3
  71009. */
  71010. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  71011. /**
  71012. * Copies the given floats to the current Vector3 coordinates
  71013. * @param x defines the x coordinate of the operand
  71014. * @param y defines the y coordinate of the operand
  71015. * @param z defines the z coordinate of the operand
  71016. * @returns the current updated Vector3
  71017. */
  71018. copyFromFloats(x: number, y: number, z: number): Vector3;
  71019. /**
  71020. * Copies the given floats to the current Vector3 coordinates
  71021. * @param x defines the x coordinate of the operand
  71022. * @param y defines the y coordinate of the operand
  71023. * @param z defines the z coordinate of the operand
  71024. * @returns the current updated Vector3
  71025. */
  71026. set(x: number, y: number, z: number): Vector3;
  71027. /**
  71028. * Copies the given float to the current Vector3 coordinates
  71029. * @param v defines the x, y and z coordinates of the operand
  71030. * @returns the current updated Vector3
  71031. */
  71032. setAll(v: number): Vector3;
  71033. /**
  71034. * Get the clip factor between two vectors
  71035. * @param vector0 defines the first operand
  71036. * @param vector1 defines the second operand
  71037. * @param axis defines the axis to use
  71038. * @param size defines the size along the axis
  71039. * @returns the clip factor
  71040. */
  71041. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  71042. /**
  71043. * Get angle between two vectors
  71044. * @param vector0 angle between vector0 and vector1
  71045. * @param vector1 angle between vector0 and vector1
  71046. * @param normal direction of the normal
  71047. * @return the angle between vector0 and vector1
  71048. */
  71049. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  71050. /**
  71051. * Returns a new Vector3 set from the index "offset" of the given array
  71052. * @param array defines the source array
  71053. * @param offset defines the offset in the source array
  71054. * @returns the new Vector3
  71055. */
  71056. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  71057. /**
  71058. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  71059. * This function is deprecated. Use FromArray instead
  71060. * @param array defines the source array
  71061. * @param offset defines the offset in the source array
  71062. * @returns the new Vector3
  71063. */
  71064. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  71065. /**
  71066. * Sets the given vector "result" with the element values from the index "offset" of the given array
  71067. * @param array defines the source array
  71068. * @param offset defines the offset in the source array
  71069. * @param result defines the Vector3 where to store the result
  71070. */
  71071. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  71072. /**
  71073. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  71074. * This function is deprecated. Use FromArrayToRef instead.
  71075. * @param array defines the source array
  71076. * @param offset defines the offset in the source array
  71077. * @param result defines the Vector3 where to store the result
  71078. */
  71079. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  71080. /**
  71081. * Sets the given vector "result" with the given floats.
  71082. * @param x defines the x coordinate of the source
  71083. * @param y defines the y coordinate of the source
  71084. * @param z defines the z coordinate of the source
  71085. * @param result defines the Vector3 where to store the result
  71086. */
  71087. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  71088. /**
  71089. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  71090. * @returns a new empty Vector3
  71091. */
  71092. static Zero(): Vector3;
  71093. /**
  71094. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  71095. * @returns a new unit Vector3
  71096. */
  71097. static One(): Vector3;
  71098. /**
  71099. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  71100. * @returns a new up Vector3
  71101. */
  71102. static Up(): Vector3;
  71103. /**
  71104. * Gets a up Vector3 that must not be updated
  71105. */
  71106. static readonly UpReadOnly: DeepImmutable<Vector3>;
  71107. /**
  71108. * Gets a zero Vector3 that must not be updated
  71109. */
  71110. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  71111. /**
  71112. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  71113. * @returns a new down Vector3
  71114. */
  71115. static Down(): Vector3;
  71116. /**
  71117. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  71118. * @returns a new forward Vector3
  71119. */
  71120. static Forward(): Vector3;
  71121. /**
  71122. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  71123. * @returns a new forward Vector3
  71124. */
  71125. static Backward(): Vector3;
  71126. /**
  71127. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  71128. * @returns a new right Vector3
  71129. */
  71130. static Right(): Vector3;
  71131. /**
  71132. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  71133. * @returns a new left Vector3
  71134. */
  71135. static Left(): Vector3;
  71136. /**
  71137. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  71138. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  71139. * @param vector defines the Vector3 to transform
  71140. * @param transformation defines the transformation matrix
  71141. * @returns the transformed Vector3
  71142. */
  71143. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  71144. /**
  71145. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  71146. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  71147. * @param vector defines the Vector3 to transform
  71148. * @param transformation defines the transformation matrix
  71149. * @param result defines the Vector3 where to store the result
  71150. */
  71151. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71152. /**
  71153. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  71154. * This method computes tranformed coordinates only, not transformed direction vectors
  71155. * @param x define the x coordinate of the source vector
  71156. * @param y define the y coordinate of the source vector
  71157. * @param z define the z coordinate of the source vector
  71158. * @param transformation defines the transformation matrix
  71159. * @param result defines the Vector3 where to store the result
  71160. */
  71161. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71162. /**
  71163. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  71164. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  71165. * @param vector defines the Vector3 to transform
  71166. * @param transformation defines the transformation matrix
  71167. * @returns the new Vector3
  71168. */
  71169. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  71170. /**
  71171. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  71172. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  71173. * @param vector defines the Vector3 to transform
  71174. * @param transformation defines the transformation matrix
  71175. * @param result defines the Vector3 where to store the result
  71176. */
  71177. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71178. /**
  71179. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  71180. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  71181. * @param x define the x coordinate of the source vector
  71182. * @param y define the y coordinate of the source vector
  71183. * @param z define the z coordinate of the source vector
  71184. * @param transformation defines the transformation matrix
  71185. * @param result defines the Vector3 where to store the result
  71186. */
  71187. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71188. /**
  71189. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  71190. * @param value1 defines the first control point
  71191. * @param value2 defines the second control point
  71192. * @param value3 defines the third control point
  71193. * @param value4 defines the fourth control point
  71194. * @param amount defines the amount on the spline to use
  71195. * @returns the new Vector3
  71196. */
  71197. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  71198. /**
  71199. * 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"
  71200. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  71201. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  71202. * @param value defines the current value
  71203. * @param min defines the lower range value
  71204. * @param max defines the upper range value
  71205. * @returns the new Vector3
  71206. */
  71207. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  71208. /**
  71209. * 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"
  71210. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  71211. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  71212. * @param value defines the current value
  71213. * @param min defines the lower range value
  71214. * @param max defines the upper range value
  71215. * @param result defines the Vector3 where to store the result
  71216. */
  71217. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  71218. /**
  71219. * Checks if a given vector is inside a specific range
  71220. * @param v defines the vector to test
  71221. * @param min defines the minimum range
  71222. * @param max defines the maximum range
  71223. */
  71224. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  71225. /**
  71226. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  71227. * @param value1 defines the first control point
  71228. * @param tangent1 defines the first tangent vector
  71229. * @param value2 defines the second control point
  71230. * @param tangent2 defines the second tangent vector
  71231. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  71232. * @returns the new Vector3
  71233. */
  71234. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  71235. /**
  71236. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  71237. * @param start defines the start value
  71238. * @param end defines the end value
  71239. * @param amount max defines amount between both (between 0 and 1)
  71240. * @returns the new Vector3
  71241. */
  71242. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  71243. /**
  71244. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  71245. * @param start defines the start value
  71246. * @param end defines the end value
  71247. * @param amount max defines amount between both (between 0 and 1)
  71248. * @param result defines the Vector3 where to store the result
  71249. */
  71250. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  71251. /**
  71252. * Returns the dot product (float) between the vectors "left" and "right"
  71253. * @param left defines the left operand
  71254. * @param right defines the right operand
  71255. * @returns the dot product
  71256. */
  71257. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  71258. /**
  71259. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  71260. * The cross product is then orthogonal to both "left" and "right"
  71261. * @param left defines the left operand
  71262. * @param right defines the right operand
  71263. * @returns the cross product
  71264. */
  71265. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71266. /**
  71267. * Sets the given vector "result" with the cross product of "left" and "right"
  71268. * The cross product is then orthogonal to both "left" and "right"
  71269. * @param left defines the left operand
  71270. * @param right defines the right operand
  71271. * @param result defines the Vector3 where to store the result
  71272. */
  71273. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  71274. /**
  71275. * Returns a new Vector3 as the normalization of the given vector
  71276. * @param vector defines the Vector3 to normalize
  71277. * @returns the new Vector3
  71278. */
  71279. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  71280. /**
  71281. * Sets the given vector "result" with the normalization of the given first vector
  71282. * @param vector defines the Vector3 to normalize
  71283. * @param result defines the Vector3 where to store the result
  71284. */
  71285. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  71286. /**
  71287. * Project a Vector3 onto screen space
  71288. * @param vector defines the Vector3 to project
  71289. * @param world defines the world matrix to use
  71290. * @param transform defines the transform (view x projection) matrix to use
  71291. * @param viewport defines the screen viewport to use
  71292. * @returns the new Vector3
  71293. */
  71294. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  71295. /** @hidden */
  71296. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  71297. /**
  71298. * Unproject from screen space to object space
  71299. * @param source defines the screen space Vector3 to use
  71300. * @param viewportWidth defines the current width of the viewport
  71301. * @param viewportHeight defines the current height of the viewport
  71302. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71303. * @param transform defines the transform (view x projection) matrix to use
  71304. * @returns the new Vector3
  71305. */
  71306. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  71307. /**
  71308. * Unproject from screen space to object space
  71309. * @param source defines the screen space Vector3 to use
  71310. * @param viewportWidth defines the current width of the viewport
  71311. * @param viewportHeight defines the current height of the viewport
  71312. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71313. * @param view defines the view matrix to use
  71314. * @param projection defines the projection matrix to use
  71315. * @returns the new Vector3
  71316. */
  71317. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  71318. /**
  71319. * Unproject from screen space to object space
  71320. * @param source defines the screen space Vector3 to use
  71321. * @param viewportWidth defines the current width of the viewport
  71322. * @param viewportHeight defines the current height of the viewport
  71323. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71324. * @param view defines the view matrix to use
  71325. * @param projection defines the projection matrix to use
  71326. * @param result defines the Vector3 where to store the result
  71327. */
  71328. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  71329. /**
  71330. * Unproject from screen space to object space
  71331. * @param sourceX defines the screen space x coordinate to use
  71332. * @param sourceY defines the screen space y coordinate to use
  71333. * @param sourceZ defines the screen space z coordinate to use
  71334. * @param viewportWidth defines the current width of the viewport
  71335. * @param viewportHeight defines the current height of the viewport
  71336. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71337. * @param view defines the view matrix to use
  71338. * @param projection defines the projection matrix to use
  71339. * @param result defines the Vector3 where to store the result
  71340. */
  71341. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  71342. /**
  71343. * Gets the minimal coordinate values between two Vector3
  71344. * @param left defines the first operand
  71345. * @param right defines the second operand
  71346. * @returns the new Vector3
  71347. */
  71348. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71349. /**
  71350. * Gets the maximal coordinate values between two Vector3
  71351. * @param left defines the first operand
  71352. * @param right defines the second operand
  71353. * @returns the new Vector3
  71354. */
  71355. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71356. /**
  71357. * Returns the distance between the vectors "value1" and "value2"
  71358. * @param value1 defines the first operand
  71359. * @param value2 defines the second operand
  71360. * @returns the distance
  71361. */
  71362. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  71363. /**
  71364. * Returns the squared distance between the vectors "value1" and "value2"
  71365. * @param value1 defines the first operand
  71366. * @param value2 defines the second operand
  71367. * @returns the squared distance
  71368. */
  71369. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  71370. /**
  71371. * Returns a new Vector3 located at the center between "value1" and "value2"
  71372. * @param value1 defines the first operand
  71373. * @param value2 defines the second operand
  71374. * @returns the new Vector3
  71375. */
  71376. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  71377. /**
  71378. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  71379. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  71380. * to something in order to rotate it from its local system to the given target system
  71381. * Note: axis1, axis2 and axis3 are normalized during this operation
  71382. * @param axis1 defines the first axis
  71383. * @param axis2 defines the second axis
  71384. * @param axis3 defines the third axis
  71385. * @returns a new Vector3
  71386. */
  71387. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  71388. /**
  71389. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  71390. * @param axis1 defines the first axis
  71391. * @param axis2 defines the second axis
  71392. * @param axis3 defines the third axis
  71393. * @param ref defines the Vector3 where to store the result
  71394. */
  71395. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  71396. }
  71397. /**
  71398. * Vector4 class created for EulerAngle class conversion to Quaternion
  71399. */
  71400. export class Vector4 {
  71401. /** x value of the vector */
  71402. x: number;
  71403. /** y value of the vector */
  71404. y: number;
  71405. /** z value of the vector */
  71406. z: number;
  71407. /** w value of the vector */
  71408. w: number;
  71409. /**
  71410. * Creates a Vector4 object from the given floats.
  71411. * @param x x value of the vector
  71412. * @param y y value of the vector
  71413. * @param z z value of the vector
  71414. * @param w w value of the vector
  71415. */
  71416. constructor(
  71417. /** x value of the vector */
  71418. x: number,
  71419. /** y value of the vector */
  71420. y: number,
  71421. /** z value of the vector */
  71422. z: number,
  71423. /** w value of the vector */
  71424. w: number);
  71425. /**
  71426. * Returns the string with the Vector4 coordinates.
  71427. * @returns a string containing all the vector values
  71428. */
  71429. toString(): string;
  71430. /**
  71431. * Returns the string "Vector4".
  71432. * @returns "Vector4"
  71433. */
  71434. getClassName(): string;
  71435. /**
  71436. * Returns the Vector4 hash code.
  71437. * @returns a unique hash code
  71438. */
  71439. getHashCode(): number;
  71440. /**
  71441. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  71442. * @returns the resulting array
  71443. */
  71444. asArray(): number[];
  71445. /**
  71446. * Populates the given array from the given index with the Vector4 coordinates.
  71447. * @param array array to populate
  71448. * @param index index of the array to start at (default: 0)
  71449. * @returns the Vector4.
  71450. */
  71451. toArray(array: FloatArray, index?: number): Vector4;
  71452. /**
  71453. * Adds the given vector to the current Vector4.
  71454. * @param otherVector the vector to add
  71455. * @returns the updated Vector4.
  71456. */
  71457. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71458. /**
  71459. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  71460. * @param otherVector the vector to add
  71461. * @returns the resulting vector
  71462. */
  71463. add(otherVector: DeepImmutable<Vector4>): Vector4;
  71464. /**
  71465. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  71466. * @param otherVector the vector to add
  71467. * @param result the vector to store the result
  71468. * @returns the current Vector4.
  71469. */
  71470. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71471. /**
  71472. * Subtract in place the given vector from the current Vector4.
  71473. * @param otherVector the vector to subtract
  71474. * @returns the updated Vector4.
  71475. */
  71476. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71477. /**
  71478. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  71479. * @param otherVector the vector to add
  71480. * @returns the new vector with the result
  71481. */
  71482. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  71483. /**
  71484. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  71485. * @param otherVector the vector to subtract
  71486. * @param result the vector to store the result
  71487. * @returns the current Vector4.
  71488. */
  71489. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71490. /**
  71491. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71492. */
  71493. /**
  71494. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71495. * @param x value to subtract
  71496. * @param y value to subtract
  71497. * @param z value to subtract
  71498. * @param w value to subtract
  71499. * @returns new vector containing the result
  71500. */
  71501. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71502. /**
  71503. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71504. * @param x value to subtract
  71505. * @param y value to subtract
  71506. * @param z value to subtract
  71507. * @param w value to subtract
  71508. * @param result the vector to store the result in
  71509. * @returns the current Vector4.
  71510. */
  71511. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  71512. /**
  71513. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  71514. * @returns a new vector with the negated values
  71515. */
  71516. negate(): Vector4;
  71517. /**
  71518. * Multiplies the current Vector4 coordinates by scale (float).
  71519. * @param scale the number to scale with
  71520. * @returns the updated Vector4.
  71521. */
  71522. scaleInPlace(scale: number): Vector4;
  71523. /**
  71524. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  71525. * @param scale the number to scale with
  71526. * @returns a new vector with the result
  71527. */
  71528. scale(scale: number): Vector4;
  71529. /**
  71530. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  71531. * @param scale the number to scale with
  71532. * @param result a vector to store the result in
  71533. * @returns the current Vector4.
  71534. */
  71535. scaleToRef(scale: number, result: Vector4): Vector4;
  71536. /**
  71537. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  71538. * @param scale defines the scale factor
  71539. * @param result defines the Vector4 object where to store the result
  71540. * @returns the unmodified current Vector4
  71541. */
  71542. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  71543. /**
  71544. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  71545. * @param otherVector the vector to compare against
  71546. * @returns true if they are equal
  71547. */
  71548. equals(otherVector: DeepImmutable<Vector4>): boolean;
  71549. /**
  71550. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  71551. * @param otherVector vector to compare against
  71552. * @param epsilon (Default: very small number)
  71553. * @returns true if they are equal
  71554. */
  71555. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  71556. /**
  71557. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  71558. * @param x x value to compare against
  71559. * @param y y value to compare against
  71560. * @param z z value to compare against
  71561. * @param w w value to compare against
  71562. * @returns true if equal
  71563. */
  71564. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  71565. /**
  71566. * Multiplies in place the current Vector4 by the given one.
  71567. * @param otherVector vector to multiple with
  71568. * @returns the updated Vector4.
  71569. */
  71570. multiplyInPlace(otherVector: Vector4): Vector4;
  71571. /**
  71572. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  71573. * @param otherVector vector to multiple with
  71574. * @returns resulting new vector
  71575. */
  71576. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  71577. /**
  71578. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  71579. * @param otherVector vector to multiple with
  71580. * @param result vector to store the result
  71581. * @returns the current Vector4.
  71582. */
  71583. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71584. /**
  71585. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  71586. * @param x x value multiply with
  71587. * @param y y value multiply with
  71588. * @param z z value multiply with
  71589. * @param w w value multiply with
  71590. * @returns resulting new vector
  71591. */
  71592. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  71593. /**
  71594. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  71595. * @param otherVector vector to devide with
  71596. * @returns resulting new vector
  71597. */
  71598. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  71599. /**
  71600. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  71601. * @param otherVector vector to devide with
  71602. * @param result vector to store the result
  71603. * @returns the current Vector4.
  71604. */
  71605. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71606. /**
  71607. * Divides the current Vector3 coordinates by the given ones.
  71608. * @param otherVector vector to devide with
  71609. * @returns the updated Vector3.
  71610. */
  71611. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71612. /**
  71613. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  71614. * @param other defines the second operand
  71615. * @returns the current updated Vector4
  71616. */
  71617. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71618. /**
  71619. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  71620. * @param other defines the second operand
  71621. * @returns the current updated Vector4
  71622. */
  71623. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71624. /**
  71625. * Gets a new Vector4 from current Vector4 floored values
  71626. * @returns a new Vector4
  71627. */
  71628. floor(): Vector4;
  71629. /**
  71630. * Gets a new Vector4 from current Vector3 floored values
  71631. * @returns a new Vector4
  71632. */
  71633. fract(): Vector4;
  71634. /**
  71635. * Returns the Vector4 length (float).
  71636. * @returns the length
  71637. */
  71638. length(): number;
  71639. /**
  71640. * Returns the Vector4 squared length (float).
  71641. * @returns the length squared
  71642. */
  71643. lengthSquared(): number;
  71644. /**
  71645. * Normalizes in place the Vector4.
  71646. * @returns the updated Vector4.
  71647. */
  71648. normalize(): Vector4;
  71649. /**
  71650. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  71651. * @returns this converted to a new vector3
  71652. */
  71653. toVector3(): Vector3;
  71654. /**
  71655. * Returns a new Vector4 copied from the current one.
  71656. * @returns the new cloned vector
  71657. */
  71658. clone(): Vector4;
  71659. /**
  71660. * Updates the current Vector4 with the given one coordinates.
  71661. * @param source the source vector to copy from
  71662. * @returns the updated Vector4.
  71663. */
  71664. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  71665. /**
  71666. * Updates the current Vector4 coordinates with the given floats.
  71667. * @param x float to copy from
  71668. * @param y float to copy from
  71669. * @param z float to copy from
  71670. * @param w float to copy from
  71671. * @returns the updated Vector4.
  71672. */
  71673. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71674. /**
  71675. * Updates the current Vector4 coordinates with the given floats.
  71676. * @param x float to set from
  71677. * @param y float to set from
  71678. * @param z float to set from
  71679. * @param w float to set from
  71680. * @returns the updated Vector4.
  71681. */
  71682. set(x: number, y: number, z: number, w: number): Vector4;
  71683. /**
  71684. * Copies the given float to the current Vector3 coordinates
  71685. * @param v defines the x, y, z and w coordinates of the operand
  71686. * @returns the current updated Vector3
  71687. */
  71688. setAll(v: number): Vector4;
  71689. /**
  71690. * Returns a new Vector4 set from the starting index of the given array.
  71691. * @param array the array to pull values from
  71692. * @param offset the offset into the array to start at
  71693. * @returns the new vector
  71694. */
  71695. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  71696. /**
  71697. * Updates the given vector "result" from the starting index of the given array.
  71698. * @param array the array to pull values from
  71699. * @param offset the offset into the array to start at
  71700. * @param result the vector to store the result in
  71701. */
  71702. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  71703. /**
  71704. * Updates the given vector "result" from the starting index of the given Float32Array.
  71705. * @param array the array to pull values from
  71706. * @param offset the offset into the array to start at
  71707. * @param result the vector to store the result in
  71708. */
  71709. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  71710. /**
  71711. * Updates the given vector "result" coordinates from the given floats.
  71712. * @param x float to set from
  71713. * @param y float to set from
  71714. * @param z float to set from
  71715. * @param w float to set from
  71716. * @param result the vector to the floats in
  71717. */
  71718. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  71719. /**
  71720. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  71721. * @returns the new vector
  71722. */
  71723. static Zero(): Vector4;
  71724. /**
  71725. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  71726. * @returns the new vector
  71727. */
  71728. static One(): Vector4;
  71729. /**
  71730. * Returns a new normalized Vector4 from the given one.
  71731. * @param vector the vector to normalize
  71732. * @returns the vector
  71733. */
  71734. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  71735. /**
  71736. * Updates the given vector "result" from the normalization of the given one.
  71737. * @param vector the vector to normalize
  71738. * @param result the vector to store the result in
  71739. */
  71740. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  71741. /**
  71742. * Returns a vector with the minimum values from the left and right vectors
  71743. * @param left left vector to minimize
  71744. * @param right right vector to minimize
  71745. * @returns a new vector with the minimum of the left and right vector values
  71746. */
  71747. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71748. /**
  71749. * Returns a vector with the maximum values from the left and right vectors
  71750. * @param left left vector to maximize
  71751. * @param right right vector to maximize
  71752. * @returns a new vector with the maximum of the left and right vector values
  71753. */
  71754. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71755. /**
  71756. * Returns the distance (float) between the vectors "value1" and "value2".
  71757. * @param value1 value to calulate the distance between
  71758. * @param value2 value to calulate the distance between
  71759. * @return the distance between the two vectors
  71760. */
  71761. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71762. /**
  71763. * Returns the squared distance (float) between the vectors "value1" and "value2".
  71764. * @param value1 value to calulate the distance between
  71765. * @param value2 value to calulate the distance between
  71766. * @return the distance between the two vectors squared
  71767. */
  71768. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71769. /**
  71770. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  71771. * @param value1 value to calulate the center between
  71772. * @param value2 value to calulate the center between
  71773. * @return the center between the two vectors
  71774. */
  71775. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  71776. /**
  71777. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  71778. * This methods computes transformed normalized direction vectors only.
  71779. * @param vector the vector to transform
  71780. * @param transformation the transformation matrix to apply
  71781. * @returns the new vector
  71782. */
  71783. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  71784. /**
  71785. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  71786. * This methods computes transformed normalized direction vectors only.
  71787. * @param vector the vector to transform
  71788. * @param transformation the transformation matrix to apply
  71789. * @param result the vector to store the result in
  71790. */
  71791. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71792. /**
  71793. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  71794. * This methods computes transformed normalized direction vectors only.
  71795. * @param x value to transform
  71796. * @param y value to transform
  71797. * @param z value to transform
  71798. * @param w value to transform
  71799. * @param transformation the transformation matrix to apply
  71800. * @param result the vector to store the results in
  71801. */
  71802. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71803. /**
  71804. * Creates a new Vector4 from a Vector3
  71805. * @param source defines the source data
  71806. * @param w defines the 4th component (default is 0)
  71807. * @returns a new Vector4
  71808. */
  71809. static FromVector3(source: Vector3, w?: number): Vector4;
  71810. }
  71811. /**
  71812. * Class used to store quaternion data
  71813. * @see https://en.wikipedia.org/wiki/Quaternion
  71814. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  71815. */
  71816. export class Quaternion {
  71817. /** defines the first component (0 by default) */
  71818. x: number;
  71819. /** defines the second component (0 by default) */
  71820. y: number;
  71821. /** defines the third component (0 by default) */
  71822. z: number;
  71823. /** defines the fourth component (1.0 by default) */
  71824. w: number;
  71825. /**
  71826. * Creates a new Quaternion from the given floats
  71827. * @param x defines the first component (0 by default)
  71828. * @param y defines the second component (0 by default)
  71829. * @param z defines the third component (0 by default)
  71830. * @param w defines the fourth component (1.0 by default)
  71831. */
  71832. constructor(
  71833. /** defines the first component (0 by default) */
  71834. x?: number,
  71835. /** defines the second component (0 by default) */
  71836. y?: number,
  71837. /** defines the third component (0 by default) */
  71838. z?: number,
  71839. /** defines the fourth component (1.0 by default) */
  71840. w?: number);
  71841. /**
  71842. * Gets a string representation for the current quaternion
  71843. * @returns a string with the Quaternion coordinates
  71844. */
  71845. toString(): string;
  71846. /**
  71847. * Gets the class name of the quaternion
  71848. * @returns the string "Quaternion"
  71849. */
  71850. getClassName(): string;
  71851. /**
  71852. * Gets a hash code for this quaternion
  71853. * @returns the quaternion hash code
  71854. */
  71855. getHashCode(): number;
  71856. /**
  71857. * Copy the quaternion to an array
  71858. * @returns a new array populated with 4 elements from the quaternion coordinates
  71859. */
  71860. asArray(): number[];
  71861. /**
  71862. * Check if two quaternions are equals
  71863. * @param otherQuaternion defines the second operand
  71864. * @return true if the current quaternion and the given one coordinates are strictly equals
  71865. */
  71866. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  71867. /**
  71868. * Clone the current quaternion
  71869. * @returns a new quaternion copied from the current one
  71870. */
  71871. clone(): Quaternion;
  71872. /**
  71873. * Copy a quaternion to the current one
  71874. * @param other defines the other quaternion
  71875. * @returns the updated current quaternion
  71876. */
  71877. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  71878. /**
  71879. * Updates the current quaternion with the given float coordinates
  71880. * @param x defines the x coordinate
  71881. * @param y defines the y coordinate
  71882. * @param z defines the z coordinate
  71883. * @param w defines the w coordinate
  71884. * @returns the updated current quaternion
  71885. */
  71886. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  71887. /**
  71888. * Updates the current quaternion from the given float coordinates
  71889. * @param x defines the x coordinate
  71890. * @param y defines the y coordinate
  71891. * @param z defines the z coordinate
  71892. * @param w defines the w coordinate
  71893. * @returns the updated current quaternion
  71894. */
  71895. set(x: number, y: number, z: number, w: number): Quaternion;
  71896. /**
  71897. * Adds two quaternions
  71898. * @param other defines the second operand
  71899. * @returns a new quaternion as the addition result of the given one and the current quaternion
  71900. */
  71901. add(other: DeepImmutable<Quaternion>): Quaternion;
  71902. /**
  71903. * Add a quaternion to the current one
  71904. * @param other defines the quaternion to add
  71905. * @returns the current quaternion
  71906. */
  71907. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  71908. /**
  71909. * Subtract two quaternions
  71910. * @param other defines the second operand
  71911. * @returns a new quaternion as the subtraction result of the given one from the current one
  71912. */
  71913. subtract(other: Quaternion): Quaternion;
  71914. /**
  71915. * Multiplies the current quaternion by a scale factor
  71916. * @param value defines the scale factor
  71917. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  71918. */
  71919. scale(value: number): Quaternion;
  71920. /**
  71921. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  71922. * @param scale defines the scale factor
  71923. * @param result defines the Quaternion object where to store the result
  71924. * @returns the unmodified current quaternion
  71925. */
  71926. scaleToRef(scale: number, result: Quaternion): Quaternion;
  71927. /**
  71928. * Multiplies in place the current quaternion by a scale factor
  71929. * @param value defines the scale factor
  71930. * @returns the current modified quaternion
  71931. */
  71932. scaleInPlace(value: number): Quaternion;
  71933. /**
  71934. * Scale the current quaternion values by a factor and add the result to a given quaternion
  71935. * @param scale defines the scale factor
  71936. * @param result defines the Quaternion object where to store the result
  71937. * @returns the unmodified current quaternion
  71938. */
  71939. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  71940. /**
  71941. * Multiplies two quaternions
  71942. * @param q1 defines the second operand
  71943. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  71944. */
  71945. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  71946. /**
  71947. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  71948. * @param q1 defines the second operand
  71949. * @param result defines the target quaternion
  71950. * @returns the current quaternion
  71951. */
  71952. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  71953. /**
  71954. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  71955. * @param q1 defines the second operand
  71956. * @returns the currentupdated quaternion
  71957. */
  71958. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  71959. /**
  71960. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  71961. * @param ref defines the target quaternion
  71962. * @returns the current quaternion
  71963. */
  71964. conjugateToRef(ref: Quaternion): Quaternion;
  71965. /**
  71966. * Conjugates in place (1-q) the current quaternion
  71967. * @returns the current updated quaternion
  71968. */
  71969. conjugateInPlace(): Quaternion;
  71970. /**
  71971. * Conjugates in place (1-q) the current quaternion
  71972. * @returns a new quaternion
  71973. */
  71974. conjugate(): Quaternion;
  71975. /**
  71976. * Gets length of current quaternion
  71977. * @returns the quaternion length (float)
  71978. */
  71979. length(): number;
  71980. /**
  71981. * Normalize in place the current quaternion
  71982. * @returns the current updated quaternion
  71983. */
  71984. normalize(): Quaternion;
  71985. /**
  71986. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  71987. * @param order is a reserved parameter and is ignore for now
  71988. * @returns a new Vector3 containing the Euler angles
  71989. */
  71990. toEulerAngles(order?: string): Vector3;
  71991. /**
  71992. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  71993. * @param result defines the vector which will be filled with the Euler angles
  71994. * @param order is a reserved parameter and is ignore for now
  71995. * @returns the current unchanged quaternion
  71996. */
  71997. toEulerAnglesToRef(result: Vector3): Quaternion;
  71998. /**
  71999. * Updates the given rotation matrix with the current quaternion values
  72000. * @param result defines the target matrix
  72001. * @returns the current unchanged quaternion
  72002. */
  72003. toRotationMatrix(result: Matrix): Quaternion;
  72004. /**
  72005. * Updates the current quaternion from the given rotation matrix values
  72006. * @param matrix defines the source matrix
  72007. * @returns the current updated quaternion
  72008. */
  72009. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  72010. /**
  72011. * Creates a new quaternion from a rotation matrix
  72012. * @param matrix defines the source matrix
  72013. * @returns a new quaternion created from the given rotation matrix values
  72014. */
  72015. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  72016. /**
  72017. * Updates the given quaternion with the given rotation matrix values
  72018. * @param matrix defines the source matrix
  72019. * @param result defines the target quaternion
  72020. */
  72021. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  72022. /**
  72023. * Returns the dot product (float) between the quaternions "left" and "right"
  72024. * @param left defines the left operand
  72025. * @param right defines the right operand
  72026. * @returns the dot product
  72027. */
  72028. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  72029. /**
  72030. * Checks if the two quaternions are close to each other
  72031. * @param quat0 defines the first quaternion to check
  72032. * @param quat1 defines the second quaternion to check
  72033. * @returns true if the two quaternions are close to each other
  72034. */
  72035. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  72036. /**
  72037. * Creates an empty quaternion
  72038. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  72039. */
  72040. static Zero(): Quaternion;
  72041. /**
  72042. * Inverse a given quaternion
  72043. * @param q defines the source quaternion
  72044. * @returns a new quaternion as the inverted current quaternion
  72045. */
  72046. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  72047. /**
  72048. * Inverse a given quaternion
  72049. * @param q defines the source quaternion
  72050. * @param result the quaternion the result will be stored in
  72051. * @returns the result quaternion
  72052. */
  72053. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  72054. /**
  72055. * Creates an identity quaternion
  72056. * @returns the identity quaternion
  72057. */
  72058. static Identity(): Quaternion;
  72059. /**
  72060. * Gets a boolean indicating if the given quaternion is identity
  72061. * @param quaternion defines the quaternion to check
  72062. * @returns true if the quaternion is identity
  72063. */
  72064. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  72065. /**
  72066. * Creates a quaternion from a rotation around an axis
  72067. * @param axis defines the axis to use
  72068. * @param angle defines the angle to use
  72069. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  72070. */
  72071. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  72072. /**
  72073. * Creates a rotation around an axis and stores it into the given quaternion
  72074. * @param axis defines the axis to use
  72075. * @param angle defines the angle to use
  72076. * @param result defines the target quaternion
  72077. * @returns the target quaternion
  72078. */
  72079. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  72080. /**
  72081. * Creates a new quaternion from data stored into an array
  72082. * @param array defines the data source
  72083. * @param offset defines the offset in the source array where the data starts
  72084. * @returns a new quaternion
  72085. */
  72086. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  72087. /**
  72088. * Create a quaternion from Euler rotation angles
  72089. * @param x Pitch
  72090. * @param y Yaw
  72091. * @param z Roll
  72092. * @returns the new Quaternion
  72093. */
  72094. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  72095. /**
  72096. * Updates a quaternion from Euler rotation angles
  72097. * @param x Pitch
  72098. * @param y Yaw
  72099. * @param z Roll
  72100. * @param result the quaternion to store the result
  72101. * @returns the updated quaternion
  72102. */
  72103. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  72104. /**
  72105. * Create a quaternion from Euler rotation vector
  72106. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  72107. * @returns the new Quaternion
  72108. */
  72109. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  72110. /**
  72111. * Updates a quaternion from Euler rotation vector
  72112. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  72113. * @param result the quaternion to store the result
  72114. * @returns the updated quaternion
  72115. */
  72116. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  72117. /**
  72118. * Creates a new quaternion from the given Euler float angles (y, x, z)
  72119. * @param yaw defines the rotation around Y axis
  72120. * @param pitch defines the rotation around X axis
  72121. * @param roll defines the rotation around Z axis
  72122. * @returns the new quaternion
  72123. */
  72124. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  72125. /**
  72126. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  72127. * @param yaw defines the rotation around Y axis
  72128. * @param pitch defines the rotation around X axis
  72129. * @param roll defines the rotation around Z axis
  72130. * @param result defines the target quaternion
  72131. */
  72132. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  72133. /**
  72134. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  72135. * @param alpha defines the rotation around first axis
  72136. * @param beta defines the rotation around second axis
  72137. * @param gamma defines the rotation around third axis
  72138. * @returns the new quaternion
  72139. */
  72140. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  72141. /**
  72142. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  72143. * @param alpha defines the rotation around first axis
  72144. * @param beta defines the rotation around second axis
  72145. * @param gamma defines the rotation around third axis
  72146. * @param result defines the target quaternion
  72147. */
  72148. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  72149. /**
  72150. * 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)
  72151. * @param axis1 defines the first axis
  72152. * @param axis2 defines the second axis
  72153. * @param axis3 defines the third axis
  72154. * @returns the new quaternion
  72155. */
  72156. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  72157. /**
  72158. * 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
  72159. * @param axis1 defines the first axis
  72160. * @param axis2 defines the second axis
  72161. * @param axis3 defines the third axis
  72162. * @param ref defines the target quaternion
  72163. */
  72164. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  72165. /**
  72166. * Interpolates between two quaternions
  72167. * @param left defines first quaternion
  72168. * @param right defines second quaternion
  72169. * @param amount defines the gradient to use
  72170. * @returns the new interpolated quaternion
  72171. */
  72172. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  72173. /**
  72174. * Interpolates between two quaternions and stores it into a target quaternion
  72175. * @param left defines first quaternion
  72176. * @param right defines second quaternion
  72177. * @param amount defines the gradient to use
  72178. * @param result defines the target quaternion
  72179. */
  72180. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  72181. /**
  72182. * Interpolate between two quaternions using Hermite interpolation
  72183. * @param value1 defines first quaternion
  72184. * @param tangent1 defines the incoming tangent
  72185. * @param value2 defines second quaternion
  72186. * @param tangent2 defines the outgoing tangent
  72187. * @param amount defines the target quaternion
  72188. * @returns the new interpolated quaternion
  72189. */
  72190. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  72191. }
  72192. /**
  72193. * Class used to store matrix data (4x4)
  72194. */
  72195. export class Matrix {
  72196. private static _updateFlagSeed;
  72197. private static _identityReadOnly;
  72198. private _isIdentity;
  72199. private _isIdentityDirty;
  72200. private _isIdentity3x2;
  72201. private _isIdentity3x2Dirty;
  72202. /**
  72203. * Gets the update flag of the matrix which is an unique number for the matrix.
  72204. * It will be incremented every time the matrix data change.
  72205. * You can use it to speed the comparison between two versions of the same matrix.
  72206. */
  72207. updateFlag: number;
  72208. private readonly _m;
  72209. /**
  72210. * Gets the internal data of the matrix
  72211. */
  72212. readonly m: DeepImmutable<Float32Array>;
  72213. /** @hidden */
  72214. _markAsUpdated(): void;
  72215. /** @hidden */
  72216. private _updateIdentityStatus;
  72217. /**
  72218. * Creates an empty matrix (filled with zeros)
  72219. */
  72220. constructor();
  72221. /**
  72222. * Check if the current matrix is identity
  72223. * @returns true is the matrix is the identity matrix
  72224. */
  72225. isIdentity(): boolean;
  72226. /**
  72227. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  72228. * @returns true is the matrix is the identity matrix
  72229. */
  72230. isIdentityAs3x2(): boolean;
  72231. /**
  72232. * Gets the determinant of the matrix
  72233. * @returns the matrix determinant
  72234. */
  72235. determinant(): number;
  72236. /**
  72237. * Returns the matrix as a Float32Array
  72238. * @returns the matrix underlying array
  72239. */
  72240. toArray(): DeepImmutable<Float32Array>;
  72241. /**
  72242. * Returns the matrix as a Float32Array
  72243. * @returns the matrix underlying array.
  72244. */
  72245. asArray(): DeepImmutable<Float32Array>;
  72246. /**
  72247. * Inverts the current matrix in place
  72248. * @returns the current inverted matrix
  72249. */
  72250. invert(): Matrix;
  72251. /**
  72252. * Sets all the matrix elements to zero
  72253. * @returns the current matrix
  72254. */
  72255. reset(): Matrix;
  72256. /**
  72257. * Adds the current matrix with a second one
  72258. * @param other defines the matrix to add
  72259. * @returns a new matrix as the addition of the current matrix and the given one
  72260. */
  72261. add(other: DeepImmutable<Matrix>): Matrix;
  72262. /**
  72263. * Sets the given matrix "result" to the addition of the current matrix and the given one
  72264. * @param other defines the matrix to add
  72265. * @param result defines the target matrix
  72266. * @returns the current matrix
  72267. */
  72268. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  72269. /**
  72270. * Adds in place the given matrix to the current matrix
  72271. * @param other defines the second operand
  72272. * @returns the current updated matrix
  72273. */
  72274. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  72275. /**
  72276. * Sets the given matrix to the current inverted Matrix
  72277. * @param other defines the target matrix
  72278. * @returns the unmodified current matrix
  72279. */
  72280. invertToRef(other: Matrix): Matrix;
  72281. /**
  72282. * add a value at the specified position in the current Matrix
  72283. * @param index the index of the value within the matrix. between 0 and 15.
  72284. * @param value the value to be added
  72285. * @returns the current updated matrix
  72286. */
  72287. addAtIndex(index: number, value: number): Matrix;
  72288. /**
  72289. * mutiply the specified position in the current Matrix by a value
  72290. * @param index the index of the value within the matrix. between 0 and 15.
  72291. * @param value the value to be added
  72292. * @returns the current updated matrix
  72293. */
  72294. multiplyAtIndex(index: number, value: number): Matrix;
  72295. /**
  72296. * Inserts the translation vector (using 3 floats) in the current matrix
  72297. * @param x defines the 1st component of the translation
  72298. * @param y defines the 2nd component of the translation
  72299. * @param z defines the 3rd component of the translation
  72300. * @returns the current updated matrix
  72301. */
  72302. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  72303. /**
  72304. * Adds the translation vector (using 3 floats) in the current matrix
  72305. * @param x defines the 1st component of the translation
  72306. * @param y defines the 2nd component of the translation
  72307. * @param z defines the 3rd component of the translation
  72308. * @returns the current updated matrix
  72309. */
  72310. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  72311. /**
  72312. * Inserts the translation vector in the current matrix
  72313. * @param vector3 defines the translation to insert
  72314. * @returns the current updated matrix
  72315. */
  72316. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  72317. /**
  72318. * Gets the translation value of the current matrix
  72319. * @returns a new Vector3 as the extracted translation from the matrix
  72320. */
  72321. getTranslation(): Vector3;
  72322. /**
  72323. * Fill a Vector3 with the extracted translation from the matrix
  72324. * @param result defines the Vector3 where to store the translation
  72325. * @returns the current matrix
  72326. */
  72327. getTranslationToRef(result: Vector3): Matrix;
  72328. /**
  72329. * Remove rotation and scaling part from the matrix
  72330. * @returns the updated matrix
  72331. */
  72332. removeRotationAndScaling(): Matrix;
  72333. /**
  72334. * Multiply two matrices
  72335. * @param other defines the second operand
  72336. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  72337. */
  72338. multiply(other: DeepImmutable<Matrix>): Matrix;
  72339. /**
  72340. * Copy the current matrix from the given one
  72341. * @param other defines the source matrix
  72342. * @returns the current updated matrix
  72343. */
  72344. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  72345. /**
  72346. * Populates the given array from the starting index with the current matrix values
  72347. * @param array defines the target array
  72348. * @param offset defines the offset in the target array where to start storing values
  72349. * @returns the current matrix
  72350. */
  72351. copyToArray(array: Float32Array, offset?: number): Matrix;
  72352. /**
  72353. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  72354. * @param other defines the second operand
  72355. * @param result defines the matrix where to store the multiplication
  72356. * @returns the current matrix
  72357. */
  72358. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  72359. /**
  72360. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  72361. * @param other defines the second operand
  72362. * @param result defines the array where to store the multiplication
  72363. * @param offset defines the offset in the target array where to start storing values
  72364. * @returns the current matrix
  72365. */
  72366. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  72367. /**
  72368. * Check equality between this matrix and a second one
  72369. * @param value defines the second matrix to compare
  72370. * @returns true is the current matrix and the given one values are strictly equal
  72371. */
  72372. equals(value: DeepImmutable<Matrix>): boolean;
  72373. /**
  72374. * Clone the current matrix
  72375. * @returns a new matrix from the current matrix
  72376. */
  72377. clone(): Matrix;
  72378. /**
  72379. * Returns the name of the current matrix class
  72380. * @returns the string "Matrix"
  72381. */
  72382. getClassName(): string;
  72383. /**
  72384. * Gets the hash code of the current matrix
  72385. * @returns the hash code
  72386. */
  72387. getHashCode(): number;
  72388. /**
  72389. * Decomposes the current Matrix into a translation, rotation and scaling components
  72390. * @param scale defines the scale vector3 given as a reference to update
  72391. * @param rotation defines the rotation quaternion given as a reference to update
  72392. * @param translation defines the translation vector3 given as a reference to update
  72393. * @returns true if operation was successful
  72394. */
  72395. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  72396. /**
  72397. * Gets specific row of the matrix
  72398. * @param index defines the number of the row to get
  72399. * @returns the index-th row of the current matrix as a new Vector4
  72400. */
  72401. getRow(index: number): Nullable<Vector4>;
  72402. /**
  72403. * Sets the index-th row of the current matrix to the vector4 values
  72404. * @param index defines the number of the row to set
  72405. * @param row defines the target vector4
  72406. * @returns the updated current matrix
  72407. */
  72408. setRow(index: number, row: Vector4): Matrix;
  72409. /**
  72410. * Compute the transpose of the matrix
  72411. * @returns the new transposed matrix
  72412. */
  72413. transpose(): Matrix;
  72414. /**
  72415. * Compute the transpose of the matrix and store it in a given matrix
  72416. * @param result defines the target matrix
  72417. * @returns the current matrix
  72418. */
  72419. transposeToRef(result: Matrix): Matrix;
  72420. /**
  72421. * Sets the index-th row of the current matrix with the given 4 x float values
  72422. * @param index defines the row index
  72423. * @param x defines the x component to set
  72424. * @param y defines the y component to set
  72425. * @param z defines the z component to set
  72426. * @param w defines the w component to set
  72427. * @returns the updated current matrix
  72428. */
  72429. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  72430. /**
  72431. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  72432. * @param scale defines the scale factor
  72433. * @returns a new matrix
  72434. */
  72435. scale(scale: number): Matrix;
  72436. /**
  72437. * Scale the current matrix values by a factor to a given result matrix
  72438. * @param scale defines the scale factor
  72439. * @param result defines the matrix to store the result
  72440. * @returns the current matrix
  72441. */
  72442. scaleToRef(scale: number, result: Matrix): Matrix;
  72443. /**
  72444. * Scale the current matrix values by a factor and add the result to a given matrix
  72445. * @param scale defines the scale factor
  72446. * @param result defines the Matrix to store the result
  72447. * @returns the current matrix
  72448. */
  72449. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  72450. /**
  72451. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  72452. * @param ref matrix to store the result
  72453. */
  72454. toNormalMatrix(ref: Matrix): void;
  72455. /**
  72456. * Gets only rotation part of the current matrix
  72457. * @returns a new matrix sets to the extracted rotation matrix from the current one
  72458. */
  72459. getRotationMatrix(): Matrix;
  72460. /**
  72461. * Extracts the rotation matrix from the current one and sets it as the given "result"
  72462. * @param result defines the target matrix to store data to
  72463. * @returns the current matrix
  72464. */
  72465. getRotationMatrixToRef(result: Matrix): Matrix;
  72466. /**
  72467. * Toggles model matrix from being right handed to left handed in place and vice versa
  72468. */
  72469. toggleModelMatrixHandInPlace(): void;
  72470. /**
  72471. * Toggles projection matrix from being right handed to left handed in place and vice versa
  72472. */
  72473. toggleProjectionMatrixHandInPlace(): void;
  72474. /**
  72475. * Creates a matrix from an array
  72476. * @param array defines the source array
  72477. * @param offset defines an offset in the source array
  72478. * @returns a new Matrix set from the starting index of the given array
  72479. */
  72480. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  72481. /**
  72482. * Copy the content of an array into a given matrix
  72483. * @param array defines the source array
  72484. * @param offset defines an offset in the source array
  72485. * @param result defines the target matrix
  72486. */
  72487. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  72488. /**
  72489. * Stores an array into a matrix after having multiplied each component by a given factor
  72490. * @param array defines the source array
  72491. * @param offset defines the offset in the source array
  72492. * @param scale defines the scaling factor
  72493. * @param result defines the target matrix
  72494. */
  72495. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  72496. /**
  72497. * Gets an identity matrix that must not be updated
  72498. */
  72499. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  72500. /**
  72501. * Stores a list of values (16) inside a given matrix
  72502. * @param initialM11 defines 1st value of 1st row
  72503. * @param initialM12 defines 2nd value of 1st row
  72504. * @param initialM13 defines 3rd value of 1st row
  72505. * @param initialM14 defines 4th value of 1st row
  72506. * @param initialM21 defines 1st value of 2nd row
  72507. * @param initialM22 defines 2nd value of 2nd row
  72508. * @param initialM23 defines 3rd value of 2nd row
  72509. * @param initialM24 defines 4th value of 2nd row
  72510. * @param initialM31 defines 1st value of 3rd row
  72511. * @param initialM32 defines 2nd value of 3rd row
  72512. * @param initialM33 defines 3rd value of 3rd row
  72513. * @param initialM34 defines 4th value of 3rd row
  72514. * @param initialM41 defines 1st value of 4th row
  72515. * @param initialM42 defines 2nd value of 4th row
  72516. * @param initialM43 defines 3rd value of 4th row
  72517. * @param initialM44 defines 4th value of 4th row
  72518. * @param result defines the target matrix
  72519. */
  72520. 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;
  72521. /**
  72522. * Creates new matrix from a list of values (16)
  72523. * @param initialM11 defines 1st value of 1st row
  72524. * @param initialM12 defines 2nd value of 1st row
  72525. * @param initialM13 defines 3rd value of 1st row
  72526. * @param initialM14 defines 4th value of 1st row
  72527. * @param initialM21 defines 1st value of 2nd row
  72528. * @param initialM22 defines 2nd value of 2nd row
  72529. * @param initialM23 defines 3rd value of 2nd row
  72530. * @param initialM24 defines 4th value of 2nd row
  72531. * @param initialM31 defines 1st value of 3rd row
  72532. * @param initialM32 defines 2nd value of 3rd row
  72533. * @param initialM33 defines 3rd value of 3rd row
  72534. * @param initialM34 defines 4th value of 3rd row
  72535. * @param initialM41 defines 1st value of 4th row
  72536. * @param initialM42 defines 2nd value of 4th row
  72537. * @param initialM43 defines 3rd value of 4th row
  72538. * @param initialM44 defines 4th value of 4th row
  72539. * @returns the new matrix
  72540. */
  72541. 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;
  72542. /**
  72543. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  72544. * @param scale defines the scale vector3
  72545. * @param rotation defines the rotation quaternion
  72546. * @param translation defines the translation vector3
  72547. * @returns a new matrix
  72548. */
  72549. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  72550. /**
  72551. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  72552. * @param scale defines the scale vector3
  72553. * @param rotation defines the rotation quaternion
  72554. * @param translation defines the translation vector3
  72555. * @param result defines the target matrix
  72556. */
  72557. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  72558. /**
  72559. * Creates a new identity matrix
  72560. * @returns a new identity matrix
  72561. */
  72562. static Identity(): Matrix;
  72563. /**
  72564. * Creates a new identity matrix and stores the result in a given matrix
  72565. * @param result defines the target matrix
  72566. */
  72567. static IdentityToRef(result: Matrix): void;
  72568. /**
  72569. * Creates a new zero matrix
  72570. * @returns a new zero matrix
  72571. */
  72572. static Zero(): Matrix;
  72573. /**
  72574. * Creates a new rotation matrix for "angle" radians around the X axis
  72575. * @param angle defines the angle (in radians) to use
  72576. * @return the new matrix
  72577. */
  72578. static RotationX(angle: number): Matrix;
  72579. /**
  72580. * Creates a new matrix as the invert of a given matrix
  72581. * @param source defines the source matrix
  72582. * @returns the new matrix
  72583. */
  72584. static Invert(source: DeepImmutable<Matrix>): Matrix;
  72585. /**
  72586. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  72587. * @param angle defines the angle (in radians) to use
  72588. * @param result defines the target matrix
  72589. */
  72590. static RotationXToRef(angle: number, result: Matrix): void;
  72591. /**
  72592. * Creates a new rotation matrix for "angle" radians around the Y axis
  72593. * @param angle defines the angle (in radians) to use
  72594. * @return the new matrix
  72595. */
  72596. static RotationY(angle: number): Matrix;
  72597. /**
  72598. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  72599. * @param angle defines the angle (in radians) to use
  72600. * @param result defines the target matrix
  72601. */
  72602. static RotationYToRef(angle: number, result: Matrix): void;
  72603. /**
  72604. * Creates a new rotation matrix for "angle" radians around the Z axis
  72605. * @param angle defines the angle (in radians) to use
  72606. * @return the new matrix
  72607. */
  72608. static RotationZ(angle: number): Matrix;
  72609. /**
  72610. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  72611. * @param angle defines the angle (in radians) to use
  72612. * @param result defines the target matrix
  72613. */
  72614. static RotationZToRef(angle: number, result: Matrix): void;
  72615. /**
  72616. * Creates a new rotation matrix for "angle" radians around the given axis
  72617. * @param axis defines the axis to use
  72618. * @param angle defines the angle (in radians) to use
  72619. * @return the new matrix
  72620. */
  72621. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  72622. /**
  72623. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  72624. * @param axis defines the axis to use
  72625. * @param angle defines the angle (in radians) to use
  72626. * @param result defines the target matrix
  72627. */
  72628. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  72629. /**
  72630. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  72631. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  72632. * @param from defines the vector to align
  72633. * @param to defines the vector to align to
  72634. * @param result defines the target matrix
  72635. */
  72636. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  72637. /**
  72638. * Creates a rotation matrix
  72639. * @param yaw defines the yaw angle in radians (Y axis)
  72640. * @param pitch defines the pitch angle in radians (X axis)
  72641. * @param roll defines the roll angle in radians (X axis)
  72642. * @returns the new rotation matrix
  72643. */
  72644. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  72645. /**
  72646. * Creates a rotation matrix and stores it in a given matrix
  72647. * @param yaw defines the yaw angle in radians (Y axis)
  72648. * @param pitch defines the pitch angle in radians (X axis)
  72649. * @param roll defines the roll angle in radians (X axis)
  72650. * @param result defines the target matrix
  72651. */
  72652. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  72653. /**
  72654. * Creates a scaling matrix
  72655. * @param x defines the scale factor on X axis
  72656. * @param y defines the scale factor on Y axis
  72657. * @param z defines the scale factor on Z axis
  72658. * @returns the new matrix
  72659. */
  72660. static Scaling(x: number, y: number, z: number): Matrix;
  72661. /**
  72662. * Creates a scaling matrix and stores it in a given matrix
  72663. * @param x defines the scale factor on X axis
  72664. * @param y defines the scale factor on Y axis
  72665. * @param z defines the scale factor on Z axis
  72666. * @param result defines the target matrix
  72667. */
  72668. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  72669. /**
  72670. * Creates a translation matrix
  72671. * @param x defines the translation on X axis
  72672. * @param y defines the translation on Y axis
  72673. * @param z defines the translationon Z axis
  72674. * @returns the new matrix
  72675. */
  72676. static Translation(x: number, y: number, z: number): Matrix;
  72677. /**
  72678. * Creates a translation matrix and stores it in a given matrix
  72679. * @param x defines the translation on X axis
  72680. * @param y defines the translation on Y axis
  72681. * @param z defines the translationon Z axis
  72682. * @param result defines the target matrix
  72683. */
  72684. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  72685. /**
  72686. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72687. * @param startValue defines the start value
  72688. * @param endValue defines the end value
  72689. * @param gradient defines the gradient factor
  72690. * @returns the new matrix
  72691. */
  72692. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72693. /**
  72694. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72695. * @param startValue defines the start value
  72696. * @param endValue defines the end value
  72697. * @param gradient defines the gradient factor
  72698. * @param result defines the Matrix object where to store data
  72699. */
  72700. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72701. /**
  72702. * Builds a new matrix whose values are computed by:
  72703. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72704. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72705. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72706. * @param startValue defines the first matrix
  72707. * @param endValue defines the second matrix
  72708. * @param gradient defines the gradient between the two matrices
  72709. * @returns the new matrix
  72710. */
  72711. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72712. /**
  72713. * Update a matrix to values which are computed by:
  72714. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72715. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72716. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72717. * @param startValue defines the first matrix
  72718. * @param endValue defines the second matrix
  72719. * @param gradient defines the gradient between the two matrices
  72720. * @param result defines the target matrix
  72721. */
  72722. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72723. /**
  72724. * 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"
  72725. * This function works in left handed mode
  72726. * @param eye defines the final position of the entity
  72727. * @param target defines where the entity should look at
  72728. * @param up defines the up vector for the entity
  72729. * @returns the new matrix
  72730. */
  72731. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72732. /**
  72733. * 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".
  72734. * This function works in left handed mode
  72735. * @param eye defines the final position of the entity
  72736. * @param target defines where the entity should look at
  72737. * @param up defines the up vector for the entity
  72738. * @param result defines the target matrix
  72739. */
  72740. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72741. /**
  72742. * 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"
  72743. * This function works in right handed mode
  72744. * @param eye defines the final position of the entity
  72745. * @param target defines where the entity should look at
  72746. * @param up defines the up vector for the entity
  72747. * @returns the new matrix
  72748. */
  72749. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72750. /**
  72751. * 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".
  72752. * This function works in right handed mode
  72753. * @param eye defines the final position of the entity
  72754. * @param target defines where the entity should look at
  72755. * @param up defines the up vector for the entity
  72756. * @param result defines the target matrix
  72757. */
  72758. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72759. /**
  72760. * Create a left-handed orthographic projection matrix
  72761. * @param width defines the viewport width
  72762. * @param height defines the viewport height
  72763. * @param znear defines the near clip plane
  72764. * @param zfar defines the far clip plane
  72765. * @returns a new matrix as a left-handed orthographic projection matrix
  72766. */
  72767. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72768. /**
  72769. * Store a left-handed orthographic projection to a given matrix
  72770. * @param width defines the viewport width
  72771. * @param height defines the viewport height
  72772. * @param znear defines the near clip plane
  72773. * @param zfar defines the far clip plane
  72774. * @param result defines the target matrix
  72775. */
  72776. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  72777. /**
  72778. * Create a left-handed orthographic projection matrix
  72779. * @param left defines the viewport left coordinate
  72780. * @param right defines the viewport right coordinate
  72781. * @param bottom defines the viewport bottom coordinate
  72782. * @param top defines the viewport top coordinate
  72783. * @param znear defines the near clip plane
  72784. * @param zfar defines the far clip plane
  72785. * @returns a new matrix as a left-handed orthographic projection matrix
  72786. */
  72787. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72788. /**
  72789. * Stores a left-handed orthographic projection into a given matrix
  72790. * @param left defines the viewport left coordinate
  72791. * @param right defines the viewport right coordinate
  72792. * @param bottom defines the viewport bottom coordinate
  72793. * @param top defines the viewport top coordinate
  72794. * @param znear defines the near clip plane
  72795. * @param zfar defines the far clip plane
  72796. * @param result defines the target matrix
  72797. */
  72798. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72799. /**
  72800. * Creates a right-handed orthographic projection matrix
  72801. * @param left defines the viewport left coordinate
  72802. * @param right defines the viewport right coordinate
  72803. * @param bottom defines the viewport bottom coordinate
  72804. * @param top defines the viewport top coordinate
  72805. * @param znear defines the near clip plane
  72806. * @param zfar defines the far clip plane
  72807. * @returns a new matrix as a right-handed orthographic projection matrix
  72808. */
  72809. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72810. /**
  72811. * Stores a right-handed orthographic projection into a given matrix
  72812. * @param left defines the viewport left coordinate
  72813. * @param right defines the viewport right coordinate
  72814. * @param bottom defines the viewport bottom coordinate
  72815. * @param top defines the viewport top coordinate
  72816. * @param znear defines the near clip plane
  72817. * @param zfar defines the far clip plane
  72818. * @param result defines the target matrix
  72819. */
  72820. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72821. /**
  72822. * Creates a left-handed perspective projection matrix
  72823. * @param width defines the viewport width
  72824. * @param height defines the viewport height
  72825. * @param znear defines the near clip plane
  72826. * @param zfar defines the far clip plane
  72827. * @returns a new matrix as a left-handed perspective projection matrix
  72828. */
  72829. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72830. /**
  72831. * Creates a left-handed perspective projection matrix
  72832. * @param fov defines the horizontal field of view
  72833. * @param aspect defines the aspect ratio
  72834. * @param znear defines the near clip plane
  72835. * @param zfar defines the far clip plane
  72836. * @returns a new matrix as a left-handed perspective projection matrix
  72837. */
  72838. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72839. /**
  72840. * Stores a left-handed perspective projection into a given matrix
  72841. * @param fov defines the horizontal field of view
  72842. * @param aspect defines the aspect ratio
  72843. * @param znear defines the near clip plane
  72844. * @param zfar defines the far clip plane
  72845. * @param result defines the target matrix
  72846. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72847. */
  72848. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72849. /**
  72850. * Stores a left-handed perspective projection into a given matrix with depth reversed
  72851. * @param fov defines the horizontal field of view
  72852. * @param aspect defines the aspect ratio
  72853. * @param znear defines the near clip plane
  72854. * @param zfar not used as infinity is used as far clip
  72855. * @param result defines the target matrix
  72856. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72857. */
  72858. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72859. /**
  72860. * Creates a right-handed perspective projection matrix
  72861. * @param fov defines the horizontal field of view
  72862. * @param aspect defines the aspect ratio
  72863. * @param znear defines the near clip plane
  72864. * @param zfar defines the far clip plane
  72865. * @returns a new matrix as a right-handed perspective projection matrix
  72866. */
  72867. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72868. /**
  72869. * Stores a right-handed perspective projection into a given matrix
  72870. * @param fov defines the horizontal field of view
  72871. * @param aspect defines the aspect ratio
  72872. * @param znear defines the near clip plane
  72873. * @param zfar defines the far clip plane
  72874. * @param result defines the target matrix
  72875. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72876. */
  72877. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72878. /**
  72879. * Stores a right-handed perspective projection into a given matrix
  72880. * @param fov defines the horizontal field of view
  72881. * @param aspect defines the aspect ratio
  72882. * @param znear defines the near clip plane
  72883. * @param zfar not used as infinity is used as far clip
  72884. * @param result defines the target matrix
  72885. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72886. */
  72887. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72888. /**
  72889. * Stores a perspective projection for WebVR info a given matrix
  72890. * @param fov defines the field of view
  72891. * @param znear defines the near clip plane
  72892. * @param zfar defines the far clip plane
  72893. * @param result defines the target matrix
  72894. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  72895. */
  72896. static PerspectiveFovWebVRToRef(fov: {
  72897. upDegrees: number;
  72898. downDegrees: number;
  72899. leftDegrees: number;
  72900. rightDegrees: number;
  72901. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  72902. /**
  72903. * Computes a complete transformation matrix
  72904. * @param viewport defines the viewport to use
  72905. * @param world defines the world matrix
  72906. * @param view defines the view matrix
  72907. * @param projection defines the projection matrix
  72908. * @param zmin defines the near clip plane
  72909. * @param zmax defines the far clip plane
  72910. * @returns the transformation matrix
  72911. */
  72912. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  72913. /**
  72914. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  72915. * @param matrix defines the matrix to use
  72916. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  72917. */
  72918. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  72919. /**
  72920. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  72921. * @param matrix defines the matrix to use
  72922. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  72923. */
  72924. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  72925. /**
  72926. * Compute the transpose of a given matrix
  72927. * @param matrix defines the matrix to transpose
  72928. * @returns the new matrix
  72929. */
  72930. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  72931. /**
  72932. * Compute the transpose of a matrix and store it in a target matrix
  72933. * @param matrix defines the matrix to transpose
  72934. * @param result defines the target matrix
  72935. */
  72936. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  72937. /**
  72938. * Computes a reflection matrix from a plane
  72939. * @param plane defines the reflection plane
  72940. * @returns a new matrix
  72941. */
  72942. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  72943. /**
  72944. * Computes a reflection matrix from a plane
  72945. * @param plane defines the reflection plane
  72946. * @param result defines the target matrix
  72947. */
  72948. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  72949. /**
  72950. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  72951. * @param xaxis defines the value of the 1st axis
  72952. * @param yaxis defines the value of the 2nd axis
  72953. * @param zaxis defines the value of the 3rd axis
  72954. * @param result defines the target matrix
  72955. */
  72956. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  72957. /**
  72958. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  72959. * @param quat defines the quaternion to use
  72960. * @param result defines the target matrix
  72961. */
  72962. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  72963. }
  72964. /**
  72965. * @hidden
  72966. */
  72967. export class TmpVectors {
  72968. static Vector2: Vector2[];
  72969. static Vector3: Vector3[];
  72970. static Vector4: Vector4[];
  72971. static Quaternion: Quaternion[];
  72972. static Matrix: Matrix[];
  72973. }
  72974. }
  72975. declare module BABYLON {
  72976. /**
  72977. * Defines potential orientation for back face culling
  72978. */
  72979. export enum Orientation {
  72980. /**
  72981. * Clockwise
  72982. */
  72983. CW = 0,
  72984. /** Counter clockwise */
  72985. CCW = 1
  72986. }
  72987. /** Class used to represent a Bezier curve */
  72988. export class BezierCurve {
  72989. /**
  72990. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  72991. * @param t defines the time
  72992. * @param x1 defines the left coordinate on X axis
  72993. * @param y1 defines the left coordinate on Y axis
  72994. * @param x2 defines the right coordinate on X axis
  72995. * @param y2 defines the right coordinate on Y axis
  72996. * @returns the interpolated value
  72997. */
  72998. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  72999. }
  73000. /**
  73001. * Defines angle representation
  73002. */
  73003. export class Angle {
  73004. private _radians;
  73005. /**
  73006. * Creates an Angle object of "radians" radians (float).
  73007. * @param radians the angle in radians
  73008. */
  73009. constructor(radians: number);
  73010. /**
  73011. * Get value in degrees
  73012. * @returns the Angle value in degrees (float)
  73013. */
  73014. degrees(): number;
  73015. /**
  73016. * Get value in radians
  73017. * @returns the Angle value in radians (float)
  73018. */
  73019. radians(): number;
  73020. /**
  73021. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  73022. * @param a defines first vector
  73023. * @param b defines second vector
  73024. * @returns a new Angle
  73025. */
  73026. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  73027. /**
  73028. * Gets a new Angle object from the given float in radians
  73029. * @param radians defines the angle value in radians
  73030. * @returns a new Angle
  73031. */
  73032. static FromRadians(radians: number): Angle;
  73033. /**
  73034. * Gets a new Angle object from the given float in degrees
  73035. * @param degrees defines the angle value in degrees
  73036. * @returns a new Angle
  73037. */
  73038. static FromDegrees(degrees: number): Angle;
  73039. }
  73040. /**
  73041. * This represents an arc in a 2d space.
  73042. */
  73043. export class Arc2 {
  73044. /** Defines the start point of the arc */
  73045. startPoint: Vector2;
  73046. /** Defines the mid point of the arc */
  73047. midPoint: Vector2;
  73048. /** Defines the end point of the arc */
  73049. endPoint: Vector2;
  73050. /**
  73051. * Defines the center point of the arc.
  73052. */
  73053. centerPoint: Vector2;
  73054. /**
  73055. * Defines the radius of the arc.
  73056. */
  73057. radius: number;
  73058. /**
  73059. * Defines the angle of the arc (from mid point to end point).
  73060. */
  73061. angle: Angle;
  73062. /**
  73063. * Defines the start angle of the arc (from start point to middle point).
  73064. */
  73065. startAngle: Angle;
  73066. /**
  73067. * Defines the orientation of the arc (clock wise/counter clock wise).
  73068. */
  73069. orientation: Orientation;
  73070. /**
  73071. * Creates an Arc object from the three given points : start, middle and end.
  73072. * @param startPoint Defines the start point of the arc
  73073. * @param midPoint Defines the midlle point of the arc
  73074. * @param endPoint Defines the end point of the arc
  73075. */
  73076. constructor(
  73077. /** Defines the start point of the arc */
  73078. startPoint: Vector2,
  73079. /** Defines the mid point of the arc */
  73080. midPoint: Vector2,
  73081. /** Defines the end point of the arc */
  73082. endPoint: Vector2);
  73083. }
  73084. /**
  73085. * Represents a 2D path made up of multiple 2D points
  73086. */
  73087. export class Path2 {
  73088. private _points;
  73089. private _length;
  73090. /**
  73091. * If the path start and end point are the same
  73092. */
  73093. closed: boolean;
  73094. /**
  73095. * Creates a Path2 object from the starting 2D coordinates x and y.
  73096. * @param x the starting points x value
  73097. * @param y the starting points y value
  73098. */
  73099. constructor(x: number, y: number);
  73100. /**
  73101. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  73102. * @param x the added points x value
  73103. * @param y the added points y value
  73104. * @returns the updated Path2.
  73105. */
  73106. addLineTo(x: number, y: number): Path2;
  73107. /**
  73108. * 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.
  73109. * @param midX middle point x value
  73110. * @param midY middle point y value
  73111. * @param endX end point x value
  73112. * @param endY end point y value
  73113. * @param numberOfSegments (default: 36)
  73114. * @returns the updated Path2.
  73115. */
  73116. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  73117. /**
  73118. * Closes the Path2.
  73119. * @returns the Path2.
  73120. */
  73121. close(): Path2;
  73122. /**
  73123. * Gets the sum of the distance between each sequential point in the path
  73124. * @returns the Path2 total length (float).
  73125. */
  73126. length(): number;
  73127. /**
  73128. * Gets the points which construct the path
  73129. * @returns the Path2 internal array of points.
  73130. */
  73131. getPoints(): Vector2[];
  73132. /**
  73133. * Retreives the point at the distance aways from the starting point
  73134. * @param normalizedLengthPosition the length along the path to retreive the point from
  73135. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  73136. */
  73137. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  73138. /**
  73139. * Creates a new path starting from an x and y position
  73140. * @param x starting x value
  73141. * @param y starting y value
  73142. * @returns a new Path2 starting at the coordinates (x, y).
  73143. */
  73144. static StartingAt(x: number, y: number): Path2;
  73145. }
  73146. /**
  73147. * Represents a 3D path made up of multiple 3D points
  73148. */
  73149. export class Path3D {
  73150. /**
  73151. * an array of Vector3, the curve axis of the Path3D
  73152. */
  73153. path: Vector3[];
  73154. private _curve;
  73155. private _distances;
  73156. private _tangents;
  73157. private _normals;
  73158. private _binormals;
  73159. private _raw;
  73160. private _alignTangentsWithPath;
  73161. private readonly _pointAtData;
  73162. /**
  73163. * new Path3D(path, normal, raw)
  73164. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  73165. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  73166. * @param path an array of Vector3, the curve axis of the Path3D
  73167. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  73168. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  73169. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  73170. */
  73171. constructor(
  73172. /**
  73173. * an array of Vector3, the curve axis of the Path3D
  73174. */
  73175. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  73176. /**
  73177. * Returns the Path3D array of successive Vector3 designing its curve.
  73178. * @returns the Path3D array of successive Vector3 designing its curve.
  73179. */
  73180. getCurve(): Vector3[];
  73181. /**
  73182. * Returns the Path3D array of successive Vector3 designing its curve.
  73183. * @returns the Path3D array of successive Vector3 designing its curve.
  73184. */
  73185. getPoints(): Vector3[];
  73186. /**
  73187. * @returns the computed length (float) of the path.
  73188. */
  73189. length(): number;
  73190. /**
  73191. * Returns an array populated with tangent vectors on each Path3D curve point.
  73192. * @returns an array populated with tangent vectors on each Path3D curve point.
  73193. */
  73194. getTangents(): Vector3[];
  73195. /**
  73196. * Returns an array populated with normal vectors on each Path3D curve point.
  73197. * @returns an array populated with normal vectors on each Path3D curve point.
  73198. */
  73199. getNormals(): Vector3[];
  73200. /**
  73201. * Returns an array populated with binormal vectors on each Path3D curve point.
  73202. * @returns an array populated with binormal vectors on each Path3D curve point.
  73203. */
  73204. getBinormals(): Vector3[];
  73205. /**
  73206. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  73207. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  73208. */
  73209. getDistances(): number[];
  73210. /**
  73211. * Returns an interpolated point along this path
  73212. * @param position the position of the point along this path, from 0.0 to 1.0
  73213. * @returns a new Vector3 as the point
  73214. */
  73215. getPointAt(position: number): Vector3;
  73216. /**
  73217. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  73218. * @param position the position of the point along this path, from 0.0 to 1.0
  73219. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  73220. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  73221. */
  73222. getTangentAt(position: number, interpolated?: boolean): Vector3;
  73223. /**
  73224. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  73225. * @param position the position of the point along this path, from 0.0 to 1.0
  73226. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  73227. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  73228. */
  73229. getNormalAt(position: number, interpolated?: boolean): Vector3;
  73230. /**
  73231. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  73232. * @param position the position of the point along this path, from 0.0 to 1.0
  73233. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  73234. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  73235. */
  73236. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  73237. /**
  73238. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  73239. * @param position the position of the point along this path, from 0.0 to 1.0
  73240. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  73241. */
  73242. getDistanceAt(position: number): number;
  73243. /**
  73244. * Returns the array index of the previous point of an interpolated point along this path
  73245. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  73246. * @returns the array index
  73247. */
  73248. getPreviousPointIndexAt(position: number): number;
  73249. /**
  73250. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  73251. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  73252. * @returns the sub position
  73253. */
  73254. getSubPositionAt(position: number): number;
  73255. /**
  73256. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  73257. * @param target the vector of which to get the closest position to
  73258. * @returns the position of the closest virtual point on this path to the target vector
  73259. */
  73260. getClosestPositionTo(target: Vector3): number;
  73261. /**
  73262. * Returns a sub path (slice) of this path
  73263. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  73264. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  73265. * @returns a sub path (slice) of this path
  73266. */
  73267. slice(start?: number, end?: number): Path3D;
  73268. /**
  73269. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  73270. * @param path path which all values are copied into the curves points
  73271. * @param firstNormal which should be projected onto the curve
  73272. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  73273. * @returns the same object updated.
  73274. */
  73275. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  73276. private _compute;
  73277. private _getFirstNonNullVector;
  73278. private _getLastNonNullVector;
  73279. private _normalVector;
  73280. /**
  73281. * Updates the point at data for an interpolated point along this curve
  73282. * @param position the position of the point along this curve, from 0.0 to 1.0
  73283. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  73284. * @returns the (updated) point at data
  73285. */
  73286. private _updatePointAtData;
  73287. /**
  73288. * Updates the point at data from the specified parameters
  73289. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  73290. * @param point the interpolated point
  73291. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  73292. */
  73293. private _setPointAtData;
  73294. /**
  73295. * Updates the point at interpolation matrix for the tangents, normals and binormals
  73296. */
  73297. private _updateInterpolationMatrix;
  73298. }
  73299. /**
  73300. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  73301. * A Curve3 is designed from a series of successive Vector3.
  73302. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  73303. */
  73304. export class Curve3 {
  73305. private _points;
  73306. private _length;
  73307. /**
  73308. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  73309. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  73310. * @param v1 (Vector3) the control point
  73311. * @param v2 (Vector3) the end point of the Quadratic Bezier
  73312. * @param nbPoints (integer) the wanted number of points in the curve
  73313. * @returns the created Curve3
  73314. */
  73315. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  73316. /**
  73317. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  73318. * @param v0 (Vector3) the origin point of the Cubic Bezier
  73319. * @param v1 (Vector3) the first control point
  73320. * @param v2 (Vector3) the second control point
  73321. * @param v3 (Vector3) the end point of the Cubic Bezier
  73322. * @param nbPoints (integer) the wanted number of points in the curve
  73323. * @returns the created Curve3
  73324. */
  73325. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  73326. /**
  73327. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  73328. * @param p1 (Vector3) the origin point of the Hermite Spline
  73329. * @param t1 (Vector3) the tangent vector at the origin point
  73330. * @param p2 (Vector3) the end point of the Hermite Spline
  73331. * @param t2 (Vector3) the tangent vector at the end point
  73332. * @param nbPoints (integer) the wanted number of points in the curve
  73333. * @returns the created Curve3
  73334. */
  73335. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  73336. /**
  73337. * Returns a Curve3 object along a CatmullRom Spline curve :
  73338. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  73339. * @param nbPoints (integer) the wanted number of points between each curve control points
  73340. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  73341. * @returns the created Curve3
  73342. */
  73343. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  73344. /**
  73345. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  73346. * A Curve3 is designed from a series of successive Vector3.
  73347. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  73348. * @param points points which make up the curve
  73349. */
  73350. constructor(points: Vector3[]);
  73351. /**
  73352. * @returns the Curve3 stored array of successive Vector3
  73353. */
  73354. getPoints(): Vector3[];
  73355. /**
  73356. * @returns the computed length (float) of the curve.
  73357. */
  73358. length(): number;
  73359. /**
  73360. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  73361. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  73362. * curveA and curveB keep unchanged.
  73363. * @param curve the curve to continue from this curve
  73364. * @returns the newly constructed curve
  73365. */
  73366. continue(curve: DeepImmutable<Curve3>): Curve3;
  73367. private _computeLength;
  73368. }
  73369. }
  73370. declare module BABYLON {
  73371. /**
  73372. * This represents the main contract an easing function should follow.
  73373. * Easing functions are used throughout the animation system.
  73374. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73375. */
  73376. export interface IEasingFunction {
  73377. /**
  73378. * Given an input gradient between 0 and 1, this returns the corrseponding value
  73379. * of the easing function.
  73380. * The link below provides some of the most common examples of easing functions.
  73381. * @see https://easings.net/
  73382. * @param gradient Defines the value between 0 and 1 we want the easing value for
  73383. * @returns the corresponding value on the curve defined by the easing function
  73384. */
  73385. ease(gradient: number): number;
  73386. }
  73387. /**
  73388. * Base class used for every default easing function.
  73389. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73390. */
  73391. export class EasingFunction implements IEasingFunction {
  73392. /**
  73393. * Interpolation follows the mathematical formula associated with the easing function.
  73394. */
  73395. static readonly EASINGMODE_EASEIN: number;
  73396. /**
  73397. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  73398. */
  73399. static readonly EASINGMODE_EASEOUT: number;
  73400. /**
  73401. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  73402. */
  73403. static readonly EASINGMODE_EASEINOUT: number;
  73404. private _easingMode;
  73405. /**
  73406. * Sets the easing mode of the current function.
  73407. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  73408. */
  73409. setEasingMode(easingMode: number): void;
  73410. /**
  73411. * Gets the current easing mode.
  73412. * @returns the easing mode
  73413. */
  73414. getEasingMode(): number;
  73415. /**
  73416. * @hidden
  73417. */
  73418. easeInCore(gradient: number): number;
  73419. /**
  73420. * Given an input gradient between 0 and 1, this returns the corresponding value
  73421. * of the easing function.
  73422. * @param gradient Defines the value between 0 and 1 we want the easing value for
  73423. * @returns the corresponding value on the curve defined by the easing function
  73424. */
  73425. ease(gradient: number): number;
  73426. }
  73427. /**
  73428. * Easing function with a circle shape (see link below).
  73429. * @see https://easings.net/#easeInCirc
  73430. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73431. */
  73432. export class CircleEase extends EasingFunction implements IEasingFunction {
  73433. /** @hidden */
  73434. easeInCore(gradient: number): number;
  73435. }
  73436. /**
  73437. * Easing function with a ease back shape (see link below).
  73438. * @see https://easings.net/#easeInBack
  73439. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73440. */
  73441. export class BackEase extends EasingFunction implements IEasingFunction {
  73442. /** Defines the amplitude of the function */
  73443. amplitude: number;
  73444. /**
  73445. * Instantiates a back ease easing
  73446. * @see https://easings.net/#easeInBack
  73447. * @param amplitude Defines the amplitude of the function
  73448. */
  73449. constructor(
  73450. /** Defines the amplitude of the function */
  73451. amplitude?: number);
  73452. /** @hidden */
  73453. easeInCore(gradient: number): number;
  73454. }
  73455. /**
  73456. * Easing function with a bouncing shape (see link below).
  73457. * @see https://easings.net/#easeInBounce
  73458. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73459. */
  73460. export class BounceEase extends EasingFunction implements IEasingFunction {
  73461. /** Defines the number of bounces */
  73462. bounces: number;
  73463. /** Defines the amplitude of the bounce */
  73464. bounciness: number;
  73465. /**
  73466. * Instantiates a bounce easing
  73467. * @see https://easings.net/#easeInBounce
  73468. * @param bounces Defines the number of bounces
  73469. * @param bounciness Defines the amplitude of the bounce
  73470. */
  73471. constructor(
  73472. /** Defines the number of bounces */
  73473. bounces?: number,
  73474. /** Defines the amplitude of the bounce */
  73475. bounciness?: number);
  73476. /** @hidden */
  73477. easeInCore(gradient: number): number;
  73478. }
  73479. /**
  73480. * Easing function with a power of 3 shape (see link below).
  73481. * @see https://easings.net/#easeInCubic
  73482. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73483. */
  73484. export class CubicEase extends EasingFunction implements IEasingFunction {
  73485. /** @hidden */
  73486. easeInCore(gradient: number): number;
  73487. }
  73488. /**
  73489. * Easing function with an elastic shape (see link below).
  73490. * @see https://easings.net/#easeInElastic
  73491. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73492. */
  73493. export class ElasticEase extends EasingFunction implements IEasingFunction {
  73494. /** Defines the number of oscillations*/
  73495. oscillations: number;
  73496. /** Defines the amplitude of the oscillations*/
  73497. springiness: number;
  73498. /**
  73499. * Instantiates an elastic easing function
  73500. * @see https://easings.net/#easeInElastic
  73501. * @param oscillations Defines the number of oscillations
  73502. * @param springiness Defines the amplitude of the oscillations
  73503. */
  73504. constructor(
  73505. /** Defines the number of oscillations*/
  73506. oscillations?: number,
  73507. /** Defines the amplitude of the oscillations*/
  73508. springiness?: number);
  73509. /** @hidden */
  73510. easeInCore(gradient: number): number;
  73511. }
  73512. /**
  73513. * Easing function with an exponential shape (see link below).
  73514. * @see https://easings.net/#easeInExpo
  73515. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73516. */
  73517. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  73518. /** Defines the exponent of the function */
  73519. exponent: number;
  73520. /**
  73521. * Instantiates an exponential easing function
  73522. * @see https://easings.net/#easeInExpo
  73523. * @param exponent Defines the exponent of the function
  73524. */
  73525. constructor(
  73526. /** Defines the exponent of the function */
  73527. exponent?: number);
  73528. /** @hidden */
  73529. easeInCore(gradient: number): number;
  73530. }
  73531. /**
  73532. * Easing function with a power shape (see link below).
  73533. * @see https://easings.net/#easeInQuad
  73534. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73535. */
  73536. export class PowerEase extends EasingFunction implements IEasingFunction {
  73537. /** Defines the power of the function */
  73538. power: number;
  73539. /**
  73540. * Instantiates an power base easing function
  73541. * @see https://easings.net/#easeInQuad
  73542. * @param power Defines the power of the function
  73543. */
  73544. constructor(
  73545. /** Defines the power of the function */
  73546. power?: number);
  73547. /** @hidden */
  73548. easeInCore(gradient: number): number;
  73549. }
  73550. /**
  73551. * Easing function with a power of 2 shape (see link below).
  73552. * @see https://easings.net/#easeInQuad
  73553. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73554. */
  73555. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  73556. /** @hidden */
  73557. easeInCore(gradient: number): number;
  73558. }
  73559. /**
  73560. * Easing function with a power of 4 shape (see link below).
  73561. * @see https://easings.net/#easeInQuart
  73562. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73563. */
  73564. export class QuarticEase extends EasingFunction implements IEasingFunction {
  73565. /** @hidden */
  73566. easeInCore(gradient: number): number;
  73567. }
  73568. /**
  73569. * Easing function with a power of 5 shape (see link below).
  73570. * @see https://easings.net/#easeInQuint
  73571. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73572. */
  73573. export class QuinticEase extends EasingFunction implements IEasingFunction {
  73574. /** @hidden */
  73575. easeInCore(gradient: number): number;
  73576. }
  73577. /**
  73578. * Easing function with a sin shape (see link below).
  73579. * @see https://easings.net/#easeInSine
  73580. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73581. */
  73582. export class SineEase extends EasingFunction implements IEasingFunction {
  73583. /** @hidden */
  73584. easeInCore(gradient: number): number;
  73585. }
  73586. /**
  73587. * Easing function with a bezier shape (see link below).
  73588. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  73589. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73590. */
  73591. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  73592. /** Defines the x component of the start tangent in the bezier curve */
  73593. x1: number;
  73594. /** Defines the y component of the start tangent in the bezier curve */
  73595. y1: number;
  73596. /** Defines the x component of the end tangent in the bezier curve */
  73597. x2: number;
  73598. /** Defines the y component of the end tangent in the bezier curve */
  73599. y2: number;
  73600. /**
  73601. * Instantiates a bezier function
  73602. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  73603. * @param x1 Defines the x component of the start tangent in the bezier curve
  73604. * @param y1 Defines the y component of the start tangent in the bezier curve
  73605. * @param x2 Defines the x component of the end tangent in the bezier curve
  73606. * @param y2 Defines the y component of the end tangent in the bezier curve
  73607. */
  73608. constructor(
  73609. /** Defines the x component of the start tangent in the bezier curve */
  73610. x1?: number,
  73611. /** Defines the y component of the start tangent in the bezier curve */
  73612. y1?: number,
  73613. /** Defines the x component of the end tangent in the bezier curve */
  73614. x2?: number,
  73615. /** Defines the y component of the end tangent in the bezier curve */
  73616. y2?: number);
  73617. /** @hidden */
  73618. easeInCore(gradient: number): number;
  73619. }
  73620. }
  73621. declare module BABYLON {
  73622. /**
  73623. * Class used to hold a RBG color
  73624. */
  73625. export class Color3 {
  73626. /**
  73627. * Defines the red component (between 0 and 1, default is 0)
  73628. */
  73629. r: number;
  73630. /**
  73631. * Defines the green component (between 0 and 1, default is 0)
  73632. */
  73633. g: number;
  73634. /**
  73635. * Defines the blue component (between 0 and 1, default is 0)
  73636. */
  73637. b: number;
  73638. /**
  73639. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  73640. * @param r defines the red component (between 0 and 1, default is 0)
  73641. * @param g defines the green component (between 0 and 1, default is 0)
  73642. * @param b defines the blue component (between 0 and 1, default is 0)
  73643. */
  73644. constructor(
  73645. /**
  73646. * Defines the red component (between 0 and 1, default is 0)
  73647. */
  73648. r?: number,
  73649. /**
  73650. * Defines the green component (between 0 and 1, default is 0)
  73651. */
  73652. g?: number,
  73653. /**
  73654. * Defines the blue component (between 0 and 1, default is 0)
  73655. */
  73656. b?: number);
  73657. /**
  73658. * Creates a string with the Color3 current values
  73659. * @returns the string representation of the Color3 object
  73660. */
  73661. toString(): string;
  73662. /**
  73663. * Returns the string "Color3"
  73664. * @returns "Color3"
  73665. */
  73666. getClassName(): string;
  73667. /**
  73668. * Compute the Color3 hash code
  73669. * @returns an unique number that can be used to hash Color3 objects
  73670. */
  73671. getHashCode(): number;
  73672. /**
  73673. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  73674. * @param array defines the array where to store the r,g,b components
  73675. * @param index defines an optional index in the target array to define where to start storing values
  73676. * @returns the current Color3 object
  73677. */
  73678. toArray(array: FloatArray, index?: number): Color3;
  73679. /**
  73680. * Returns a new Color4 object from the current Color3 and the given alpha
  73681. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  73682. * @returns a new Color4 object
  73683. */
  73684. toColor4(alpha?: number): Color4;
  73685. /**
  73686. * Returns a new array populated with 3 numeric elements : red, green and blue values
  73687. * @returns the new array
  73688. */
  73689. asArray(): number[];
  73690. /**
  73691. * Returns the luminance value
  73692. * @returns a float value
  73693. */
  73694. toLuminance(): number;
  73695. /**
  73696. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  73697. * @param otherColor defines the second operand
  73698. * @returns the new Color3 object
  73699. */
  73700. multiply(otherColor: DeepImmutable<Color3>): Color3;
  73701. /**
  73702. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  73703. * @param otherColor defines the second operand
  73704. * @param result defines the Color3 object where to store the result
  73705. * @returns the current Color3
  73706. */
  73707. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73708. /**
  73709. * Determines equality between Color3 objects
  73710. * @param otherColor defines the second operand
  73711. * @returns true if the rgb values are equal to the given ones
  73712. */
  73713. equals(otherColor: DeepImmutable<Color3>): boolean;
  73714. /**
  73715. * Determines equality between the current Color3 object and a set of r,b,g values
  73716. * @param r defines the red component to check
  73717. * @param g defines the green component to check
  73718. * @param b defines the blue component to check
  73719. * @returns true if the rgb values are equal to the given ones
  73720. */
  73721. equalsFloats(r: number, g: number, b: number): boolean;
  73722. /**
  73723. * Multiplies in place each rgb value by scale
  73724. * @param scale defines the scaling factor
  73725. * @returns the updated Color3
  73726. */
  73727. scale(scale: number): Color3;
  73728. /**
  73729. * Multiplies the rgb values by scale and stores the result into "result"
  73730. * @param scale defines the scaling factor
  73731. * @param result defines the Color3 object where to store the result
  73732. * @returns the unmodified current Color3
  73733. */
  73734. scaleToRef(scale: number, result: Color3): Color3;
  73735. /**
  73736. * Scale the current Color3 values by a factor and add the result to a given Color3
  73737. * @param scale defines the scale factor
  73738. * @param result defines color to store the result into
  73739. * @returns the unmodified current Color3
  73740. */
  73741. scaleAndAddToRef(scale: number, result: Color3): Color3;
  73742. /**
  73743. * Clamps the rgb values by the min and max values and stores the result into "result"
  73744. * @param min defines minimum clamping value (default is 0)
  73745. * @param max defines maximum clamping value (default is 1)
  73746. * @param result defines color to store the result into
  73747. * @returns the original Color3
  73748. */
  73749. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  73750. /**
  73751. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  73752. * @param otherColor defines the second operand
  73753. * @returns the new Color3
  73754. */
  73755. add(otherColor: DeepImmutable<Color3>): Color3;
  73756. /**
  73757. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  73758. * @param otherColor defines the second operand
  73759. * @param result defines Color3 object to store the result into
  73760. * @returns the unmodified current Color3
  73761. */
  73762. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73763. /**
  73764. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  73765. * @param otherColor defines the second operand
  73766. * @returns the new Color3
  73767. */
  73768. subtract(otherColor: DeepImmutable<Color3>): Color3;
  73769. /**
  73770. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  73771. * @param otherColor defines the second operand
  73772. * @param result defines Color3 object to store the result into
  73773. * @returns the unmodified current Color3
  73774. */
  73775. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73776. /**
  73777. * Copy the current object
  73778. * @returns a new Color3 copied the current one
  73779. */
  73780. clone(): Color3;
  73781. /**
  73782. * Copies the rgb values from the source in the current Color3
  73783. * @param source defines the source Color3 object
  73784. * @returns the updated Color3 object
  73785. */
  73786. copyFrom(source: DeepImmutable<Color3>): Color3;
  73787. /**
  73788. * Updates the Color3 rgb values from the given floats
  73789. * @param r defines the red component to read from
  73790. * @param g defines the green component to read from
  73791. * @param b defines the blue component to read from
  73792. * @returns the current Color3 object
  73793. */
  73794. copyFromFloats(r: number, g: number, b: number): Color3;
  73795. /**
  73796. * Updates the Color3 rgb values from the given floats
  73797. * @param r defines the red component to read from
  73798. * @param g defines the green component to read from
  73799. * @param b defines the blue component to read from
  73800. * @returns the current Color3 object
  73801. */
  73802. set(r: number, g: number, b: number): Color3;
  73803. /**
  73804. * Compute the Color3 hexadecimal code as a string
  73805. * @returns a string containing the hexadecimal representation of the Color3 object
  73806. */
  73807. toHexString(): string;
  73808. /**
  73809. * Computes a new Color3 converted from the current one to linear space
  73810. * @returns a new Color3 object
  73811. */
  73812. toLinearSpace(): Color3;
  73813. /**
  73814. * Converts current color in rgb space to HSV values
  73815. * @returns a new color3 representing the HSV values
  73816. */
  73817. toHSV(): Color3;
  73818. /**
  73819. * Converts current color in rgb space to HSV values
  73820. * @param result defines the Color3 where to store the HSV values
  73821. */
  73822. toHSVToRef(result: Color3): void;
  73823. /**
  73824. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  73825. * @param convertedColor defines the Color3 object where to store the linear space version
  73826. * @returns the unmodified Color3
  73827. */
  73828. toLinearSpaceToRef(convertedColor: Color3): Color3;
  73829. /**
  73830. * Computes a new Color3 converted from the current one to gamma space
  73831. * @returns a new Color3 object
  73832. */
  73833. toGammaSpace(): Color3;
  73834. /**
  73835. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  73836. * @param convertedColor defines the Color3 object where to store the gamma space version
  73837. * @returns the unmodified Color3
  73838. */
  73839. toGammaSpaceToRef(convertedColor: Color3): Color3;
  73840. private static _BlackReadOnly;
  73841. /**
  73842. * Convert Hue, saturation and value to a Color3 (RGB)
  73843. * @param hue defines the hue
  73844. * @param saturation defines the saturation
  73845. * @param value defines the value
  73846. * @param result defines the Color3 where to store the RGB values
  73847. */
  73848. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  73849. /**
  73850. * Creates a new Color3 from the string containing valid hexadecimal values
  73851. * @param hex defines a string containing valid hexadecimal values
  73852. * @returns a new Color3 object
  73853. */
  73854. static FromHexString(hex: string): Color3;
  73855. /**
  73856. * Creates a new Color3 from the starting index of the given array
  73857. * @param array defines the source array
  73858. * @param offset defines an offset in the source array
  73859. * @returns a new Color3 object
  73860. */
  73861. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  73862. /**
  73863. * Creates a new Color3 from integer values (< 256)
  73864. * @param r defines the red component to read from (value between 0 and 255)
  73865. * @param g defines the green component to read from (value between 0 and 255)
  73866. * @param b defines the blue component to read from (value between 0 and 255)
  73867. * @returns a new Color3 object
  73868. */
  73869. static FromInts(r: number, g: number, b: number): Color3;
  73870. /**
  73871. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73872. * @param start defines the start Color3 value
  73873. * @param end defines the end Color3 value
  73874. * @param amount defines the gradient value between start and end
  73875. * @returns a new Color3 object
  73876. */
  73877. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  73878. /**
  73879. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73880. * @param left defines the start value
  73881. * @param right defines the end value
  73882. * @param amount defines the gradient factor
  73883. * @param result defines the Color3 object where to store the result
  73884. */
  73885. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  73886. /**
  73887. * Returns a Color3 value containing a red color
  73888. * @returns a new Color3 object
  73889. */
  73890. static Red(): Color3;
  73891. /**
  73892. * Returns a Color3 value containing a green color
  73893. * @returns a new Color3 object
  73894. */
  73895. static Green(): Color3;
  73896. /**
  73897. * Returns a Color3 value containing a blue color
  73898. * @returns a new Color3 object
  73899. */
  73900. static Blue(): Color3;
  73901. /**
  73902. * Returns a Color3 value containing a black color
  73903. * @returns a new Color3 object
  73904. */
  73905. static Black(): Color3;
  73906. /**
  73907. * Gets a Color3 value containing a black color that must not be updated
  73908. */
  73909. static readonly BlackReadOnly: DeepImmutable<Color3>;
  73910. /**
  73911. * Returns a Color3 value containing a white color
  73912. * @returns a new Color3 object
  73913. */
  73914. static White(): Color3;
  73915. /**
  73916. * Returns a Color3 value containing a purple color
  73917. * @returns a new Color3 object
  73918. */
  73919. static Purple(): Color3;
  73920. /**
  73921. * Returns a Color3 value containing a magenta color
  73922. * @returns a new Color3 object
  73923. */
  73924. static Magenta(): Color3;
  73925. /**
  73926. * Returns a Color3 value containing a yellow color
  73927. * @returns a new Color3 object
  73928. */
  73929. static Yellow(): Color3;
  73930. /**
  73931. * Returns a Color3 value containing a gray color
  73932. * @returns a new Color3 object
  73933. */
  73934. static Gray(): Color3;
  73935. /**
  73936. * Returns a Color3 value containing a teal color
  73937. * @returns a new Color3 object
  73938. */
  73939. static Teal(): Color3;
  73940. /**
  73941. * Returns a Color3 value containing a random color
  73942. * @returns a new Color3 object
  73943. */
  73944. static Random(): Color3;
  73945. }
  73946. /**
  73947. * Class used to hold a RBGA color
  73948. */
  73949. export class Color4 {
  73950. /**
  73951. * Defines the red component (between 0 and 1, default is 0)
  73952. */
  73953. r: number;
  73954. /**
  73955. * Defines the green component (between 0 and 1, default is 0)
  73956. */
  73957. g: number;
  73958. /**
  73959. * Defines the blue component (between 0 and 1, default is 0)
  73960. */
  73961. b: number;
  73962. /**
  73963. * Defines the alpha component (between 0 and 1, default is 1)
  73964. */
  73965. a: number;
  73966. /**
  73967. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  73968. * @param r defines the red component (between 0 and 1, default is 0)
  73969. * @param g defines the green component (between 0 and 1, default is 0)
  73970. * @param b defines the blue component (between 0 and 1, default is 0)
  73971. * @param a defines the alpha component (between 0 and 1, default is 1)
  73972. */
  73973. constructor(
  73974. /**
  73975. * Defines the red component (between 0 and 1, default is 0)
  73976. */
  73977. r?: number,
  73978. /**
  73979. * Defines the green component (between 0 and 1, default is 0)
  73980. */
  73981. g?: number,
  73982. /**
  73983. * Defines the blue component (between 0 and 1, default is 0)
  73984. */
  73985. b?: number,
  73986. /**
  73987. * Defines the alpha component (between 0 and 1, default is 1)
  73988. */
  73989. a?: number);
  73990. /**
  73991. * Adds in place the given Color4 values to the current Color4 object
  73992. * @param right defines the second operand
  73993. * @returns the current updated Color4 object
  73994. */
  73995. addInPlace(right: DeepImmutable<Color4>): Color4;
  73996. /**
  73997. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  73998. * @returns the new array
  73999. */
  74000. asArray(): number[];
  74001. /**
  74002. * Stores from the starting index in the given array the Color4 successive values
  74003. * @param array defines the array where to store the r,g,b components
  74004. * @param index defines an optional index in the target array to define where to start storing values
  74005. * @returns the current Color4 object
  74006. */
  74007. toArray(array: number[], index?: number): Color4;
  74008. /**
  74009. * Determines equality between Color4 objects
  74010. * @param otherColor defines the second operand
  74011. * @returns true if the rgba values are equal to the given ones
  74012. */
  74013. equals(otherColor: DeepImmutable<Color4>): boolean;
  74014. /**
  74015. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  74016. * @param right defines the second operand
  74017. * @returns a new Color4 object
  74018. */
  74019. add(right: DeepImmutable<Color4>): Color4;
  74020. /**
  74021. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  74022. * @param right defines the second operand
  74023. * @returns a new Color4 object
  74024. */
  74025. subtract(right: DeepImmutable<Color4>): Color4;
  74026. /**
  74027. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  74028. * @param right defines the second operand
  74029. * @param result defines the Color4 object where to store the result
  74030. * @returns the current Color4 object
  74031. */
  74032. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  74033. /**
  74034. * Creates a new Color4 with the current Color4 values multiplied by scale
  74035. * @param scale defines the scaling factor to apply
  74036. * @returns a new Color4 object
  74037. */
  74038. scale(scale: number): Color4;
  74039. /**
  74040. * Multiplies the current Color4 values by scale and stores the result in "result"
  74041. * @param scale defines the scaling factor to apply
  74042. * @param result defines the Color4 object where to store the result
  74043. * @returns the current unmodified Color4
  74044. */
  74045. scaleToRef(scale: number, result: Color4): Color4;
  74046. /**
  74047. * Scale the current Color4 values by a factor and add the result to a given Color4
  74048. * @param scale defines the scale factor
  74049. * @param result defines the Color4 object where to store the result
  74050. * @returns the unmodified current Color4
  74051. */
  74052. scaleAndAddToRef(scale: number, result: Color4): Color4;
  74053. /**
  74054. * Clamps the rgb values by the min and max values and stores the result into "result"
  74055. * @param min defines minimum clamping value (default is 0)
  74056. * @param max defines maximum clamping value (default is 1)
  74057. * @param result defines color to store the result into.
  74058. * @returns the cuurent Color4
  74059. */
  74060. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  74061. /**
  74062. * Multipy an Color4 value by another and return a new Color4 object
  74063. * @param color defines the Color4 value to multiply by
  74064. * @returns a new Color4 object
  74065. */
  74066. multiply(color: Color4): Color4;
  74067. /**
  74068. * Multipy a Color4 value by another and push the result in a reference value
  74069. * @param color defines the Color4 value to multiply by
  74070. * @param result defines the Color4 to fill the result in
  74071. * @returns the result Color4
  74072. */
  74073. multiplyToRef(color: Color4, result: Color4): Color4;
  74074. /**
  74075. * Creates a string with the Color4 current values
  74076. * @returns the string representation of the Color4 object
  74077. */
  74078. toString(): string;
  74079. /**
  74080. * Returns the string "Color4"
  74081. * @returns "Color4"
  74082. */
  74083. getClassName(): string;
  74084. /**
  74085. * Compute the Color4 hash code
  74086. * @returns an unique number that can be used to hash Color4 objects
  74087. */
  74088. getHashCode(): number;
  74089. /**
  74090. * Creates a new Color4 copied from the current one
  74091. * @returns a new Color4 object
  74092. */
  74093. clone(): Color4;
  74094. /**
  74095. * Copies the given Color4 values into the current one
  74096. * @param source defines the source Color4 object
  74097. * @returns the current updated Color4 object
  74098. */
  74099. copyFrom(source: Color4): Color4;
  74100. /**
  74101. * Copies the given float values into the current one
  74102. * @param r defines the red component to read from
  74103. * @param g defines the green component to read from
  74104. * @param b defines the blue component to read from
  74105. * @param a defines the alpha component to read from
  74106. * @returns the current updated Color4 object
  74107. */
  74108. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  74109. /**
  74110. * Copies the given float values into the current one
  74111. * @param r defines the red component to read from
  74112. * @param g defines the green component to read from
  74113. * @param b defines the blue component to read from
  74114. * @param a defines the alpha component to read from
  74115. * @returns the current updated Color4 object
  74116. */
  74117. set(r: number, g: number, b: number, a: number): Color4;
  74118. /**
  74119. * Compute the Color4 hexadecimal code as a string
  74120. * @returns a string containing the hexadecimal representation of the Color4 object
  74121. */
  74122. toHexString(): string;
  74123. /**
  74124. * Computes a new Color4 converted from the current one to linear space
  74125. * @returns a new Color4 object
  74126. */
  74127. toLinearSpace(): Color4;
  74128. /**
  74129. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  74130. * @param convertedColor defines the Color4 object where to store the linear space version
  74131. * @returns the unmodified Color4
  74132. */
  74133. toLinearSpaceToRef(convertedColor: Color4): Color4;
  74134. /**
  74135. * Computes a new Color4 converted from the current one to gamma space
  74136. * @returns a new Color4 object
  74137. */
  74138. toGammaSpace(): Color4;
  74139. /**
  74140. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  74141. * @param convertedColor defines the Color4 object where to store the gamma space version
  74142. * @returns the unmodified Color4
  74143. */
  74144. toGammaSpaceToRef(convertedColor: Color4): Color4;
  74145. /**
  74146. * Creates a new Color4 from the string containing valid hexadecimal values
  74147. * @param hex defines a string containing valid hexadecimal values
  74148. * @returns a new Color4 object
  74149. */
  74150. static FromHexString(hex: string): Color4;
  74151. /**
  74152. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  74153. * @param left defines the start value
  74154. * @param right defines the end value
  74155. * @param amount defines the gradient factor
  74156. * @returns a new Color4 object
  74157. */
  74158. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  74159. /**
  74160. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  74161. * @param left defines the start value
  74162. * @param right defines the end value
  74163. * @param amount defines the gradient factor
  74164. * @param result defines the Color4 object where to store data
  74165. */
  74166. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  74167. /**
  74168. * Creates a new Color4 from a Color3 and an alpha value
  74169. * @param color3 defines the source Color3 to read from
  74170. * @param alpha defines the alpha component (1.0 by default)
  74171. * @returns a new Color4 object
  74172. */
  74173. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  74174. /**
  74175. * Creates a new Color4 from the starting index element of the given array
  74176. * @param array defines the source array to read from
  74177. * @param offset defines the offset in the source array
  74178. * @returns a new Color4 object
  74179. */
  74180. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  74181. /**
  74182. * Creates a new Color3 from integer values (< 256)
  74183. * @param r defines the red component to read from (value between 0 and 255)
  74184. * @param g defines the green component to read from (value between 0 and 255)
  74185. * @param b defines the blue component to read from (value between 0 and 255)
  74186. * @param a defines the alpha component to read from (value between 0 and 255)
  74187. * @returns a new Color3 object
  74188. */
  74189. static FromInts(r: number, g: number, b: number, a: number): Color4;
  74190. /**
  74191. * Check the content of a given array and convert it to an array containing RGBA data
  74192. * If the original array was already containing count * 4 values then it is returned directly
  74193. * @param colors defines the array to check
  74194. * @param count defines the number of RGBA data to expect
  74195. * @returns an array containing count * 4 values (RGBA)
  74196. */
  74197. static CheckColors4(colors: number[], count: number): number[];
  74198. }
  74199. /**
  74200. * @hidden
  74201. */
  74202. export class TmpColors {
  74203. static Color3: Color3[];
  74204. static Color4: Color4[];
  74205. }
  74206. }
  74207. declare module BABYLON {
  74208. /**
  74209. * Defines an interface which represents an animation key frame
  74210. */
  74211. export interface IAnimationKey {
  74212. /**
  74213. * Frame of the key frame
  74214. */
  74215. frame: number;
  74216. /**
  74217. * Value at the specifies key frame
  74218. */
  74219. value: any;
  74220. /**
  74221. * The input tangent for the cubic hermite spline
  74222. */
  74223. inTangent?: any;
  74224. /**
  74225. * The output tangent for the cubic hermite spline
  74226. */
  74227. outTangent?: any;
  74228. /**
  74229. * The animation interpolation type
  74230. */
  74231. interpolation?: AnimationKeyInterpolation;
  74232. }
  74233. /**
  74234. * Enum for the animation key frame interpolation type
  74235. */
  74236. export enum AnimationKeyInterpolation {
  74237. /**
  74238. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  74239. */
  74240. STEP = 1
  74241. }
  74242. }
  74243. declare module BABYLON {
  74244. /**
  74245. * Represents the range of an animation
  74246. */
  74247. export class AnimationRange {
  74248. /**The name of the animation range**/
  74249. name: string;
  74250. /**The starting frame of the animation */
  74251. from: number;
  74252. /**The ending frame of the animation*/
  74253. to: number;
  74254. /**
  74255. * Initializes the range of an animation
  74256. * @param name The name of the animation range
  74257. * @param from The starting frame of the animation
  74258. * @param to The ending frame of the animation
  74259. */
  74260. constructor(
  74261. /**The name of the animation range**/
  74262. name: string,
  74263. /**The starting frame of the animation */
  74264. from: number,
  74265. /**The ending frame of the animation*/
  74266. to: number);
  74267. /**
  74268. * Makes a copy of the animation range
  74269. * @returns A copy of the animation range
  74270. */
  74271. clone(): AnimationRange;
  74272. }
  74273. }
  74274. declare module BABYLON {
  74275. /**
  74276. * Composed of a frame, and an action function
  74277. */
  74278. export class AnimationEvent {
  74279. /** The frame for which the event is triggered **/
  74280. frame: number;
  74281. /** The event to perform when triggered **/
  74282. action: (currentFrame: number) => void;
  74283. /** Specifies if the event should be triggered only once**/
  74284. onlyOnce?: boolean | undefined;
  74285. /**
  74286. * Specifies if the animation event is done
  74287. */
  74288. isDone: boolean;
  74289. /**
  74290. * Initializes the animation event
  74291. * @param frame The frame for which the event is triggered
  74292. * @param action The event to perform when triggered
  74293. * @param onlyOnce Specifies if the event should be triggered only once
  74294. */
  74295. constructor(
  74296. /** The frame for which the event is triggered **/
  74297. frame: number,
  74298. /** The event to perform when triggered **/
  74299. action: (currentFrame: number) => void,
  74300. /** Specifies if the event should be triggered only once**/
  74301. onlyOnce?: boolean | undefined);
  74302. /** @hidden */
  74303. _clone(): AnimationEvent;
  74304. }
  74305. }
  74306. declare module BABYLON {
  74307. /**
  74308. * Interface used to define a behavior
  74309. */
  74310. export interface Behavior<T> {
  74311. /** gets or sets behavior's name */
  74312. name: string;
  74313. /**
  74314. * Function called when the behavior needs to be initialized (after attaching it to a target)
  74315. */
  74316. init(): void;
  74317. /**
  74318. * Called when the behavior is attached to a target
  74319. * @param target defines the target where the behavior is attached to
  74320. */
  74321. attach(target: T): void;
  74322. /**
  74323. * Called when the behavior is detached from its target
  74324. */
  74325. detach(): void;
  74326. }
  74327. /**
  74328. * Interface implemented by classes supporting behaviors
  74329. */
  74330. export interface IBehaviorAware<T> {
  74331. /**
  74332. * Attach a behavior
  74333. * @param behavior defines the behavior to attach
  74334. * @returns the current host
  74335. */
  74336. addBehavior(behavior: Behavior<T>): T;
  74337. /**
  74338. * Remove a behavior from the current object
  74339. * @param behavior defines the behavior to detach
  74340. * @returns the current host
  74341. */
  74342. removeBehavior(behavior: Behavior<T>): T;
  74343. /**
  74344. * Gets a behavior using its name to search
  74345. * @param name defines the name to search
  74346. * @returns the behavior or null if not found
  74347. */
  74348. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  74349. }
  74350. }
  74351. declare module BABYLON {
  74352. /**
  74353. * Defines an array and its length.
  74354. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  74355. */
  74356. export interface ISmartArrayLike<T> {
  74357. /**
  74358. * The data of the array.
  74359. */
  74360. data: Array<T>;
  74361. /**
  74362. * The active length of the array.
  74363. */
  74364. length: number;
  74365. }
  74366. /**
  74367. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  74368. */
  74369. export class SmartArray<T> implements ISmartArrayLike<T> {
  74370. /**
  74371. * The full set of data from the array.
  74372. */
  74373. data: Array<T>;
  74374. /**
  74375. * The active length of the array.
  74376. */
  74377. length: number;
  74378. protected _id: number;
  74379. /**
  74380. * Instantiates a Smart Array.
  74381. * @param capacity defines the default capacity of the array.
  74382. */
  74383. constructor(capacity: number);
  74384. /**
  74385. * Pushes a value at the end of the active data.
  74386. * @param value defines the object to push in the array.
  74387. */
  74388. push(value: T): void;
  74389. /**
  74390. * Iterates over the active data and apply the lambda to them.
  74391. * @param func defines the action to apply on each value.
  74392. */
  74393. forEach(func: (content: T) => void): void;
  74394. /**
  74395. * Sorts the full sets of data.
  74396. * @param compareFn defines the comparison function to apply.
  74397. */
  74398. sort(compareFn: (a: T, b: T) => number): void;
  74399. /**
  74400. * Resets the active data to an empty array.
  74401. */
  74402. reset(): void;
  74403. /**
  74404. * Releases all the data from the array as well as the array.
  74405. */
  74406. dispose(): void;
  74407. /**
  74408. * Concats the active data with a given array.
  74409. * @param array defines the data to concatenate with.
  74410. */
  74411. concat(array: any): void;
  74412. /**
  74413. * Returns the position of a value in the active data.
  74414. * @param value defines the value to find the index for
  74415. * @returns the index if found in the active data otherwise -1
  74416. */
  74417. indexOf(value: T): number;
  74418. /**
  74419. * Returns whether an element is part of the active data.
  74420. * @param value defines the value to look for
  74421. * @returns true if found in the active data otherwise false
  74422. */
  74423. contains(value: T): boolean;
  74424. private static _GlobalId;
  74425. }
  74426. /**
  74427. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  74428. * The data in this array can only be present once
  74429. */
  74430. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  74431. private _duplicateId;
  74432. /**
  74433. * Pushes a value at the end of the active data.
  74434. * THIS DOES NOT PREVENT DUPPLICATE DATA
  74435. * @param value defines the object to push in the array.
  74436. */
  74437. push(value: T): void;
  74438. /**
  74439. * Pushes a value at the end of the active data.
  74440. * If the data is already present, it won t be added again
  74441. * @param value defines the object to push in the array.
  74442. * @returns true if added false if it was already present
  74443. */
  74444. pushNoDuplicate(value: T): boolean;
  74445. /**
  74446. * Resets the active data to an empty array.
  74447. */
  74448. reset(): void;
  74449. /**
  74450. * Concats the active data with a given array.
  74451. * This ensures no dupplicate will be present in the result.
  74452. * @param array defines the data to concatenate with.
  74453. */
  74454. concatWithNoDuplicate(array: any): void;
  74455. }
  74456. }
  74457. declare module BABYLON {
  74458. /**
  74459. * @ignore
  74460. * This is a list of all the different input types that are available in the application.
  74461. * Fo instance: ArcRotateCameraGamepadInput...
  74462. */
  74463. export var CameraInputTypes: {};
  74464. /**
  74465. * This is the contract to implement in order to create a new input class.
  74466. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  74467. */
  74468. export interface ICameraInput<TCamera extends Camera> {
  74469. /**
  74470. * Defines the camera the input is attached to.
  74471. */
  74472. camera: Nullable<TCamera>;
  74473. /**
  74474. * Gets the class name of the current intput.
  74475. * @returns the class name
  74476. */
  74477. getClassName(): string;
  74478. /**
  74479. * Get the friendly name associated with the input class.
  74480. * @returns the input friendly name
  74481. */
  74482. getSimpleName(): string;
  74483. /**
  74484. * Attach the input controls to a specific dom element to get the input from.
  74485. * @param element Defines the element the controls should be listened from
  74486. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74487. */
  74488. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  74489. /**
  74490. * Detach the current controls from the specified dom element.
  74491. * @param element Defines the element to stop listening the inputs from
  74492. */
  74493. detachControl(element: Nullable<HTMLElement>): void;
  74494. /**
  74495. * Update the current camera state depending on the inputs that have been used this frame.
  74496. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74497. */
  74498. checkInputs?: () => void;
  74499. }
  74500. /**
  74501. * Represents a map of input types to input instance or input index to input instance.
  74502. */
  74503. export interface CameraInputsMap<TCamera extends Camera> {
  74504. /**
  74505. * Accessor to the input by input type.
  74506. */
  74507. [name: string]: ICameraInput<TCamera>;
  74508. /**
  74509. * Accessor to the input by input index.
  74510. */
  74511. [idx: number]: ICameraInput<TCamera>;
  74512. }
  74513. /**
  74514. * This represents the input manager used within a camera.
  74515. * It helps dealing with all the different kind of input attached to a camera.
  74516. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74517. */
  74518. export class CameraInputsManager<TCamera extends Camera> {
  74519. /**
  74520. * Defines the list of inputs attahed to the camera.
  74521. */
  74522. attached: CameraInputsMap<TCamera>;
  74523. /**
  74524. * Defines the dom element the camera is collecting inputs from.
  74525. * This is null if the controls have not been attached.
  74526. */
  74527. attachedElement: Nullable<HTMLElement>;
  74528. /**
  74529. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74530. */
  74531. noPreventDefault: boolean;
  74532. /**
  74533. * Defined the camera the input manager belongs to.
  74534. */
  74535. camera: TCamera;
  74536. /**
  74537. * Update the current camera state depending on the inputs that have been used this frame.
  74538. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74539. */
  74540. checkInputs: () => void;
  74541. /**
  74542. * Instantiate a new Camera Input Manager.
  74543. * @param camera Defines the camera the input manager blongs to
  74544. */
  74545. constructor(camera: TCamera);
  74546. /**
  74547. * Add an input method to a camera
  74548. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74549. * @param input camera input method
  74550. */
  74551. add(input: ICameraInput<TCamera>): void;
  74552. /**
  74553. * Remove a specific input method from a camera
  74554. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  74555. * @param inputToRemove camera input method
  74556. */
  74557. remove(inputToRemove: ICameraInput<TCamera>): void;
  74558. /**
  74559. * Remove a specific input type from a camera
  74560. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  74561. * @param inputType the type of the input to remove
  74562. */
  74563. removeByType(inputType: string): void;
  74564. private _addCheckInputs;
  74565. /**
  74566. * Attach the input controls to the currently attached dom element to listen the events from.
  74567. * @param input Defines the input to attach
  74568. */
  74569. attachInput(input: ICameraInput<TCamera>): void;
  74570. /**
  74571. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  74572. * @param element Defines the dom element to collect the events from
  74573. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74574. */
  74575. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  74576. /**
  74577. * Detach the current manager inputs controls from a specific dom element.
  74578. * @param element Defines the dom element to collect the events from
  74579. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  74580. */
  74581. detachElement(element: HTMLElement, disconnect?: boolean): void;
  74582. /**
  74583. * Rebuild the dynamic inputCheck function from the current list of
  74584. * defined inputs in the manager.
  74585. */
  74586. rebuildInputCheck(): void;
  74587. /**
  74588. * Remove all attached input methods from a camera
  74589. */
  74590. clear(): void;
  74591. /**
  74592. * Serialize the current input manager attached to a camera.
  74593. * This ensures than once parsed,
  74594. * the input associated to the camera will be identical to the current ones
  74595. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  74596. */
  74597. serialize(serializedCamera: any): void;
  74598. /**
  74599. * Parses an input manager serialized JSON to restore the previous list of inputs
  74600. * and states associated to a camera.
  74601. * @param parsedCamera Defines the JSON to parse
  74602. */
  74603. parse(parsedCamera: any): void;
  74604. }
  74605. }
  74606. declare module BABYLON {
  74607. /**
  74608. * Class used to store data that will be store in GPU memory
  74609. */
  74610. export class Buffer {
  74611. private _engine;
  74612. private _buffer;
  74613. /** @hidden */
  74614. _data: Nullable<DataArray>;
  74615. private _updatable;
  74616. private _instanced;
  74617. private _divisor;
  74618. /**
  74619. * Gets the byte stride.
  74620. */
  74621. readonly byteStride: number;
  74622. /**
  74623. * Constructor
  74624. * @param engine the engine
  74625. * @param data the data to use for this buffer
  74626. * @param updatable whether the data is updatable
  74627. * @param stride the stride (optional)
  74628. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74629. * @param instanced whether the buffer is instanced (optional)
  74630. * @param useBytes set to true if the stride in in bytes (optional)
  74631. * @param divisor sets an optional divisor for instances (1 by default)
  74632. */
  74633. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  74634. /**
  74635. * Create a new VertexBuffer based on the current buffer
  74636. * @param kind defines the vertex buffer kind (position, normal, etc.)
  74637. * @param offset defines offset in the buffer (0 by default)
  74638. * @param size defines the size in floats of attributes (position is 3 for instance)
  74639. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  74640. * @param instanced defines if the vertex buffer contains indexed data
  74641. * @param useBytes defines if the offset and stride are in bytes *
  74642. * @param divisor sets an optional divisor for instances (1 by default)
  74643. * @returns the new vertex buffer
  74644. */
  74645. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  74646. /**
  74647. * Gets a boolean indicating if the Buffer is updatable?
  74648. * @returns true if the buffer is updatable
  74649. */
  74650. isUpdatable(): boolean;
  74651. /**
  74652. * Gets current buffer's data
  74653. * @returns a DataArray or null
  74654. */
  74655. getData(): Nullable<DataArray>;
  74656. /**
  74657. * Gets underlying native buffer
  74658. * @returns underlying native buffer
  74659. */
  74660. getBuffer(): Nullable<DataBuffer>;
  74661. /**
  74662. * Gets the stride in float32 units (i.e. byte stride / 4).
  74663. * May not be an integer if the byte stride is not divisible by 4.
  74664. * DEPRECATED. Use byteStride instead.
  74665. * @returns the stride in float32 units
  74666. */
  74667. getStrideSize(): number;
  74668. /**
  74669. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74670. * @param data defines the data to store
  74671. */
  74672. create(data?: Nullable<DataArray>): void;
  74673. /** @hidden */
  74674. _rebuild(): void;
  74675. /**
  74676. * Update current buffer data
  74677. * @param data defines the data to store
  74678. */
  74679. update(data: DataArray): void;
  74680. /**
  74681. * Updates the data directly.
  74682. * @param data the new data
  74683. * @param offset the new offset
  74684. * @param vertexCount the vertex count (optional)
  74685. * @param useBytes set to true if the offset is in bytes
  74686. */
  74687. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  74688. /**
  74689. * Release all resources
  74690. */
  74691. dispose(): void;
  74692. }
  74693. /**
  74694. * Specialized buffer used to store vertex data
  74695. */
  74696. export class VertexBuffer {
  74697. /** @hidden */
  74698. _buffer: Buffer;
  74699. private _kind;
  74700. private _size;
  74701. private _ownsBuffer;
  74702. private _instanced;
  74703. private _instanceDivisor;
  74704. /**
  74705. * The byte type.
  74706. */
  74707. static readonly BYTE: number;
  74708. /**
  74709. * The unsigned byte type.
  74710. */
  74711. static readonly UNSIGNED_BYTE: number;
  74712. /**
  74713. * The short type.
  74714. */
  74715. static readonly SHORT: number;
  74716. /**
  74717. * The unsigned short type.
  74718. */
  74719. static readonly UNSIGNED_SHORT: number;
  74720. /**
  74721. * The integer type.
  74722. */
  74723. static readonly INT: number;
  74724. /**
  74725. * The unsigned integer type.
  74726. */
  74727. static readonly UNSIGNED_INT: number;
  74728. /**
  74729. * The float type.
  74730. */
  74731. static readonly FLOAT: number;
  74732. /**
  74733. * Gets or sets the instance divisor when in instanced mode
  74734. */
  74735. instanceDivisor: number;
  74736. /**
  74737. * Gets the byte stride.
  74738. */
  74739. readonly byteStride: number;
  74740. /**
  74741. * Gets the byte offset.
  74742. */
  74743. readonly byteOffset: number;
  74744. /**
  74745. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  74746. */
  74747. readonly normalized: boolean;
  74748. /**
  74749. * Gets the data type of each component in the array.
  74750. */
  74751. readonly type: number;
  74752. /**
  74753. * Constructor
  74754. * @param engine the engine
  74755. * @param data the data to use for this vertex buffer
  74756. * @param kind the vertex buffer kind
  74757. * @param updatable whether the data is updatable
  74758. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74759. * @param stride the stride (optional)
  74760. * @param instanced whether the buffer is instanced (optional)
  74761. * @param offset the offset of the data (optional)
  74762. * @param size the number of components (optional)
  74763. * @param type the type of the component (optional)
  74764. * @param normalized whether the data contains normalized data (optional)
  74765. * @param useBytes set to true if stride and offset are in bytes (optional)
  74766. * @param divisor defines the instance divisor to use (1 by default)
  74767. */
  74768. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  74769. /** @hidden */
  74770. _rebuild(): void;
  74771. /**
  74772. * Returns the kind of the VertexBuffer (string)
  74773. * @returns a string
  74774. */
  74775. getKind(): string;
  74776. /**
  74777. * Gets a boolean indicating if the VertexBuffer is updatable?
  74778. * @returns true if the buffer is updatable
  74779. */
  74780. isUpdatable(): boolean;
  74781. /**
  74782. * Gets current buffer's data
  74783. * @returns a DataArray or null
  74784. */
  74785. getData(): Nullable<DataArray>;
  74786. /**
  74787. * Gets underlying native buffer
  74788. * @returns underlying native buffer
  74789. */
  74790. getBuffer(): Nullable<DataBuffer>;
  74791. /**
  74792. * Gets the stride in float32 units (i.e. byte stride / 4).
  74793. * May not be an integer if the byte stride is not divisible by 4.
  74794. * DEPRECATED. Use byteStride instead.
  74795. * @returns the stride in float32 units
  74796. */
  74797. getStrideSize(): number;
  74798. /**
  74799. * Returns the offset as a multiple of the type byte length.
  74800. * DEPRECATED. Use byteOffset instead.
  74801. * @returns the offset in bytes
  74802. */
  74803. getOffset(): number;
  74804. /**
  74805. * Returns the number of components per vertex attribute (integer)
  74806. * @returns the size in float
  74807. */
  74808. getSize(): number;
  74809. /**
  74810. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  74811. * @returns true if this buffer is instanced
  74812. */
  74813. getIsInstanced(): boolean;
  74814. /**
  74815. * Returns the instancing divisor, zero for non-instanced (integer).
  74816. * @returns a number
  74817. */
  74818. getInstanceDivisor(): number;
  74819. /**
  74820. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74821. * @param data defines the data to store
  74822. */
  74823. create(data?: DataArray): void;
  74824. /**
  74825. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  74826. * This function will create a new buffer if the current one is not updatable
  74827. * @param data defines the data to store
  74828. */
  74829. update(data: DataArray): void;
  74830. /**
  74831. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  74832. * Returns the directly updated WebGLBuffer.
  74833. * @param data the new data
  74834. * @param offset the new offset
  74835. * @param useBytes set to true if the offset is in bytes
  74836. */
  74837. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  74838. /**
  74839. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  74840. */
  74841. dispose(): void;
  74842. /**
  74843. * Enumerates each value of this vertex buffer as numbers.
  74844. * @param count the number of values to enumerate
  74845. * @param callback the callback function called for each value
  74846. */
  74847. forEach(count: number, callback: (value: number, index: number) => void): void;
  74848. /**
  74849. * Positions
  74850. */
  74851. static readonly PositionKind: string;
  74852. /**
  74853. * Normals
  74854. */
  74855. static readonly NormalKind: string;
  74856. /**
  74857. * Tangents
  74858. */
  74859. static readonly TangentKind: string;
  74860. /**
  74861. * Texture coordinates
  74862. */
  74863. static readonly UVKind: string;
  74864. /**
  74865. * Texture coordinates 2
  74866. */
  74867. static readonly UV2Kind: string;
  74868. /**
  74869. * Texture coordinates 3
  74870. */
  74871. static readonly UV3Kind: string;
  74872. /**
  74873. * Texture coordinates 4
  74874. */
  74875. static readonly UV4Kind: string;
  74876. /**
  74877. * Texture coordinates 5
  74878. */
  74879. static readonly UV5Kind: string;
  74880. /**
  74881. * Texture coordinates 6
  74882. */
  74883. static readonly UV6Kind: string;
  74884. /**
  74885. * Colors
  74886. */
  74887. static readonly ColorKind: string;
  74888. /**
  74889. * Matrix indices (for bones)
  74890. */
  74891. static readonly MatricesIndicesKind: string;
  74892. /**
  74893. * Matrix weights (for bones)
  74894. */
  74895. static readonly MatricesWeightsKind: string;
  74896. /**
  74897. * Additional matrix indices (for bones)
  74898. */
  74899. static readonly MatricesIndicesExtraKind: string;
  74900. /**
  74901. * Additional matrix weights (for bones)
  74902. */
  74903. static readonly MatricesWeightsExtraKind: string;
  74904. /**
  74905. * Deduces the stride given a kind.
  74906. * @param kind The kind string to deduce
  74907. * @returns The deduced stride
  74908. */
  74909. static DeduceStride(kind: string): number;
  74910. /**
  74911. * Gets the byte length of the given type.
  74912. * @param type the type
  74913. * @returns the number of bytes
  74914. */
  74915. static GetTypeByteLength(type: number): number;
  74916. /**
  74917. * Enumerates each value of the given parameters as numbers.
  74918. * @param data the data to enumerate
  74919. * @param byteOffset the byte offset of the data
  74920. * @param byteStride the byte stride of the data
  74921. * @param componentCount the number of components per element
  74922. * @param componentType the type of the component
  74923. * @param count the number of values to enumerate
  74924. * @param normalized whether the data is normalized
  74925. * @param callback the callback function called for each value
  74926. */
  74927. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  74928. private static _GetFloatValue;
  74929. }
  74930. }
  74931. declare module BABYLON {
  74932. /**
  74933. * @hidden
  74934. */
  74935. export class IntersectionInfo {
  74936. bu: Nullable<number>;
  74937. bv: Nullable<number>;
  74938. distance: number;
  74939. faceId: number;
  74940. subMeshId: number;
  74941. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  74942. }
  74943. }
  74944. declare module BABYLON {
  74945. /**
  74946. * Represens a plane by the equation ax + by + cz + d = 0
  74947. */
  74948. export class Plane {
  74949. private static _TmpMatrix;
  74950. /**
  74951. * Normal of the plane (a,b,c)
  74952. */
  74953. normal: Vector3;
  74954. /**
  74955. * d component of the plane
  74956. */
  74957. d: number;
  74958. /**
  74959. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  74960. * @param a a component of the plane
  74961. * @param b b component of the plane
  74962. * @param c c component of the plane
  74963. * @param d d component of the plane
  74964. */
  74965. constructor(a: number, b: number, c: number, d: number);
  74966. /**
  74967. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  74968. */
  74969. asArray(): number[];
  74970. /**
  74971. * @returns a new plane copied from the current Plane.
  74972. */
  74973. clone(): Plane;
  74974. /**
  74975. * @returns the string "Plane".
  74976. */
  74977. getClassName(): string;
  74978. /**
  74979. * @returns the Plane hash code.
  74980. */
  74981. getHashCode(): number;
  74982. /**
  74983. * Normalize the current Plane in place.
  74984. * @returns the updated Plane.
  74985. */
  74986. normalize(): Plane;
  74987. /**
  74988. * Applies a transformation the plane and returns the result
  74989. * @param transformation the transformation matrix to be applied to the plane
  74990. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  74991. */
  74992. transform(transformation: DeepImmutable<Matrix>): Plane;
  74993. /**
  74994. * Calcualtte the dot product between the point and the plane normal
  74995. * @param point point to calculate the dot product with
  74996. * @returns the dot product (float) of the point coordinates and the plane normal.
  74997. */
  74998. dotCoordinate(point: DeepImmutable<Vector3>): number;
  74999. /**
  75000. * Updates the current Plane from the plane defined by the three given points.
  75001. * @param point1 one of the points used to contruct the plane
  75002. * @param point2 one of the points used to contruct the plane
  75003. * @param point3 one of the points used to contruct the plane
  75004. * @returns the updated Plane.
  75005. */
  75006. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  75007. /**
  75008. * Checks if the plane is facing a given direction
  75009. * @param direction the direction to check if the plane is facing
  75010. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  75011. * @returns True is the vector "direction" is the same side than the plane normal.
  75012. */
  75013. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  75014. /**
  75015. * Calculates the distance to a point
  75016. * @param point point to calculate distance to
  75017. * @returns the signed distance (float) from the given point to the Plane.
  75018. */
  75019. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  75020. /**
  75021. * Creates a plane from an array
  75022. * @param array the array to create a plane from
  75023. * @returns a new Plane from the given array.
  75024. */
  75025. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  75026. /**
  75027. * Creates a plane from three points
  75028. * @param point1 point used to create the plane
  75029. * @param point2 point used to create the plane
  75030. * @param point3 point used to create the plane
  75031. * @returns a new Plane defined by the three given points.
  75032. */
  75033. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  75034. /**
  75035. * Creates a plane from an origin point and a normal
  75036. * @param origin origin of the plane to be constructed
  75037. * @param normal normal of the plane to be constructed
  75038. * @returns a new Plane the normal vector to this plane at the given origin point.
  75039. * Note : the vector "normal" is updated because normalized.
  75040. */
  75041. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  75042. /**
  75043. * Calculates the distance from a plane and a point
  75044. * @param origin origin of the plane to be constructed
  75045. * @param normal normal of the plane to be constructed
  75046. * @param point point to calculate distance to
  75047. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  75048. */
  75049. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  75050. }
  75051. }
  75052. declare module BABYLON {
  75053. /**
  75054. * Class used to store bounding sphere information
  75055. */
  75056. export class BoundingSphere {
  75057. /**
  75058. * Gets the center of the bounding sphere in local space
  75059. */
  75060. readonly center: Vector3;
  75061. /**
  75062. * Radius of the bounding sphere in local space
  75063. */
  75064. radius: number;
  75065. /**
  75066. * Gets the center of the bounding sphere in world space
  75067. */
  75068. readonly centerWorld: Vector3;
  75069. /**
  75070. * Radius of the bounding sphere in world space
  75071. */
  75072. radiusWorld: number;
  75073. /**
  75074. * Gets the minimum vector in local space
  75075. */
  75076. readonly minimum: Vector3;
  75077. /**
  75078. * Gets the maximum vector in local space
  75079. */
  75080. readonly maximum: Vector3;
  75081. private _worldMatrix;
  75082. private static readonly TmpVector3;
  75083. /**
  75084. * Creates a new bounding sphere
  75085. * @param min defines the minimum vector (in local space)
  75086. * @param max defines the maximum vector (in local space)
  75087. * @param worldMatrix defines the new world matrix
  75088. */
  75089. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  75090. /**
  75091. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  75092. * @param min defines the new minimum vector (in local space)
  75093. * @param max defines the new maximum vector (in local space)
  75094. * @param worldMatrix defines the new world matrix
  75095. */
  75096. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  75097. /**
  75098. * Scale the current bounding sphere by applying a scale factor
  75099. * @param factor defines the scale factor to apply
  75100. * @returns the current bounding box
  75101. */
  75102. scale(factor: number): BoundingSphere;
  75103. /**
  75104. * Gets the world matrix of the bounding box
  75105. * @returns a matrix
  75106. */
  75107. getWorldMatrix(): DeepImmutable<Matrix>;
  75108. /** @hidden */
  75109. _update(worldMatrix: DeepImmutable<Matrix>): void;
  75110. /**
  75111. * Tests if the bounding sphere is intersecting the frustum planes
  75112. * @param frustumPlanes defines the frustum planes to test
  75113. * @returns true if there is an intersection
  75114. */
  75115. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75116. /**
  75117. * Tests if the bounding sphere center is in between the frustum planes.
  75118. * Used for optimistic fast inclusion.
  75119. * @param frustumPlanes defines the frustum planes to test
  75120. * @returns true if the sphere center is in between the frustum planes
  75121. */
  75122. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75123. /**
  75124. * Tests if a point is inside the bounding sphere
  75125. * @param point defines the point to test
  75126. * @returns true if the point is inside the bounding sphere
  75127. */
  75128. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  75129. /**
  75130. * Checks if two sphere intersct
  75131. * @param sphere0 sphere 0
  75132. * @param sphere1 sphere 1
  75133. * @returns true if the speres intersect
  75134. */
  75135. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  75136. }
  75137. }
  75138. declare module BABYLON {
  75139. /**
  75140. * Class used to store bounding box information
  75141. */
  75142. export class BoundingBox implements ICullable {
  75143. /**
  75144. * Gets the 8 vectors representing the bounding box in local space
  75145. */
  75146. readonly vectors: Vector3[];
  75147. /**
  75148. * Gets the center of the bounding box in local space
  75149. */
  75150. readonly center: Vector3;
  75151. /**
  75152. * Gets the center of the bounding box in world space
  75153. */
  75154. readonly centerWorld: Vector3;
  75155. /**
  75156. * Gets the extend size in local space
  75157. */
  75158. readonly extendSize: Vector3;
  75159. /**
  75160. * Gets the extend size in world space
  75161. */
  75162. readonly extendSizeWorld: Vector3;
  75163. /**
  75164. * Gets the OBB (object bounding box) directions
  75165. */
  75166. readonly directions: Vector3[];
  75167. /**
  75168. * Gets the 8 vectors representing the bounding box in world space
  75169. */
  75170. readonly vectorsWorld: Vector3[];
  75171. /**
  75172. * Gets the minimum vector in world space
  75173. */
  75174. readonly minimumWorld: Vector3;
  75175. /**
  75176. * Gets the maximum vector in world space
  75177. */
  75178. readonly maximumWorld: Vector3;
  75179. /**
  75180. * Gets the minimum vector in local space
  75181. */
  75182. readonly minimum: Vector3;
  75183. /**
  75184. * Gets the maximum vector in local space
  75185. */
  75186. readonly maximum: Vector3;
  75187. private _worldMatrix;
  75188. private static readonly TmpVector3;
  75189. /**
  75190. * @hidden
  75191. */
  75192. _tag: number;
  75193. /**
  75194. * Creates a new bounding box
  75195. * @param min defines the minimum vector (in local space)
  75196. * @param max defines the maximum vector (in local space)
  75197. * @param worldMatrix defines the new world matrix
  75198. */
  75199. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  75200. /**
  75201. * Recreates the entire bounding box from scratch as if we call the constructor in place
  75202. * @param min defines the new minimum vector (in local space)
  75203. * @param max defines the new maximum vector (in local space)
  75204. * @param worldMatrix defines the new world matrix
  75205. */
  75206. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  75207. /**
  75208. * Scale the current bounding box by applying a scale factor
  75209. * @param factor defines the scale factor to apply
  75210. * @returns the current bounding box
  75211. */
  75212. scale(factor: number): BoundingBox;
  75213. /**
  75214. * Gets the world matrix of the bounding box
  75215. * @returns a matrix
  75216. */
  75217. getWorldMatrix(): DeepImmutable<Matrix>;
  75218. /** @hidden */
  75219. _update(world: DeepImmutable<Matrix>): void;
  75220. /**
  75221. * Tests if the bounding box is intersecting the frustum planes
  75222. * @param frustumPlanes defines the frustum planes to test
  75223. * @returns true if there is an intersection
  75224. */
  75225. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75226. /**
  75227. * Tests if the bounding box is entirely inside the frustum planes
  75228. * @param frustumPlanes defines the frustum planes to test
  75229. * @returns true if there is an inclusion
  75230. */
  75231. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75232. /**
  75233. * Tests if a point is inside the bounding box
  75234. * @param point defines the point to test
  75235. * @returns true if the point is inside the bounding box
  75236. */
  75237. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  75238. /**
  75239. * Tests if the bounding box intersects with a bounding sphere
  75240. * @param sphere defines the sphere to test
  75241. * @returns true if there is an intersection
  75242. */
  75243. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  75244. /**
  75245. * Tests if the bounding box intersects with a box defined by a min and max vectors
  75246. * @param min defines the min vector to use
  75247. * @param max defines the max vector to use
  75248. * @returns true if there is an intersection
  75249. */
  75250. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  75251. /**
  75252. * Tests if two bounding boxes are intersections
  75253. * @param box0 defines the first box to test
  75254. * @param box1 defines the second box to test
  75255. * @returns true if there is an intersection
  75256. */
  75257. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  75258. /**
  75259. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  75260. * @param minPoint defines the minimum vector of the bounding box
  75261. * @param maxPoint defines the maximum vector of the bounding box
  75262. * @param sphereCenter defines the sphere center
  75263. * @param sphereRadius defines the sphere radius
  75264. * @returns true if there is an intersection
  75265. */
  75266. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  75267. /**
  75268. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  75269. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  75270. * @param frustumPlanes defines the frustum planes to test
  75271. * @return true if there is an inclusion
  75272. */
  75273. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75274. /**
  75275. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  75276. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  75277. * @param frustumPlanes defines the frustum planes to test
  75278. * @return true if there is an intersection
  75279. */
  75280. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75281. }
  75282. }
  75283. declare module BABYLON {
  75284. /** @hidden */
  75285. export class Collider {
  75286. /** Define if a collision was found */
  75287. collisionFound: boolean;
  75288. /**
  75289. * Define last intersection point in local space
  75290. */
  75291. intersectionPoint: Vector3;
  75292. /**
  75293. * Define last collided mesh
  75294. */
  75295. collidedMesh: Nullable<AbstractMesh>;
  75296. private _collisionPoint;
  75297. private _planeIntersectionPoint;
  75298. private _tempVector;
  75299. private _tempVector2;
  75300. private _tempVector3;
  75301. private _tempVector4;
  75302. private _edge;
  75303. private _baseToVertex;
  75304. private _destinationPoint;
  75305. private _slidePlaneNormal;
  75306. private _displacementVector;
  75307. /** @hidden */
  75308. _radius: Vector3;
  75309. /** @hidden */
  75310. _retry: number;
  75311. private _velocity;
  75312. private _basePoint;
  75313. private _epsilon;
  75314. /** @hidden */
  75315. _velocityWorldLength: number;
  75316. /** @hidden */
  75317. _basePointWorld: Vector3;
  75318. private _velocityWorld;
  75319. private _normalizedVelocity;
  75320. /** @hidden */
  75321. _initialVelocity: Vector3;
  75322. /** @hidden */
  75323. _initialPosition: Vector3;
  75324. private _nearestDistance;
  75325. private _collisionMask;
  75326. collisionMask: number;
  75327. /**
  75328. * Gets the plane normal used to compute the sliding response (in local space)
  75329. */
  75330. readonly slidePlaneNormal: Vector3;
  75331. /** @hidden */
  75332. _initialize(source: Vector3, dir: Vector3, e: number): void;
  75333. /** @hidden */
  75334. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  75335. /** @hidden */
  75336. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  75337. /** @hidden */
  75338. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  75339. /** @hidden */
  75340. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  75341. /** @hidden */
  75342. _getResponse(pos: Vector3, vel: Vector3): void;
  75343. }
  75344. }
  75345. declare module BABYLON {
  75346. /**
  75347. * Interface for cullable objects
  75348. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  75349. */
  75350. export interface ICullable {
  75351. /**
  75352. * Checks if the object or part of the object is in the frustum
  75353. * @param frustumPlanes Camera near/planes
  75354. * @returns true if the object is in frustum otherwise false
  75355. */
  75356. isInFrustum(frustumPlanes: Plane[]): boolean;
  75357. /**
  75358. * Checks if a cullable object (mesh...) is in the camera frustum
  75359. * Unlike isInFrustum this cheks the full bounding box
  75360. * @param frustumPlanes Camera near/planes
  75361. * @returns true if the object is in frustum otherwise false
  75362. */
  75363. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  75364. }
  75365. /**
  75366. * Info for a bounding data of a mesh
  75367. */
  75368. export class BoundingInfo implements ICullable {
  75369. /**
  75370. * Bounding box for the mesh
  75371. */
  75372. readonly boundingBox: BoundingBox;
  75373. /**
  75374. * Bounding sphere for the mesh
  75375. */
  75376. readonly boundingSphere: BoundingSphere;
  75377. private _isLocked;
  75378. private static readonly TmpVector3;
  75379. /**
  75380. * Constructs bounding info
  75381. * @param minimum min vector of the bounding box/sphere
  75382. * @param maximum max vector of the bounding box/sphere
  75383. * @param worldMatrix defines the new world matrix
  75384. */
  75385. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  75386. /**
  75387. * Recreates the entire bounding info from scratch as if we call the constructor in place
  75388. * @param min defines the new minimum vector (in local space)
  75389. * @param max defines the new maximum vector (in local space)
  75390. * @param worldMatrix defines the new world matrix
  75391. */
  75392. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  75393. /**
  75394. * min vector of the bounding box/sphere
  75395. */
  75396. readonly minimum: Vector3;
  75397. /**
  75398. * max vector of the bounding box/sphere
  75399. */
  75400. readonly maximum: Vector3;
  75401. /**
  75402. * If the info is locked and won't be updated to avoid perf overhead
  75403. */
  75404. isLocked: boolean;
  75405. /**
  75406. * Updates the bounding sphere and box
  75407. * @param world world matrix to be used to update
  75408. */
  75409. update(world: DeepImmutable<Matrix>): void;
  75410. /**
  75411. * Recreate the bounding info to be centered around a specific point given a specific extend.
  75412. * @param center New center of the bounding info
  75413. * @param extend New extend of the bounding info
  75414. * @returns the current bounding info
  75415. */
  75416. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  75417. /**
  75418. * Scale the current bounding info by applying a scale factor
  75419. * @param factor defines the scale factor to apply
  75420. * @returns the current bounding info
  75421. */
  75422. scale(factor: number): BoundingInfo;
  75423. /**
  75424. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  75425. * @param frustumPlanes defines the frustum to test
  75426. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  75427. * @returns true if the bounding info is in the frustum planes
  75428. */
  75429. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  75430. /**
  75431. * Gets the world distance between the min and max points of the bounding box
  75432. */
  75433. readonly diagonalLength: number;
  75434. /**
  75435. * Checks if a cullable object (mesh...) is in the camera frustum
  75436. * Unlike isInFrustum this cheks the full bounding box
  75437. * @param frustumPlanes Camera near/planes
  75438. * @returns true if the object is in frustum otherwise false
  75439. */
  75440. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75441. /** @hidden */
  75442. _checkCollision(collider: Collider): boolean;
  75443. /**
  75444. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  75445. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  75446. * @param point the point to check intersection with
  75447. * @returns if the point intersects
  75448. */
  75449. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  75450. /**
  75451. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  75452. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  75453. * @param boundingInfo the bounding info to check intersection with
  75454. * @param precise if the intersection should be done using OBB
  75455. * @returns if the bounding info intersects
  75456. */
  75457. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  75458. }
  75459. }
  75460. declare module BABYLON {
  75461. /**
  75462. * Extracts minimum and maximum values from a list of indexed positions
  75463. * @param positions defines the positions to use
  75464. * @param indices defines the indices to the positions
  75465. * @param indexStart defines the start index
  75466. * @param indexCount defines the end index
  75467. * @param bias defines bias value to add to the result
  75468. * @return minimum and maximum values
  75469. */
  75470. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  75471. minimum: Vector3;
  75472. maximum: Vector3;
  75473. };
  75474. /**
  75475. * Extracts minimum and maximum values from a list of positions
  75476. * @param positions defines the positions to use
  75477. * @param start defines the start index in the positions array
  75478. * @param count defines the number of positions to handle
  75479. * @param bias defines bias value to add to the result
  75480. * @param stride defines the stride size to use (distance between two positions in the positions array)
  75481. * @return minimum and maximum values
  75482. */
  75483. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  75484. minimum: Vector3;
  75485. maximum: Vector3;
  75486. };
  75487. }
  75488. declare module BABYLON {
  75489. /** @hidden */
  75490. export class WebGLDataBuffer extends DataBuffer {
  75491. private _buffer;
  75492. constructor(resource: WebGLBuffer);
  75493. readonly underlyingResource: any;
  75494. }
  75495. }
  75496. declare module BABYLON {
  75497. /** @hidden */
  75498. export class WebGLPipelineContext implements IPipelineContext {
  75499. engine: ThinEngine;
  75500. program: Nullable<WebGLProgram>;
  75501. context?: WebGLRenderingContext;
  75502. vertexShader?: WebGLShader;
  75503. fragmentShader?: WebGLShader;
  75504. isParallelCompiled: boolean;
  75505. onCompiled?: () => void;
  75506. transformFeedback?: WebGLTransformFeedback | null;
  75507. readonly isAsync: boolean;
  75508. readonly isReady: boolean;
  75509. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  75510. }
  75511. }
  75512. declare module BABYLON {
  75513. interface ThinEngine {
  75514. /**
  75515. * Create an uniform buffer
  75516. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75517. * @param elements defines the content of the uniform buffer
  75518. * @returns the webGL uniform buffer
  75519. */
  75520. createUniformBuffer(elements: FloatArray): DataBuffer;
  75521. /**
  75522. * Create a dynamic uniform buffer
  75523. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75524. * @param elements defines the content of the uniform buffer
  75525. * @returns the webGL uniform buffer
  75526. */
  75527. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  75528. /**
  75529. * Update an existing uniform buffer
  75530. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75531. * @param uniformBuffer defines the target uniform buffer
  75532. * @param elements defines the content to update
  75533. * @param offset defines the offset in the uniform buffer where update should start
  75534. * @param count defines the size of the data to update
  75535. */
  75536. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  75537. /**
  75538. * Bind an uniform buffer to the current webGL context
  75539. * @param buffer defines the buffer to bind
  75540. */
  75541. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  75542. /**
  75543. * Bind a buffer to the current webGL context at a given location
  75544. * @param buffer defines the buffer to bind
  75545. * @param location defines the index where to bind the buffer
  75546. */
  75547. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  75548. /**
  75549. * Bind a specific block at a given index in a specific shader program
  75550. * @param pipelineContext defines the pipeline context to use
  75551. * @param blockName defines the block name
  75552. * @param index defines the index where to bind the block
  75553. */
  75554. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  75555. }
  75556. }
  75557. declare module BABYLON {
  75558. /**
  75559. * Uniform buffer objects.
  75560. *
  75561. * Handles blocks of uniform on the GPU.
  75562. *
  75563. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  75564. *
  75565. * For more information, please refer to :
  75566. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  75567. */
  75568. export class UniformBuffer {
  75569. private _engine;
  75570. private _buffer;
  75571. private _data;
  75572. private _bufferData;
  75573. private _dynamic?;
  75574. private _uniformLocations;
  75575. private _uniformSizes;
  75576. private _uniformLocationPointer;
  75577. private _needSync;
  75578. private _noUBO;
  75579. private _currentEffect;
  75580. /** @hidden */
  75581. _alreadyBound: boolean;
  75582. private static _MAX_UNIFORM_SIZE;
  75583. private static _tempBuffer;
  75584. /**
  75585. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  75586. * This is dynamic to allow compat with webgl 1 and 2.
  75587. * You will need to pass the name of the uniform as well as the value.
  75588. */
  75589. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  75590. /**
  75591. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  75592. * This is dynamic to allow compat with webgl 1 and 2.
  75593. * You will need to pass the name of the uniform as well as the value.
  75594. */
  75595. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  75596. /**
  75597. * Lambda to Update a single float in a uniform buffer.
  75598. * This is dynamic to allow compat with webgl 1 and 2.
  75599. * You will need to pass the name of the uniform as well as the value.
  75600. */
  75601. updateFloat: (name: string, x: number) => void;
  75602. /**
  75603. * Lambda to Update a vec2 of float in a uniform buffer.
  75604. * This is dynamic to allow compat with webgl 1 and 2.
  75605. * You will need to pass the name of the uniform as well as the value.
  75606. */
  75607. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  75608. /**
  75609. * Lambda to Update a vec3 of float in a uniform buffer.
  75610. * This is dynamic to allow compat with webgl 1 and 2.
  75611. * You will need to pass the name of the uniform as well as the value.
  75612. */
  75613. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  75614. /**
  75615. * Lambda to Update a vec4 of float in a uniform buffer.
  75616. * This is dynamic to allow compat with webgl 1 and 2.
  75617. * You will need to pass the name of the uniform as well as the value.
  75618. */
  75619. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  75620. /**
  75621. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  75622. * This is dynamic to allow compat with webgl 1 and 2.
  75623. * You will need to pass the name of the uniform as well as the value.
  75624. */
  75625. updateMatrix: (name: string, mat: Matrix) => void;
  75626. /**
  75627. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  75628. * This is dynamic to allow compat with webgl 1 and 2.
  75629. * You will need to pass the name of the uniform as well as the value.
  75630. */
  75631. updateVector3: (name: string, vector: Vector3) => void;
  75632. /**
  75633. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  75634. * This is dynamic to allow compat with webgl 1 and 2.
  75635. * You will need to pass the name of the uniform as well as the value.
  75636. */
  75637. updateVector4: (name: string, vector: Vector4) => void;
  75638. /**
  75639. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  75640. * This is dynamic to allow compat with webgl 1 and 2.
  75641. * You will need to pass the name of the uniform as well as the value.
  75642. */
  75643. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  75644. /**
  75645. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  75646. * This is dynamic to allow compat with webgl 1 and 2.
  75647. * You will need to pass the name of the uniform as well as the value.
  75648. */
  75649. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  75650. /**
  75651. * Instantiates a new Uniform buffer objects.
  75652. *
  75653. * Handles blocks of uniform on the GPU.
  75654. *
  75655. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  75656. *
  75657. * For more information, please refer to :
  75658. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  75659. * @param engine Define the engine the buffer is associated with
  75660. * @param data Define the data contained in the buffer
  75661. * @param dynamic Define if the buffer is updatable
  75662. */
  75663. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  75664. /**
  75665. * Indicates if the buffer is using the WebGL2 UBO implementation,
  75666. * or just falling back on setUniformXXX calls.
  75667. */
  75668. readonly useUbo: boolean;
  75669. /**
  75670. * Indicates if the WebGL underlying uniform buffer is in sync
  75671. * with the javascript cache data.
  75672. */
  75673. readonly isSync: boolean;
  75674. /**
  75675. * Indicates if the WebGL underlying uniform buffer is dynamic.
  75676. * Also, a dynamic UniformBuffer will disable cache verification and always
  75677. * update the underlying WebGL uniform buffer to the GPU.
  75678. * @returns if Dynamic, otherwise false
  75679. */
  75680. isDynamic(): boolean;
  75681. /**
  75682. * The data cache on JS side.
  75683. * @returns the underlying data as a float array
  75684. */
  75685. getData(): Float32Array;
  75686. /**
  75687. * The underlying WebGL Uniform buffer.
  75688. * @returns the webgl buffer
  75689. */
  75690. getBuffer(): Nullable<DataBuffer>;
  75691. /**
  75692. * std140 layout specifies how to align data within an UBO structure.
  75693. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  75694. * for specs.
  75695. */
  75696. private _fillAlignment;
  75697. /**
  75698. * Adds an uniform in the buffer.
  75699. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  75700. * for the layout to be correct !
  75701. * @param name Name of the uniform, as used in the uniform block in the shader.
  75702. * @param size Data size, or data directly.
  75703. */
  75704. addUniform(name: string, size: number | number[]): void;
  75705. /**
  75706. * Adds a Matrix 4x4 to the uniform buffer.
  75707. * @param name Name of the uniform, as used in the uniform block in the shader.
  75708. * @param mat A 4x4 matrix.
  75709. */
  75710. addMatrix(name: string, mat: Matrix): void;
  75711. /**
  75712. * Adds a vec2 to the uniform buffer.
  75713. * @param name Name of the uniform, as used in the uniform block in the shader.
  75714. * @param x Define the x component value of the vec2
  75715. * @param y Define the y component value of the vec2
  75716. */
  75717. addFloat2(name: string, x: number, y: number): void;
  75718. /**
  75719. * Adds a vec3 to the uniform buffer.
  75720. * @param name Name of the uniform, as used in the uniform block in the shader.
  75721. * @param x Define the x component value of the vec3
  75722. * @param y Define the y component value of the vec3
  75723. * @param z Define the z component value of the vec3
  75724. */
  75725. addFloat3(name: string, x: number, y: number, z: number): void;
  75726. /**
  75727. * Adds a vec3 to the uniform buffer.
  75728. * @param name Name of the uniform, as used in the uniform block in the shader.
  75729. * @param color Define the vec3 from a Color
  75730. */
  75731. addColor3(name: string, color: Color3): void;
  75732. /**
  75733. * Adds a vec4 to the uniform buffer.
  75734. * @param name Name of the uniform, as used in the uniform block in the shader.
  75735. * @param color Define the rgb components from a Color
  75736. * @param alpha Define the a component of the vec4
  75737. */
  75738. addColor4(name: string, color: Color3, alpha: number): void;
  75739. /**
  75740. * Adds a vec3 to the uniform buffer.
  75741. * @param name Name of the uniform, as used in the uniform block in the shader.
  75742. * @param vector Define the vec3 components from a Vector
  75743. */
  75744. addVector3(name: string, vector: Vector3): void;
  75745. /**
  75746. * Adds a Matrix 3x3 to the uniform buffer.
  75747. * @param name Name of the uniform, as used in the uniform block in the shader.
  75748. */
  75749. addMatrix3x3(name: string): void;
  75750. /**
  75751. * Adds a Matrix 2x2 to the uniform buffer.
  75752. * @param name Name of the uniform, as used in the uniform block in the shader.
  75753. */
  75754. addMatrix2x2(name: string): void;
  75755. /**
  75756. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  75757. */
  75758. create(): void;
  75759. /** @hidden */
  75760. _rebuild(): void;
  75761. /**
  75762. * Updates the WebGL Uniform Buffer on the GPU.
  75763. * If the `dynamic` flag is set to true, no cache comparison is done.
  75764. * Otherwise, the buffer will be updated only if the cache differs.
  75765. */
  75766. update(): void;
  75767. /**
  75768. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  75769. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75770. * @param data Define the flattened data
  75771. * @param size Define the size of the data.
  75772. */
  75773. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  75774. private _valueCache;
  75775. private _cacheMatrix;
  75776. private _updateMatrix3x3ForUniform;
  75777. private _updateMatrix3x3ForEffect;
  75778. private _updateMatrix2x2ForEffect;
  75779. private _updateMatrix2x2ForUniform;
  75780. private _updateFloatForEffect;
  75781. private _updateFloatForUniform;
  75782. private _updateFloat2ForEffect;
  75783. private _updateFloat2ForUniform;
  75784. private _updateFloat3ForEffect;
  75785. private _updateFloat3ForUniform;
  75786. private _updateFloat4ForEffect;
  75787. private _updateFloat4ForUniform;
  75788. private _updateMatrixForEffect;
  75789. private _updateMatrixForUniform;
  75790. private _updateVector3ForEffect;
  75791. private _updateVector3ForUniform;
  75792. private _updateVector4ForEffect;
  75793. private _updateVector4ForUniform;
  75794. private _updateColor3ForEffect;
  75795. private _updateColor3ForUniform;
  75796. private _updateColor4ForEffect;
  75797. private _updateColor4ForUniform;
  75798. /**
  75799. * Sets a sampler uniform on the effect.
  75800. * @param name Define the name of the sampler.
  75801. * @param texture Define the texture to set in the sampler
  75802. */
  75803. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  75804. /**
  75805. * Directly updates the value of the uniform in the cache AND on the GPU.
  75806. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75807. * @param data Define the flattened data
  75808. */
  75809. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  75810. /**
  75811. * Binds this uniform buffer to an effect.
  75812. * @param effect Define the effect to bind the buffer to
  75813. * @param name Name of the uniform block in the shader.
  75814. */
  75815. bindToEffect(effect: Effect, name: string): void;
  75816. /**
  75817. * Disposes the uniform buffer.
  75818. */
  75819. dispose(): void;
  75820. }
  75821. }
  75822. declare module BABYLON {
  75823. /**
  75824. * Enum that determines the text-wrapping mode to use.
  75825. */
  75826. export enum InspectableType {
  75827. /**
  75828. * Checkbox for booleans
  75829. */
  75830. Checkbox = 0,
  75831. /**
  75832. * Sliders for numbers
  75833. */
  75834. Slider = 1,
  75835. /**
  75836. * Vector3
  75837. */
  75838. Vector3 = 2,
  75839. /**
  75840. * Quaternions
  75841. */
  75842. Quaternion = 3,
  75843. /**
  75844. * Color3
  75845. */
  75846. Color3 = 4,
  75847. /**
  75848. * String
  75849. */
  75850. String = 5
  75851. }
  75852. /**
  75853. * Interface used to define custom inspectable properties.
  75854. * This interface is used by the inspector to display custom property grids
  75855. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  75856. */
  75857. export interface IInspectable {
  75858. /**
  75859. * Gets the label to display
  75860. */
  75861. label: string;
  75862. /**
  75863. * Gets the name of the property to edit
  75864. */
  75865. propertyName: string;
  75866. /**
  75867. * Gets the type of the editor to use
  75868. */
  75869. type: InspectableType;
  75870. /**
  75871. * Gets the minimum value of the property when using in "slider" mode
  75872. */
  75873. min?: number;
  75874. /**
  75875. * Gets the maximum value of the property when using in "slider" mode
  75876. */
  75877. max?: number;
  75878. /**
  75879. * Gets the setp to use when using in "slider" mode
  75880. */
  75881. step?: number;
  75882. }
  75883. }
  75884. declare module BABYLON {
  75885. /**
  75886. * Class used to provide helper for timing
  75887. */
  75888. export class TimingTools {
  75889. /**
  75890. * Polyfill for setImmediate
  75891. * @param action defines the action to execute after the current execution block
  75892. */
  75893. static SetImmediate(action: () => void): void;
  75894. }
  75895. }
  75896. declare module BABYLON {
  75897. /**
  75898. * Class used to enable instatition of objects by class name
  75899. */
  75900. export class InstantiationTools {
  75901. /**
  75902. * Use this object to register external classes like custom textures or material
  75903. * to allow the laoders to instantiate them
  75904. */
  75905. static RegisteredExternalClasses: {
  75906. [key: string]: Object;
  75907. };
  75908. /**
  75909. * Tries to instantiate a new object from a given class name
  75910. * @param className defines the class name to instantiate
  75911. * @returns the new object or null if the system was not able to do the instantiation
  75912. */
  75913. static Instantiate(className: string): any;
  75914. }
  75915. }
  75916. declare module BABYLON {
  75917. /**
  75918. * Define options used to create a depth texture
  75919. */
  75920. export class DepthTextureCreationOptions {
  75921. /** Specifies whether or not a stencil should be allocated in the texture */
  75922. generateStencil?: boolean;
  75923. /** Specifies whether or not bilinear filtering is enable on the texture */
  75924. bilinearFiltering?: boolean;
  75925. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  75926. comparisonFunction?: number;
  75927. /** Specifies if the created texture is a cube texture */
  75928. isCube?: boolean;
  75929. }
  75930. }
  75931. declare module BABYLON {
  75932. interface ThinEngine {
  75933. /**
  75934. * Creates a depth stencil cube texture.
  75935. * This is only available in WebGL 2.
  75936. * @param size The size of face edge in the cube texture.
  75937. * @param options The options defining the cube texture.
  75938. * @returns The cube texture
  75939. */
  75940. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  75941. /**
  75942. * Creates a cube texture
  75943. * @param rootUrl defines the url where the files to load is located
  75944. * @param scene defines the current scene
  75945. * @param files defines the list of files to load (1 per face)
  75946. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75947. * @param onLoad defines an optional callback raised when the texture is loaded
  75948. * @param onError defines an optional callback raised if there is an issue to load the texture
  75949. * @param format defines the format of the data
  75950. * @param forcedExtension defines the extension to use to pick the right loader
  75951. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75952. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75953. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75954. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  75955. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  75956. * @returns the cube texture as an InternalTexture
  75957. */
  75958. 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;
  75959. /**
  75960. * Creates a cube texture
  75961. * @param rootUrl defines the url where the files to load is located
  75962. * @param scene defines the current scene
  75963. * @param files defines the list of files to load (1 per face)
  75964. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75965. * @param onLoad defines an optional callback raised when the texture is loaded
  75966. * @param onError defines an optional callback raised if there is an issue to load the texture
  75967. * @param format defines the format of the data
  75968. * @param forcedExtension defines the extension to use to pick the right loader
  75969. * @returns the cube texture as an InternalTexture
  75970. */
  75971. 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;
  75972. /**
  75973. * Creates a cube texture
  75974. * @param rootUrl defines the url where the files to load is located
  75975. * @param scene defines the current scene
  75976. * @param files defines the list of files to load (1 per face)
  75977. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75978. * @param onLoad defines an optional callback raised when the texture is loaded
  75979. * @param onError defines an optional callback raised if there is an issue to load the texture
  75980. * @param format defines the format of the data
  75981. * @param forcedExtension defines the extension to use to pick the right loader
  75982. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75983. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75984. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75985. * @returns the cube texture as an InternalTexture
  75986. */
  75987. 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;
  75988. /** @hidden */
  75989. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  75990. /** @hidden */
  75991. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  75992. /** @hidden */
  75993. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75994. /** @hidden */
  75995. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75996. /**
  75997. * @hidden
  75998. */
  75999. _setCubeMapTextureParams(loadMipmap: boolean): void;
  76000. }
  76001. }
  76002. declare module BABYLON {
  76003. /**
  76004. * Class for creating a cube texture
  76005. */
  76006. export class CubeTexture extends BaseTexture {
  76007. private _delayedOnLoad;
  76008. /**
  76009. * The url of the texture
  76010. */
  76011. url: string;
  76012. /**
  76013. * Gets or sets the center of the bounding box associated with the cube texture.
  76014. * It must define where the camera used to render the texture was set
  76015. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  76016. */
  76017. boundingBoxPosition: Vector3;
  76018. private _boundingBoxSize;
  76019. /**
  76020. * Gets or sets the size of the bounding box associated with the cube texture
  76021. * When defined, the cubemap will switch to local mode
  76022. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  76023. * @example https://www.babylonjs-playground.com/#RNASML
  76024. */
  76025. /**
  76026. * Returns the bounding box size
  76027. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  76028. */
  76029. boundingBoxSize: Vector3;
  76030. protected _rotationY: number;
  76031. /**
  76032. * Sets texture matrix rotation angle around Y axis in radians.
  76033. */
  76034. /**
  76035. * Gets texture matrix rotation angle around Y axis radians.
  76036. */
  76037. rotationY: number;
  76038. /**
  76039. * Are mip maps generated for this texture or not.
  76040. */
  76041. readonly noMipmap: boolean;
  76042. private _noMipmap;
  76043. private _files;
  76044. protected _forcedExtension: Nullable<string>;
  76045. private _extensions;
  76046. private _textureMatrix;
  76047. private _format;
  76048. private _createPolynomials;
  76049. /** @hidden */
  76050. _prefiltered: boolean;
  76051. /**
  76052. * Creates a cube texture from an array of image urls
  76053. * @param files defines an array of image urls
  76054. * @param scene defines the hosting scene
  76055. * @param noMipmap specifies if mip maps are not used
  76056. * @returns a cube texture
  76057. */
  76058. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  76059. /**
  76060. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  76061. * @param url defines the url of the prefiltered texture
  76062. * @param scene defines the scene the texture is attached to
  76063. * @param forcedExtension defines the extension of the file if different from the url
  76064. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  76065. * @return the prefiltered texture
  76066. */
  76067. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  76068. /**
  76069. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  76070. * as prefiltered data.
  76071. * @param rootUrl defines the url of the texture or the root name of the six images
  76072. * @param scene defines the scene the texture is attached to
  76073. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  76074. * @param noMipmap defines if mipmaps should be created or not
  76075. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  76076. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  76077. * @param onError defines a callback triggered in case of error during load
  76078. * @param format defines the internal format to use for the texture once loaded
  76079. * @param prefiltered defines whether or not the texture is created from prefiltered data
  76080. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  76081. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  76082. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  76083. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  76084. * @return the cube texture
  76085. */
  76086. 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);
  76087. /**
  76088. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  76089. */
  76090. readonly isPrefiltered: boolean;
  76091. /**
  76092. * Get the current class name of the texture useful for serialization or dynamic coding.
  76093. * @returns "CubeTexture"
  76094. */
  76095. getClassName(): string;
  76096. /**
  76097. * Update the url (and optional buffer) of this texture if url was null during construction.
  76098. * @param url the url of the texture
  76099. * @param forcedExtension defines the extension to use
  76100. * @param onLoad callback called when the texture is loaded (defaults to null)
  76101. */
  76102. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  76103. /**
  76104. * Delays loading of the cube texture
  76105. * @param forcedExtension defines the extension to use
  76106. */
  76107. delayLoad(forcedExtension?: string): void;
  76108. /**
  76109. * Returns the reflection texture matrix
  76110. * @returns the reflection texture matrix
  76111. */
  76112. getReflectionTextureMatrix(): Matrix;
  76113. /**
  76114. * Sets the reflection texture matrix
  76115. * @param value Reflection texture matrix
  76116. */
  76117. setReflectionTextureMatrix(value: Matrix): void;
  76118. /**
  76119. * Parses text to create a cube texture
  76120. * @param parsedTexture define the serialized text to read from
  76121. * @param scene defines the hosting scene
  76122. * @param rootUrl defines the root url of the cube texture
  76123. * @returns a cube texture
  76124. */
  76125. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  76126. /**
  76127. * Makes a clone, or deep copy, of the cube texture
  76128. * @returns a new cube texture
  76129. */
  76130. clone(): CubeTexture;
  76131. }
  76132. }
  76133. declare module BABYLON {
  76134. /**
  76135. * Manages the defines for the Material
  76136. */
  76137. export class MaterialDefines {
  76138. /** @hidden */
  76139. protected _keys: string[];
  76140. private _isDirty;
  76141. /** @hidden */
  76142. _renderId: number;
  76143. /** @hidden */
  76144. _areLightsDirty: boolean;
  76145. /** @hidden */
  76146. _areLightsDisposed: boolean;
  76147. /** @hidden */
  76148. _areAttributesDirty: boolean;
  76149. /** @hidden */
  76150. _areTexturesDirty: boolean;
  76151. /** @hidden */
  76152. _areFresnelDirty: boolean;
  76153. /** @hidden */
  76154. _areMiscDirty: boolean;
  76155. /** @hidden */
  76156. _areImageProcessingDirty: boolean;
  76157. /** @hidden */
  76158. _normals: boolean;
  76159. /** @hidden */
  76160. _uvs: boolean;
  76161. /** @hidden */
  76162. _needNormals: boolean;
  76163. /** @hidden */
  76164. _needUVs: boolean;
  76165. [id: string]: any;
  76166. /**
  76167. * Specifies if the material needs to be re-calculated
  76168. */
  76169. readonly isDirty: boolean;
  76170. /**
  76171. * Marks the material to indicate that it has been re-calculated
  76172. */
  76173. markAsProcessed(): void;
  76174. /**
  76175. * Marks the material to indicate that it needs to be re-calculated
  76176. */
  76177. markAsUnprocessed(): void;
  76178. /**
  76179. * Marks the material to indicate all of its defines need to be re-calculated
  76180. */
  76181. markAllAsDirty(): void;
  76182. /**
  76183. * Marks the material to indicate that image processing needs to be re-calculated
  76184. */
  76185. markAsImageProcessingDirty(): void;
  76186. /**
  76187. * Marks the material to indicate the lights need to be re-calculated
  76188. * @param disposed Defines whether the light is dirty due to dispose or not
  76189. */
  76190. markAsLightDirty(disposed?: boolean): void;
  76191. /**
  76192. * Marks the attribute state as changed
  76193. */
  76194. markAsAttributesDirty(): void;
  76195. /**
  76196. * Marks the texture state as changed
  76197. */
  76198. markAsTexturesDirty(): void;
  76199. /**
  76200. * Marks the fresnel state as changed
  76201. */
  76202. markAsFresnelDirty(): void;
  76203. /**
  76204. * Marks the misc state as changed
  76205. */
  76206. markAsMiscDirty(): void;
  76207. /**
  76208. * Rebuilds the material defines
  76209. */
  76210. rebuild(): void;
  76211. /**
  76212. * Specifies if two material defines are equal
  76213. * @param other - A material define instance to compare to
  76214. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  76215. */
  76216. isEqual(other: MaterialDefines): boolean;
  76217. /**
  76218. * Clones this instance's defines to another instance
  76219. * @param other - material defines to clone values to
  76220. */
  76221. cloneTo(other: MaterialDefines): void;
  76222. /**
  76223. * Resets the material define values
  76224. */
  76225. reset(): void;
  76226. /**
  76227. * Converts the material define values to a string
  76228. * @returns - String of material define information
  76229. */
  76230. toString(): string;
  76231. }
  76232. }
  76233. declare module BABYLON {
  76234. /**
  76235. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  76236. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  76237. * 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;
  76238. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  76239. */
  76240. export class ColorCurves {
  76241. private _dirty;
  76242. private _tempColor;
  76243. private _globalCurve;
  76244. private _highlightsCurve;
  76245. private _midtonesCurve;
  76246. private _shadowsCurve;
  76247. private _positiveCurve;
  76248. private _negativeCurve;
  76249. private _globalHue;
  76250. private _globalDensity;
  76251. private _globalSaturation;
  76252. private _globalExposure;
  76253. /**
  76254. * Gets the global Hue value.
  76255. * 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).
  76256. */
  76257. /**
  76258. * Sets the global Hue value.
  76259. * 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).
  76260. */
  76261. globalHue: number;
  76262. /**
  76263. * Gets the global Density value.
  76264. * 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.
  76265. * Values less than zero provide a filter of opposite hue.
  76266. */
  76267. /**
  76268. * Sets the global Density value.
  76269. * 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.
  76270. * Values less than zero provide a filter of opposite hue.
  76271. */
  76272. globalDensity: number;
  76273. /**
  76274. * Gets the global Saturation value.
  76275. * 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.
  76276. */
  76277. /**
  76278. * Sets the global Saturation value.
  76279. * 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.
  76280. */
  76281. globalSaturation: number;
  76282. /**
  76283. * Gets the global Exposure value.
  76284. * 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.
  76285. */
  76286. /**
  76287. * Sets the global Exposure value.
  76288. * 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.
  76289. */
  76290. globalExposure: number;
  76291. private _highlightsHue;
  76292. private _highlightsDensity;
  76293. private _highlightsSaturation;
  76294. private _highlightsExposure;
  76295. /**
  76296. * Gets the highlights Hue value.
  76297. * 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).
  76298. */
  76299. /**
  76300. * Sets the highlights Hue value.
  76301. * 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).
  76302. */
  76303. highlightsHue: number;
  76304. /**
  76305. * Gets the highlights Density value.
  76306. * 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.
  76307. * Values less than zero provide a filter of opposite hue.
  76308. */
  76309. /**
  76310. * Sets the highlights Density value.
  76311. * 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.
  76312. * Values less than zero provide a filter of opposite hue.
  76313. */
  76314. highlightsDensity: number;
  76315. /**
  76316. * Gets the highlights Saturation value.
  76317. * 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.
  76318. */
  76319. /**
  76320. * Sets the highlights Saturation value.
  76321. * 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.
  76322. */
  76323. highlightsSaturation: number;
  76324. /**
  76325. * Gets the highlights Exposure value.
  76326. * 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.
  76327. */
  76328. /**
  76329. * Sets the highlights Exposure value.
  76330. * 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.
  76331. */
  76332. highlightsExposure: number;
  76333. private _midtonesHue;
  76334. private _midtonesDensity;
  76335. private _midtonesSaturation;
  76336. private _midtonesExposure;
  76337. /**
  76338. * Gets the midtones Hue value.
  76339. * 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).
  76340. */
  76341. /**
  76342. * Sets the midtones Hue value.
  76343. * 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).
  76344. */
  76345. midtonesHue: number;
  76346. /**
  76347. * Gets the midtones Density value.
  76348. * 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.
  76349. * Values less than zero provide a filter of opposite hue.
  76350. */
  76351. /**
  76352. * Sets the midtones Density value.
  76353. * 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.
  76354. * Values less than zero provide a filter of opposite hue.
  76355. */
  76356. midtonesDensity: number;
  76357. /**
  76358. * Gets the midtones Saturation value.
  76359. * 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.
  76360. */
  76361. /**
  76362. * Sets the midtones Saturation value.
  76363. * 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.
  76364. */
  76365. midtonesSaturation: number;
  76366. /**
  76367. * Gets the midtones Exposure value.
  76368. * 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.
  76369. */
  76370. /**
  76371. * Sets the midtones Exposure value.
  76372. * 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.
  76373. */
  76374. midtonesExposure: number;
  76375. private _shadowsHue;
  76376. private _shadowsDensity;
  76377. private _shadowsSaturation;
  76378. private _shadowsExposure;
  76379. /**
  76380. * Gets the shadows Hue value.
  76381. * 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).
  76382. */
  76383. /**
  76384. * Sets the shadows Hue value.
  76385. * 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).
  76386. */
  76387. shadowsHue: number;
  76388. /**
  76389. * Gets the shadows Density value.
  76390. * 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.
  76391. * Values less than zero provide a filter of opposite hue.
  76392. */
  76393. /**
  76394. * Sets the shadows Density value.
  76395. * 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.
  76396. * Values less than zero provide a filter of opposite hue.
  76397. */
  76398. shadowsDensity: number;
  76399. /**
  76400. * Gets the shadows Saturation value.
  76401. * 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.
  76402. */
  76403. /**
  76404. * Sets the shadows Saturation value.
  76405. * 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.
  76406. */
  76407. shadowsSaturation: number;
  76408. /**
  76409. * Gets the shadows Exposure value.
  76410. * 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.
  76411. */
  76412. /**
  76413. * Sets the shadows Exposure value.
  76414. * 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.
  76415. */
  76416. shadowsExposure: number;
  76417. /**
  76418. * Returns the class name
  76419. * @returns The class name
  76420. */
  76421. getClassName(): string;
  76422. /**
  76423. * Binds the color curves to the shader.
  76424. * @param colorCurves The color curve to bind
  76425. * @param effect The effect to bind to
  76426. * @param positiveUniform The positive uniform shader parameter
  76427. * @param neutralUniform The neutral uniform shader parameter
  76428. * @param negativeUniform The negative uniform shader parameter
  76429. */
  76430. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  76431. /**
  76432. * Prepare the list of uniforms associated with the ColorCurves effects.
  76433. * @param uniformsList The list of uniforms used in the effect
  76434. */
  76435. static PrepareUniforms(uniformsList: string[]): void;
  76436. /**
  76437. * Returns color grading data based on a hue, density, saturation and exposure value.
  76438. * @param filterHue The hue of the color filter.
  76439. * @param filterDensity The density of the color filter.
  76440. * @param saturation The saturation.
  76441. * @param exposure The exposure.
  76442. * @param result The result data container.
  76443. */
  76444. private getColorGradingDataToRef;
  76445. /**
  76446. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  76447. * @param value The input slider value in range [-100,100].
  76448. * @returns Adjusted value.
  76449. */
  76450. private static applyColorGradingSliderNonlinear;
  76451. /**
  76452. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  76453. * @param hue The hue (H) input.
  76454. * @param saturation The saturation (S) input.
  76455. * @param brightness The brightness (B) input.
  76456. * @result An RGBA color represented as Vector4.
  76457. */
  76458. private static fromHSBToRef;
  76459. /**
  76460. * Returns a value clamped between min and max
  76461. * @param value The value to clamp
  76462. * @param min The minimum of value
  76463. * @param max The maximum of value
  76464. * @returns The clamped value.
  76465. */
  76466. private static clamp;
  76467. /**
  76468. * Clones the current color curve instance.
  76469. * @return The cloned curves
  76470. */
  76471. clone(): ColorCurves;
  76472. /**
  76473. * Serializes the current color curve instance to a json representation.
  76474. * @return a JSON representation
  76475. */
  76476. serialize(): any;
  76477. /**
  76478. * Parses the color curve from a json representation.
  76479. * @param source the JSON source to parse
  76480. * @return The parsed curves
  76481. */
  76482. static Parse(source: any): ColorCurves;
  76483. }
  76484. }
  76485. declare module BABYLON {
  76486. /**
  76487. * Interface to follow in your material defines to integrate easily the
  76488. * Image proccessing functions.
  76489. * @hidden
  76490. */
  76491. export interface IImageProcessingConfigurationDefines {
  76492. IMAGEPROCESSING: boolean;
  76493. VIGNETTE: boolean;
  76494. VIGNETTEBLENDMODEMULTIPLY: boolean;
  76495. VIGNETTEBLENDMODEOPAQUE: boolean;
  76496. TONEMAPPING: boolean;
  76497. TONEMAPPING_ACES: boolean;
  76498. CONTRAST: boolean;
  76499. EXPOSURE: boolean;
  76500. COLORCURVES: boolean;
  76501. COLORGRADING: boolean;
  76502. COLORGRADING3D: boolean;
  76503. SAMPLER3DGREENDEPTH: boolean;
  76504. SAMPLER3DBGRMAP: boolean;
  76505. IMAGEPROCESSINGPOSTPROCESS: boolean;
  76506. }
  76507. /**
  76508. * @hidden
  76509. */
  76510. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  76511. IMAGEPROCESSING: boolean;
  76512. VIGNETTE: boolean;
  76513. VIGNETTEBLENDMODEMULTIPLY: boolean;
  76514. VIGNETTEBLENDMODEOPAQUE: boolean;
  76515. TONEMAPPING: boolean;
  76516. TONEMAPPING_ACES: boolean;
  76517. CONTRAST: boolean;
  76518. COLORCURVES: boolean;
  76519. COLORGRADING: boolean;
  76520. COLORGRADING3D: boolean;
  76521. SAMPLER3DGREENDEPTH: boolean;
  76522. SAMPLER3DBGRMAP: boolean;
  76523. IMAGEPROCESSINGPOSTPROCESS: boolean;
  76524. EXPOSURE: boolean;
  76525. constructor();
  76526. }
  76527. /**
  76528. * This groups together the common properties used for image processing either in direct forward pass
  76529. * or through post processing effect depending on the use of the image processing pipeline in your scene
  76530. * or not.
  76531. */
  76532. export class ImageProcessingConfiguration {
  76533. /**
  76534. * Default tone mapping applied in BabylonJS.
  76535. */
  76536. static readonly TONEMAPPING_STANDARD: number;
  76537. /**
  76538. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  76539. * to other engines rendering to increase portability.
  76540. */
  76541. static readonly TONEMAPPING_ACES: number;
  76542. /**
  76543. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  76544. */
  76545. colorCurves: Nullable<ColorCurves>;
  76546. private _colorCurvesEnabled;
  76547. /**
  76548. * Gets wether the color curves effect is enabled.
  76549. */
  76550. /**
  76551. * Sets wether the color curves effect is enabled.
  76552. */
  76553. colorCurvesEnabled: boolean;
  76554. private _colorGradingTexture;
  76555. /**
  76556. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  76557. */
  76558. /**
  76559. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  76560. */
  76561. colorGradingTexture: Nullable<BaseTexture>;
  76562. private _colorGradingEnabled;
  76563. /**
  76564. * Gets wether the color grading effect is enabled.
  76565. */
  76566. /**
  76567. * Sets wether the color grading effect is enabled.
  76568. */
  76569. colorGradingEnabled: boolean;
  76570. private _colorGradingWithGreenDepth;
  76571. /**
  76572. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  76573. */
  76574. /**
  76575. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  76576. */
  76577. colorGradingWithGreenDepth: boolean;
  76578. private _colorGradingBGR;
  76579. /**
  76580. * Gets wether the color grading texture contains BGR values.
  76581. */
  76582. /**
  76583. * Sets wether the color grading texture contains BGR values.
  76584. */
  76585. colorGradingBGR: boolean;
  76586. /** @hidden */
  76587. _exposure: number;
  76588. /**
  76589. * Gets the Exposure used in the effect.
  76590. */
  76591. /**
  76592. * Sets the Exposure used in the effect.
  76593. */
  76594. exposure: number;
  76595. private _toneMappingEnabled;
  76596. /**
  76597. * Gets wether the tone mapping effect is enabled.
  76598. */
  76599. /**
  76600. * Sets wether the tone mapping effect is enabled.
  76601. */
  76602. toneMappingEnabled: boolean;
  76603. private _toneMappingType;
  76604. /**
  76605. * Gets the type of tone mapping effect.
  76606. */
  76607. /**
  76608. * Sets the type of tone mapping effect used in BabylonJS.
  76609. */
  76610. toneMappingType: number;
  76611. protected _contrast: number;
  76612. /**
  76613. * Gets the contrast used in the effect.
  76614. */
  76615. /**
  76616. * Sets the contrast used in the effect.
  76617. */
  76618. contrast: number;
  76619. /**
  76620. * Vignette stretch size.
  76621. */
  76622. vignetteStretch: number;
  76623. /**
  76624. * Vignette centre X Offset.
  76625. */
  76626. vignetteCentreX: number;
  76627. /**
  76628. * Vignette centre Y Offset.
  76629. */
  76630. vignetteCentreY: number;
  76631. /**
  76632. * Vignette weight or intensity of the vignette effect.
  76633. */
  76634. vignetteWeight: number;
  76635. /**
  76636. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  76637. * if vignetteEnabled is set to true.
  76638. */
  76639. vignetteColor: Color4;
  76640. /**
  76641. * Camera field of view used by the Vignette effect.
  76642. */
  76643. vignetteCameraFov: number;
  76644. private _vignetteBlendMode;
  76645. /**
  76646. * Gets the vignette blend mode allowing different kind of effect.
  76647. */
  76648. /**
  76649. * Sets the vignette blend mode allowing different kind of effect.
  76650. */
  76651. vignetteBlendMode: number;
  76652. private _vignetteEnabled;
  76653. /**
  76654. * Gets wether the vignette effect is enabled.
  76655. */
  76656. /**
  76657. * Sets wether the vignette effect is enabled.
  76658. */
  76659. vignetteEnabled: boolean;
  76660. private _applyByPostProcess;
  76661. /**
  76662. * Gets wether the image processing is applied through a post process or not.
  76663. */
  76664. /**
  76665. * Sets wether the image processing is applied through a post process or not.
  76666. */
  76667. applyByPostProcess: boolean;
  76668. private _isEnabled;
  76669. /**
  76670. * Gets wether the image processing is enabled or not.
  76671. */
  76672. /**
  76673. * Sets wether the image processing is enabled or not.
  76674. */
  76675. isEnabled: boolean;
  76676. /**
  76677. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  76678. */
  76679. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  76680. /**
  76681. * Method called each time the image processing information changes requires to recompile the effect.
  76682. */
  76683. protected _updateParameters(): void;
  76684. /**
  76685. * Gets the current class name.
  76686. * @return "ImageProcessingConfiguration"
  76687. */
  76688. getClassName(): string;
  76689. /**
  76690. * Prepare the list of uniforms associated with the Image Processing effects.
  76691. * @param uniforms The list of uniforms used in the effect
  76692. * @param defines the list of defines currently in use
  76693. */
  76694. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  76695. /**
  76696. * Prepare the list of samplers associated with the Image Processing effects.
  76697. * @param samplersList The list of uniforms used in the effect
  76698. * @param defines the list of defines currently in use
  76699. */
  76700. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  76701. /**
  76702. * Prepare the list of defines associated to the shader.
  76703. * @param defines the list of defines to complete
  76704. * @param forPostProcess Define if we are currently in post process mode or not
  76705. */
  76706. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  76707. /**
  76708. * Returns true if all the image processing information are ready.
  76709. * @returns True if ready, otherwise, false
  76710. */
  76711. isReady(): boolean;
  76712. /**
  76713. * Binds the image processing to the shader.
  76714. * @param effect The effect to bind to
  76715. * @param overrideAspectRatio Override the aspect ratio of the effect
  76716. */
  76717. bind(effect: Effect, overrideAspectRatio?: number): void;
  76718. /**
  76719. * Clones the current image processing instance.
  76720. * @return The cloned image processing
  76721. */
  76722. clone(): ImageProcessingConfiguration;
  76723. /**
  76724. * Serializes the current image processing instance to a json representation.
  76725. * @return a JSON representation
  76726. */
  76727. serialize(): any;
  76728. /**
  76729. * Parses the image processing from a json representation.
  76730. * @param source the JSON source to parse
  76731. * @return The parsed image processing
  76732. */
  76733. static Parse(source: any): ImageProcessingConfiguration;
  76734. private static _VIGNETTEMODE_MULTIPLY;
  76735. private static _VIGNETTEMODE_OPAQUE;
  76736. /**
  76737. * Used to apply the vignette as a mix with the pixel color.
  76738. */
  76739. static readonly VIGNETTEMODE_MULTIPLY: number;
  76740. /**
  76741. * Used to apply the vignette as a replacement of the pixel color.
  76742. */
  76743. static readonly VIGNETTEMODE_OPAQUE: number;
  76744. }
  76745. }
  76746. declare module BABYLON {
  76747. /** @hidden */
  76748. export var postprocessVertexShader: {
  76749. name: string;
  76750. shader: string;
  76751. };
  76752. }
  76753. declare module BABYLON {
  76754. interface ThinEngine {
  76755. /**
  76756. * Creates a new render target texture
  76757. * @param size defines the size of the texture
  76758. * @param options defines the options used to create the texture
  76759. * @returns a new render target texture stored in an InternalTexture
  76760. */
  76761. createRenderTargetTexture(size: number | {
  76762. width: number;
  76763. height: number;
  76764. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  76765. /**
  76766. * Creates a depth stencil texture.
  76767. * This is only available in WebGL 2 or with the depth texture extension available.
  76768. * @param size The size of face edge in the texture.
  76769. * @param options The options defining the texture.
  76770. * @returns The texture
  76771. */
  76772. createDepthStencilTexture(size: number | {
  76773. width: number;
  76774. height: number;
  76775. }, options: DepthTextureCreationOptions): InternalTexture;
  76776. /** @hidden */
  76777. _createDepthStencilTexture(size: number | {
  76778. width: number;
  76779. height: number;
  76780. }, options: DepthTextureCreationOptions): InternalTexture;
  76781. }
  76782. }
  76783. declare module BABYLON {
  76784. /** Defines supported spaces */
  76785. export enum Space {
  76786. /** Local (object) space */
  76787. LOCAL = 0,
  76788. /** World space */
  76789. WORLD = 1,
  76790. /** Bone space */
  76791. BONE = 2
  76792. }
  76793. /** Defines the 3 main axes */
  76794. export class Axis {
  76795. /** X axis */
  76796. static X: Vector3;
  76797. /** Y axis */
  76798. static Y: Vector3;
  76799. /** Z axis */
  76800. static Z: Vector3;
  76801. }
  76802. }
  76803. declare module BABYLON {
  76804. /**
  76805. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  76806. * This is the base of the follow, arc rotate cameras and Free camera
  76807. * @see http://doc.babylonjs.com/features/cameras
  76808. */
  76809. export class TargetCamera extends Camera {
  76810. private static _RigCamTransformMatrix;
  76811. private static _TargetTransformMatrix;
  76812. private static _TargetFocalPoint;
  76813. /**
  76814. * Define the current direction the camera is moving to
  76815. */
  76816. cameraDirection: Vector3;
  76817. /**
  76818. * Define the current rotation the camera is rotating to
  76819. */
  76820. cameraRotation: Vector2;
  76821. /**
  76822. * When set, the up vector of the camera will be updated by the rotation of the camera
  76823. */
  76824. updateUpVectorFromRotation: boolean;
  76825. private _tmpQuaternion;
  76826. /**
  76827. * Define the current rotation of the camera
  76828. */
  76829. rotation: Vector3;
  76830. /**
  76831. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  76832. */
  76833. rotationQuaternion: Quaternion;
  76834. /**
  76835. * Define the current speed of the camera
  76836. */
  76837. speed: number;
  76838. /**
  76839. * Add constraint to the camera to prevent it to move freely in all directions and
  76840. * around all axis.
  76841. */
  76842. noRotationConstraint: boolean;
  76843. /**
  76844. * Define the current target of the camera as an object or a position.
  76845. */
  76846. lockedTarget: any;
  76847. /** @hidden */
  76848. _currentTarget: Vector3;
  76849. /** @hidden */
  76850. _initialFocalDistance: number;
  76851. /** @hidden */
  76852. _viewMatrix: Matrix;
  76853. /** @hidden */
  76854. _camMatrix: Matrix;
  76855. /** @hidden */
  76856. _cameraTransformMatrix: Matrix;
  76857. /** @hidden */
  76858. _cameraRotationMatrix: Matrix;
  76859. /** @hidden */
  76860. _referencePoint: Vector3;
  76861. /** @hidden */
  76862. _transformedReferencePoint: Vector3;
  76863. protected _globalCurrentTarget: Vector3;
  76864. protected _globalCurrentUpVector: Vector3;
  76865. /** @hidden */
  76866. _reset: () => void;
  76867. private _defaultUp;
  76868. /**
  76869. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  76870. * This is the base of the follow, arc rotate cameras and Free camera
  76871. * @see http://doc.babylonjs.com/features/cameras
  76872. * @param name Defines the name of the camera in the scene
  76873. * @param position Defines the start position of the camera in the scene
  76874. * @param scene Defines the scene the camera belongs to
  76875. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  76876. */
  76877. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  76878. /**
  76879. * Gets the position in front of the camera at a given distance.
  76880. * @param distance The distance from the camera we want the position to be
  76881. * @returns the position
  76882. */
  76883. getFrontPosition(distance: number): Vector3;
  76884. /** @hidden */
  76885. _getLockedTargetPosition(): Nullable<Vector3>;
  76886. private _storedPosition;
  76887. private _storedRotation;
  76888. private _storedRotationQuaternion;
  76889. /**
  76890. * Store current camera state of the camera (fov, position, rotation, etc..)
  76891. * @returns the camera
  76892. */
  76893. storeState(): Camera;
  76894. /**
  76895. * Restored camera state. You must call storeState() first
  76896. * @returns whether it was successful or not
  76897. * @hidden
  76898. */
  76899. _restoreStateValues(): boolean;
  76900. /** @hidden */
  76901. _initCache(): void;
  76902. /** @hidden */
  76903. _updateCache(ignoreParentClass?: boolean): void;
  76904. /** @hidden */
  76905. _isSynchronizedViewMatrix(): boolean;
  76906. /** @hidden */
  76907. _computeLocalCameraSpeed(): number;
  76908. /**
  76909. * Defines the target the camera should look at.
  76910. * @param target Defines the new target as a Vector or a mesh
  76911. */
  76912. setTarget(target: Vector3): void;
  76913. /**
  76914. * Return the current target position of the camera. This value is expressed in local space.
  76915. * @returns the target position
  76916. */
  76917. getTarget(): Vector3;
  76918. /** @hidden */
  76919. _decideIfNeedsToMove(): boolean;
  76920. /** @hidden */
  76921. _updatePosition(): void;
  76922. /** @hidden */
  76923. _checkInputs(): void;
  76924. protected _updateCameraRotationMatrix(): void;
  76925. /**
  76926. * 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)
  76927. * @returns the current camera
  76928. */
  76929. private _rotateUpVectorWithCameraRotationMatrix;
  76930. private _cachedRotationZ;
  76931. private _cachedQuaternionRotationZ;
  76932. /** @hidden */
  76933. _getViewMatrix(): Matrix;
  76934. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  76935. /**
  76936. * @hidden
  76937. */
  76938. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  76939. /**
  76940. * @hidden
  76941. */
  76942. _updateRigCameras(): void;
  76943. private _getRigCamPositionAndTarget;
  76944. /**
  76945. * Gets the current object class name.
  76946. * @return the class name
  76947. */
  76948. getClassName(): string;
  76949. }
  76950. }
  76951. declare module BABYLON {
  76952. /**
  76953. * Gather the list of keyboard event types as constants.
  76954. */
  76955. export class KeyboardEventTypes {
  76956. /**
  76957. * The keydown event is fired when a key becomes active (pressed).
  76958. */
  76959. static readonly KEYDOWN: number;
  76960. /**
  76961. * The keyup event is fired when a key has been released.
  76962. */
  76963. static readonly KEYUP: number;
  76964. }
  76965. /**
  76966. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76967. */
  76968. export class KeyboardInfo {
  76969. /**
  76970. * Defines the type of event (KeyboardEventTypes)
  76971. */
  76972. type: number;
  76973. /**
  76974. * Defines the related dom event
  76975. */
  76976. event: KeyboardEvent;
  76977. /**
  76978. * Instantiates a new keyboard info.
  76979. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76980. * @param type Defines the type of event (KeyboardEventTypes)
  76981. * @param event Defines the related dom event
  76982. */
  76983. constructor(
  76984. /**
  76985. * Defines the type of event (KeyboardEventTypes)
  76986. */
  76987. type: number,
  76988. /**
  76989. * Defines the related dom event
  76990. */
  76991. event: KeyboardEvent);
  76992. }
  76993. /**
  76994. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76995. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  76996. */
  76997. export class KeyboardInfoPre extends KeyboardInfo {
  76998. /**
  76999. * Defines the type of event (KeyboardEventTypes)
  77000. */
  77001. type: number;
  77002. /**
  77003. * Defines the related dom event
  77004. */
  77005. event: KeyboardEvent;
  77006. /**
  77007. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  77008. */
  77009. skipOnPointerObservable: boolean;
  77010. /**
  77011. * Instantiates a new keyboard pre info.
  77012. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  77013. * @param type Defines the type of event (KeyboardEventTypes)
  77014. * @param event Defines the related dom event
  77015. */
  77016. constructor(
  77017. /**
  77018. * Defines the type of event (KeyboardEventTypes)
  77019. */
  77020. type: number,
  77021. /**
  77022. * Defines the related dom event
  77023. */
  77024. event: KeyboardEvent);
  77025. }
  77026. }
  77027. declare module BABYLON {
  77028. /**
  77029. * Manage the keyboard inputs to control the movement of a free camera.
  77030. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  77031. */
  77032. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  77033. /**
  77034. * Defines the camera the input is attached to.
  77035. */
  77036. camera: FreeCamera;
  77037. /**
  77038. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  77039. */
  77040. keysUp: number[];
  77041. /**
  77042. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  77043. */
  77044. keysDown: number[];
  77045. /**
  77046. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  77047. */
  77048. keysLeft: number[];
  77049. /**
  77050. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  77051. */
  77052. keysRight: number[];
  77053. private _keys;
  77054. private _onCanvasBlurObserver;
  77055. private _onKeyboardObserver;
  77056. private _engine;
  77057. private _scene;
  77058. /**
  77059. * Attach the input controls to a specific dom element to get the input from.
  77060. * @param element Defines the element the controls should be listened from
  77061. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  77062. */
  77063. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  77064. /**
  77065. * Detach the current controls from the specified dom element.
  77066. * @param element Defines the element to stop listening the inputs from
  77067. */
  77068. detachControl(element: Nullable<HTMLElement>): void;
  77069. /**
  77070. * Update the current camera state depending on the inputs that have been used this frame.
  77071. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  77072. */
  77073. checkInputs(): void;
  77074. /**
  77075. * Gets the class name of the current intput.
  77076. * @returns the class name
  77077. */
  77078. getClassName(): string;
  77079. /** @hidden */
  77080. _onLostFocus(): void;
  77081. /**
  77082. * Get the friendly name associated with the input class.
  77083. * @returns the input friendly name
  77084. */
  77085. getSimpleName(): string;
  77086. }
  77087. }
  77088. declare module BABYLON {
  77089. /**
  77090. * Interface describing all the common properties and methods a shadow light needs to implement.
  77091. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  77092. * as well as binding the different shadow properties to the effects.
  77093. */
  77094. export interface IShadowLight extends Light {
  77095. /**
  77096. * The light id in the scene (used in scene.findLighById for instance)
  77097. */
  77098. id: string;
  77099. /**
  77100. * The position the shdow will be casted from.
  77101. */
  77102. position: Vector3;
  77103. /**
  77104. * In 2d mode (needCube being false), the direction used to cast the shadow.
  77105. */
  77106. direction: Vector3;
  77107. /**
  77108. * The transformed position. Position of the light in world space taking parenting in account.
  77109. */
  77110. transformedPosition: Vector3;
  77111. /**
  77112. * The transformed direction. Direction of the light in world space taking parenting in account.
  77113. */
  77114. transformedDirection: Vector3;
  77115. /**
  77116. * The friendly name of the light in the scene.
  77117. */
  77118. name: string;
  77119. /**
  77120. * Defines the shadow projection clipping minimum z value.
  77121. */
  77122. shadowMinZ: number;
  77123. /**
  77124. * Defines the shadow projection clipping maximum z value.
  77125. */
  77126. shadowMaxZ: number;
  77127. /**
  77128. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  77129. * @returns true if the information has been computed, false if it does not need to (no parenting)
  77130. */
  77131. computeTransformedInformation(): boolean;
  77132. /**
  77133. * Gets the scene the light belongs to.
  77134. * @returns The scene
  77135. */
  77136. getScene(): Scene;
  77137. /**
  77138. * Callback defining a custom Projection Matrix Builder.
  77139. * This can be used to override the default projection matrix computation.
  77140. */
  77141. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  77142. /**
  77143. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  77144. * @param matrix The materix to updated with the projection information
  77145. * @param viewMatrix The transform matrix of the light
  77146. * @param renderList The list of mesh to render in the map
  77147. * @returns The current light
  77148. */
  77149. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  77150. /**
  77151. * Gets the current depth scale used in ESM.
  77152. * @returns The scale
  77153. */
  77154. getDepthScale(): number;
  77155. /**
  77156. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  77157. * @returns true if a cube texture needs to be use
  77158. */
  77159. needCube(): boolean;
  77160. /**
  77161. * Detects if the projection matrix requires to be recomputed this frame.
  77162. * @returns true if it requires to be recomputed otherwise, false.
  77163. */
  77164. needProjectionMatrixCompute(): boolean;
  77165. /**
  77166. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  77167. */
  77168. forceProjectionMatrixCompute(): void;
  77169. /**
  77170. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  77171. * @param faceIndex The index of the face we are computed the direction to generate shadow
  77172. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  77173. */
  77174. getShadowDirection(faceIndex?: number): Vector3;
  77175. /**
  77176. * Gets the minZ used for shadow according to both the scene and the light.
  77177. * @param activeCamera The camera we are returning the min for
  77178. * @returns the depth min z
  77179. */
  77180. getDepthMinZ(activeCamera: Camera): number;
  77181. /**
  77182. * Gets the maxZ used for shadow according to both the scene and the light.
  77183. * @param activeCamera The camera we are returning the max for
  77184. * @returns the depth max z
  77185. */
  77186. getDepthMaxZ(activeCamera: Camera): number;
  77187. }
  77188. /**
  77189. * Base implementation IShadowLight
  77190. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  77191. */
  77192. export abstract class ShadowLight extends Light implements IShadowLight {
  77193. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  77194. protected _position: Vector3;
  77195. protected _setPosition(value: Vector3): void;
  77196. /**
  77197. * Sets the position the shadow will be casted from. Also use as the light position for both
  77198. * point and spot lights.
  77199. */
  77200. /**
  77201. * Sets the position the shadow will be casted from. Also use as the light position for both
  77202. * point and spot lights.
  77203. */
  77204. position: Vector3;
  77205. protected _direction: Vector3;
  77206. protected _setDirection(value: Vector3): void;
  77207. /**
  77208. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  77209. * Also use as the light direction on spot and directional lights.
  77210. */
  77211. /**
  77212. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  77213. * Also use as the light direction on spot and directional lights.
  77214. */
  77215. direction: Vector3;
  77216. private _shadowMinZ;
  77217. /**
  77218. * Gets the shadow projection clipping minimum z value.
  77219. */
  77220. /**
  77221. * Sets the shadow projection clipping minimum z value.
  77222. */
  77223. shadowMinZ: number;
  77224. private _shadowMaxZ;
  77225. /**
  77226. * Sets the shadow projection clipping maximum z value.
  77227. */
  77228. /**
  77229. * Gets the shadow projection clipping maximum z value.
  77230. */
  77231. shadowMaxZ: number;
  77232. /**
  77233. * Callback defining a custom Projection Matrix Builder.
  77234. * This can be used to override the default projection matrix computation.
  77235. */
  77236. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  77237. /**
  77238. * The transformed position. Position of the light in world space taking parenting in account.
  77239. */
  77240. transformedPosition: Vector3;
  77241. /**
  77242. * The transformed direction. Direction of the light in world space taking parenting in account.
  77243. */
  77244. transformedDirection: Vector3;
  77245. private _needProjectionMatrixCompute;
  77246. /**
  77247. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  77248. * @returns true if the information has been computed, false if it does not need to (no parenting)
  77249. */
  77250. computeTransformedInformation(): boolean;
  77251. /**
  77252. * Return the depth scale used for the shadow map.
  77253. * @returns the depth scale.
  77254. */
  77255. getDepthScale(): number;
  77256. /**
  77257. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  77258. * @param faceIndex The index of the face we are computed the direction to generate shadow
  77259. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  77260. */
  77261. getShadowDirection(faceIndex?: number): Vector3;
  77262. /**
  77263. * Returns the ShadowLight absolute position in the World.
  77264. * @returns the position vector in world space
  77265. */
  77266. getAbsolutePosition(): Vector3;
  77267. /**
  77268. * Sets the ShadowLight direction toward the passed target.
  77269. * @param target The point to target in local space
  77270. * @returns the updated ShadowLight direction
  77271. */
  77272. setDirectionToTarget(target: Vector3): Vector3;
  77273. /**
  77274. * Returns the light rotation in euler definition.
  77275. * @returns the x y z rotation in local space.
  77276. */
  77277. getRotation(): Vector3;
  77278. /**
  77279. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  77280. * @returns true if a cube texture needs to be use
  77281. */
  77282. needCube(): boolean;
  77283. /**
  77284. * Detects if the projection matrix requires to be recomputed this frame.
  77285. * @returns true if it requires to be recomputed otherwise, false.
  77286. */
  77287. needProjectionMatrixCompute(): boolean;
  77288. /**
  77289. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  77290. */
  77291. forceProjectionMatrixCompute(): void;
  77292. /** @hidden */
  77293. _initCache(): void;
  77294. /** @hidden */
  77295. _isSynchronized(): boolean;
  77296. /**
  77297. * Computes the world matrix of the node
  77298. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  77299. * @returns the world matrix
  77300. */
  77301. computeWorldMatrix(force?: boolean): Matrix;
  77302. /**
  77303. * Gets the minZ used for shadow according to both the scene and the light.
  77304. * @param activeCamera The camera we are returning the min for
  77305. * @returns the depth min z
  77306. */
  77307. getDepthMinZ(activeCamera: Camera): number;
  77308. /**
  77309. * Gets the maxZ used for shadow according to both the scene and the light.
  77310. * @param activeCamera The camera we are returning the max for
  77311. * @returns the depth max z
  77312. */
  77313. getDepthMaxZ(activeCamera: Camera): number;
  77314. /**
  77315. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  77316. * @param matrix The materix to updated with the projection information
  77317. * @param viewMatrix The transform matrix of the light
  77318. * @param renderList The list of mesh to render in the map
  77319. * @returns The current light
  77320. */
  77321. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  77322. }
  77323. }
  77324. declare module BABYLON {
  77325. /**
  77326. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  77327. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  77328. */
  77329. export class EffectFallbacks implements IEffectFallbacks {
  77330. private _defines;
  77331. private _currentRank;
  77332. private _maxRank;
  77333. private _mesh;
  77334. /**
  77335. * Removes the fallback from the bound mesh.
  77336. */
  77337. unBindMesh(): void;
  77338. /**
  77339. * Adds a fallback on the specified property.
  77340. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  77341. * @param define The name of the define in the shader
  77342. */
  77343. addFallback(rank: number, define: string): void;
  77344. /**
  77345. * Sets the mesh to use CPU skinning when needing to fallback.
  77346. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  77347. * @param mesh The mesh to use the fallbacks.
  77348. */
  77349. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  77350. /**
  77351. * Checks to see if more fallbacks are still availible.
  77352. */
  77353. readonly hasMoreFallbacks: boolean;
  77354. /**
  77355. * Removes the defines that should be removed when falling back.
  77356. * @param currentDefines defines the current define statements for the shader.
  77357. * @param effect defines the current effect we try to compile
  77358. * @returns The resulting defines with defines of the current rank removed.
  77359. */
  77360. reduce(currentDefines: string, effect: Effect): string;
  77361. }
  77362. }
  77363. declare module BABYLON {
  77364. /**
  77365. * "Static Class" containing the most commonly used helper while dealing with material for
  77366. * rendering purpose.
  77367. *
  77368. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  77369. *
  77370. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  77371. */
  77372. export class MaterialHelper {
  77373. /**
  77374. * Bind the current view position to an effect.
  77375. * @param effect The effect to be bound
  77376. * @param scene The scene the eyes position is used from
  77377. */
  77378. static BindEyePosition(effect: Effect, scene: Scene): void;
  77379. /**
  77380. * Helps preparing the defines values about the UVs in used in the effect.
  77381. * UVs are shared as much as we can accross channels in the shaders.
  77382. * @param texture The texture we are preparing the UVs for
  77383. * @param defines The defines to update
  77384. * @param key The channel key "diffuse", "specular"... used in the shader
  77385. */
  77386. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  77387. /**
  77388. * Binds a texture matrix value to its corrsponding uniform
  77389. * @param texture The texture to bind the matrix for
  77390. * @param uniformBuffer The uniform buffer receivin the data
  77391. * @param key The channel key "diffuse", "specular"... used in the shader
  77392. */
  77393. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  77394. /**
  77395. * Gets the current status of the fog (should it be enabled?)
  77396. * @param mesh defines the mesh to evaluate for fog support
  77397. * @param scene defines the hosting scene
  77398. * @returns true if fog must be enabled
  77399. */
  77400. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  77401. /**
  77402. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  77403. * @param mesh defines the current mesh
  77404. * @param scene defines the current scene
  77405. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  77406. * @param pointsCloud defines if point cloud rendering has to be turned on
  77407. * @param fogEnabled defines if fog has to be turned on
  77408. * @param alphaTest defines if alpha testing has to be turned on
  77409. * @param defines defines the current list of defines
  77410. */
  77411. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  77412. /**
  77413. * Helper used to prepare the list of defines associated with frame values for shader compilation
  77414. * @param scene defines the current scene
  77415. * @param engine defines the current engine
  77416. * @param defines specifies the list of active defines
  77417. * @param useInstances defines if instances have to be turned on
  77418. * @param useClipPlane defines if clip plane have to be turned on
  77419. */
  77420. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  77421. /**
  77422. * Prepares the defines for bones
  77423. * @param mesh The mesh containing the geometry data we will draw
  77424. * @param defines The defines to update
  77425. */
  77426. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  77427. /**
  77428. * Prepares the defines for morph targets
  77429. * @param mesh The mesh containing the geometry data we will draw
  77430. * @param defines The defines to update
  77431. */
  77432. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  77433. /**
  77434. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  77435. * @param mesh The mesh containing the geometry data we will draw
  77436. * @param defines The defines to update
  77437. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  77438. * @param useBones Precise whether bones should be used or not (override mesh info)
  77439. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  77440. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  77441. * @returns false if defines are considered not dirty and have not been checked
  77442. */
  77443. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  77444. /**
  77445. * Prepares the defines related to multiview
  77446. * @param scene The scene we are intending to draw
  77447. * @param defines The defines to update
  77448. */
  77449. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  77450. /**
  77451. * Prepares the defines related to the light information passed in parameter
  77452. * @param scene The scene we are intending to draw
  77453. * @param mesh The mesh the effect is compiling for
  77454. * @param light The light the effect is compiling for
  77455. * @param lightIndex The index of the light
  77456. * @param defines The defines to update
  77457. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  77458. * @param state Defines the current state regarding what is needed (normals, etc...)
  77459. */
  77460. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  77461. needNormals: boolean;
  77462. needRebuild: boolean;
  77463. shadowEnabled: boolean;
  77464. specularEnabled: boolean;
  77465. lightmapMode: boolean;
  77466. }): void;
  77467. /**
  77468. * Prepares the defines related to the light information passed in parameter
  77469. * @param scene The scene we are intending to draw
  77470. * @param mesh The mesh the effect is compiling for
  77471. * @param defines The defines to update
  77472. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  77473. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  77474. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  77475. * @returns true if normals will be required for the rest of the effect
  77476. */
  77477. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  77478. /**
  77479. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  77480. * @param lightIndex defines the light index
  77481. * @param uniformsList The uniform list
  77482. * @param samplersList The sampler list
  77483. * @param projectedLightTexture defines if projected texture must be used
  77484. * @param uniformBuffersList defines an optional list of uniform buffers
  77485. */
  77486. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  77487. /**
  77488. * Prepares the uniforms and samplers list to be used in the effect
  77489. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  77490. * @param samplersList The sampler list
  77491. * @param defines The defines helping in the list generation
  77492. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  77493. */
  77494. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  77495. /**
  77496. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  77497. * @param defines The defines to update while falling back
  77498. * @param fallbacks The authorized effect fallbacks
  77499. * @param maxSimultaneousLights The maximum number of lights allowed
  77500. * @param rank the current rank of the Effect
  77501. * @returns The newly affected rank
  77502. */
  77503. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  77504. private static _TmpMorphInfluencers;
  77505. /**
  77506. * Prepares the list of attributes required for morph targets according to the effect defines.
  77507. * @param attribs The current list of supported attribs
  77508. * @param mesh The mesh to prepare the morph targets attributes for
  77509. * @param influencers The number of influencers
  77510. */
  77511. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  77512. /**
  77513. * Prepares the list of attributes required for morph targets according to the effect defines.
  77514. * @param attribs The current list of supported attribs
  77515. * @param mesh The mesh to prepare the morph targets attributes for
  77516. * @param defines The current Defines of the effect
  77517. */
  77518. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  77519. /**
  77520. * Prepares the list of attributes required for bones according to the effect defines.
  77521. * @param attribs The current list of supported attribs
  77522. * @param mesh The mesh to prepare the bones attributes for
  77523. * @param defines The current Defines of the effect
  77524. * @param fallbacks The current efffect fallback strategy
  77525. */
  77526. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  77527. /**
  77528. * Check and prepare the list of attributes required for instances according to the effect defines.
  77529. * @param attribs The current list of supported attribs
  77530. * @param defines The current MaterialDefines of the effect
  77531. */
  77532. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  77533. /**
  77534. * Add the list of attributes required for instances to the attribs array.
  77535. * @param attribs The current list of supported attribs
  77536. */
  77537. static PushAttributesForInstances(attribs: string[]): void;
  77538. /**
  77539. * Binds the light information to the effect.
  77540. * @param light The light containing the generator
  77541. * @param effect The effect we are binding the data to
  77542. * @param lightIndex The light index in the effect used to render
  77543. */
  77544. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  77545. /**
  77546. * Binds the lights information from the scene to the effect for the given mesh.
  77547. * @param light Light to bind
  77548. * @param lightIndex Light index
  77549. * @param scene The scene where the light belongs to
  77550. * @param effect The effect we are binding the data to
  77551. * @param useSpecular Defines if specular is supported
  77552. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  77553. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  77554. */
  77555. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  77556. /**
  77557. * Binds the lights information from the scene to the effect for the given mesh.
  77558. * @param scene The scene the lights belongs to
  77559. * @param mesh The mesh we are binding the information to render
  77560. * @param effect The effect we are binding the data to
  77561. * @param defines The generated defines for the effect
  77562. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  77563. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  77564. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  77565. */
  77566. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  77567. private static _tempFogColor;
  77568. /**
  77569. * Binds the fog information from the scene to the effect for the given mesh.
  77570. * @param scene The scene the lights belongs to
  77571. * @param mesh The mesh we are binding the information to render
  77572. * @param effect The effect we are binding the data to
  77573. * @param linearSpace Defines if the fog effect is applied in linear space
  77574. */
  77575. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  77576. /**
  77577. * Binds the bones information from the mesh to the effect.
  77578. * @param mesh The mesh we are binding the information to render
  77579. * @param effect The effect we are binding the data to
  77580. */
  77581. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  77582. /**
  77583. * Binds the morph targets information from the mesh to the effect.
  77584. * @param abstractMesh The mesh we are binding the information to render
  77585. * @param effect The effect we are binding the data to
  77586. */
  77587. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  77588. /**
  77589. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  77590. * @param defines The generated defines used in the effect
  77591. * @param effect The effect we are binding the data to
  77592. * @param scene The scene we are willing to render with logarithmic scale for
  77593. */
  77594. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  77595. /**
  77596. * Binds the clip plane information from the scene to the effect.
  77597. * @param scene The scene the clip plane information are extracted from
  77598. * @param effect The effect we are binding the data to
  77599. */
  77600. static BindClipPlane(effect: Effect, scene: Scene): void;
  77601. }
  77602. }
  77603. declare module BABYLON {
  77604. /** @hidden */
  77605. export var packingFunctions: {
  77606. name: string;
  77607. shader: string;
  77608. };
  77609. }
  77610. declare module BABYLON {
  77611. /** @hidden */
  77612. export var shadowMapPixelShader: {
  77613. name: string;
  77614. shader: string;
  77615. };
  77616. }
  77617. declare module BABYLON {
  77618. /** @hidden */
  77619. export var bonesDeclaration: {
  77620. name: string;
  77621. shader: string;
  77622. };
  77623. }
  77624. declare module BABYLON {
  77625. /** @hidden */
  77626. export var morphTargetsVertexGlobalDeclaration: {
  77627. name: string;
  77628. shader: string;
  77629. };
  77630. }
  77631. declare module BABYLON {
  77632. /** @hidden */
  77633. export var morphTargetsVertexDeclaration: {
  77634. name: string;
  77635. shader: string;
  77636. };
  77637. }
  77638. declare module BABYLON {
  77639. /** @hidden */
  77640. export var instancesDeclaration: {
  77641. name: string;
  77642. shader: string;
  77643. };
  77644. }
  77645. declare module BABYLON {
  77646. /** @hidden */
  77647. export var helperFunctions: {
  77648. name: string;
  77649. shader: string;
  77650. };
  77651. }
  77652. declare module BABYLON {
  77653. /** @hidden */
  77654. export var morphTargetsVertex: {
  77655. name: string;
  77656. shader: string;
  77657. };
  77658. }
  77659. declare module BABYLON {
  77660. /** @hidden */
  77661. export var instancesVertex: {
  77662. name: string;
  77663. shader: string;
  77664. };
  77665. }
  77666. declare module BABYLON {
  77667. /** @hidden */
  77668. export var bonesVertex: {
  77669. name: string;
  77670. shader: string;
  77671. };
  77672. }
  77673. declare module BABYLON {
  77674. /** @hidden */
  77675. export var shadowMapVertexShader: {
  77676. name: string;
  77677. shader: string;
  77678. };
  77679. }
  77680. declare module BABYLON {
  77681. /** @hidden */
  77682. export var depthBoxBlurPixelShader: {
  77683. name: string;
  77684. shader: string;
  77685. };
  77686. }
  77687. declare module BABYLON {
  77688. /**
  77689. * Defines the options associated with the creation of a custom shader for a shadow generator.
  77690. */
  77691. export interface ICustomShaderOptions {
  77692. /**
  77693. * Gets or sets the custom shader name to use
  77694. */
  77695. shaderName: string;
  77696. /**
  77697. * The list of attribute names used in the shader
  77698. */
  77699. attributes?: string[];
  77700. /**
  77701. * The list of unifrom names used in the shader
  77702. */
  77703. uniforms?: string[];
  77704. /**
  77705. * The list of sampler names used in the shader
  77706. */
  77707. samplers?: string[];
  77708. /**
  77709. * The list of defines used in the shader
  77710. */
  77711. defines?: string[];
  77712. }
  77713. /**
  77714. * Interface to implement to create a shadow generator compatible with BJS.
  77715. */
  77716. export interface IShadowGenerator {
  77717. /**
  77718. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77719. * @returns The render target texture if present otherwise, null
  77720. */
  77721. getShadowMap(): Nullable<RenderTargetTexture>;
  77722. /**
  77723. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77724. * @returns The render target texture if the shadow map is present otherwise, null
  77725. */
  77726. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77727. /**
  77728. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  77729. * @param subMesh The submesh we want to render in the shadow map
  77730. * @param useInstances Defines wether will draw in the map using instances
  77731. * @returns true if ready otherwise, false
  77732. */
  77733. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77734. /**
  77735. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77736. * @param defines Defines of the material we want to update
  77737. * @param lightIndex Index of the light in the enabled light list of the material
  77738. */
  77739. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  77740. /**
  77741. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77742. * defined in the generator but impacting the effect).
  77743. * It implies the unifroms available on the materials are the standard BJS ones.
  77744. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77745. * @param effect The effect we are binfing the information for
  77746. */
  77747. bindShadowLight(lightIndex: string, effect: Effect): void;
  77748. /**
  77749. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77750. * (eq to shadow prjection matrix * light transform matrix)
  77751. * @returns The transform matrix used to create the shadow map
  77752. */
  77753. getTransformMatrix(): Matrix;
  77754. /**
  77755. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77756. * Cube and 2D textures for instance.
  77757. */
  77758. recreateShadowMap(): void;
  77759. /**
  77760. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77761. * @param onCompiled Callback triggered at the and of the effects compilation
  77762. * @param options Sets of optional options forcing the compilation with different modes
  77763. */
  77764. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77765. useInstances: boolean;
  77766. }>): void;
  77767. /**
  77768. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77769. * @param options Sets of optional options forcing the compilation with different modes
  77770. * @returns A promise that resolves when the compilation completes
  77771. */
  77772. forceCompilationAsync(options?: Partial<{
  77773. useInstances: boolean;
  77774. }>): Promise<void>;
  77775. /**
  77776. * Serializes the shadow generator setup to a json object.
  77777. * @returns The serialized JSON object
  77778. */
  77779. serialize(): any;
  77780. /**
  77781. * Disposes the Shadow map and related Textures and effects.
  77782. */
  77783. dispose(): void;
  77784. }
  77785. /**
  77786. * Default implementation IShadowGenerator.
  77787. * This is the main object responsible of generating shadows in the framework.
  77788. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  77789. */
  77790. export class ShadowGenerator implements IShadowGenerator {
  77791. /**
  77792. * Shadow generator mode None: no filtering applied.
  77793. */
  77794. static readonly FILTER_NONE: number;
  77795. /**
  77796. * Shadow generator mode ESM: Exponential Shadow Mapping.
  77797. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77798. */
  77799. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  77800. /**
  77801. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  77802. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  77803. */
  77804. static readonly FILTER_POISSONSAMPLING: number;
  77805. /**
  77806. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  77807. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77808. */
  77809. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  77810. /**
  77811. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  77812. * edge artifacts on steep falloff.
  77813. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77814. */
  77815. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  77816. /**
  77817. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  77818. * edge artifacts on steep falloff.
  77819. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77820. */
  77821. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  77822. /**
  77823. * Shadow generator mode PCF: Percentage Closer Filtering
  77824. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77825. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  77826. */
  77827. static readonly FILTER_PCF: number;
  77828. /**
  77829. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  77830. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77831. * Contact Hardening
  77832. */
  77833. static readonly FILTER_PCSS: number;
  77834. /**
  77835. * Reserved for PCF and PCSS
  77836. * Highest Quality.
  77837. *
  77838. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  77839. *
  77840. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  77841. */
  77842. static readonly QUALITY_HIGH: number;
  77843. /**
  77844. * Reserved for PCF and PCSS
  77845. * Good tradeoff for quality/perf cross devices
  77846. *
  77847. * Execute PCF on a 3*3 kernel.
  77848. *
  77849. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  77850. */
  77851. static readonly QUALITY_MEDIUM: number;
  77852. /**
  77853. * Reserved for PCF and PCSS
  77854. * The lowest quality but the fastest.
  77855. *
  77856. * Execute PCF on a 1*1 kernel.
  77857. *
  77858. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  77859. */
  77860. static readonly QUALITY_LOW: number;
  77861. /** Gets or sets the custom shader name to use */
  77862. customShaderOptions: ICustomShaderOptions;
  77863. /**
  77864. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  77865. */
  77866. onBeforeShadowMapRenderObservable: Observable<Effect>;
  77867. /**
  77868. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  77869. */
  77870. onAfterShadowMapRenderObservable: Observable<Effect>;
  77871. /**
  77872. * Observable triggered before a mesh is rendered in the shadow map.
  77873. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  77874. */
  77875. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  77876. /**
  77877. * Observable triggered after a mesh is rendered in the shadow map.
  77878. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  77879. */
  77880. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  77881. private _bias;
  77882. /**
  77883. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  77884. */
  77885. /**
  77886. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  77887. */
  77888. bias: number;
  77889. private _normalBias;
  77890. /**
  77891. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77892. */
  77893. /**
  77894. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77895. */
  77896. normalBias: number;
  77897. private _blurBoxOffset;
  77898. /**
  77899. * Gets the blur box offset: offset applied during the blur pass.
  77900. * Only useful if useKernelBlur = false
  77901. */
  77902. /**
  77903. * Sets the blur box offset: offset applied during the blur pass.
  77904. * Only useful if useKernelBlur = false
  77905. */
  77906. blurBoxOffset: number;
  77907. private _blurScale;
  77908. /**
  77909. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  77910. * 2 means half of the size.
  77911. */
  77912. /**
  77913. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  77914. * 2 means half of the size.
  77915. */
  77916. blurScale: number;
  77917. private _blurKernel;
  77918. /**
  77919. * Gets the blur kernel: kernel size of the blur pass.
  77920. * Only useful if useKernelBlur = true
  77921. */
  77922. /**
  77923. * Sets the blur kernel: kernel size of the blur pass.
  77924. * Only useful if useKernelBlur = true
  77925. */
  77926. blurKernel: number;
  77927. private _useKernelBlur;
  77928. /**
  77929. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  77930. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77931. */
  77932. /**
  77933. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  77934. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77935. */
  77936. useKernelBlur: boolean;
  77937. private _depthScale;
  77938. /**
  77939. * Gets the depth scale used in ESM mode.
  77940. */
  77941. /**
  77942. * Sets the depth scale used in ESM mode.
  77943. * This can override the scale stored on the light.
  77944. */
  77945. depthScale: number;
  77946. private _filter;
  77947. /**
  77948. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  77949. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77950. */
  77951. /**
  77952. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  77953. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77954. */
  77955. filter: number;
  77956. /**
  77957. * Gets if the current filter is set to Poisson Sampling.
  77958. */
  77959. /**
  77960. * Sets the current filter to Poisson Sampling.
  77961. */
  77962. usePoissonSampling: boolean;
  77963. /**
  77964. * Gets if the current filter is set to ESM.
  77965. */
  77966. /**
  77967. * Sets the current filter is to ESM.
  77968. */
  77969. useExponentialShadowMap: boolean;
  77970. /**
  77971. * Gets if the current filter is set to filtered ESM.
  77972. */
  77973. /**
  77974. * Gets if the current filter is set to filtered ESM.
  77975. */
  77976. useBlurExponentialShadowMap: boolean;
  77977. /**
  77978. * Gets if the current filter is set to "close ESM" (using the inverse of the
  77979. * exponential to prevent steep falloff artifacts).
  77980. */
  77981. /**
  77982. * Sets the current filter to "close ESM" (using the inverse of the
  77983. * exponential to prevent steep falloff artifacts).
  77984. */
  77985. useCloseExponentialShadowMap: boolean;
  77986. /**
  77987. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  77988. * exponential to prevent steep falloff artifacts).
  77989. */
  77990. /**
  77991. * Sets the current filter to filtered "close ESM" (using the inverse of the
  77992. * exponential to prevent steep falloff artifacts).
  77993. */
  77994. useBlurCloseExponentialShadowMap: boolean;
  77995. /**
  77996. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  77997. */
  77998. /**
  77999. * Sets the current filter to "PCF" (percentage closer filtering).
  78000. */
  78001. usePercentageCloserFiltering: boolean;
  78002. private _filteringQuality;
  78003. /**
  78004. * Gets the PCF or PCSS Quality.
  78005. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  78006. */
  78007. /**
  78008. * Sets the PCF or PCSS Quality.
  78009. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  78010. */
  78011. filteringQuality: number;
  78012. /**
  78013. * Gets if the current filter is set to "PCSS" (contact hardening).
  78014. */
  78015. /**
  78016. * Sets the current filter to "PCSS" (contact hardening).
  78017. */
  78018. useContactHardeningShadow: boolean;
  78019. private _contactHardeningLightSizeUVRatio;
  78020. /**
  78021. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  78022. * Using a ratio helps keeping shape stability independently of the map size.
  78023. *
  78024. * It does not account for the light projection as it was having too much
  78025. * instability during the light setup or during light position changes.
  78026. *
  78027. * Only valid if useContactHardeningShadow is true.
  78028. */
  78029. /**
  78030. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  78031. * Using a ratio helps keeping shape stability independently of the map size.
  78032. *
  78033. * It does not account for the light projection as it was having too much
  78034. * instability during the light setup or during light position changes.
  78035. *
  78036. * Only valid if useContactHardeningShadow is true.
  78037. */
  78038. contactHardeningLightSizeUVRatio: number;
  78039. private _darkness;
  78040. /** Gets or sets the actual darkness of a shadow */
  78041. darkness: number;
  78042. /**
  78043. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  78044. * 0 means strongest and 1 would means no shadow.
  78045. * @returns the darkness.
  78046. */
  78047. getDarkness(): number;
  78048. /**
  78049. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  78050. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  78051. * @returns the shadow generator allowing fluent coding.
  78052. */
  78053. setDarkness(darkness: number): ShadowGenerator;
  78054. private _transparencyShadow;
  78055. /** Gets or sets the ability to have transparent shadow */
  78056. transparencyShadow: boolean;
  78057. /**
  78058. * Sets the ability to have transparent shadow (boolean).
  78059. * @param transparent True if transparent else False
  78060. * @returns the shadow generator allowing fluent coding
  78061. */
  78062. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  78063. private _shadowMap;
  78064. private _shadowMap2;
  78065. /**
  78066. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  78067. * @returns The render target texture if present otherwise, null
  78068. */
  78069. getShadowMap(): Nullable<RenderTargetTexture>;
  78070. /**
  78071. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  78072. * @returns The render target texture if the shadow map is present otherwise, null
  78073. */
  78074. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  78075. /**
  78076. * Gets the class name of that object
  78077. * @returns "ShadowGenerator"
  78078. */
  78079. getClassName(): string;
  78080. /**
  78081. * Helper function to add a mesh and its descendants to the list of shadow casters.
  78082. * @param mesh Mesh to add
  78083. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  78084. * @returns the Shadow Generator itself
  78085. */
  78086. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  78087. /**
  78088. * Helper function to remove a mesh and its descendants from the list of shadow casters
  78089. * @param mesh Mesh to remove
  78090. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  78091. * @returns the Shadow Generator itself
  78092. */
  78093. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  78094. /**
  78095. * Controls the extent to which the shadows fade out at the edge of the frustum
  78096. * Used only by directionals and spots
  78097. */
  78098. frustumEdgeFalloff: number;
  78099. private _light;
  78100. /**
  78101. * Returns the associated light object.
  78102. * @returns the light generating the shadow
  78103. */
  78104. getLight(): IShadowLight;
  78105. /**
  78106. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  78107. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  78108. * It might on the other hand introduce peter panning.
  78109. */
  78110. forceBackFacesOnly: boolean;
  78111. private _scene;
  78112. private _lightDirection;
  78113. private _effect;
  78114. private _viewMatrix;
  78115. private _projectionMatrix;
  78116. private _transformMatrix;
  78117. private _cachedPosition;
  78118. private _cachedDirection;
  78119. private _cachedDefines;
  78120. private _currentRenderID;
  78121. private _boxBlurPostprocess;
  78122. private _kernelBlurXPostprocess;
  78123. private _kernelBlurYPostprocess;
  78124. private _blurPostProcesses;
  78125. private _mapSize;
  78126. private _currentFaceIndex;
  78127. private _currentFaceIndexCache;
  78128. private _textureType;
  78129. private _defaultTextureMatrix;
  78130. private _storedUniqueId;
  78131. /** @hidden */
  78132. static _SceneComponentInitialization: (scene: Scene) => void;
  78133. /**
  78134. * Creates a ShadowGenerator object.
  78135. * A ShadowGenerator is the required tool to use the shadows.
  78136. * Each light casting shadows needs to use its own ShadowGenerator.
  78137. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  78138. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  78139. * @param light The light object generating the shadows.
  78140. * @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.
  78141. */
  78142. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  78143. private _initializeGenerator;
  78144. private _initializeShadowMap;
  78145. private _initializeBlurRTTAndPostProcesses;
  78146. private _renderForShadowMap;
  78147. private _renderSubMeshForShadowMap;
  78148. private _applyFilterValues;
  78149. /**
  78150. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  78151. * @param onCompiled Callback triggered at the and of the effects compilation
  78152. * @param options Sets of optional options forcing the compilation with different modes
  78153. */
  78154. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  78155. useInstances: boolean;
  78156. }>): void;
  78157. /**
  78158. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  78159. * @param options Sets of optional options forcing the compilation with different modes
  78160. * @returns A promise that resolves when the compilation completes
  78161. */
  78162. forceCompilationAsync(options?: Partial<{
  78163. useInstances: boolean;
  78164. }>): Promise<void>;
  78165. /**
  78166. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  78167. * @param subMesh The submesh we want to render in the shadow map
  78168. * @param useInstances Defines wether will draw in the map using instances
  78169. * @returns true if ready otherwise, false
  78170. */
  78171. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  78172. /**
  78173. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  78174. * @param defines Defines of the material we want to update
  78175. * @param lightIndex Index of the light in the enabled light list of the material
  78176. */
  78177. prepareDefines(defines: any, lightIndex: number): void;
  78178. /**
  78179. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  78180. * defined in the generator but impacting the effect).
  78181. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  78182. * @param effect The effect we are binfing the information for
  78183. */
  78184. bindShadowLight(lightIndex: string, effect: Effect): void;
  78185. /**
  78186. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  78187. * (eq to shadow prjection matrix * light transform matrix)
  78188. * @returns The transform matrix used to create the shadow map
  78189. */
  78190. getTransformMatrix(): Matrix;
  78191. /**
  78192. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  78193. * Cube and 2D textures for instance.
  78194. */
  78195. recreateShadowMap(): void;
  78196. private _disposeBlurPostProcesses;
  78197. private _disposeRTTandPostProcesses;
  78198. /**
  78199. * Disposes the ShadowGenerator.
  78200. * Returns nothing.
  78201. */
  78202. dispose(): void;
  78203. /**
  78204. * Serializes the shadow generator setup to a json object.
  78205. * @returns The serialized JSON object
  78206. */
  78207. serialize(): any;
  78208. /**
  78209. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  78210. * @param parsedShadowGenerator The JSON object to parse
  78211. * @param scene The scene to create the shadow map for
  78212. * @returns The parsed shadow generator
  78213. */
  78214. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  78215. }
  78216. }
  78217. declare module BABYLON {
  78218. /**
  78219. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  78220. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  78221. * 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.
  78222. */
  78223. export abstract class Light extends Node {
  78224. /**
  78225. * Falloff Default: light is falling off following the material specification:
  78226. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  78227. */
  78228. static readonly FALLOFF_DEFAULT: number;
  78229. /**
  78230. * Falloff Physical: light is falling off following the inverse squared distance law.
  78231. */
  78232. static readonly FALLOFF_PHYSICAL: number;
  78233. /**
  78234. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  78235. * to enhance interoperability with other engines.
  78236. */
  78237. static readonly FALLOFF_GLTF: number;
  78238. /**
  78239. * Falloff Standard: light is falling off like in the standard material
  78240. * to enhance interoperability with other materials.
  78241. */
  78242. static readonly FALLOFF_STANDARD: number;
  78243. /**
  78244. * If every light affecting the material is in this lightmapMode,
  78245. * material.lightmapTexture adds or multiplies
  78246. * (depends on material.useLightmapAsShadowmap)
  78247. * after every other light calculations.
  78248. */
  78249. static readonly LIGHTMAP_DEFAULT: number;
  78250. /**
  78251. * material.lightmapTexture as only diffuse lighting from this light
  78252. * adds only specular lighting from this light
  78253. * adds dynamic shadows
  78254. */
  78255. static readonly LIGHTMAP_SPECULAR: number;
  78256. /**
  78257. * material.lightmapTexture as only lighting
  78258. * no light calculation from this light
  78259. * only adds dynamic shadows from this light
  78260. */
  78261. static readonly LIGHTMAP_SHADOWSONLY: number;
  78262. /**
  78263. * Each light type uses the default quantity according to its type:
  78264. * point/spot lights use luminous intensity
  78265. * directional lights use illuminance
  78266. */
  78267. static readonly INTENSITYMODE_AUTOMATIC: number;
  78268. /**
  78269. * lumen (lm)
  78270. */
  78271. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  78272. /**
  78273. * candela (lm/sr)
  78274. */
  78275. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  78276. /**
  78277. * lux (lm/m^2)
  78278. */
  78279. static readonly INTENSITYMODE_ILLUMINANCE: number;
  78280. /**
  78281. * nit (cd/m^2)
  78282. */
  78283. static readonly INTENSITYMODE_LUMINANCE: number;
  78284. /**
  78285. * Light type const id of the point light.
  78286. */
  78287. static readonly LIGHTTYPEID_POINTLIGHT: number;
  78288. /**
  78289. * Light type const id of the directional light.
  78290. */
  78291. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  78292. /**
  78293. * Light type const id of the spot light.
  78294. */
  78295. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  78296. /**
  78297. * Light type const id of the hemispheric light.
  78298. */
  78299. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  78300. /**
  78301. * Diffuse gives the basic color to an object.
  78302. */
  78303. diffuse: Color3;
  78304. /**
  78305. * Specular produces a highlight color on an object.
  78306. * Note: This is note affecting PBR materials.
  78307. */
  78308. specular: Color3;
  78309. /**
  78310. * Defines the falloff type for this light. This lets overrriding how punctual light are
  78311. * falling off base on range or angle.
  78312. * This can be set to any values in Light.FALLOFF_x.
  78313. *
  78314. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  78315. * other types of materials.
  78316. */
  78317. falloffType: number;
  78318. /**
  78319. * Strength of the light.
  78320. * Note: By default it is define in the framework own unit.
  78321. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  78322. */
  78323. intensity: number;
  78324. private _range;
  78325. protected _inverseSquaredRange: number;
  78326. /**
  78327. * Defines how far from the source the light is impacting in scene units.
  78328. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  78329. */
  78330. /**
  78331. * Defines how far from the source the light is impacting in scene units.
  78332. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  78333. */
  78334. range: number;
  78335. /**
  78336. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  78337. * of light.
  78338. */
  78339. private _photometricScale;
  78340. private _intensityMode;
  78341. /**
  78342. * Gets the photometric scale used to interpret the intensity.
  78343. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  78344. */
  78345. /**
  78346. * Sets the photometric scale used to interpret the intensity.
  78347. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  78348. */
  78349. intensityMode: number;
  78350. private _radius;
  78351. /**
  78352. * Gets the light radius used by PBR Materials to simulate soft area lights.
  78353. */
  78354. /**
  78355. * sets the light radius used by PBR Materials to simulate soft area lights.
  78356. */
  78357. radius: number;
  78358. private _renderPriority;
  78359. /**
  78360. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  78361. * exceeding the number allowed of the materials.
  78362. */
  78363. renderPriority: number;
  78364. private _shadowEnabled;
  78365. /**
  78366. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  78367. * the current shadow generator.
  78368. */
  78369. /**
  78370. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  78371. * the current shadow generator.
  78372. */
  78373. shadowEnabled: boolean;
  78374. private _includedOnlyMeshes;
  78375. /**
  78376. * Gets the only meshes impacted by this light.
  78377. */
  78378. /**
  78379. * Sets the only meshes impacted by this light.
  78380. */
  78381. includedOnlyMeshes: AbstractMesh[];
  78382. private _excludedMeshes;
  78383. /**
  78384. * Gets the meshes not impacted by this light.
  78385. */
  78386. /**
  78387. * Sets the meshes not impacted by this light.
  78388. */
  78389. excludedMeshes: AbstractMesh[];
  78390. private _excludeWithLayerMask;
  78391. /**
  78392. * Gets the layer id use to find what meshes are not impacted by the light.
  78393. * Inactive if 0
  78394. */
  78395. /**
  78396. * Sets the layer id use to find what meshes are not impacted by the light.
  78397. * Inactive if 0
  78398. */
  78399. excludeWithLayerMask: number;
  78400. private _includeOnlyWithLayerMask;
  78401. /**
  78402. * Gets the layer id use to find what meshes are impacted by the light.
  78403. * Inactive if 0
  78404. */
  78405. /**
  78406. * Sets the layer id use to find what meshes are impacted by the light.
  78407. * Inactive if 0
  78408. */
  78409. includeOnlyWithLayerMask: number;
  78410. private _lightmapMode;
  78411. /**
  78412. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  78413. */
  78414. /**
  78415. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  78416. */
  78417. lightmapMode: number;
  78418. /**
  78419. * Shadow generator associted to the light.
  78420. * @hidden Internal use only.
  78421. */
  78422. _shadowGenerator: Nullable<IShadowGenerator>;
  78423. /**
  78424. * @hidden Internal use only.
  78425. */
  78426. _excludedMeshesIds: string[];
  78427. /**
  78428. * @hidden Internal use only.
  78429. */
  78430. _includedOnlyMeshesIds: string[];
  78431. /**
  78432. * The current light unifom buffer.
  78433. * @hidden Internal use only.
  78434. */
  78435. _uniformBuffer: UniformBuffer;
  78436. /** @hidden */
  78437. _renderId: number;
  78438. /**
  78439. * Creates a Light object in the scene.
  78440. * Documentation : https://doc.babylonjs.com/babylon101/lights
  78441. * @param name The firendly name of the light
  78442. * @param scene The scene the light belongs too
  78443. */
  78444. constructor(name: string, scene: Scene);
  78445. protected abstract _buildUniformLayout(): void;
  78446. /**
  78447. * Sets the passed Effect "effect" with the Light information.
  78448. * @param effect The effect to update
  78449. * @param lightIndex The index of the light in the effect to update
  78450. * @returns The light
  78451. */
  78452. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  78453. /**
  78454. * Sets the passed Effect "effect" with the Light information.
  78455. * @param effect The effect to update
  78456. * @param lightDataUniformName The uniform used to store light data (position or direction)
  78457. * @returns The light
  78458. */
  78459. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  78460. /**
  78461. * Returns the string "Light".
  78462. * @returns the class name
  78463. */
  78464. getClassName(): string;
  78465. /** @hidden */
  78466. readonly _isLight: boolean;
  78467. /**
  78468. * Converts the light information to a readable string for debug purpose.
  78469. * @param fullDetails Supports for multiple levels of logging within scene loading
  78470. * @returns the human readable light info
  78471. */
  78472. toString(fullDetails?: boolean): string;
  78473. /** @hidden */
  78474. protected _syncParentEnabledState(): void;
  78475. /**
  78476. * Set the enabled state of this node.
  78477. * @param value - the new enabled state
  78478. */
  78479. setEnabled(value: boolean): void;
  78480. /**
  78481. * Returns the Light associated shadow generator if any.
  78482. * @return the associated shadow generator.
  78483. */
  78484. getShadowGenerator(): Nullable<IShadowGenerator>;
  78485. /**
  78486. * Returns a Vector3, the absolute light position in the World.
  78487. * @returns the world space position of the light
  78488. */
  78489. getAbsolutePosition(): Vector3;
  78490. /**
  78491. * Specifies if the light will affect the passed mesh.
  78492. * @param mesh The mesh to test against the light
  78493. * @return true the mesh is affected otherwise, false.
  78494. */
  78495. canAffectMesh(mesh: AbstractMesh): boolean;
  78496. /**
  78497. * Sort function to order lights for rendering.
  78498. * @param a First Light object to compare to second.
  78499. * @param b Second Light object to compare first.
  78500. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  78501. */
  78502. static CompareLightsPriority(a: Light, b: Light): number;
  78503. /**
  78504. * Releases resources associated with this node.
  78505. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  78506. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  78507. */
  78508. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  78509. /**
  78510. * Returns the light type ID (integer).
  78511. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  78512. */
  78513. getTypeID(): number;
  78514. /**
  78515. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  78516. * @returns the scaled intensity in intensity mode unit
  78517. */
  78518. getScaledIntensity(): number;
  78519. /**
  78520. * Returns a new Light object, named "name", from the current one.
  78521. * @param name The name of the cloned light
  78522. * @returns the new created light
  78523. */
  78524. clone(name: string): Nullable<Light>;
  78525. /**
  78526. * Serializes the current light into a Serialization object.
  78527. * @returns the serialized object.
  78528. */
  78529. serialize(): any;
  78530. /**
  78531. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  78532. * This new light is named "name" and added to the passed scene.
  78533. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  78534. * @param name The friendly name of the light
  78535. * @param scene The scene the new light will belong to
  78536. * @returns the constructor function
  78537. */
  78538. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  78539. /**
  78540. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  78541. * @param parsedLight The JSON representation of the light
  78542. * @param scene The scene to create the parsed light in
  78543. * @returns the created light after parsing
  78544. */
  78545. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  78546. private _hookArrayForExcluded;
  78547. private _hookArrayForIncludedOnly;
  78548. private _resyncMeshes;
  78549. /**
  78550. * Forces the meshes to update their light related information in their rendering used effects
  78551. * @hidden Internal Use Only
  78552. */
  78553. _markMeshesAsLightDirty(): void;
  78554. /**
  78555. * Recomputes the cached photometric scale if needed.
  78556. */
  78557. private _computePhotometricScale;
  78558. /**
  78559. * Returns the Photometric Scale according to the light type and intensity mode.
  78560. */
  78561. private _getPhotometricScale;
  78562. /**
  78563. * Reorder the light in the scene according to their defined priority.
  78564. * @hidden Internal Use Only
  78565. */
  78566. _reorderLightsInScene(): void;
  78567. /**
  78568. * Prepares the list of defines specific to the light type.
  78569. * @param defines the list of defines
  78570. * @param lightIndex defines the index of the light for the effect
  78571. */
  78572. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  78573. }
  78574. }
  78575. declare module BABYLON {
  78576. /**
  78577. * Interface used to define Action
  78578. */
  78579. export interface IAction {
  78580. /**
  78581. * Trigger for the action
  78582. */
  78583. trigger: number;
  78584. /** Options of the trigger */
  78585. triggerOptions: any;
  78586. /**
  78587. * Gets the trigger parameters
  78588. * @returns the trigger parameters
  78589. */
  78590. getTriggerParameter(): any;
  78591. /**
  78592. * Internal only - executes current action event
  78593. * @hidden
  78594. */
  78595. _executeCurrent(evt?: ActionEvent): void;
  78596. /**
  78597. * Serialize placeholder for child classes
  78598. * @param parent of child
  78599. * @returns the serialized object
  78600. */
  78601. serialize(parent: any): any;
  78602. /**
  78603. * Internal only
  78604. * @hidden
  78605. */
  78606. _prepare(): void;
  78607. /**
  78608. * Internal only - manager for action
  78609. * @hidden
  78610. */
  78611. _actionManager: AbstractActionManager;
  78612. /**
  78613. * Adds action to chain of actions, may be a DoNothingAction
  78614. * @param action defines the next action to execute
  78615. * @returns The action passed in
  78616. * @see https://www.babylonjs-playground.com/#1T30HR#0
  78617. */
  78618. then(action: IAction): IAction;
  78619. }
  78620. /**
  78621. * The action to be carried out following a trigger
  78622. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  78623. */
  78624. export class Action implements IAction {
  78625. /** the trigger, with or without parameters, for the action */
  78626. triggerOptions: any;
  78627. /**
  78628. * Trigger for the action
  78629. */
  78630. trigger: number;
  78631. /**
  78632. * Internal only - manager for action
  78633. * @hidden
  78634. */
  78635. _actionManager: ActionManager;
  78636. private _nextActiveAction;
  78637. private _child;
  78638. private _condition?;
  78639. private _triggerParameter;
  78640. /**
  78641. * An event triggered prior to action being executed.
  78642. */
  78643. onBeforeExecuteObservable: Observable<Action>;
  78644. /**
  78645. * Creates a new Action
  78646. * @param triggerOptions the trigger, with or without parameters, for the action
  78647. * @param condition an optional determinant of action
  78648. */
  78649. constructor(
  78650. /** the trigger, with or without parameters, for the action */
  78651. triggerOptions: any, condition?: Condition);
  78652. /**
  78653. * Internal only
  78654. * @hidden
  78655. */
  78656. _prepare(): void;
  78657. /**
  78658. * Gets the trigger parameters
  78659. * @returns the trigger parameters
  78660. */
  78661. getTriggerParameter(): any;
  78662. /**
  78663. * Internal only - executes current action event
  78664. * @hidden
  78665. */
  78666. _executeCurrent(evt?: ActionEvent): void;
  78667. /**
  78668. * Execute placeholder for child classes
  78669. * @param evt optional action event
  78670. */
  78671. execute(evt?: ActionEvent): void;
  78672. /**
  78673. * Skips to next active action
  78674. */
  78675. skipToNextActiveAction(): void;
  78676. /**
  78677. * Adds action to chain of actions, may be a DoNothingAction
  78678. * @param action defines the next action to execute
  78679. * @returns The action passed in
  78680. * @see https://www.babylonjs-playground.com/#1T30HR#0
  78681. */
  78682. then(action: Action): Action;
  78683. /**
  78684. * Internal only
  78685. * @hidden
  78686. */
  78687. _getProperty(propertyPath: string): string;
  78688. /**
  78689. * Internal only
  78690. * @hidden
  78691. */
  78692. _getEffectiveTarget(target: any, propertyPath: string): any;
  78693. /**
  78694. * Serialize placeholder for child classes
  78695. * @param parent of child
  78696. * @returns the serialized object
  78697. */
  78698. serialize(parent: any): any;
  78699. /**
  78700. * Internal only called by serialize
  78701. * @hidden
  78702. */
  78703. protected _serialize(serializedAction: any, parent?: any): any;
  78704. /**
  78705. * Internal only
  78706. * @hidden
  78707. */
  78708. static _SerializeValueAsString: (value: any) => string;
  78709. /**
  78710. * Internal only
  78711. * @hidden
  78712. */
  78713. static _GetTargetProperty: (target: Node | Scene) => {
  78714. name: string;
  78715. targetType: string;
  78716. value: string;
  78717. };
  78718. }
  78719. }
  78720. declare module BABYLON {
  78721. /**
  78722. * A Condition applied to an Action
  78723. */
  78724. export class Condition {
  78725. /**
  78726. * Internal only - manager for action
  78727. * @hidden
  78728. */
  78729. _actionManager: ActionManager;
  78730. /**
  78731. * Internal only
  78732. * @hidden
  78733. */
  78734. _evaluationId: number;
  78735. /**
  78736. * Internal only
  78737. * @hidden
  78738. */
  78739. _currentResult: boolean;
  78740. /**
  78741. * Creates a new Condition
  78742. * @param actionManager the manager of the action the condition is applied to
  78743. */
  78744. constructor(actionManager: ActionManager);
  78745. /**
  78746. * Check if the current condition is valid
  78747. * @returns a boolean
  78748. */
  78749. isValid(): boolean;
  78750. /**
  78751. * Internal only
  78752. * @hidden
  78753. */
  78754. _getProperty(propertyPath: string): string;
  78755. /**
  78756. * Internal only
  78757. * @hidden
  78758. */
  78759. _getEffectiveTarget(target: any, propertyPath: string): any;
  78760. /**
  78761. * Serialize placeholder for child classes
  78762. * @returns the serialized object
  78763. */
  78764. serialize(): any;
  78765. /**
  78766. * Internal only
  78767. * @hidden
  78768. */
  78769. protected _serialize(serializedCondition: any): any;
  78770. }
  78771. /**
  78772. * Defines specific conditional operators as extensions of Condition
  78773. */
  78774. export class ValueCondition extends Condition {
  78775. /** path to specify the property of the target the conditional operator uses */
  78776. propertyPath: string;
  78777. /** the value compared by the conditional operator against the current value of the property */
  78778. value: any;
  78779. /** the conditional operator, default ValueCondition.IsEqual */
  78780. operator: number;
  78781. /**
  78782. * Internal only
  78783. * @hidden
  78784. */
  78785. private static _IsEqual;
  78786. /**
  78787. * Internal only
  78788. * @hidden
  78789. */
  78790. private static _IsDifferent;
  78791. /**
  78792. * Internal only
  78793. * @hidden
  78794. */
  78795. private static _IsGreater;
  78796. /**
  78797. * Internal only
  78798. * @hidden
  78799. */
  78800. private static _IsLesser;
  78801. /**
  78802. * returns the number for IsEqual
  78803. */
  78804. static readonly IsEqual: number;
  78805. /**
  78806. * Returns the number for IsDifferent
  78807. */
  78808. static readonly IsDifferent: number;
  78809. /**
  78810. * Returns the number for IsGreater
  78811. */
  78812. static readonly IsGreater: number;
  78813. /**
  78814. * Returns the number for IsLesser
  78815. */
  78816. static readonly IsLesser: number;
  78817. /**
  78818. * Internal only The action manager for the condition
  78819. * @hidden
  78820. */
  78821. _actionManager: ActionManager;
  78822. /**
  78823. * Internal only
  78824. * @hidden
  78825. */
  78826. private _target;
  78827. /**
  78828. * Internal only
  78829. * @hidden
  78830. */
  78831. private _effectiveTarget;
  78832. /**
  78833. * Internal only
  78834. * @hidden
  78835. */
  78836. private _property;
  78837. /**
  78838. * Creates a new ValueCondition
  78839. * @param actionManager manager for the action the condition applies to
  78840. * @param target for the action
  78841. * @param propertyPath path to specify the property of the target the conditional operator uses
  78842. * @param value the value compared by the conditional operator against the current value of the property
  78843. * @param operator the conditional operator, default ValueCondition.IsEqual
  78844. */
  78845. constructor(actionManager: ActionManager, target: any,
  78846. /** path to specify the property of the target the conditional operator uses */
  78847. propertyPath: string,
  78848. /** the value compared by the conditional operator against the current value of the property */
  78849. value: any,
  78850. /** the conditional operator, default ValueCondition.IsEqual */
  78851. operator?: number);
  78852. /**
  78853. * Compares the given value with the property value for the specified conditional operator
  78854. * @returns the result of the comparison
  78855. */
  78856. isValid(): boolean;
  78857. /**
  78858. * Serialize the ValueCondition into a JSON compatible object
  78859. * @returns serialization object
  78860. */
  78861. serialize(): any;
  78862. /**
  78863. * Gets the name of the conditional operator for the ValueCondition
  78864. * @param operator the conditional operator
  78865. * @returns the name
  78866. */
  78867. static GetOperatorName(operator: number): string;
  78868. }
  78869. /**
  78870. * Defines a predicate condition as an extension of Condition
  78871. */
  78872. export class PredicateCondition extends Condition {
  78873. /** defines the predicate function used to validate the condition */
  78874. predicate: () => boolean;
  78875. /**
  78876. * Internal only - manager for action
  78877. * @hidden
  78878. */
  78879. _actionManager: ActionManager;
  78880. /**
  78881. * Creates a new PredicateCondition
  78882. * @param actionManager manager for the action the condition applies to
  78883. * @param predicate defines the predicate function used to validate the condition
  78884. */
  78885. constructor(actionManager: ActionManager,
  78886. /** defines the predicate function used to validate the condition */
  78887. predicate: () => boolean);
  78888. /**
  78889. * @returns the validity of the predicate condition
  78890. */
  78891. isValid(): boolean;
  78892. }
  78893. /**
  78894. * Defines a state condition as an extension of Condition
  78895. */
  78896. export class StateCondition extends Condition {
  78897. /** Value to compare with target state */
  78898. value: string;
  78899. /**
  78900. * Internal only - manager for action
  78901. * @hidden
  78902. */
  78903. _actionManager: ActionManager;
  78904. /**
  78905. * Internal only
  78906. * @hidden
  78907. */
  78908. private _target;
  78909. /**
  78910. * Creates a new StateCondition
  78911. * @param actionManager manager for the action the condition applies to
  78912. * @param target of the condition
  78913. * @param value to compare with target state
  78914. */
  78915. constructor(actionManager: ActionManager, target: any,
  78916. /** Value to compare with target state */
  78917. value: string);
  78918. /**
  78919. * Gets a boolean indicating if the current condition is met
  78920. * @returns the validity of the state
  78921. */
  78922. isValid(): boolean;
  78923. /**
  78924. * Serialize the StateCondition into a JSON compatible object
  78925. * @returns serialization object
  78926. */
  78927. serialize(): any;
  78928. }
  78929. }
  78930. declare module BABYLON {
  78931. /**
  78932. * This defines an action responsible to toggle a boolean once triggered.
  78933. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78934. */
  78935. export class SwitchBooleanAction extends Action {
  78936. /**
  78937. * The path to the boolean property in the target object
  78938. */
  78939. propertyPath: string;
  78940. private _target;
  78941. private _effectiveTarget;
  78942. private _property;
  78943. /**
  78944. * Instantiate the action
  78945. * @param triggerOptions defines the trigger options
  78946. * @param target defines the object containing the boolean
  78947. * @param propertyPath defines the path to the boolean property in the target object
  78948. * @param condition defines the trigger related conditions
  78949. */
  78950. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  78951. /** @hidden */
  78952. _prepare(): void;
  78953. /**
  78954. * Execute the action toggle the boolean value.
  78955. */
  78956. execute(): void;
  78957. /**
  78958. * Serializes the actions and its related information.
  78959. * @param parent defines the object to serialize in
  78960. * @returns the serialized object
  78961. */
  78962. serialize(parent: any): any;
  78963. }
  78964. /**
  78965. * This defines an action responsible to set a the state field of the target
  78966. * to a desired value once triggered.
  78967. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78968. */
  78969. export class SetStateAction extends Action {
  78970. /**
  78971. * The value to store in the state field.
  78972. */
  78973. value: string;
  78974. private _target;
  78975. /**
  78976. * Instantiate the action
  78977. * @param triggerOptions defines the trigger options
  78978. * @param target defines the object containing the state property
  78979. * @param value defines the value to store in the state field
  78980. * @param condition defines the trigger related conditions
  78981. */
  78982. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  78983. /**
  78984. * Execute the action and store the value on the target state property.
  78985. */
  78986. execute(): void;
  78987. /**
  78988. * Serializes the actions and its related information.
  78989. * @param parent defines the object to serialize in
  78990. * @returns the serialized object
  78991. */
  78992. serialize(parent: any): any;
  78993. }
  78994. /**
  78995. * This defines an action responsible to set a property of the target
  78996. * to a desired value once triggered.
  78997. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78998. */
  78999. export class SetValueAction extends Action {
  79000. /**
  79001. * The path of the property to set in the target.
  79002. */
  79003. propertyPath: string;
  79004. /**
  79005. * The value to set in the property
  79006. */
  79007. value: any;
  79008. private _target;
  79009. private _effectiveTarget;
  79010. private _property;
  79011. /**
  79012. * Instantiate the action
  79013. * @param triggerOptions defines the trigger options
  79014. * @param target defines the object containing the property
  79015. * @param propertyPath defines the path of the property to set in the target
  79016. * @param value defines the value to set in the property
  79017. * @param condition defines the trigger related conditions
  79018. */
  79019. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  79020. /** @hidden */
  79021. _prepare(): void;
  79022. /**
  79023. * Execute the action and set the targetted property to the desired value.
  79024. */
  79025. execute(): void;
  79026. /**
  79027. * Serializes the actions and its related information.
  79028. * @param parent defines the object to serialize in
  79029. * @returns the serialized object
  79030. */
  79031. serialize(parent: any): any;
  79032. }
  79033. /**
  79034. * This defines an action responsible to increment the target value
  79035. * to a desired value once triggered.
  79036. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79037. */
  79038. export class IncrementValueAction extends Action {
  79039. /**
  79040. * The path of the property to increment in the target.
  79041. */
  79042. propertyPath: string;
  79043. /**
  79044. * The value we should increment the property by.
  79045. */
  79046. value: any;
  79047. private _target;
  79048. private _effectiveTarget;
  79049. private _property;
  79050. /**
  79051. * Instantiate the action
  79052. * @param triggerOptions defines the trigger options
  79053. * @param target defines the object containing the property
  79054. * @param propertyPath defines the path of the property to increment in the target
  79055. * @param value defines the value value we should increment the property by
  79056. * @param condition defines the trigger related conditions
  79057. */
  79058. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  79059. /** @hidden */
  79060. _prepare(): void;
  79061. /**
  79062. * Execute the action and increment the target of the value amount.
  79063. */
  79064. execute(): void;
  79065. /**
  79066. * Serializes the actions and its related information.
  79067. * @param parent defines the object to serialize in
  79068. * @returns the serialized object
  79069. */
  79070. serialize(parent: any): any;
  79071. }
  79072. /**
  79073. * This defines an action responsible to start an animation once triggered.
  79074. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79075. */
  79076. export class PlayAnimationAction extends Action {
  79077. /**
  79078. * Where the animation should start (animation frame)
  79079. */
  79080. from: number;
  79081. /**
  79082. * Where the animation should stop (animation frame)
  79083. */
  79084. to: number;
  79085. /**
  79086. * Define if the animation should loop or stop after the first play.
  79087. */
  79088. loop?: boolean;
  79089. private _target;
  79090. /**
  79091. * Instantiate the action
  79092. * @param triggerOptions defines the trigger options
  79093. * @param target defines the target animation or animation name
  79094. * @param from defines from where the animation should start (animation frame)
  79095. * @param end defines where the animation should stop (animation frame)
  79096. * @param loop defines if the animation should loop or stop after the first play
  79097. * @param condition defines the trigger related conditions
  79098. */
  79099. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  79100. /** @hidden */
  79101. _prepare(): void;
  79102. /**
  79103. * Execute the action and play the animation.
  79104. */
  79105. execute(): void;
  79106. /**
  79107. * Serializes the actions and its related information.
  79108. * @param parent defines the object to serialize in
  79109. * @returns the serialized object
  79110. */
  79111. serialize(parent: any): any;
  79112. }
  79113. /**
  79114. * This defines an action responsible to stop an animation once triggered.
  79115. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79116. */
  79117. export class StopAnimationAction extends Action {
  79118. private _target;
  79119. /**
  79120. * Instantiate the action
  79121. * @param triggerOptions defines the trigger options
  79122. * @param target defines the target animation or animation name
  79123. * @param condition defines the trigger related conditions
  79124. */
  79125. constructor(triggerOptions: any, target: any, condition?: Condition);
  79126. /** @hidden */
  79127. _prepare(): void;
  79128. /**
  79129. * Execute the action and stop the animation.
  79130. */
  79131. execute(): void;
  79132. /**
  79133. * Serializes the actions and its related information.
  79134. * @param parent defines the object to serialize in
  79135. * @returns the serialized object
  79136. */
  79137. serialize(parent: any): any;
  79138. }
  79139. /**
  79140. * This defines an action responsible that does nothing once triggered.
  79141. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79142. */
  79143. export class DoNothingAction extends Action {
  79144. /**
  79145. * Instantiate the action
  79146. * @param triggerOptions defines the trigger options
  79147. * @param condition defines the trigger related conditions
  79148. */
  79149. constructor(triggerOptions?: any, condition?: Condition);
  79150. /**
  79151. * Execute the action and do nothing.
  79152. */
  79153. execute(): void;
  79154. /**
  79155. * Serializes the actions and its related information.
  79156. * @param parent defines the object to serialize in
  79157. * @returns the serialized object
  79158. */
  79159. serialize(parent: any): any;
  79160. }
  79161. /**
  79162. * This defines an action responsible to trigger several actions once triggered.
  79163. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79164. */
  79165. export class CombineAction extends Action {
  79166. /**
  79167. * The list of aggregated animations to run.
  79168. */
  79169. children: Action[];
  79170. /**
  79171. * Instantiate the action
  79172. * @param triggerOptions defines the trigger options
  79173. * @param children defines the list of aggregated animations to run
  79174. * @param condition defines the trigger related conditions
  79175. */
  79176. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  79177. /** @hidden */
  79178. _prepare(): void;
  79179. /**
  79180. * Execute the action and executes all the aggregated actions.
  79181. */
  79182. execute(evt: ActionEvent): void;
  79183. /**
  79184. * Serializes the actions and its related information.
  79185. * @param parent defines the object to serialize in
  79186. * @returns the serialized object
  79187. */
  79188. serialize(parent: any): any;
  79189. }
  79190. /**
  79191. * This defines an action responsible to run code (external event) once triggered.
  79192. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79193. */
  79194. export class ExecuteCodeAction extends Action {
  79195. /**
  79196. * The callback function to run.
  79197. */
  79198. func: (evt: ActionEvent) => void;
  79199. /**
  79200. * Instantiate the action
  79201. * @param triggerOptions defines the trigger options
  79202. * @param func defines the callback function to run
  79203. * @param condition defines the trigger related conditions
  79204. */
  79205. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  79206. /**
  79207. * Execute the action and run the attached code.
  79208. */
  79209. execute(evt: ActionEvent): void;
  79210. }
  79211. /**
  79212. * This defines an action responsible to set the parent property of the target once triggered.
  79213. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79214. */
  79215. export class SetParentAction extends Action {
  79216. private _parent;
  79217. private _target;
  79218. /**
  79219. * Instantiate the action
  79220. * @param triggerOptions defines the trigger options
  79221. * @param target defines the target containing the parent property
  79222. * @param parent defines from where the animation should start (animation frame)
  79223. * @param condition defines the trigger related conditions
  79224. */
  79225. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  79226. /** @hidden */
  79227. _prepare(): void;
  79228. /**
  79229. * Execute the action and set the parent property.
  79230. */
  79231. execute(): void;
  79232. /**
  79233. * Serializes the actions and its related information.
  79234. * @param parent defines the object to serialize in
  79235. * @returns the serialized object
  79236. */
  79237. serialize(parent: any): any;
  79238. }
  79239. }
  79240. declare module BABYLON {
  79241. /**
  79242. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  79243. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  79244. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79245. */
  79246. export class ActionManager extends AbstractActionManager {
  79247. /**
  79248. * Nothing
  79249. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79250. */
  79251. static readonly NothingTrigger: number;
  79252. /**
  79253. * On pick
  79254. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79255. */
  79256. static readonly OnPickTrigger: number;
  79257. /**
  79258. * On left pick
  79259. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79260. */
  79261. static readonly OnLeftPickTrigger: number;
  79262. /**
  79263. * On right pick
  79264. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79265. */
  79266. static readonly OnRightPickTrigger: number;
  79267. /**
  79268. * On center pick
  79269. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79270. */
  79271. static readonly OnCenterPickTrigger: number;
  79272. /**
  79273. * On pick down
  79274. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79275. */
  79276. static readonly OnPickDownTrigger: number;
  79277. /**
  79278. * On double pick
  79279. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79280. */
  79281. static readonly OnDoublePickTrigger: number;
  79282. /**
  79283. * On pick up
  79284. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79285. */
  79286. static readonly OnPickUpTrigger: number;
  79287. /**
  79288. * On pick out.
  79289. * This trigger will only be raised if you also declared a OnPickDown
  79290. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79291. */
  79292. static readonly OnPickOutTrigger: number;
  79293. /**
  79294. * On long press
  79295. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79296. */
  79297. static readonly OnLongPressTrigger: number;
  79298. /**
  79299. * On pointer over
  79300. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79301. */
  79302. static readonly OnPointerOverTrigger: number;
  79303. /**
  79304. * On pointer out
  79305. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79306. */
  79307. static readonly OnPointerOutTrigger: number;
  79308. /**
  79309. * On every frame
  79310. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79311. */
  79312. static readonly OnEveryFrameTrigger: number;
  79313. /**
  79314. * On intersection enter
  79315. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79316. */
  79317. static readonly OnIntersectionEnterTrigger: number;
  79318. /**
  79319. * On intersection exit
  79320. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79321. */
  79322. static readonly OnIntersectionExitTrigger: number;
  79323. /**
  79324. * On key down
  79325. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79326. */
  79327. static readonly OnKeyDownTrigger: number;
  79328. /**
  79329. * On key up
  79330. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79331. */
  79332. static readonly OnKeyUpTrigger: number;
  79333. private _scene;
  79334. /**
  79335. * Creates a new action manager
  79336. * @param scene defines the hosting scene
  79337. */
  79338. constructor(scene: Scene);
  79339. /**
  79340. * Releases all associated resources
  79341. */
  79342. dispose(): void;
  79343. /**
  79344. * Gets hosting scene
  79345. * @returns the hosting scene
  79346. */
  79347. getScene(): Scene;
  79348. /**
  79349. * Does this action manager handles actions of any of the given triggers
  79350. * @param triggers defines the triggers to be tested
  79351. * @return a boolean indicating whether one (or more) of the triggers is handled
  79352. */
  79353. hasSpecificTriggers(triggers: number[]): boolean;
  79354. /**
  79355. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  79356. * speed.
  79357. * @param triggerA defines the trigger to be tested
  79358. * @param triggerB defines the trigger to be tested
  79359. * @return a boolean indicating whether one (or more) of the triggers is handled
  79360. */
  79361. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  79362. /**
  79363. * Does this action manager handles actions of a given trigger
  79364. * @param trigger defines the trigger to be tested
  79365. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  79366. * @return whether the trigger is handled
  79367. */
  79368. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  79369. /**
  79370. * Does this action manager has pointer triggers
  79371. */
  79372. readonly hasPointerTriggers: boolean;
  79373. /**
  79374. * Does this action manager has pick triggers
  79375. */
  79376. readonly hasPickTriggers: boolean;
  79377. /**
  79378. * Registers an action to this action manager
  79379. * @param action defines the action to be registered
  79380. * @return the action amended (prepared) after registration
  79381. */
  79382. registerAction(action: IAction): Nullable<IAction>;
  79383. /**
  79384. * Unregisters an action to this action manager
  79385. * @param action defines the action to be unregistered
  79386. * @return a boolean indicating whether the action has been unregistered
  79387. */
  79388. unregisterAction(action: IAction): Boolean;
  79389. /**
  79390. * Process a specific trigger
  79391. * @param trigger defines the trigger to process
  79392. * @param evt defines the event details to be processed
  79393. */
  79394. processTrigger(trigger: number, evt?: IActionEvent): void;
  79395. /** @hidden */
  79396. _getEffectiveTarget(target: any, propertyPath: string): any;
  79397. /** @hidden */
  79398. _getProperty(propertyPath: string): string;
  79399. /**
  79400. * Serialize this manager to a JSON object
  79401. * @param name defines the property name to store this manager
  79402. * @returns a JSON representation of this manager
  79403. */
  79404. serialize(name: string): any;
  79405. /**
  79406. * Creates a new ActionManager from a JSON data
  79407. * @param parsedActions defines the JSON data to read from
  79408. * @param object defines the hosting mesh
  79409. * @param scene defines the hosting scene
  79410. */
  79411. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  79412. /**
  79413. * Get a trigger name by index
  79414. * @param trigger defines the trigger index
  79415. * @returns a trigger name
  79416. */
  79417. static GetTriggerName(trigger: number): string;
  79418. }
  79419. }
  79420. declare module BABYLON {
  79421. /**
  79422. * Class representing a ray with position and direction
  79423. */
  79424. export class Ray {
  79425. /** origin point */
  79426. origin: Vector3;
  79427. /** direction */
  79428. direction: Vector3;
  79429. /** length of the ray */
  79430. length: number;
  79431. private static readonly TmpVector3;
  79432. private _tmpRay;
  79433. /**
  79434. * Creates a new ray
  79435. * @param origin origin point
  79436. * @param direction direction
  79437. * @param length length of the ray
  79438. */
  79439. constructor(
  79440. /** origin point */
  79441. origin: Vector3,
  79442. /** direction */
  79443. direction: Vector3,
  79444. /** length of the ray */
  79445. length?: number);
  79446. /**
  79447. * Checks if the ray intersects a box
  79448. * @param minimum bound of the box
  79449. * @param maximum bound of the box
  79450. * @param intersectionTreshold extra extend to be added to the box in all direction
  79451. * @returns if the box was hit
  79452. */
  79453. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  79454. /**
  79455. * Checks if the ray intersects a box
  79456. * @param box the bounding box to check
  79457. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  79458. * @returns if the box was hit
  79459. */
  79460. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  79461. /**
  79462. * If the ray hits a sphere
  79463. * @param sphere the bounding sphere to check
  79464. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  79465. * @returns true if it hits the sphere
  79466. */
  79467. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  79468. /**
  79469. * If the ray hits a triange
  79470. * @param vertex0 triangle vertex
  79471. * @param vertex1 triangle vertex
  79472. * @param vertex2 triangle vertex
  79473. * @returns intersection information if hit
  79474. */
  79475. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  79476. /**
  79477. * Checks if ray intersects a plane
  79478. * @param plane the plane to check
  79479. * @returns the distance away it was hit
  79480. */
  79481. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  79482. /**
  79483. * Calculate the intercept of a ray on a given axis
  79484. * @param axis to check 'x' | 'y' | 'z'
  79485. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  79486. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  79487. */
  79488. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  79489. /**
  79490. * Checks if ray intersects a mesh
  79491. * @param mesh the mesh to check
  79492. * @param fastCheck if only the bounding box should checked
  79493. * @returns picking info of the intersecton
  79494. */
  79495. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  79496. /**
  79497. * Checks if ray intersects a mesh
  79498. * @param meshes the meshes to check
  79499. * @param fastCheck if only the bounding box should checked
  79500. * @param results array to store result in
  79501. * @returns Array of picking infos
  79502. */
  79503. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  79504. private _comparePickingInfo;
  79505. private static smallnum;
  79506. private static rayl;
  79507. /**
  79508. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  79509. * @param sega the first point of the segment to test the intersection against
  79510. * @param segb the second point of the segment to test the intersection against
  79511. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  79512. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  79513. */
  79514. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  79515. /**
  79516. * Update the ray from viewport position
  79517. * @param x position
  79518. * @param y y position
  79519. * @param viewportWidth viewport width
  79520. * @param viewportHeight viewport height
  79521. * @param world world matrix
  79522. * @param view view matrix
  79523. * @param projection projection matrix
  79524. * @returns this ray updated
  79525. */
  79526. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  79527. /**
  79528. * Creates a ray with origin and direction of 0,0,0
  79529. * @returns the new ray
  79530. */
  79531. static Zero(): Ray;
  79532. /**
  79533. * Creates a new ray from screen space and viewport
  79534. * @param x position
  79535. * @param y y position
  79536. * @param viewportWidth viewport width
  79537. * @param viewportHeight viewport height
  79538. * @param world world matrix
  79539. * @param view view matrix
  79540. * @param projection projection matrix
  79541. * @returns new ray
  79542. */
  79543. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  79544. /**
  79545. * 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
  79546. * transformed to the given world matrix.
  79547. * @param origin The origin point
  79548. * @param end The end point
  79549. * @param world a matrix to transform the ray to. Default is the identity matrix.
  79550. * @returns the new ray
  79551. */
  79552. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  79553. /**
  79554. * Transforms a ray by a matrix
  79555. * @param ray ray to transform
  79556. * @param matrix matrix to apply
  79557. * @returns the resulting new ray
  79558. */
  79559. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  79560. /**
  79561. * Transforms a ray by a matrix
  79562. * @param ray ray to transform
  79563. * @param matrix matrix to apply
  79564. * @param result ray to store result in
  79565. */
  79566. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  79567. /**
  79568. * Unproject a ray from screen space to object space
  79569. * @param sourceX defines the screen space x coordinate to use
  79570. * @param sourceY defines the screen space y coordinate to use
  79571. * @param viewportWidth defines the current width of the viewport
  79572. * @param viewportHeight defines the current height of the viewport
  79573. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  79574. * @param view defines the view matrix to use
  79575. * @param projection defines the projection matrix to use
  79576. */
  79577. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  79578. }
  79579. /**
  79580. * Type used to define predicate used to select faces when a mesh intersection is detected
  79581. */
  79582. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  79583. interface Scene {
  79584. /** @hidden */
  79585. _tempPickingRay: Nullable<Ray>;
  79586. /** @hidden */
  79587. _cachedRayForTransform: Ray;
  79588. /** @hidden */
  79589. _pickWithRayInverseMatrix: Matrix;
  79590. /** @hidden */
  79591. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  79592. /** @hidden */
  79593. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  79594. }
  79595. }
  79596. declare module BABYLON {
  79597. /**
  79598. * Groups all the scene component constants in one place to ease maintenance.
  79599. * @hidden
  79600. */
  79601. export class SceneComponentConstants {
  79602. static readonly NAME_EFFECTLAYER: string;
  79603. static readonly NAME_LAYER: string;
  79604. static readonly NAME_LENSFLARESYSTEM: string;
  79605. static readonly NAME_BOUNDINGBOXRENDERER: string;
  79606. static readonly NAME_PARTICLESYSTEM: string;
  79607. static readonly NAME_GAMEPAD: string;
  79608. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  79609. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  79610. static readonly NAME_DEPTHRENDERER: string;
  79611. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  79612. static readonly NAME_SPRITE: string;
  79613. static readonly NAME_OUTLINERENDERER: string;
  79614. static readonly NAME_PROCEDURALTEXTURE: string;
  79615. static readonly NAME_SHADOWGENERATOR: string;
  79616. static readonly NAME_OCTREE: string;
  79617. static readonly NAME_PHYSICSENGINE: string;
  79618. static readonly NAME_AUDIO: string;
  79619. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  79620. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  79621. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  79622. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  79623. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  79624. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  79625. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  79626. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  79627. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  79628. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  79629. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  79630. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  79631. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  79632. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  79633. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  79634. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  79635. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  79636. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  79637. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  79638. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  79639. static readonly STEP_AFTERRENDER_AUDIO: number;
  79640. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  79641. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  79642. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  79643. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  79644. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  79645. static readonly STEP_POINTERMOVE_SPRITE: number;
  79646. static readonly STEP_POINTERDOWN_SPRITE: number;
  79647. static readonly STEP_POINTERUP_SPRITE: number;
  79648. }
  79649. /**
  79650. * This represents a scene component.
  79651. *
  79652. * This is used to decouple the dependency the scene is having on the different workloads like
  79653. * layers, post processes...
  79654. */
  79655. export interface ISceneComponent {
  79656. /**
  79657. * The name of the component. Each component must have a unique name.
  79658. */
  79659. name: string;
  79660. /**
  79661. * The scene the component belongs to.
  79662. */
  79663. scene: Scene;
  79664. /**
  79665. * Register the component to one instance of a scene.
  79666. */
  79667. register(): void;
  79668. /**
  79669. * Rebuilds the elements related to this component in case of
  79670. * context lost for instance.
  79671. */
  79672. rebuild(): void;
  79673. /**
  79674. * Disposes the component and the associated ressources.
  79675. */
  79676. dispose(): void;
  79677. }
  79678. /**
  79679. * This represents a SERIALIZABLE scene component.
  79680. *
  79681. * This extends Scene Component to add Serialization methods on top.
  79682. */
  79683. export interface ISceneSerializableComponent extends ISceneComponent {
  79684. /**
  79685. * Adds all the elements from the container to the scene
  79686. * @param container the container holding the elements
  79687. */
  79688. addFromContainer(container: AbstractScene): void;
  79689. /**
  79690. * Removes all the elements in the container from the scene
  79691. * @param container contains the elements to remove
  79692. * @param dispose if the removed element should be disposed (default: false)
  79693. */
  79694. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  79695. /**
  79696. * Serializes the component data to the specified json object
  79697. * @param serializationObject The object to serialize to
  79698. */
  79699. serialize(serializationObject: any): void;
  79700. }
  79701. /**
  79702. * Strong typing of a Mesh related stage step action
  79703. */
  79704. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  79705. /**
  79706. * Strong typing of a Evaluate Sub Mesh related stage step action
  79707. */
  79708. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  79709. /**
  79710. * Strong typing of a Active Mesh related stage step action
  79711. */
  79712. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  79713. /**
  79714. * Strong typing of a Camera related stage step action
  79715. */
  79716. export type CameraStageAction = (camera: Camera) => void;
  79717. /**
  79718. * Strong typing of a Camera Frame buffer related stage step action
  79719. */
  79720. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  79721. /**
  79722. * Strong typing of a Render Target related stage step action
  79723. */
  79724. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  79725. /**
  79726. * Strong typing of a RenderingGroup related stage step action
  79727. */
  79728. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  79729. /**
  79730. * Strong typing of a Mesh Render related stage step action
  79731. */
  79732. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  79733. /**
  79734. * Strong typing of a simple stage step action
  79735. */
  79736. export type SimpleStageAction = () => void;
  79737. /**
  79738. * Strong typing of a render target action.
  79739. */
  79740. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  79741. /**
  79742. * Strong typing of a pointer move action.
  79743. */
  79744. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  79745. /**
  79746. * Strong typing of a pointer up/down action.
  79747. */
  79748. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  79749. /**
  79750. * Representation of a stage in the scene (Basically a list of ordered steps)
  79751. * @hidden
  79752. */
  79753. export class Stage<T extends Function> extends Array<{
  79754. index: number;
  79755. component: ISceneComponent;
  79756. action: T;
  79757. }> {
  79758. /**
  79759. * Hide ctor from the rest of the world.
  79760. * @param items The items to add.
  79761. */
  79762. private constructor();
  79763. /**
  79764. * Creates a new Stage.
  79765. * @returns A new instance of a Stage
  79766. */
  79767. static Create<T extends Function>(): Stage<T>;
  79768. /**
  79769. * Registers a step in an ordered way in the targeted stage.
  79770. * @param index Defines the position to register the step in
  79771. * @param component Defines the component attached to the step
  79772. * @param action Defines the action to launch during the step
  79773. */
  79774. registerStep(index: number, component: ISceneComponent, action: T): void;
  79775. /**
  79776. * Clears all the steps from the stage.
  79777. */
  79778. clear(): void;
  79779. }
  79780. }
  79781. declare module BABYLON {
  79782. interface Scene {
  79783. /** @hidden */
  79784. _pointerOverSprite: Nullable<Sprite>;
  79785. /** @hidden */
  79786. _pickedDownSprite: Nullable<Sprite>;
  79787. /** @hidden */
  79788. _tempSpritePickingRay: Nullable<Ray>;
  79789. /**
  79790. * All of the sprite managers added to this scene
  79791. * @see http://doc.babylonjs.com/babylon101/sprites
  79792. */
  79793. spriteManagers: Array<ISpriteManager>;
  79794. /**
  79795. * An event triggered when sprites rendering is about to start
  79796. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79797. */
  79798. onBeforeSpritesRenderingObservable: Observable<Scene>;
  79799. /**
  79800. * An event triggered when sprites rendering is done
  79801. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79802. */
  79803. onAfterSpritesRenderingObservable: Observable<Scene>;
  79804. /** @hidden */
  79805. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79806. /** Launch a ray to try to pick a sprite in the scene
  79807. * @param x position on screen
  79808. * @param y position on screen
  79809. * @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
  79810. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79811. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79812. * @returns a PickingInfo
  79813. */
  79814. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79815. /** Use the given ray to pick a sprite in the scene
  79816. * @param ray The ray (in world space) to use to pick meshes
  79817. * @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
  79818. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79819. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79820. * @returns a PickingInfo
  79821. */
  79822. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79823. /** @hidden */
  79824. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79825. /** Launch a ray to try to pick sprites in the scene
  79826. * @param x position on screen
  79827. * @param y position on screen
  79828. * @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
  79829. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79830. * @returns a PickingInfo array
  79831. */
  79832. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79833. /** Use the given ray to pick sprites in the scene
  79834. * @param ray The ray (in world space) to use to pick meshes
  79835. * @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
  79836. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79837. * @returns a PickingInfo array
  79838. */
  79839. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79840. /**
  79841. * Force the sprite under the pointer
  79842. * @param sprite defines the sprite to use
  79843. */
  79844. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  79845. /**
  79846. * Gets the sprite under the pointer
  79847. * @returns a Sprite or null if no sprite is under the pointer
  79848. */
  79849. getPointerOverSprite(): Nullable<Sprite>;
  79850. }
  79851. /**
  79852. * Defines the sprite scene component responsible to manage sprites
  79853. * in a given scene.
  79854. */
  79855. export class SpriteSceneComponent implements ISceneComponent {
  79856. /**
  79857. * The component name helpfull to identify the component in the list of scene components.
  79858. */
  79859. readonly name: string;
  79860. /**
  79861. * The scene the component belongs to.
  79862. */
  79863. scene: Scene;
  79864. /** @hidden */
  79865. private _spritePredicate;
  79866. /**
  79867. * Creates a new instance of the component for the given scene
  79868. * @param scene Defines the scene to register the component in
  79869. */
  79870. constructor(scene: Scene);
  79871. /**
  79872. * Registers the component in a given scene
  79873. */
  79874. register(): void;
  79875. /**
  79876. * Rebuilds the elements related to this component in case of
  79877. * context lost for instance.
  79878. */
  79879. rebuild(): void;
  79880. /**
  79881. * Disposes the component and the associated ressources.
  79882. */
  79883. dispose(): void;
  79884. private _pickSpriteButKeepRay;
  79885. private _pointerMove;
  79886. private _pointerDown;
  79887. private _pointerUp;
  79888. }
  79889. }
  79890. declare module BABYLON {
  79891. /** @hidden */
  79892. export var fogFragmentDeclaration: {
  79893. name: string;
  79894. shader: string;
  79895. };
  79896. }
  79897. declare module BABYLON {
  79898. /** @hidden */
  79899. export var fogFragment: {
  79900. name: string;
  79901. shader: string;
  79902. };
  79903. }
  79904. declare module BABYLON {
  79905. /** @hidden */
  79906. export var spritesPixelShader: {
  79907. name: string;
  79908. shader: string;
  79909. };
  79910. }
  79911. declare module BABYLON {
  79912. /** @hidden */
  79913. export var fogVertexDeclaration: {
  79914. name: string;
  79915. shader: string;
  79916. };
  79917. }
  79918. declare module BABYLON {
  79919. /** @hidden */
  79920. export var spritesVertexShader: {
  79921. name: string;
  79922. shader: string;
  79923. };
  79924. }
  79925. declare module BABYLON {
  79926. /**
  79927. * Defines the minimum interface to fullfil in order to be a sprite manager.
  79928. */
  79929. export interface ISpriteManager extends IDisposable {
  79930. /**
  79931. * Restricts the camera to viewing objects with the same layerMask.
  79932. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  79933. */
  79934. layerMask: number;
  79935. /**
  79936. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  79937. */
  79938. isPickable: boolean;
  79939. /**
  79940. * Specifies the rendering group id for this mesh (0 by default)
  79941. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  79942. */
  79943. renderingGroupId: number;
  79944. /**
  79945. * Defines the list of sprites managed by the manager.
  79946. */
  79947. sprites: Array<Sprite>;
  79948. /**
  79949. * Tests the intersection of a sprite with a specific ray.
  79950. * @param ray The ray we are sending to test the collision
  79951. * @param camera The camera space we are sending rays in
  79952. * @param predicate A predicate allowing excluding sprites from the list of object to test
  79953. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  79954. * @returns picking info or null.
  79955. */
  79956. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79957. /**
  79958. * Intersects the sprites with a ray
  79959. * @param ray defines the ray to intersect with
  79960. * @param camera defines the current active camera
  79961. * @param predicate defines a predicate used to select candidate sprites
  79962. * @returns null if no hit or a PickingInfo array
  79963. */
  79964. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79965. /**
  79966. * Renders the list of sprites on screen.
  79967. */
  79968. render(): void;
  79969. }
  79970. /**
  79971. * Class used to manage multiple sprites on the same spritesheet
  79972. * @see http://doc.babylonjs.com/babylon101/sprites
  79973. */
  79974. export class SpriteManager implements ISpriteManager {
  79975. /** defines the manager's name */
  79976. name: string;
  79977. /** Gets the list of sprites */
  79978. sprites: Sprite[];
  79979. /** Gets or sets the rendering group id (0 by default) */
  79980. renderingGroupId: number;
  79981. /** Gets or sets camera layer mask */
  79982. layerMask: number;
  79983. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  79984. fogEnabled: boolean;
  79985. /** Gets or sets a boolean indicating if the sprites are pickable */
  79986. isPickable: boolean;
  79987. /** Defines the default width of a cell in the spritesheet */
  79988. cellWidth: number;
  79989. /** Defines the default height of a cell in the spritesheet */
  79990. cellHeight: number;
  79991. /** Associative array from JSON sprite data file */
  79992. private _cellData;
  79993. /** Array of sprite names from JSON sprite data file */
  79994. private _spriteMap;
  79995. /** True when packed cell data from JSON file is ready*/
  79996. private _packedAndReady;
  79997. /**
  79998. * An event triggered when the manager is disposed.
  79999. */
  80000. onDisposeObservable: Observable<SpriteManager>;
  80001. private _onDisposeObserver;
  80002. /**
  80003. * Callback called when the manager is disposed
  80004. */
  80005. onDispose: () => void;
  80006. private _capacity;
  80007. private _fromPacked;
  80008. private _spriteTexture;
  80009. private _epsilon;
  80010. private _scene;
  80011. private _vertexData;
  80012. private _buffer;
  80013. private _vertexBuffers;
  80014. private _indexBuffer;
  80015. private _effectBase;
  80016. private _effectFog;
  80017. /**
  80018. * Gets or sets the spritesheet texture
  80019. */
  80020. texture: Texture;
  80021. /**
  80022. * Creates a new sprite manager
  80023. * @param name defines the manager's name
  80024. * @param imgUrl defines the sprite sheet url
  80025. * @param capacity defines the maximum allowed number of sprites
  80026. * @param cellSize defines the size of a sprite cell
  80027. * @param scene defines the hosting scene
  80028. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  80029. * @param samplingMode defines the smapling mode to use with spritesheet
  80030. * @param fromPacked set to false; do not alter
  80031. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  80032. */
  80033. constructor(
  80034. /** defines the manager's name */
  80035. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  80036. private _makePacked;
  80037. private _appendSpriteVertex;
  80038. /**
  80039. * Intersects the sprites with a ray
  80040. * @param ray defines the ray to intersect with
  80041. * @param camera defines the current active camera
  80042. * @param predicate defines a predicate used to select candidate sprites
  80043. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  80044. * @returns null if no hit or a PickingInfo
  80045. */
  80046. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  80047. /**
  80048. * Intersects the sprites with a ray
  80049. * @param ray defines the ray to intersect with
  80050. * @param camera defines the current active camera
  80051. * @param predicate defines a predicate used to select candidate sprites
  80052. * @returns null if no hit or a PickingInfo array
  80053. */
  80054. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  80055. /**
  80056. * Render all child sprites
  80057. */
  80058. render(): void;
  80059. /**
  80060. * Release associated resources
  80061. */
  80062. dispose(): void;
  80063. }
  80064. }
  80065. declare module BABYLON {
  80066. /**
  80067. * Class used to represent a sprite
  80068. * @see http://doc.babylonjs.com/babylon101/sprites
  80069. */
  80070. export class Sprite {
  80071. /** defines the name */
  80072. name: string;
  80073. /** Gets or sets the current world position */
  80074. position: Vector3;
  80075. /** Gets or sets the main color */
  80076. color: Color4;
  80077. /** Gets or sets the width */
  80078. width: number;
  80079. /** Gets or sets the height */
  80080. height: number;
  80081. /** Gets or sets rotation angle */
  80082. angle: number;
  80083. /** Gets or sets the cell index in the sprite sheet */
  80084. cellIndex: number;
  80085. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  80086. cellRef: string;
  80087. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  80088. invertU: number;
  80089. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  80090. invertV: number;
  80091. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  80092. disposeWhenFinishedAnimating: boolean;
  80093. /** Gets the list of attached animations */
  80094. animations: Animation[];
  80095. /** Gets or sets a boolean indicating if the sprite can be picked */
  80096. isPickable: boolean;
  80097. /**
  80098. * Gets or sets the associated action manager
  80099. */
  80100. actionManager: Nullable<ActionManager>;
  80101. private _animationStarted;
  80102. private _loopAnimation;
  80103. private _fromIndex;
  80104. private _toIndex;
  80105. private _delay;
  80106. private _direction;
  80107. private _manager;
  80108. private _time;
  80109. private _onAnimationEnd;
  80110. /**
  80111. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  80112. */
  80113. isVisible: boolean;
  80114. /**
  80115. * Gets or sets the sprite size
  80116. */
  80117. size: number;
  80118. /**
  80119. * Creates a new Sprite
  80120. * @param name defines the name
  80121. * @param manager defines the manager
  80122. */
  80123. constructor(
  80124. /** defines the name */
  80125. name: string, manager: ISpriteManager);
  80126. /**
  80127. * Starts an animation
  80128. * @param from defines the initial key
  80129. * @param to defines the end key
  80130. * @param loop defines if the animation must loop
  80131. * @param delay defines the start delay (in ms)
  80132. * @param onAnimationEnd defines a callback to call when animation ends
  80133. */
  80134. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  80135. /** Stops current animation (if any) */
  80136. stopAnimation(): void;
  80137. /** @hidden */
  80138. _animate(deltaTime: number): void;
  80139. /** Release associated resources */
  80140. dispose(): void;
  80141. }
  80142. }
  80143. declare module BABYLON {
  80144. /**
  80145. * Information about the result of picking within a scene
  80146. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  80147. */
  80148. export class PickingInfo {
  80149. /** @hidden */
  80150. _pickingUnavailable: boolean;
  80151. /**
  80152. * If the pick collided with an object
  80153. */
  80154. hit: boolean;
  80155. /**
  80156. * Distance away where the pick collided
  80157. */
  80158. distance: number;
  80159. /**
  80160. * The location of pick collision
  80161. */
  80162. pickedPoint: Nullable<Vector3>;
  80163. /**
  80164. * The mesh corresponding the the pick collision
  80165. */
  80166. pickedMesh: Nullable<AbstractMesh>;
  80167. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  80168. bu: number;
  80169. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  80170. bv: number;
  80171. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  80172. faceId: number;
  80173. /** Id of the the submesh that was picked */
  80174. subMeshId: number;
  80175. /** If a sprite was picked, this will be the sprite the pick collided with */
  80176. pickedSprite: Nullable<Sprite>;
  80177. /**
  80178. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  80179. */
  80180. originMesh: Nullable<AbstractMesh>;
  80181. /**
  80182. * The ray that was used to perform the picking.
  80183. */
  80184. ray: Nullable<Ray>;
  80185. /**
  80186. * Gets the normal correspodning to the face the pick collided with
  80187. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  80188. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  80189. * @returns The normal correspodning to the face the pick collided with
  80190. */
  80191. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  80192. /**
  80193. * Gets the texture coordinates of where the pick occured
  80194. * @returns the vector containing the coordnates of the texture
  80195. */
  80196. getTextureCoordinates(): Nullable<Vector2>;
  80197. }
  80198. }
  80199. declare module BABYLON {
  80200. /**
  80201. * Gather the list of pointer event types as constants.
  80202. */
  80203. export class PointerEventTypes {
  80204. /**
  80205. * 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.
  80206. */
  80207. static readonly POINTERDOWN: number;
  80208. /**
  80209. * The pointerup event is fired when a pointer is no longer active.
  80210. */
  80211. static readonly POINTERUP: number;
  80212. /**
  80213. * The pointermove event is fired when a pointer changes coordinates.
  80214. */
  80215. static readonly POINTERMOVE: number;
  80216. /**
  80217. * The pointerwheel event is fired when a mouse wheel has been rotated.
  80218. */
  80219. static readonly POINTERWHEEL: number;
  80220. /**
  80221. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  80222. */
  80223. static readonly POINTERPICK: number;
  80224. /**
  80225. * The pointertap event is fired when a the object has been touched and released without drag.
  80226. */
  80227. static readonly POINTERTAP: number;
  80228. /**
  80229. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  80230. */
  80231. static readonly POINTERDOUBLETAP: number;
  80232. }
  80233. /**
  80234. * Base class of pointer info types.
  80235. */
  80236. export class PointerInfoBase {
  80237. /**
  80238. * Defines the type of event (PointerEventTypes)
  80239. */
  80240. type: number;
  80241. /**
  80242. * Defines the related dom event
  80243. */
  80244. event: PointerEvent | MouseWheelEvent;
  80245. /**
  80246. * Instantiates the base class of pointers info.
  80247. * @param type Defines the type of event (PointerEventTypes)
  80248. * @param event Defines the related dom event
  80249. */
  80250. constructor(
  80251. /**
  80252. * Defines the type of event (PointerEventTypes)
  80253. */
  80254. type: number,
  80255. /**
  80256. * Defines the related dom event
  80257. */
  80258. event: PointerEvent | MouseWheelEvent);
  80259. }
  80260. /**
  80261. * This class is used to store pointer related info for the onPrePointerObservable event.
  80262. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  80263. */
  80264. export class PointerInfoPre extends PointerInfoBase {
  80265. /**
  80266. * Ray from a pointer if availible (eg. 6dof controller)
  80267. */
  80268. ray: Nullable<Ray>;
  80269. /**
  80270. * Defines the local position of the pointer on the canvas.
  80271. */
  80272. localPosition: Vector2;
  80273. /**
  80274. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  80275. */
  80276. skipOnPointerObservable: boolean;
  80277. /**
  80278. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  80279. * @param type Defines the type of event (PointerEventTypes)
  80280. * @param event Defines the related dom event
  80281. * @param localX Defines the local x coordinates of the pointer when the event occured
  80282. * @param localY Defines the local y coordinates of the pointer when the event occured
  80283. */
  80284. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  80285. }
  80286. /**
  80287. * This type contains all the data related to a pointer event in Babylon.js.
  80288. * 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.
  80289. */
  80290. export class PointerInfo extends PointerInfoBase {
  80291. /**
  80292. * Defines the picking info associated to the info (if any)\
  80293. */
  80294. pickInfo: Nullable<PickingInfo>;
  80295. /**
  80296. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  80297. * @param type Defines the type of event (PointerEventTypes)
  80298. * @param event Defines the related dom event
  80299. * @param pickInfo Defines the picking info associated to the info (if any)\
  80300. */
  80301. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  80302. /**
  80303. * Defines the picking info associated to the info (if any)\
  80304. */
  80305. pickInfo: Nullable<PickingInfo>);
  80306. }
  80307. /**
  80308. * Data relating to a touch event on the screen.
  80309. */
  80310. export interface PointerTouch {
  80311. /**
  80312. * X coordinate of touch.
  80313. */
  80314. x: number;
  80315. /**
  80316. * Y coordinate of touch.
  80317. */
  80318. y: number;
  80319. /**
  80320. * Id of touch. Unique for each finger.
  80321. */
  80322. pointerId: number;
  80323. /**
  80324. * Event type passed from DOM.
  80325. */
  80326. type: any;
  80327. }
  80328. }
  80329. declare module BABYLON {
  80330. /**
  80331. * Manage the mouse inputs to control the movement of a free camera.
  80332. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80333. */
  80334. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  80335. /**
  80336. * Define if touch is enabled in the mouse input
  80337. */
  80338. touchEnabled: boolean;
  80339. /**
  80340. * Defines the camera the input is attached to.
  80341. */
  80342. camera: FreeCamera;
  80343. /**
  80344. * Defines the buttons associated with the input to handle camera move.
  80345. */
  80346. buttons: number[];
  80347. /**
  80348. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  80349. */
  80350. angularSensibility: number;
  80351. private _pointerInput;
  80352. private _onMouseMove;
  80353. private _observer;
  80354. private previousPosition;
  80355. /**
  80356. * Observable for when a pointer move event occurs containing the move offset
  80357. */
  80358. onPointerMovedObservable: Observable<{
  80359. offsetX: number;
  80360. offsetY: number;
  80361. }>;
  80362. /**
  80363. * @hidden
  80364. * If the camera should be rotated automatically based on pointer movement
  80365. */
  80366. _allowCameraRotation: boolean;
  80367. /**
  80368. * Manage the mouse inputs to control the movement of a free camera.
  80369. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80370. * @param touchEnabled Defines if touch is enabled or not
  80371. */
  80372. constructor(
  80373. /**
  80374. * Define if touch is enabled in the mouse input
  80375. */
  80376. touchEnabled?: boolean);
  80377. /**
  80378. * Attach the input controls to a specific dom element to get the input from.
  80379. * @param element Defines the element the controls should be listened from
  80380. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80381. */
  80382. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80383. /**
  80384. * Called on JS contextmenu event.
  80385. * Override this method to provide functionality.
  80386. */
  80387. protected onContextMenu(evt: PointerEvent): void;
  80388. /**
  80389. * Detach the current controls from the specified dom element.
  80390. * @param element Defines the element to stop listening the inputs from
  80391. */
  80392. detachControl(element: Nullable<HTMLElement>): void;
  80393. /**
  80394. * Gets the class name of the current intput.
  80395. * @returns the class name
  80396. */
  80397. getClassName(): string;
  80398. /**
  80399. * Get the friendly name associated with the input class.
  80400. * @returns the input friendly name
  80401. */
  80402. getSimpleName(): string;
  80403. }
  80404. }
  80405. declare module BABYLON {
  80406. /**
  80407. * Manage the touch inputs to control the movement of a free camera.
  80408. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80409. */
  80410. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  80411. /**
  80412. * Defines the camera the input is attached to.
  80413. */
  80414. camera: FreeCamera;
  80415. /**
  80416. * Defines the touch sensibility for rotation.
  80417. * The higher the faster.
  80418. */
  80419. touchAngularSensibility: number;
  80420. /**
  80421. * Defines the touch sensibility for move.
  80422. * The higher the faster.
  80423. */
  80424. touchMoveSensibility: number;
  80425. private _offsetX;
  80426. private _offsetY;
  80427. private _pointerPressed;
  80428. private _pointerInput;
  80429. private _observer;
  80430. private _onLostFocus;
  80431. /**
  80432. * Attach the input controls to a specific dom element to get the input from.
  80433. * @param element Defines the element the controls should be listened from
  80434. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80435. */
  80436. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80437. /**
  80438. * Detach the current controls from the specified dom element.
  80439. * @param element Defines the element to stop listening the inputs from
  80440. */
  80441. detachControl(element: Nullable<HTMLElement>): void;
  80442. /**
  80443. * Update the current camera state depending on the inputs that have been used this frame.
  80444. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  80445. */
  80446. checkInputs(): void;
  80447. /**
  80448. * Gets the class name of the current intput.
  80449. * @returns the class name
  80450. */
  80451. getClassName(): string;
  80452. /**
  80453. * Get the friendly name associated with the input class.
  80454. * @returns the input friendly name
  80455. */
  80456. getSimpleName(): string;
  80457. }
  80458. }
  80459. declare module BABYLON {
  80460. /**
  80461. * Default Inputs manager for the FreeCamera.
  80462. * It groups all the default supported inputs for ease of use.
  80463. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80464. */
  80465. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  80466. /**
  80467. * @hidden
  80468. */
  80469. _mouseInput: Nullable<FreeCameraMouseInput>;
  80470. /**
  80471. * Instantiates a new FreeCameraInputsManager.
  80472. * @param camera Defines the camera the inputs belong to
  80473. */
  80474. constructor(camera: FreeCamera);
  80475. /**
  80476. * Add keyboard input support to the input manager.
  80477. * @returns the current input manager
  80478. */
  80479. addKeyboard(): FreeCameraInputsManager;
  80480. /**
  80481. * Add mouse input support to the input manager.
  80482. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  80483. * @returns the current input manager
  80484. */
  80485. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  80486. /**
  80487. * Removes the mouse input support from the manager
  80488. * @returns the current input manager
  80489. */
  80490. removeMouse(): FreeCameraInputsManager;
  80491. /**
  80492. * Add touch input support to the input manager.
  80493. * @returns the current input manager
  80494. */
  80495. addTouch(): FreeCameraInputsManager;
  80496. /**
  80497. * Remove all attached input methods from a camera
  80498. */
  80499. clear(): void;
  80500. }
  80501. }
  80502. declare module BABYLON {
  80503. /**
  80504. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  80505. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  80506. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  80507. */
  80508. export class FreeCamera extends TargetCamera {
  80509. /**
  80510. * Define the collision ellipsoid of the camera.
  80511. * This is helpful to simulate a camera body like the player body around the camera
  80512. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  80513. */
  80514. ellipsoid: Vector3;
  80515. /**
  80516. * Define an offset for the position of the ellipsoid around the camera.
  80517. * This can be helpful to determine the center of the body near the gravity center of the body
  80518. * instead of its head.
  80519. */
  80520. ellipsoidOffset: Vector3;
  80521. /**
  80522. * Enable or disable collisions of the camera with the rest of the scene objects.
  80523. */
  80524. checkCollisions: boolean;
  80525. /**
  80526. * Enable or disable gravity on the camera.
  80527. */
  80528. applyGravity: boolean;
  80529. /**
  80530. * Define the input manager associated to the camera.
  80531. */
  80532. inputs: FreeCameraInputsManager;
  80533. /**
  80534. * Gets the input sensibility for a mouse input. (default is 2000.0)
  80535. * Higher values reduce sensitivity.
  80536. */
  80537. /**
  80538. * Sets the input sensibility for a mouse input. (default is 2000.0)
  80539. * Higher values reduce sensitivity.
  80540. */
  80541. angularSensibility: number;
  80542. /**
  80543. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  80544. */
  80545. keysUp: number[];
  80546. /**
  80547. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  80548. */
  80549. keysDown: number[];
  80550. /**
  80551. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  80552. */
  80553. keysLeft: number[];
  80554. /**
  80555. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  80556. */
  80557. keysRight: number[];
  80558. /**
  80559. * Event raised when the camera collide with a mesh in the scene.
  80560. */
  80561. onCollide: (collidedMesh: AbstractMesh) => void;
  80562. private _collider;
  80563. private _needMoveForGravity;
  80564. private _oldPosition;
  80565. private _diffPosition;
  80566. private _newPosition;
  80567. /** @hidden */
  80568. _localDirection: Vector3;
  80569. /** @hidden */
  80570. _transformedDirection: Vector3;
  80571. /**
  80572. * Instantiates a Free Camera.
  80573. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  80574. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  80575. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  80576. * @param name Define the name of the camera in the scene
  80577. * @param position Define the start position of the camera in the scene
  80578. * @param scene Define the scene the camera belongs to
  80579. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  80580. */
  80581. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  80582. /**
  80583. * Attached controls to the current camera.
  80584. * @param element Defines the element the controls should be listened from
  80585. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80586. */
  80587. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80588. /**
  80589. * Detach the current controls from the camera.
  80590. * The camera will stop reacting to inputs.
  80591. * @param element Defines the element to stop listening the inputs from
  80592. */
  80593. detachControl(element: HTMLElement): void;
  80594. private _collisionMask;
  80595. /**
  80596. * Define a collision mask to limit the list of object the camera can collide with
  80597. */
  80598. collisionMask: number;
  80599. /** @hidden */
  80600. _collideWithWorld(displacement: Vector3): void;
  80601. private _onCollisionPositionChange;
  80602. /** @hidden */
  80603. _checkInputs(): void;
  80604. /** @hidden */
  80605. _decideIfNeedsToMove(): boolean;
  80606. /** @hidden */
  80607. _updatePosition(): void;
  80608. /**
  80609. * Destroy the camera and release the current resources hold by it.
  80610. */
  80611. dispose(): void;
  80612. /**
  80613. * Gets the current object class name.
  80614. * @return the class name
  80615. */
  80616. getClassName(): string;
  80617. }
  80618. }
  80619. declare module BABYLON {
  80620. /**
  80621. * Represents a gamepad control stick position
  80622. */
  80623. export class StickValues {
  80624. /**
  80625. * The x component of the control stick
  80626. */
  80627. x: number;
  80628. /**
  80629. * The y component of the control stick
  80630. */
  80631. y: number;
  80632. /**
  80633. * Initializes the gamepad x and y control stick values
  80634. * @param x The x component of the gamepad control stick value
  80635. * @param y The y component of the gamepad control stick value
  80636. */
  80637. constructor(
  80638. /**
  80639. * The x component of the control stick
  80640. */
  80641. x: number,
  80642. /**
  80643. * The y component of the control stick
  80644. */
  80645. y: number);
  80646. }
  80647. /**
  80648. * An interface which manages callbacks for gamepad button changes
  80649. */
  80650. export interface GamepadButtonChanges {
  80651. /**
  80652. * Called when a gamepad has been changed
  80653. */
  80654. changed: boolean;
  80655. /**
  80656. * Called when a gamepad press event has been triggered
  80657. */
  80658. pressChanged: boolean;
  80659. /**
  80660. * Called when a touch event has been triggered
  80661. */
  80662. touchChanged: boolean;
  80663. /**
  80664. * Called when a value has changed
  80665. */
  80666. valueChanged: boolean;
  80667. }
  80668. /**
  80669. * Represents a gamepad
  80670. */
  80671. export class Gamepad {
  80672. /**
  80673. * The id of the gamepad
  80674. */
  80675. id: string;
  80676. /**
  80677. * The index of the gamepad
  80678. */
  80679. index: number;
  80680. /**
  80681. * The browser gamepad
  80682. */
  80683. browserGamepad: any;
  80684. /**
  80685. * Specifies what type of gamepad this represents
  80686. */
  80687. type: number;
  80688. private _leftStick;
  80689. private _rightStick;
  80690. /** @hidden */
  80691. _isConnected: boolean;
  80692. private _leftStickAxisX;
  80693. private _leftStickAxisY;
  80694. private _rightStickAxisX;
  80695. private _rightStickAxisY;
  80696. /**
  80697. * Triggered when the left control stick has been changed
  80698. */
  80699. private _onleftstickchanged;
  80700. /**
  80701. * Triggered when the right control stick has been changed
  80702. */
  80703. private _onrightstickchanged;
  80704. /**
  80705. * Represents a gamepad controller
  80706. */
  80707. static GAMEPAD: number;
  80708. /**
  80709. * Represents a generic controller
  80710. */
  80711. static GENERIC: number;
  80712. /**
  80713. * Represents an XBox controller
  80714. */
  80715. static XBOX: number;
  80716. /**
  80717. * Represents a pose-enabled controller
  80718. */
  80719. static POSE_ENABLED: number;
  80720. /**
  80721. * Represents an Dual Shock controller
  80722. */
  80723. static DUALSHOCK: number;
  80724. /**
  80725. * Specifies whether the left control stick should be Y-inverted
  80726. */
  80727. protected _invertLeftStickY: boolean;
  80728. /**
  80729. * Specifies if the gamepad has been connected
  80730. */
  80731. readonly isConnected: boolean;
  80732. /**
  80733. * Initializes the gamepad
  80734. * @param id The id of the gamepad
  80735. * @param index The index of the gamepad
  80736. * @param browserGamepad The browser gamepad
  80737. * @param leftStickX The x component of the left joystick
  80738. * @param leftStickY The y component of the left joystick
  80739. * @param rightStickX The x component of the right joystick
  80740. * @param rightStickY The y component of the right joystick
  80741. */
  80742. constructor(
  80743. /**
  80744. * The id of the gamepad
  80745. */
  80746. id: string,
  80747. /**
  80748. * The index of the gamepad
  80749. */
  80750. index: number,
  80751. /**
  80752. * The browser gamepad
  80753. */
  80754. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  80755. /**
  80756. * Callback triggered when the left joystick has changed
  80757. * @param callback
  80758. */
  80759. onleftstickchanged(callback: (values: StickValues) => void): void;
  80760. /**
  80761. * Callback triggered when the right joystick has changed
  80762. * @param callback
  80763. */
  80764. onrightstickchanged(callback: (values: StickValues) => void): void;
  80765. /**
  80766. * Gets the left joystick
  80767. */
  80768. /**
  80769. * Sets the left joystick values
  80770. */
  80771. leftStick: StickValues;
  80772. /**
  80773. * Gets the right joystick
  80774. */
  80775. /**
  80776. * Sets the right joystick value
  80777. */
  80778. rightStick: StickValues;
  80779. /**
  80780. * Updates the gamepad joystick positions
  80781. */
  80782. update(): void;
  80783. /**
  80784. * Disposes the gamepad
  80785. */
  80786. dispose(): void;
  80787. }
  80788. /**
  80789. * Represents a generic gamepad
  80790. */
  80791. export class GenericPad extends Gamepad {
  80792. private _buttons;
  80793. private _onbuttondown;
  80794. private _onbuttonup;
  80795. /**
  80796. * Observable triggered when a button has been pressed
  80797. */
  80798. onButtonDownObservable: Observable<number>;
  80799. /**
  80800. * Observable triggered when a button has been released
  80801. */
  80802. onButtonUpObservable: Observable<number>;
  80803. /**
  80804. * Callback triggered when a button has been pressed
  80805. * @param callback Called when a button has been pressed
  80806. */
  80807. onbuttondown(callback: (buttonPressed: number) => void): void;
  80808. /**
  80809. * Callback triggered when a button has been released
  80810. * @param callback Called when a button has been released
  80811. */
  80812. onbuttonup(callback: (buttonReleased: number) => void): void;
  80813. /**
  80814. * Initializes the generic gamepad
  80815. * @param id The id of the generic gamepad
  80816. * @param index The index of the generic gamepad
  80817. * @param browserGamepad The browser gamepad
  80818. */
  80819. constructor(id: string, index: number, browserGamepad: any);
  80820. private _setButtonValue;
  80821. /**
  80822. * Updates the generic gamepad
  80823. */
  80824. update(): void;
  80825. /**
  80826. * Disposes the generic gamepad
  80827. */
  80828. dispose(): void;
  80829. }
  80830. }
  80831. declare module BABYLON {
  80832. interface Engine {
  80833. /**
  80834. * Creates a raw texture
  80835. * @param data defines the data to store in the texture
  80836. * @param width defines the width of the texture
  80837. * @param height defines the height of the texture
  80838. * @param format defines the format of the data
  80839. * @param generateMipMaps defines if the engine should generate the mip levels
  80840. * @param invertY defines if data must be stored with Y axis inverted
  80841. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  80842. * @param compression defines the compression used (null by default)
  80843. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80844. * @returns the raw texture inside an InternalTexture
  80845. */
  80846. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  80847. /**
  80848. * Update a raw texture
  80849. * @param texture defines the texture to update
  80850. * @param data defines the data to store in the texture
  80851. * @param format defines the format of the data
  80852. * @param invertY defines if data must be stored with Y axis inverted
  80853. */
  80854. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80855. /**
  80856. * Update a raw texture
  80857. * @param texture defines the texture to update
  80858. * @param data defines the data to store in the texture
  80859. * @param format defines the format of the data
  80860. * @param invertY defines if data must be stored with Y axis inverted
  80861. * @param compression defines the compression used (null by default)
  80862. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80863. */
  80864. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  80865. /**
  80866. * Creates a new raw cube texture
  80867. * @param data defines the array of data to use to create each face
  80868. * @param size defines the size of the textures
  80869. * @param format defines the format of the data
  80870. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80871. * @param generateMipMaps defines if the engine should generate the mip levels
  80872. * @param invertY defines if data must be stored with Y axis inverted
  80873. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80874. * @param compression defines the compression used (null by default)
  80875. * @returns the cube texture as an InternalTexture
  80876. */
  80877. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  80878. /**
  80879. * Update a raw cube texture
  80880. * @param texture defines the texture to udpdate
  80881. * @param data defines the data to store
  80882. * @param format defines the data format
  80883. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80884. * @param invertY defines if data must be stored with Y axis inverted
  80885. */
  80886. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  80887. /**
  80888. * Update a raw cube texture
  80889. * @param texture defines the texture to udpdate
  80890. * @param data defines the data to store
  80891. * @param format defines the data format
  80892. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80893. * @param invertY defines if data must be stored with Y axis inverted
  80894. * @param compression defines the compression used (null by default)
  80895. */
  80896. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  80897. /**
  80898. * Update a raw cube texture
  80899. * @param texture defines the texture to udpdate
  80900. * @param data defines the data to store
  80901. * @param format defines the data format
  80902. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80903. * @param invertY defines if data must be stored with Y axis inverted
  80904. * @param compression defines the compression used (null by default)
  80905. * @param level defines which level of the texture to update
  80906. */
  80907. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  80908. /**
  80909. * Creates a new raw cube texture from a specified url
  80910. * @param url defines the url where the data is located
  80911. * @param scene defines the current scene
  80912. * @param size defines the size of the textures
  80913. * @param format defines the format of the data
  80914. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80915. * @param noMipmap defines if the engine should avoid generating the mip levels
  80916. * @param callback defines a callback used to extract texture data from loaded data
  80917. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80918. * @param onLoad defines a callback called when texture is loaded
  80919. * @param onError defines a callback called if there is an error
  80920. * @returns the cube texture as an InternalTexture
  80921. */
  80922. 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;
  80923. /**
  80924. * Creates a new raw cube texture from a specified url
  80925. * @param url defines the url where the data is located
  80926. * @param scene defines the current scene
  80927. * @param size defines the size of the textures
  80928. * @param format defines the format of the data
  80929. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80930. * @param noMipmap defines if the engine should avoid generating the mip levels
  80931. * @param callback defines a callback used to extract texture data from loaded data
  80932. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80933. * @param onLoad defines a callback called when texture is loaded
  80934. * @param onError defines a callback called if there is an error
  80935. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80936. * @param invertY defines if data must be stored with Y axis inverted
  80937. * @returns the cube texture as an InternalTexture
  80938. */
  80939. 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;
  80940. /**
  80941. * Creates a new raw 3D texture
  80942. * @param data defines the data used to create the texture
  80943. * @param width defines the width of the texture
  80944. * @param height defines the height of the texture
  80945. * @param depth defines the depth of the texture
  80946. * @param format defines the format of the texture
  80947. * @param generateMipMaps defines if the engine must generate mip levels
  80948. * @param invertY defines if data must be stored with Y axis inverted
  80949. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80950. * @param compression defines the compressed used (can be null)
  80951. * @param textureType defines the compressed used (can be null)
  80952. * @returns a new raw 3D texture (stored in an InternalTexture)
  80953. */
  80954. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80955. /**
  80956. * Update a raw 3D texture
  80957. * @param texture defines the texture to update
  80958. * @param data defines the data to store
  80959. * @param format defines the data format
  80960. * @param invertY defines if data must be stored with Y axis inverted
  80961. */
  80962. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80963. /**
  80964. * Update a raw 3D texture
  80965. * @param texture defines the texture to update
  80966. * @param data defines the data to store
  80967. * @param format defines the data format
  80968. * @param invertY defines if data must be stored with Y axis inverted
  80969. * @param compression defines the used compression (can be null)
  80970. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80971. */
  80972. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80973. /**
  80974. * Creates a new raw 2D array texture
  80975. * @param data defines the data used to create the texture
  80976. * @param width defines the width of the texture
  80977. * @param height defines the height of the texture
  80978. * @param depth defines the number of layers of the texture
  80979. * @param format defines the format of the texture
  80980. * @param generateMipMaps defines if the engine must generate mip levels
  80981. * @param invertY defines if data must be stored with Y axis inverted
  80982. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80983. * @param compression defines the compressed used (can be null)
  80984. * @param textureType defines the compressed used (can be null)
  80985. * @returns a new raw 2D array texture (stored in an InternalTexture)
  80986. */
  80987. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80988. /**
  80989. * Update a raw 2D array texture
  80990. * @param texture defines the texture to update
  80991. * @param data defines the data to store
  80992. * @param format defines the data format
  80993. * @param invertY defines if data must be stored with Y axis inverted
  80994. */
  80995. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80996. /**
  80997. * Update a raw 2D array texture
  80998. * @param texture defines the texture to update
  80999. * @param data defines the data to store
  81000. * @param format defines the data format
  81001. * @param invertY defines if data must be stored with Y axis inverted
  81002. * @param compression defines the used compression (can be null)
  81003. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  81004. */
  81005. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  81006. }
  81007. }
  81008. declare module BABYLON {
  81009. /**
  81010. * Raw texture can help creating a texture directly from an array of data.
  81011. * This can be super useful if you either get the data from an uncompressed source or
  81012. * if you wish to create your texture pixel by pixel.
  81013. */
  81014. export class RawTexture extends Texture {
  81015. /**
  81016. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  81017. */
  81018. format: number;
  81019. private _engine;
  81020. /**
  81021. * Instantiates a new RawTexture.
  81022. * Raw texture can help creating a texture directly from an array of data.
  81023. * This can be super useful if you either get the data from an uncompressed source or
  81024. * if you wish to create your texture pixel by pixel.
  81025. * @param data define the array of data to use to create the texture
  81026. * @param width define the width of the texture
  81027. * @param height define the height of the texture
  81028. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  81029. * @param scene define the scene the texture belongs to
  81030. * @param generateMipMaps define whether mip maps should be generated or not
  81031. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81032. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81033. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81034. */
  81035. constructor(data: ArrayBufferView, width: number, height: number,
  81036. /**
  81037. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  81038. */
  81039. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  81040. /**
  81041. * Updates the texture underlying data.
  81042. * @param data Define the new data of the texture
  81043. */
  81044. update(data: ArrayBufferView): void;
  81045. /**
  81046. * Creates a luminance texture from some data.
  81047. * @param data Define the texture data
  81048. * @param width Define the width of the texture
  81049. * @param height Define the height of the texture
  81050. * @param scene Define the scene the texture belongs to
  81051. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81052. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81053. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81054. * @returns the luminance texture
  81055. */
  81056. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  81057. /**
  81058. * Creates a luminance alpha texture from some data.
  81059. * @param data Define the texture data
  81060. * @param width Define the width of the texture
  81061. * @param height Define the height of the texture
  81062. * @param scene Define the scene the texture belongs to
  81063. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81064. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81065. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81066. * @returns the luminance alpha texture
  81067. */
  81068. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  81069. /**
  81070. * Creates an alpha texture from some data.
  81071. * @param data Define the texture data
  81072. * @param width Define the width of the texture
  81073. * @param height Define the height of the texture
  81074. * @param scene Define the scene the texture belongs to
  81075. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81076. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81077. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81078. * @returns the alpha texture
  81079. */
  81080. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  81081. /**
  81082. * Creates a RGB texture from some data.
  81083. * @param data Define the texture data
  81084. * @param width Define the width of the texture
  81085. * @param height Define the height of the texture
  81086. * @param scene Define the scene the texture belongs to
  81087. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81088. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81089. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81090. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81091. * @returns the RGB alpha texture
  81092. */
  81093. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  81094. /**
  81095. * Creates a RGBA texture from some data.
  81096. * @param data Define the texture data
  81097. * @param width Define the width of the texture
  81098. * @param height Define the height of the texture
  81099. * @param scene Define the scene the texture belongs to
  81100. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81101. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81102. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81103. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81104. * @returns the RGBA texture
  81105. */
  81106. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  81107. /**
  81108. * Creates a R texture from some data.
  81109. * @param data Define the texture data
  81110. * @param width Define the width of the texture
  81111. * @param height Define the height of the texture
  81112. * @param scene Define the scene the texture belongs to
  81113. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81114. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81115. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81116. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81117. * @returns the R texture
  81118. */
  81119. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  81120. }
  81121. }
  81122. declare module BABYLON {
  81123. /**
  81124. * Interface for the size containing width and height
  81125. */
  81126. export interface ISize {
  81127. /**
  81128. * Width
  81129. */
  81130. width: number;
  81131. /**
  81132. * Heighht
  81133. */
  81134. height: number;
  81135. }
  81136. /**
  81137. * Size containing widht and height
  81138. */
  81139. export class Size implements ISize {
  81140. /**
  81141. * Width
  81142. */
  81143. width: number;
  81144. /**
  81145. * Height
  81146. */
  81147. height: number;
  81148. /**
  81149. * Creates a Size object from the given width and height (floats).
  81150. * @param width width of the new size
  81151. * @param height height of the new size
  81152. */
  81153. constructor(width: number, height: number);
  81154. /**
  81155. * Returns a string with the Size width and height
  81156. * @returns a string with the Size width and height
  81157. */
  81158. toString(): string;
  81159. /**
  81160. * "Size"
  81161. * @returns the string "Size"
  81162. */
  81163. getClassName(): string;
  81164. /**
  81165. * Returns the Size hash code.
  81166. * @returns a hash code for a unique width and height
  81167. */
  81168. getHashCode(): number;
  81169. /**
  81170. * Updates the current size from the given one.
  81171. * @param src the given size
  81172. */
  81173. copyFrom(src: Size): void;
  81174. /**
  81175. * Updates in place the current Size from the given floats.
  81176. * @param width width of the new size
  81177. * @param height height of the new size
  81178. * @returns the updated Size.
  81179. */
  81180. copyFromFloats(width: number, height: number): Size;
  81181. /**
  81182. * Updates in place the current Size from the given floats.
  81183. * @param width width to set
  81184. * @param height height to set
  81185. * @returns the updated Size.
  81186. */
  81187. set(width: number, height: number): Size;
  81188. /**
  81189. * Multiplies the width and height by numbers
  81190. * @param w factor to multiple the width by
  81191. * @param h factor to multiple the height by
  81192. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  81193. */
  81194. multiplyByFloats(w: number, h: number): Size;
  81195. /**
  81196. * Clones the size
  81197. * @returns a new Size copied from the given one.
  81198. */
  81199. clone(): Size;
  81200. /**
  81201. * True if the current Size and the given one width and height are strictly equal.
  81202. * @param other the other size to compare against
  81203. * @returns True if the current Size and the given one width and height are strictly equal.
  81204. */
  81205. equals(other: Size): boolean;
  81206. /**
  81207. * The surface of the Size : width * height (float).
  81208. */
  81209. readonly surface: number;
  81210. /**
  81211. * Create a new size of zero
  81212. * @returns a new Size set to (0.0, 0.0)
  81213. */
  81214. static Zero(): Size;
  81215. /**
  81216. * Sums the width and height of two sizes
  81217. * @param otherSize size to add to this size
  81218. * @returns a new Size set as the addition result of the current Size and the given one.
  81219. */
  81220. add(otherSize: Size): Size;
  81221. /**
  81222. * Subtracts the width and height of two
  81223. * @param otherSize size to subtract to this size
  81224. * @returns a new Size set as the subtraction result of the given one from the current Size.
  81225. */
  81226. subtract(otherSize: Size): Size;
  81227. /**
  81228. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  81229. * @param start starting size to lerp between
  81230. * @param end end size to lerp between
  81231. * @param amount amount to lerp between the start and end values
  81232. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  81233. */
  81234. static Lerp(start: Size, end: Size, amount: number): Size;
  81235. }
  81236. }
  81237. declare module BABYLON {
  81238. /**
  81239. * Defines a runtime animation
  81240. */
  81241. export class RuntimeAnimation {
  81242. private _events;
  81243. /**
  81244. * The current frame of the runtime animation
  81245. */
  81246. private _currentFrame;
  81247. /**
  81248. * The animation used by the runtime animation
  81249. */
  81250. private _animation;
  81251. /**
  81252. * The target of the runtime animation
  81253. */
  81254. private _target;
  81255. /**
  81256. * The initiating animatable
  81257. */
  81258. private _host;
  81259. /**
  81260. * The original value of the runtime animation
  81261. */
  81262. private _originalValue;
  81263. /**
  81264. * The original blend value of the runtime animation
  81265. */
  81266. private _originalBlendValue;
  81267. /**
  81268. * The offsets cache of the runtime animation
  81269. */
  81270. private _offsetsCache;
  81271. /**
  81272. * The high limits cache of the runtime animation
  81273. */
  81274. private _highLimitsCache;
  81275. /**
  81276. * Specifies if the runtime animation has been stopped
  81277. */
  81278. private _stopped;
  81279. /**
  81280. * The blending factor of the runtime animation
  81281. */
  81282. private _blendingFactor;
  81283. /**
  81284. * The BabylonJS scene
  81285. */
  81286. private _scene;
  81287. /**
  81288. * The current value of the runtime animation
  81289. */
  81290. private _currentValue;
  81291. /** @hidden */
  81292. _animationState: _IAnimationState;
  81293. /**
  81294. * The active target of the runtime animation
  81295. */
  81296. private _activeTargets;
  81297. private _currentActiveTarget;
  81298. private _directTarget;
  81299. /**
  81300. * The target path of the runtime animation
  81301. */
  81302. private _targetPath;
  81303. /**
  81304. * The weight of the runtime animation
  81305. */
  81306. private _weight;
  81307. /**
  81308. * The ratio offset of the runtime animation
  81309. */
  81310. private _ratioOffset;
  81311. /**
  81312. * The previous delay of the runtime animation
  81313. */
  81314. private _previousDelay;
  81315. /**
  81316. * The previous ratio of the runtime animation
  81317. */
  81318. private _previousRatio;
  81319. private _enableBlending;
  81320. private _keys;
  81321. private _minFrame;
  81322. private _maxFrame;
  81323. private _minValue;
  81324. private _maxValue;
  81325. private _targetIsArray;
  81326. /**
  81327. * Gets the current frame of the runtime animation
  81328. */
  81329. readonly currentFrame: number;
  81330. /**
  81331. * Gets the weight of the runtime animation
  81332. */
  81333. readonly weight: number;
  81334. /**
  81335. * Gets the current value of the runtime animation
  81336. */
  81337. readonly currentValue: any;
  81338. /**
  81339. * Gets the target path of the runtime animation
  81340. */
  81341. readonly targetPath: string;
  81342. /**
  81343. * Gets the actual target of the runtime animation
  81344. */
  81345. readonly target: any;
  81346. /** @hidden */
  81347. _onLoop: () => void;
  81348. /**
  81349. * Create a new RuntimeAnimation object
  81350. * @param target defines the target of the animation
  81351. * @param animation defines the source animation object
  81352. * @param scene defines the hosting scene
  81353. * @param host defines the initiating Animatable
  81354. */
  81355. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  81356. private _preparePath;
  81357. /**
  81358. * Gets the animation from the runtime animation
  81359. */
  81360. readonly animation: Animation;
  81361. /**
  81362. * Resets the runtime animation to the beginning
  81363. * @param restoreOriginal defines whether to restore the target property to the original value
  81364. */
  81365. reset(restoreOriginal?: boolean): void;
  81366. /**
  81367. * Specifies if the runtime animation is stopped
  81368. * @returns Boolean specifying if the runtime animation is stopped
  81369. */
  81370. isStopped(): boolean;
  81371. /**
  81372. * Disposes of the runtime animation
  81373. */
  81374. dispose(): void;
  81375. /**
  81376. * Apply the interpolated value to the target
  81377. * @param currentValue defines the value computed by the animation
  81378. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  81379. */
  81380. setValue(currentValue: any, weight: number): void;
  81381. private _getOriginalValues;
  81382. private _setValue;
  81383. /**
  81384. * Gets the loop pmode of the runtime animation
  81385. * @returns Loop Mode
  81386. */
  81387. private _getCorrectLoopMode;
  81388. /**
  81389. * Move the current animation to a given frame
  81390. * @param frame defines the frame to move to
  81391. */
  81392. goToFrame(frame: number): void;
  81393. /**
  81394. * @hidden Internal use only
  81395. */
  81396. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  81397. /**
  81398. * Execute the current animation
  81399. * @param delay defines the delay to add to the current frame
  81400. * @param from defines the lower bound of the animation range
  81401. * @param to defines the upper bound of the animation range
  81402. * @param loop defines if the current animation must loop
  81403. * @param speedRatio defines the current speed ratio
  81404. * @param weight defines the weight of the animation (default is -1 so no weight)
  81405. * @param onLoop optional callback called when animation loops
  81406. * @returns a boolean indicating if the animation is running
  81407. */
  81408. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  81409. }
  81410. }
  81411. declare module BABYLON {
  81412. /**
  81413. * Class used to store an actual running animation
  81414. */
  81415. export class Animatable {
  81416. /** defines the target object */
  81417. target: any;
  81418. /** defines the starting frame number (default is 0) */
  81419. fromFrame: number;
  81420. /** defines the ending frame number (default is 100) */
  81421. toFrame: number;
  81422. /** defines if the animation must loop (default is false) */
  81423. loopAnimation: boolean;
  81424. /** defines a callback to call when animation ends if it is not looping */
  81425. onAnimationEnd?: (() => void) | null | undefined;
  81426. /** defines a callback to call when animation loops */
  81427. onAnimationLoop?: (() => void) | null | undefined;
  81428. private _localDelayOffset;
  81429. private _pausedDelay;
  81430. private _runtimeAnimations;
  81431. private _paused;
  81432. private _scene;
  81433. private _speedRatio;
  81434. private _weight;
  81435. private _syncRoot;
  81436. /**
  81437. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  81438. * This will only apply for non looping animation (default is true)
  81439. */
  81440. disposeOnEnd: boolean;
  81441. /**
  81442. * Gets a boolean indicating if the animation has started
  81443. */
  81444. animationStarted: boolean;
  81445. /**
  81446. * Observer raised when the animation ends
  81447. */
  81448. onAnimationEndObservable: Observable<Animatable>;
  81449. /**
  81450. * Observer raised when the animation loops
  81451. */
  81452. onAnimationLoopObservable: Observable<Animatable>;
  81453. /**
  81454. * Gets the root Animatable used to synchronize and normalize animations
  81455. */
  81456. readonly syncRoot: Nullable<Animatable>;
  81457. /**
  81458. * Gets the current frame of the first RuntimeAnimation
  81459. * Used to synchronize Animatables
  81460. */
  81461. readonly masterFrame: number;
  81462. /**
  81463. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  81464. */
  81465. weight: number;
  81466. /**
  81467. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  81468. */
  81469. speedRatio: number;
  81470. /**
  81471. * Creates a new Animatable
  81472. * @param scene defines the hosting scene
  81473. * @param target defines the target object
  81474. * @param fromFrame defines the starting frame number (default is 0)
  81475. * @param toFrame defines the ending frame number (default is 100)
  81476. * @param loopAnimation defines if the animation must loop (default is false)
  81477. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  81478. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  81479. * @param animations defines a group of animation to add to the new Animatable
  81480. * @param onAnimationLoop defines a callback to call when animation loops
  81481. */
  81482. constructor(scene: Scene,
  81483. /** defines the target object */
  81484. target: any,
  81485. /** defines the starting frame number (default is 0) */
  81486. fromFrame?: number,
  81487. /** defines the ending frame number (default is 100) */
  81488. toFrame?: number,
  81489. /** defines if the animation must loop (default is false) */
  81490. loopAnimation?: boolean, speedRatio?: number,
  81491. /** defines a callback to call when animation ends if it is not looping */
  81492. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  81493. /** defines a callback to call when animation loops */
  81494. onAnimationLoop?: (() => void) | null | undefined);
  81495. /**
  81496. * Synchronize and normalize current Animatable with a source Animatable
  81497. * This is useful when using animation weights and when animations are not of the same length
  81498. * @param root defines the root Animatable to synchronize with
  81499. * @returns the current Animatable
  81500. */
  81501. syncWith(root: Animatable): Animatable;
  81502. /**
  81503. * Gets the list of runtime animations
  81504. * @returns an array of RuntimeAnimation
  81505. */
  81506. getAnimations(): RuntimeAnimation[];
  81507. /**
  81508. * Adds more animations to the current animatable
  81509. * @param target defines the target of the animations
  81510. * @param animations defines the new animations to add
  81511. */
  81512. appendAnimations(target: any, animations: Animation[]): void;
  81513. /**
  81514. * Gets the source animation for a specific property
  81515. * @param property defines the propertyu to look for
  81516. * @returns null or the source animation for the given property
  81517. */
  81518. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  81519. /**
  81520. * Gets the runtime animation for a specific property
  81521. * @param property defines the propertyu to look for
  81522. * @returns null or the runtime animation for the given property
  81523. */
  81524. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  81525. /**
  81526. * Resets the animatable to its original state
  81527. */
  81528. reset(): void;
  81529. /**
  81530. * Allows the animatable to blend with current running animations
  81531. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81532. * @param blendingSpeed defines the blending speed to use
  81533. */
  81534. enableBlending(blendingSpeed: number): void;
  81535. /**
  81536. * Disable animation blending
  81537. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81538. */
  81539. disableBlending(): void;
  81540. /**
  81541. * Jump directly to a given frame
  81542. * @param frame defines the frame to jump to
  81543. */
  81544. goToFrame(frame: number): void;
  81545. /**
  81546. * Pause the animation
  81547. */
  81548. pause(): void;
  81549. /**
  81550. * Restart the animation
  81551. */
  81552. restart(): void;
  81553. private _raiseOnAnimationEnd;
  81554. /**
  81555. * Stop and delete the current animation
  81556. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  81557. * @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)
  81558. */
  81559. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  81560. /**
  81561. * Wait asynchronously for the animation to end
  81562. * @returns a promise which will be fullfilled when the animation ends
  81563. */
  81564. waitAsync(): Promise<Animatable>;
  81565. /** @hidden */
  81566. _animate(delay: number): boolean;
  81567. }
  81568. interface Scene {
  81569. /** @hidden */
  81570. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  81571. /** @hidden */
  81572. _processLateAnimationBindingsForMatrices(holder: {
  81573. totalWeight: number;
  81574. animations: RuntimeAnimation[];
  81575. originalValue: Matrix;
  81576. }): any;
  81577. /** @hidden */
  81578. _processLateAnimationBindingsForQuaternions(holder: {
  81579. totalWeight: number;
  81580. animations: RuntimeAnimation[];
  81581. originalValue: Quaternion;
  81582. }, refQuaternion: Quaternion): Quaternion;
  81583. /** @hidden */
  81584. _processLateAnimationBindings(): void;
  81585. /**
  81586. * Will start the animation sequence of a given target
  81587. * @param target defines the target
  81588. * @param from defines from which frame should animation start
  81589. * @param to defines until which frame should animation run.
  81590. * @param weight defines the weight to apply to the animation (1.0 by default)
  81591. * @param loop defines if the animation loops
  81592. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81593. * @param onAnimationEnd defines the function to be executed when the animation ends
  81594. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81595. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  81596. * @param onAnimationLoop defines the callback to call when an animation loops
  81597. * @returns the animatable object created for this animation
  81598. */
  81599. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  81600. /**
  81601. * Will start the animation sequence of a given target
  81602. * @param target defines the target
  81603. * @param from defines from which frame should animation start
  81604. * @param to defines until which frame should animation run.
  81605. * @param loop defines if the animation loops
  81606. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81607. * @param onAnimationEnd defines the function to be executed when the animation ends
  81608. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81609. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  81610. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  81611. * @param onAnimationLoop defines the callback to call when an animation loops
  81612. * @returns the animatable object created for this animation
  81613. */
  81614. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  81615. /**
  81616. * Will start the animation sequence of a given target and its hierarchy
  81617. * @param target defines the target
  81618. * @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.
  81619. * @param from defines from which frame should animation start
  81620. * @param to defines until which frame should animation run.
  81621. * @param loop defines if the animation loops
  81622. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81623. * @param onAnimationEnd defines the function to be executed when the animation ends
  81624. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81625. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  81626. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  81627. * @param onAnimationLoop defines the callback to call when an animation loops
  81628. * @returns the list of created animatables
  81629. */
  81630. 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[];
  81631. /**
  81632. * Begin a new animation on a given node
  81633. * @param target defines the target where the animation will take place
  81634. * @param animations defines the list of animations to start
  81635. * @param from defines the initial value
  81636. * @param to defines the final value
  81637. * @param loop defines if you want animation to loop (off by default)
  81638. * @param speedRatio defines the speed ratio to apply to all animations
  81639. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  81640. * @param onAnimationLoop defines the callback to call when an animation loops
  81641. * @returns the list of created animatables
  81642. */
  81643. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  81644. /**
  81645. * Begin a new animation on a given node and its hierarchy
  81646. * @param target defines the root node where the animation will take place
  81647. * @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.
  81648. * @param animations defines the list of animations to start
  81649. * @param from defines the initial value
  81650. * @param to defines the final value
  81651. * @param loop defines if you want animation to loop (off by default)
  81652. * @param speedRatio defines the speed ratio to apply to all animations
  81653. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  81654. * @param onAnimationLoop defines the callback to call when an animation loops
  81655. * @returns the list of animatables created for all nodes
  81656. */
  81657. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  81658. /**
  81659. * Gets the animatable associated with a specific target
  81660. * @param target defines the target of the animatable
  81661. * @returns the required animatable if found
  81662. */
  81663. getAnimatableByTarget(target: any): Nullable<Animatable>;
  81664. /**
  81665. * Gets all animatables associated with a given target
  81666. * @param target defines the target to look animatables for
  81667. * @returns an array of Animatables
  81668. */
  81669. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  81670. /**
  81671. * Stops and removes all animations that have been applied to the scene
  81672. */
  81673. stopAllAnimations(): void;
  81674. /**
  81675. * Gets the current delta time used by animation engine
  81676. */
  81677. deltaTime: number;
  81678. }
  81679. interface Bone {
  81680. /**
  81681. * Copy an animation range from another bone
  81682. * @param source defines the source bone
  81683. * @param rangeName defines the range name to copy
  81684. * @param frameOffset defines the frame offset
  81685. * @param rescaleAsRequired defines if rescaling must be applied if required
  81686. * @param skelDimensionsRatio defines the scaling ratio
  81687. * @returns true if operation was successful
  81688. */
  81689. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  81690. }
  81691. }
  81692. declare module BABYLON {
  81693. /**
  81694. * Class used to override all child animations of a given target
  81695. */
  81696. export class AnimationPropertiesOverride {
  81697. /**
  81698. * Gets or sets a value indicating if animation blending must be used
  81699. */
  81700. enableBlending: boolean;
  81701. /**
  81702. * Gets or sets the blending speed to use when enableBlending is true
  81703. */
  81704. blendingSpeed: number;
  81705. /**
  81706. * Gets or sets the default loop mode to use
  81707. */
  81708. loopMode: number;
  81709. }
  81710. }
  81711. declare module BABYLON {
  81712. /**
  81713. * Class used to handle skinning animations
  81714. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81715. */
  81716. export class Skeleton implements IAnimatable {
  81717. /** defines the skeleton name */
  81718. name: string;
  81719. /** defines the skeleton Id */
  81720. id: string;
  81721. /**
  81722. * Defines the list of child bones
  81723. */
  81724. bones: Bone[];
  81725. /**
  81726. * Defines an estimate of the dimension of the skeleton at rest
  81727. */
  81728. dimensionsAtRest: Vector3;
  81729. /**
  81730. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  81731. */
  81732. needInitialSkinMatrix: boolean;
  81733. /**
  81734. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  81735. */
  81736. overrideMesh: Nullable<AbstractMesh>;
  81737. /**
  81738. * Gets the list of animations attached to this skeleton
  81739. */
  81740. animations: Array<Animation>;
  81741. private _scene;
  81742. private _isDirty;
  81743. private _transformMatrices;
  81744. private _transformMatrixTexture;
  81745. private _meshesWithPoseMatrix;
  81746. private _animatables;
  81747. private _identity;
  81748. private _synchronizedWithMesh;
  81749. private _ranges;
  81750. private _lastAbsoluteTransformsUpdateId;
  81751. private _canUseTextureForBones;
  81752. private _uniqueId;
  81753. /** @hidden */
  81754. _numBonesWithLinkedTransformNode: number;
  81755. /** @hidden */
  81756. _hasWaitingData: Nullable<boolean>;
  81757. /**
  81758. * Specifies if the skeleton should be serialized
  81759. */
  81760. doNotSerialize: boolean;
  81761. private _useTextureToStoreBoneMatrices;
  81762. /**
  81763. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  81764. * Please note that this option is not available if the hardware does not support it
  81765. */
  81766. useTextureToStoreBoneMatrices: boolean;
  81767. private _animationPropertiesOverride;
  81768. /**
  81769. * Gets or sets the animation properties override
  81770. */
  81771. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81772. /**
  81773. * List of inspectable custom properties (used by the Inspector)
  81774. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  81775. */
  81776. inspectableCustomProperties: IInspectable[];
  81777. /**
  81778. * An observable triggered before computing the skeleton's matrices
  81779. */
  81780. onBeforeComputeObservable: Observable<Skeleton>;
  81781. /**
  81782. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  81783. */
  81784. readonly isUsingTextureForMatrices: boolean;
  81785. /**
  81786. * Gets the unique ID of this skeleton
  81787. */
  81788. readonly uniqueId: number;
  81789. /**
  81790. * Creates a new skeleton
  81791. * @param name defines the skeleton name
  81792. * @param id defines the skeleton Id
  81793. * @param scene defines the hosting scene
  81794. */
  81795. constructor(
  81796. /** defines the skeleton name */
  81797. name: string,
  81798. /** defines the skeleton Id */
  81799. id: string, scene: Scene);
  81800. /**
  81801. * Gets the current object class name.
  81802. * @return the class name
  81803. */
  81804. getClassName(): string;
  81805. /**
  81806. * Returns an array containing the root bones
  81807. * @returns an array containing the root bones
  81808. */
  81809. getChildren(): Array<Bone>;
  81810. /**
  81811. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  81812. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81813. * @returns a Float32Array containing matrices data
  81814. */
  81815. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  81816. /**
  81817. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  81818. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81819. * @returns a raw texture containing the data
  81820. */
  81821. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  81822. /**
  81823. * Gets the current hosting scene
  81824. * @returns a scene object
  81825. */
  81826. getScene(): Scene;
  81827. /**
  81828. * Gets a string representing the current skeleton data
  81829. * @param fullDetails defines a boolean indicating if we want a verbose version
  81830. * @returns a string representing the current skeleton data
  81831. */
  81832. toString(fullDetails?: boolean): string;
  81833. /**
  81834. * Get bone's index searching by name
  81835. * @param name defines bone's name to search for
  81836. * @return the indice of the bone. Returns -1 if not found
  81837. */
  81838. getBoneIndexByName(name: string): number;
  81839. /**
  81840. * Creater a new animation range
  81841. * @param name defines the name of the range
  81842. * @param from defines the start key
  81843. * @param to defines the end key
  81844. */
  81845. createAnimationRange(name: string, from: number, to: number): void;
  81846. /**
  81847. * Delete a specific animation range
  81848. * @param name defines the name of the range
  81849. * @param deleteFrames defines if frames must be removed as well
  81850. */
  81851. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  81852. /**
  81853. * Gets a specific animation range
  81854. * @param name defines the name of the range to look for
  81855. * @returns the requested animation range or null if not found
  81856. */
  81857. getAnimationRange(name: string): Nullable<AnimationRange>;
  81858. /**
  81859. * Gets the list of all animation ranges defined on this skeleton
  81860. * @returns an array
  81861. */
  81862. getAnimationRanges(): Nullable<AnimationRange>[];
  81863. /**
  81864. * Copy animation range from a source skeleton.
  81865. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  81866. * @param source defines the source skeleton
  81867. * @param name defines the name of the range to copy
  81868. * @param rescaleAsRequired defines if rescaling must be applied if required
  81869. * @returns true if operation was successful
  81870. */
  81871. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  81872. /**
  81873. * Forces the skeleton to go to rest pose
  81874. */
  81875. returnToRest(): void;
  81876. private _getHighestAnimationFrame;
  81877. /**
  81878. * Begin a specific animation range
  81879. * @param name defines the name of the range to start
  81880. * @param loop defines if looping must be turned on (false by default)
  81881. * @param speedRatio defines the speed ratio to apply (1 by default)
  81882. * @param onAnimationEnd defines a callback which will be called when animation will end
  81883. * @returns a new animatable
  81884. */
  81885. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  81886. /** @hidden */
  81887. _markAsDirty(): void;
  81888. /** @hidden */
  81889. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81890. /** @hidden */
  81891. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81892. private _computeTransformMatrices;
  81893. /**
  81894. * Build all resources required to render a skeleton
  81895. */
  81896. prepare(): void;
  81897. /**
  81898. * Gets the list of animatables currently running for this skeleton
  81899. * @returns an array of animatables
  81900. */
  81901. getAnimatables(): IAnimatable[];
  81902. /**
  81903. * Clone the current skeleton
  81904. * @param name defines the name of the new skeleton
  81905. * @param id defines the id of the new skeleton
  81906. * @returns the new skeleton
  81907. */
  81908. clone(name: string, id?: string): Skeleton;
  81909. /**
  81910. * Enable animation blending for this skeleton
  81911. * @param blendingSpeed defines the blending speed to apply
  81912. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81913. */
  81914. enableBlending(blendingSpeed?: number): void;
  81915. /**
  81916. * Releases all resources associated with the current skeleton
  81917. */
  81918. dispose(): void;
  81919. /**
  81920. * Serialize the skeleton in a JSON object
  81921. * @returns a JSON object
  81922. */
  81923. serialize(): any;
  81924. /**
  81925. * Creates a new skeleton from serialized data
  81926. * @param parsedSkeleton defines the serialized data
  81927. * @param scene defines the hosting scene
  81928. * @returns a new skeleton
  81929. */
  81930. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  81931. /**
  81932. * Compute all node absolute transforms
  81933. * @param forceUpdate defines if computation must be done even if cache is up to date
  81934. */
  81935. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  81936. /**
  81937. * Gets the root pose matrix
  81938. * @returns a matrix
  81939. */
  81940. getPoseMatrix(): Nullable<Matrix>;
  81941. /**
  81942. * Sorts bones per internal index
  81943. */
  81944. sortBones(): void;
  81945. private _sortBones;
  81946. }
  81947. }
  81948. declare module BABYLON {
  81949. /**
  81950. * Class used to store bone information
  81951. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81952. */
  81953. export class Bone extends Node {
  81954. /**
  81955. * defines the bone name
  81956. */
  81957. name: string;
  81958. private static _tmpVecs;
  81959. private static _tmpQuat;
  81960. private static _tmpMats;
  81961. /**
  81962. * Gets the list of child bones
  81963. */
  81964. children: Bone[];
  81965. /** Gets the animations associated with this bone */
  81966. animations: Animation[];
  81967. /**
  81968. * Gets or sets bone length
  81969. */
  81970. length: number;
  81971. /**
  81972. * @hidden Internal only
  81973. * Set this value to map this bone to a different index in the transform matrices
  81974. * Set this value to -1 to exclude the bone from the transform matrices
  81975. */
  81976. _index: Nullable<number>;
  81977. private _skeleton;
  81978. private _localMatrix;
  81979. private _restPose;
  81980. private _baseMatrix;
  81981. private _absoluteTransform;
  81982. private _invertedAbsoluteTransform;
  81983. private _parent;
  81984. private _scalingDeterminant;
  81985. private _worldTransform;
  81986. private _localScaling;
  81987. private _localRotation;
  81988. private _localPosition;
  81989. private _needToDecompose;
  81990. private _needToCompose;
  81991. /** @hidden */
  81992. _linkedTransformNode: Nullable<TransformNode>;
  81993. /** @hidden */
  81994. _waitingTransformNodeId: Nullable<string>;
  81995. /** @hidden */
  81996. /** @hidden */
  81997. _matrix: Matrix;
  81998. /**
  81999. * Create a new bone
  82000. * @param name defines the bone name
  82001. * @param skeleton defines the parent skeleton
  82002. * @param parentBone defines the parent (can be null if the bone is the root)
  82003. * @param localMatrix defines the local matrix
  82004. * @param restPose defines the rest pose matrix
  82005. * @param baseMatrix defines the base matrix
  82006. * @param index defines index of the bone in the hiearchy
  82007. */
  82008. constructor(
  82009. /**
  82010. * defines the bone name
  82011. */
  82012. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  82013. /**
  82014. * Gets the current object class name.
  82015. * @return the class name
  82016. */
  82017. getClassName(): string;
  82018. /**
  82019. * Gets the parent skeleton
  82020. * @returns a skeleton
  82021. */
  82022. getSkeleton(): Skeleton;
  82023. /**
  82024. * Gets parent bone
  82025. * @returns a bone or null if the bone is the root of the bone hierarchy
  82026. */
  82027. getParent(): Nullable<Bone>;
  82028. /**
  82029. * Returns an array containing the root bones
  82030. * @returns an array containing the root bones
  82031. */
  82032. getChildren(): Array<Bone>;
  82033. /**
  82034. * Gets the node index in matrix array generated for rendering
  82035. * @returns the node index
  82036. */
  82037. getIndex(): number;
  82038. /**
  82039. * Sets the parent bone
  82040. * @param parent defines the parent (can be null if the bone is the root)
  82041. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  82042. */
  82043. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  82044. /**
  82045. * Gets the local matrix
  82046. * @returns a matrix
  82047. */
  82048. getLocalMatrix(): Matrix;
  82049. /**
  82050. * Gets the base matrix (initial matrix which remains unchanged)
  82051. * @returns a matrix
  82052. */
  82053. getBaseMatrix(): Matrix;
  82054. /**
  82055. * Gets the rest pose matrix
  82056. * @returns a matrix
  82057. */
  82058. getRestPose(): Matrix;
  82059. /**
  82060. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  82061. */
  82062. getWorldMatrix(): Matrix;
  82063. /**
  82064. * Sets the local matrix to rest pose matrix
  82065. */
  82066. returnToRest(): void;
  82067. /**
  82068. * Gets the inverse of the absolute transform matrix.
  82069. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  82070. * @returns a matrix
  82071. */
  82072. getInvertedAbsoluteTransform(): Matrix;
  82073. /**
  82074. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  82075. * @returns a matrix
  82076. */
  82077. getAbsoluteTransform(): Matrix;
  82078. /**
  82079. * Links with the given transform node.
  82080. * The local matrix of this bone is copied from the transform node every frame.
  82081. * @param transformNode defines the transform node to link to
  82082. */
  82083. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  82084. /**
  82085. * Gets the node used to drive the bone's transformation
  82086. * @returns a transform node or null
  82087. */
  82088. getTransformNode(): Nullable<TransformNode>;
  82089. /** Gets or sets current position (in local space) */
  82090. position: Vector3;
  82091. /** Gets or sets current rotation (in local space) */
  82092. rotation: Vector3;
  82093. /** Gets or sets current rotation quaternion (in local space) */
  82094. rotationQuaternion: Quaternion;
  82095. /** Gets or sets current scaling (in local space) */
  82096. scaling: Vector3;
  82097. /**
  82098. * Gets the animation properties override
  82099. */
  82100. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  82101. private _decompose;
  82102. private _compose;
  82103. /**
  82104. * Update the base and local matrices
  82105. * @param matrix defines the new base or local matrix
  82106. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  82107. * @param updateLocalMatrix defines if the local matrix should be updated
  82108. */
  82109. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  82110. /** @hidden */
  82111. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  82112. /**
  82113. * Flag the bone as dirty (Forcing it to update everything)
  82114. */
  82115. markAsDirty(): void;
  82116. /** @hidden */
  82117. _markAsDirtyAndCompose(): void;
  82118. private _markAsDirtyAndDecompose;
  82119. /**
  82120. * Translate the bone in local or world space
  82121. * @param vec The amount to translate the bone
  82122. * @param space The space that the translation is in
  82123. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82124. */
  82125. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  82126. /**
  82127. * Set the postion of the bone in local or world space
  82128. * @param position The position to set the bone
  82129. * @param space The space that the position is in
  82130. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82131. */
  82132. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  82133. /**
  82134. * Set the absolute position of the bone (world space)
  82135. * @param position The position to set the bone
  82136. * @param mesh The mesh that this bone is attached to
  82137. */
  82138. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  82139. /**
  82140. * Scale the bone on the x, y and z axes (in local space)
  82141. * @param x The amount to scale the bone on the x axis
  82142. * @param y The amount to scale the bone on the y axis
  82143. * @param z The amount to scale the bone on the z axis
  82144. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  82145. */
  82146. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  82147. /**
  82148. * Set the bone scaling in local space
  82149. * @param scale defines the scaling vector
  82150. */
  82151. setScale(scale: Vector3): void;
  82152. /**
  82153. * Gets the current scaling in local space
  82154. * @returns the current scaling vector
  82155. */
  82156. getScale(): Vector3;
  82157. /**
  82158. * Gets the current scaling in local space and stores it in a target vector
  82159. * @param result defines the target vector
  82160. */
  82161. getScaleToRef(result: Vector3): void;
  82162. /**
  82163. * Set the yaw, pitch, and roll of the bone in local or world space
  82164. * @param yaw The rotation of the bone on the y axis
  82165. * @param pitch The rotation of the bone on the x axis
  82166. * @param roll The rotation of the bone on the z axis
  82167. * @param space The space that the axes of rotation are in
  82168. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82169. */
  82170. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  82171. /**
  82172. * Add a rotation to the bone on an axis in local or world space
  82173. * @param axis The axis to rotate the bone on
  82174. * @param amount The amount to rotate the bone
  82175. * @param space The space that the axis is in
  82176. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82177. */
  82178. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  82179. /**
  82180. * Set the rotation of the bone to a particular axis angle in local or world space
  82181. * @param axis The axis to rotate the bone on
  82182. * @param angle The angle that the bone should be rotated to
  82183. * @param space The space that the axis is in
  82184. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82185. */
  82186. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  82187. /**
  82188. * Set the euler rotation of the bone in local of world space
  82189. * @param rotation The euler rotation that the bone should be set to
  82190. * @param space The space that the rotation is in
  82191. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82192. */
  82193. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  82194. /**
  82195. * Set the quaternion rotation of the bone in local of world space
  82196. * @param quat The quaternion rotation that the bone should be set to
  82197. * @param space The space that the rotation is in
  82198. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82199. */
  82200. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  82201. /**
  82202. * Set the rotation matrix of the bone in local of world space
  82203. * @param rotMat The rotation matrix that the bone should be set to
  82204. * @param space The space that the rotation is in
  82205. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82206. */
  82207. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  82208. private _rotateWithMatrix;
  82209. private _getNegativeRotationToRef;
  82210. /**
  82211. * Get the position of the bone in local or world space
  82212. * @param space The space that the returned position is in
  82213. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82214. * @returns The position of the bone
  82215. */
  82216. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  82217. /**
  82218. * Copy the position of the bone to a vector3 in local or world space
  82219. * @param space The space that the returned position is in
  82220. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82221. * @param result The vector3 to copy the position to
  82222. */
  82223. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  82224. /**
  82225. * Get the absolute position of the bone (world space)
  82226. * @param mesh The mesh that this bone is attached to
  82227. * @returns The absolute position of the bone
  82228. */
  82229. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  82230. /**
  82231. * Copy the absolute position of the bone (world space) to the result param
  82232. * @param mesh The mesh that this bone is attached to
  82233. * @param result The vector3 to copy the absolute position to
  82234. */
  82235. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  82236. /**
  82237. * Compute the absolute transforms of this bone and its children
  82238. */
  82239. computeAbsoluteTransforms(): void;
  82240. /**
  82241. * Get the world direction from an axis that is in the local space of the bone
  82242. * @param localAxis The local direction that is used to compute the world direction
  82243. * @param mesh The mesh that this bone is attached to
  82244. * @returns The world direction
  82245. */
  82246. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  82247. /**
  82248. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  82249. * @param localAxis The local direction that is used to compute the world direction
  82250. * @param mesh The mesh that this bone is attached to
  82251. * @param result The vector3 that the world direction will be copied to
  82252. */
  82253. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82254. /**
  82255. * Get the euler rotation of the bone in local or world space
  82256. * @param space The space that the rotation should be in
  82257. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82258. * @returns The euler rotation
  82259. */
  82260. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  82261. /**
  82262. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  82263. * @param space The space that the rotation should be in
  82264. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82265. * @param result The vector3 that the rotation should be copied to
  82266. */
  82267. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82268. /**
  82269. * Get the quaternion rotation of the bone in either local or world space
  82270. * @param space The space that the rotation should be in
  82271. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82272. * @returns The quaternion rotation
  82273. */
  82274. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  82275. /**
  82276. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  82277. * @param space The space that the rotation should be in
  82278. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82279. * @param result The quaternion that the rotation should be copied to
  82280. */
  82281. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  82282. /**
  82283. * Get the rotation matrix of the bone in local or world space
  82284. * @param space The space that the rotation should be in
  82285. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82286. * @returns The rotation matrix
  82287. */
  82288. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  82289. /**
  82290. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  82291. * @param space The space that the rotation should be in
  82292. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82293. * @param result The quaternion that the rotation should be copied to
  82294. */
  82295. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  82296. /**
  82297. * Get the world position of a point that is in the local space of the bone
  82298. * @param position The local position
  82299. * @param mesh The mesh that this bone is attached to
  82300. * @returns The world position
  82301. */
  82302. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  82303. /**
  82304. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  82305. * @param position The local position
  82306. * @param mesh The mesh that this bone is attached to
  82307. * @param result The vector3 that the world position should be copied to
  82308. */
  82309. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82310. /**
  82311. * Get the local position of a point that is in world space
  82312. * @param position The world position
  82313. * @param mesh The mesh that this bone is attached to
  82314. * @returns The local position
  82315. */
  82316. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  82317. /**
  82318. * Get the local position of a point that is in world space and copy it to the result param
  82319. * @param position The world position
  82320. * @param mesh The mesh that this bone is attached to
  82321. * @param result The vector3 that the local position should be copied to
  82322. */
  82323. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82324. }
  82325. }
  82326. declare module BABYLON {
  82327. /**
  82328. * 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.
  82329. * @see https://doc.babylonjs.com/how_to/transformnode
  82330. */
  82331. export class TransformNode extends Node {
  82332. /**
  82333. * Object will not rotate to face the camera
  82334. */
  82335. static BILLBOARDMODE_NONE: number;
  82336. /**
  82337. * Object will rotate to face the camera but only on the x axis
  82338. */
  82339. static BILLBOARDMODE_X: number;
  82340. /**
  82341. * Object will rotate to face the camera but only on the y axis
  82342. */
  82343. static BILLBOARDMODE_Y: number;
  82344. /**
  82345. * Object will rotate to face the camera but only on the z axis
  82346. */
  82347. static BILLBOARDMODE_Z: number;
  82348. /**
  82349. * Object will rotate to face the camera
  82350. */
  82351. static BILLBOARDMODE_ALL: number;
  82352. /**
  82353. * Object will rotate to face the camera's position instead of orientation
  82354. */
  82355. static BILLBOARDMODE_USE_POSITION: number;
  82356. private _forward;
  82357. private _forwardInverted;
  82358. private _up;
  82359. private _right;
  82360. private _rightInverted;
  82361. private _position;
  82362. private _rotation;
  82363. private _rotationQuaternion;
  82364. protected _scaling: Vector3;
  82365. protected _isDirty: boolean;
  82366. private _transformToBoneReferal;
  82367. private _isAbsoluteSynced;
  82368. private _billboardMode;
  82369. /**
  82370. * Gets or sets the billboard mode. Default is 0.
  82371. *
  82372. * | Value | Type | Description |
  82373. * | --- | --- | --- |
  82374. * | 0 | BILLBOARDMODE_NONE | |
  82375. * | 1 | BILLBOARDMODE_X | |
  82376. * | 2 | BILLBOARDMODE_Y | |
  82377. * | 4 | BILLBOARDMODE_Z | |
  82378. * | 7 | BILLBOARDMODE_ALL | |
  82379. *
  82380. */
  82381. billboardMode: number;
  82382. private _preserveParentRotationForBillboard;
  82383. /**
  82384. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  82385. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  82386. */
  82387. preserveParentRotationForBillboard: boolean;
  82388. /**
  82389. * 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
  82390. */
  82391. scalingDeterminant: number;
  82392. private _infiniteDistance;
  82393. /**
  82394. * Gets or sets the distance of the object to max, often used by skybox
  82395. */
  82396. infiniteDistance: boolean;
  82397. /**
  82398. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  82399. * By default the system will update normals to compensate
  82400. */
  82401. ignoreNonUniformScaling: boolean;
  82402. /**
  82403. * 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
  82404. */
  82405. reIntegrateRotationIntoRotationQuaternion: boolean;
  82406. /** @hidden */
  82407. _poseMatrix: Nullable<Matrix>;
  82408. /** @hidden */
  82409. _localMatrix: Matrix;
  82410. private _usePivotMatrix;
  82411. private _absolutePosition;
  82412. private _absoluteScaling;
  82413. private _absoluteRotationQuaternion;
  82414. private _pivotMatrix;
  82415. private _pivotMatrixInverse;
  82416. protected _postMultiplyPivotMatrix: boolean;
  82417. protected _isWorldMatrixFrozen: boolean;
  82418. /** @hidden */
  82419. _indexInSceneTransformNodesArray: number;
  82420. /**
  82421. * An event triggered after the world matrix is updated
  82422. */
  82423. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  82424. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  82425. /**
  82426. * Gets a string identifying the name of the class
  82427. * @returns "TransformNode" string
  82428. */
  82429. getClassName(): string;
  82430. /**
  82431. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  82432. */
  82433. position: Vector3;
  82434. /**
  82435. * 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)).
  82436. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  82437. */
  82438. rotation: Vector3;
  82439. /**
  82440. * 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)).
  82441. */
  82442. scaling: Vector3;
  82443. /**
  82444. * 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).
  82445. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  82446. */
  82447. rotationQuaternion: Nullable<Quaternion>;
  82448. /**
  82449. * The forward direction of that transform in world space.
  82450. */
  82451. readonly forward: Vector3;
  82452. /**
  82453. * The up direction of that transform in world space.
  82454. */
  82455. readonly up: Vector3;
  82456. /**
  82457. * The right direction of that transform in world space.
  82458. */
  82459. readonly right: Vector3;
  82460. /**
  82461. * Copies the parameter passed Matrix into the mesh Pose matrix.
  82462. * @param matrix the matrix to copy the pose from
  82463. * @returns this TransformNode.
  82464. */
  82465. updatePoseMatrix(matrix: Matrix): TransformNode;
  82466. /**
  82467. * Returns the mesh Pose matrix.
  82468. * @returns the pose matrix
  82469. */
  82470. getPoseMatrix(): Matrix;
  82471. /** @hidden */
  82472. _isSynchronized(): boolean;
  82473. /** @hidden */
  82474. _initCache(): void;
  82475. /**
  82476. * Flag the transform node as dirty (Forcing it to update everything)
  82477. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  82478. * @returns this transform node
  82479. */
  82480. markAsDirty(property: string): TransformNode;
  82481. /**
  82482. * Returns the current mesh absolute position.
  82483. * Returns a Vector3.
  82484. */
  82485. readonly absolutePosition: Vector3;
  82486. /**
  82487. * Returns the current mesh absolute scaling.
  82488. * Returns a Vector3.
  82489. */
  82490. readonly absoluteScaling: Vector3;
  82491. /**
  82492. * Returns the current mesh absolute rotation.
  82493. * Returns a Quaternion.
  82494. */
  82495. readonly absoluteRotationQuaternion: Quaternion;
  82496. /**
  82497. * Sets a new matrix to apply before all other transformation
  82498. * @param matrix defines the transform matrix
  82499. * @returns the current TransformNode
  82500. */
  82501. setPreTransformMatrix(matrix: Matrix): TransformNode;
  82502. /**
  82503. * Sets a new pivot matrix to the current node
  82504. * @param matrix defines the new pivot matrix to use
  82505. * @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
  82506. * @returns the current TransformNode
  82507. */
  82508. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  82509. /**
  82510. * Returns the mesh pivot matrix.
  82511. * Default : Identity.
  82512. * @returns the matrix
  82513. */
  82514. getPivotMatrix(): Matrix;
  82515. /**
  82516. * Instantiate (when possible) or clone that node with its hierarchy
  82517. * @param newParent defines the new parent to use for the instance (or clone)
  82518. * @param options defines options to configure how copy is done
  82519. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  82520. * @returns an instance (or a clone) of the current node with its hiearchy
  82521. */
  82522. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  82523. doNotInstantiate: boolean;
  82524. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  82525. /**
  82526. * Prevents the World matrix to be computed any longer
  82527. * @param newWorldMatrix defines an optional matrix to use as world matrix
  82528. * @returns the TransformNode.
  82529. */
  82530. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  82531. /**
  82532. * Allows back the World matrix computation.
  82533. * @returns the TransformNode.
  82534. */
  82535. unfreezeWorldMatrix(): this;
  82536. /**
  82537. * True if the World matrix has been frozen.
  82538. */
  82539. readonly isWorldMatrixFrozen: boolean;
  82540. /**
  82541. * Retuns the mesh absolute position in the World.
  82542. * @returns a Vector3.
  82543. */
  82544. getAbsolutePosition(): Vector3;
  82545. /**
  82546. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  82547. * @param absolutePosition the absolute position to set
  82548. * @returns the TransformNode.
  82549. */
  82550. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  82551. /**
  82552. * Sets the mesh position in its local space.
  82553. * @param vector3 the position to set in localspace
  82554. * @returns the TransformNode.
  82555. */
  82556. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  82557. /**
  82558. * Returns the mesh position in the local space from the current World matrix values.
  82559. * @returns a new Vector3.
  82560. */
  82561. getPositionExpressedInLocalSpace(): Vector3;
  82562. /**
  82563. * Translates the mesh along the passed Vector3 in its local space.
  82564. * @param vector3 the distance to translate in localspace
  82565. * @returns the TransformNode.
  82566. */
  82567. locallyTranslate(vector3: Vector3): TransformNode;
  82568. private static _lookAtVectorCache;
  82569. /**
  82570. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  82571. * @param targetPoint the position (must be in same space as current mesh) to look at
  82572. * @param yawCor optional yaw (y-axis) correction in radians
  82573. * @param pitchCor optional pitch (x-axis) correction in radians
  82574. * @param rollCor optional roll (z-axis) correction in radians
  82575. * @param space the choosen space of the target
  82576. * @returns the TransformNode.
  82577. */
  82578. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  82579. /**
  82580. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  82581. * This Vector3 is expressed in the World space.
  82582. * @param localAxis axis to rotate
  82583. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  82584. */
  82585. getDirection(localAxis: Vector3): Vector3;
  82586. /**
  82587. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  82588. * localAxis is expressed in the mesh local space.
  82589. * result is computed in the Wordl space from the mesh World matrix.
  82590. * @param localAxis axis to rotate
  82591. * @param result the resulting transformnode
  82592. * @returns this TransformNode.
  82593. */
  82594. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  82595. /**
  82596. * Sets this transform node rotation to the given local axis.
  82597. * @param localAxis the axis in local space
  82598. * @param yawCor optional yaw (y-axis) correction in radians
  82599. * @param pitchCor optional pitch (x-axis) correction in radians
  82600. * @param rollCor optional roll (z-axis) correction in radians
  82601. * @returns this TransformNode
  82602. */
  82603. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  82604. /**
  82605. * Sets a new pivot point to the current node
  82606. * @param point defines the new pivot point to use
  82607. * @param space defines if the point is in world or local space (local by default)
  82608. * @returns the current TransformNode
  82609. */
  82610. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  82611. /**
  82612. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  82613. * @returns the pivot point
  82614. */
  82615. getPivotPoint(): Vector3;
  82616. /**
  82617. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  82618. * @param result the vector3 to store the result
  82619. * @returns this TransformNode.
  82620. */
  82621. getPivotPointToRef(result: Vector3): TransformNode;
  82622. /**
  82623. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  82624. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  82625. */
  82626. getAbsolutePivotPoint(): Vector3;
  82627. /**
  82628. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  82629. * @param result vector3 to store the result
  82630. * @returns this TransformNode.
  82631. */
  82632. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  82633. /**
  82634. * Defines the passed node as the parent of the current node.
  82635. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  82636. * @see https://doc.babylonjs.com/how_to/parenting
  82637. * @param node the node ot set as the parent
  82638. * @returns this TransformNode.
  82639. */
  82640. setParent(node: Nullable<Node>): TransformNode;
  82641. private _nonUniformScaling;
  82642. /**
  82643. * True if the scaling property of this object is non uniform eg. (1,2,1)
  82644. */
  82645. readonly nonUniformScaling: boolean;
  82646. /** @hidden */
  82647. _updateNonUniformScalingState(value: boolean): boolean;
  82648. /**
  82649. * Attach the current TransformNode to another TransformNode associated with a bone
  82650. * @param bone Bone affecting the TransformNode
  82651. * @param affectedTransformNode TransformNode associated with the bone
  82652. * @returns this object
  82653. */
  82654. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  82655. /**
  82656. * Detach the transform node if its associated with a bone
  82657. * @returns this object
  82658. */
  82659. detachFromBone(): TransformNode;
  82660. private static _rotationAxisCache;
  82661. /**
  82662. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  82663. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  82664. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  82665. * The passed axis is also normalized.
  82666. * @param axis the axis to rotate around
  82667. * @param amount the amount to rotate in radians
  82668. * @param space Space to rotate in (Default: local)
  82669. * @returns the TransformNode.
  82670. */
  82671. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  82672. /**
  82673. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  82674. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  82675. * The passed axis is also normalized. .
  82676. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  82677. * @param point the point to rotate around
  82678. * @param axis the axis to rotate around
  82679. * @param amount the amount to rotate in radians
  82680. * @returns the TransformNode
  82681. */
  82682. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  82683. /**
  82684. * Translates the mesh along the axis vector for the passed distance in the given space.
  82685. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  82686. * @param axis the axis to translate in
  82687. * @param distance the distance to translate
  82688. * @param space Space to rotate in (Default: local)
  82689. * @returns the TransformNode.
  82690. */
  82691. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  82692. /**
  82693. * Adds a rotation step to the mesh current rotation.
  82694. * x, y, z are Euler angles expressed in radians.
  82695. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  82696. * This means this rotation is made in the mesh local space only.
  82697. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  82698. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  82699. * ```javascript
  82700. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  82701. * ```
  82702. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  82703. * 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.
  82704. * @param x Rotation to add
  82705. * @param y Rotation to add
  82706. * @param z Rotation to add
  82707. * @returns the TransformNode.
  82708. */
  82709. addRotation(x: number, y: number, z: number): TransformNode;
  82710. /**
  82711. * @hidden
  82712. */
  82713. protected _getEffectiveParent(): Nullable<Node>;
  82714. /**
  82715. * Computes the world matrix of the node
  82716. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  82717. * @returns the world matrix
  82718. */
  82719. computeWorldMatrix(force?: boolean): Matrix;
  82720. protected _afterComputeWorldMatrix(): void;
  82721. /**
  82722. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  82723. * @param func callback function to add
  82724. *
  82725. * @returns the TransformNode.
  82726. */
  82727. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  82728. /**
  82729. * Removes a registered callback function.
  82730. * @param func callback function to remove
  82731. * @returns the TransformNode.
  82732. */
  82733. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  82734. /**
  82735. * Gets the position of the current mesh in camera space
  82736. * @param camera defines the camera to use
  82737. * @returns a position
  82738. */
  82739. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  82740. /**
  82741. * Returns the distance from the mesh to the active camera
  82742. * @param camera defines the camera to use
  82743. * @returns the distance
  82744. */
  82745. getDistanceToCamera(camera?: Nullable<Camera>): number;
  82746. /**
  82747. * Clone the current transform node
  82748. * @param name Name of the new clone
  82749. * @param newParent New parent for the clone
  82750. * @param doNotCloneChildren Do not clone children hierarchy
  82751. * @returns the new transform node
  82752. */
  82753. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  82754. /**
  82755. * Serializes the objects information.
  82756. * @param currentSerializationObject defines the object to serialize in
  82757. * @returns the serialized object
  82758. */
  82759. serialize(currentSerializationObject?: any): any;
  82760. /**
  82761. * Returns a new TransformNode object parsed from the source provided.
  82762. * @param parsedTransformNode is the source.
  82763. * @param scene the scne the object belongs to
  82764. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  82765. * @returns a new TransformNode object parsed from the source provided.
  82766. */
  82767. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  82768. /**
  82769. * Get all child-transformNodes of this node
  82770. * @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
  82771. * @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
  82772. * @returns an array of TransformNode
  82773. */
  82774. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  82775. /**
  82776. * Releases resources associated with this transform node.
  82777. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  82778. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  82779. */
  82780. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  82781. /**
  82782. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  82783. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  82784. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  82785. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  82786. * @returns the current mesh
  82787. */
  82788. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  82789. private _syncAbsoluteScalingAndRotation;
  82790. }
  82791. }
  82792. declare module BABYLON {
  82793. /**
  82794. * Defines the types of pose enabled controllers that are supported
  82795. */
  82796. export enum PoseEnabledControllerType {
  82797. /**
  82798. * HTC Vive
  82799. */
  82800. VIVE = 0,
  82801. /**
  82802. * Oculus Rift
  82803. */
  82804. OCULUS = 1,
  82805. /**
  82806. * Windows mixed reality
  82807. */
  82808. WINDOWS = 2,
  82809. /**
  82810. * Samsung gear VR
  82811. */
  82812. GEAR_VR = 3,
  82813. /**
  82814. * Google Daydream
  82815. */
  82816. DAYDREAM = 4,
  82817. /**
  82818. * Generic
  82819. */
  82820. GENERIC = 5
  82821. }
  82822. /**
  82823. * Defines the MutableGamepadButton interface for the state of a gamepad button
  82824. */
  82825. export interface MutableGamepadButton {
  82826. /**
  82827. * Value of the button/trigger
  82828. */
  82829. value: number;
  82830. /**
  82831. * If the button/trigger is currently touched
  82832. */
  82833. touched: boolean;
  82834. /**
  82835. * If the button/trigger is currently pressed
  82836. */
  82837. pressed: boolean;
  82838. }
  82839. /**
  82840. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  82841. * @hidden
  82842. */
  82843. export interface ExtendedGamepadButton extends GamepadButton {
  82844. /**
  82845. * If the button/trigger is currently pressed
  82846. */
  82847. readonly pressed: boolean;
  82848. /**
  82849. * If the button/trigger is currently touched
  82850. */
  82851. readonly touched: boolean;
  82852. /**
  82853. * Value of the button/trigger
  82854. */
  82855. readonly value: number;
  82856. }
  82857. /** @hidden */
  82858. export interface _GamePadFactory {
  82859. /**
  82860. * Returns wether or not the current gamepad can be created for this type of controller.
  82861. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82862. * @returns true if it can be created, otherwise false
  82863. */
  82864. canCreate(gamepadInfo: any): boolean;
  82865. /**
  82866. * Creates a new instance of the Gamepad.
  82867. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82868. * @returns the new gamepad instance
  82869. */
  82870. create(gamepadInfo: any): Gamepad;
  82871. }
  82872. /**
  82873. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82874. */
  82875. export class PoseEnabledControllerHelper {
  82876. /** @hidden */
  82877. static _ControllerFactories: _GamePadFactory[];
  82878. /** @hidden */
  82879. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  82880. /**
  82881. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82882. * @param vrGamepad the gamepad to initialized
  82883. * @returns a vr controller of the type the gamepad identified as
  82884. */
  82885. static InitiateController(vrGamepad: any): Gamepad;
  82886. }
  82887. /**
  82888. * Defines the PoseEnabledController object that contains state of a vr capable controller
  82889. */
  82890. export class PoseEnabledController extends Gamepad implements PoseControlled {
  82891. /**
  82892. * If the controller is used in a webXR session
  82893. */
  82894. isXR: boolean;
  82895. private _deviceRoomPosition;
  82896. private _deviceRoomRotationQuaternion;
  82897. /**
  82898. * The device position in babylon space
  82899. */
  82900. devicePosition: Vector3;
  82901. /**
  82902. * The device rotation in babylon space
  82903. */
  82904. deviceRotationQuaternion: Quaternion;
  82905. /**
  82906. * The scale factor of the device in babylon space
  82907. */
  82908. deviceScaleFactor: number;
  82909. /**
  82910. * (Likely devicePosition should be used instead) The device position in its room space
  82911. */
  82912. position: Vector3;
  82913. /**
  82914. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  82915. */
  82916. rotationQuaternion: Quaternion;
  82917. /**
  82918. * The type of controller (Eg. Windows mixed reality)
  82919. */
  82920. controllerType: PoseEnabledControllerType;
  82921. protected _calculatedPosition: Vector3;
  82922. private _calculatedRotation;
  82923. /**
  82924. * The raw pose from the device
  82925. */
  82926. rawPose: DevicePose;
  82927. private _trackPosition;
  82928. private _maxRotationDistFromHeadset;
  82929. private _draggedRoomRotation;
  82930. /**
  82931. * @hidden
  82932. */
  82933. _disableTrackPosition(fixedPosition: Vector3): void;
  82934. /**
  82935. * Internal, the mesh attached to the controller
  82936. * @hidden
  82937. */
  82938. _mesh: Nullable<AbstractMesh>;
  82939. private _poseControlledCamera;
  82940. private _leftHandSystemQuaternion;
  82941. /**
  82942. * Internal, matrix used to convert room space to babylon space
  82943. * @hidden
  82944. */
  82945. _deviceToWorld: Matrix;
  82946. /**
  82947. * Node to be used when casting a ray from the controller
  82948. * @hidden
  82949. */
  82950. _pointingPoseNode: Nullable<TransformNode>;
  82951. /**
  82952. * Name of the child mesh that can be used to cast a ray from the controller
  82953. */
  82954. static readonly POINTING_POSE: string;
  82955. /**
  82956. * Creates a new PoseEnabledController from a gamepad
  82957. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  82958. */
  82959. constructor(browserGamepad: any);
  82960. private _workingMatrix;
  82961. /**
  82962. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  82963. */
  82964. update(): void;
  82965. /**
  82966. * Updates only the pose device and mesh without doing any button event checking
  82967. */
  82968. protected _updatePoseAndMesh(): void;
  82969. /**
  82970. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  82971. * @param poseData raw pose fromthe device
  82972. */
  82973. updateFromDevice(poseData: DevicePose): void;
  82974. /**
  82975. * @hidden
  82976. */
  82977. _meshAttachedObservable: Observable<AbstractMesh>;
  82978. /**
  82979. * Attaches a mesh to the controller
  82980. * @param mesh the mesh to be attached
  82981. */
  82982. attachToMesh(mesh: AbstractMesh): void;
  82983. /**
  82984. * Attaches the controllers mesh to a camera
  82985. * @param camera the camera the mesh should be attached to
  82986. */
  82987. attachToPoseControlledCamera(camera: TargetCamera): void;
  82988. /**
  82989. * Disposes of the controller
  82990. */
  82991. dispose(): void;
  82992. /**
  82993. * The mesh that is attached to the controller
  82994. */
  82995. readonly mesh: Nullable<AbstractMesh>;
  82996. /**
  82997. * Gets the ray of the controller in the direction the controller is pointing
  82998. * @param length the length the resulting ray should be
  82999. * @returns a ray in the direction the controller is pointing
  83000. */
  83001. getForwardRay(length?: number): Ray;
  83002. }
  83003. }
  83004. declare module BABYLON {
  83005. /**
  83006. * Defines the WebVRController object that represents controllers tracked in 3D space
  83007. */
  83008. export abstract class WebVRController extends PoseEnabledController {
  83009. /**
  83010. * Internal, the default controller model for the controller
  83011. */
  83012. protected _defaultModel: Nullable<AbstractMesh>;
  83013. /**
  83014. * Fired when the trigger state has changed
  83015. */
  83016. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  83017. /**
  83018. * Fired when the main button state has changed
  83019. */
  83020. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  83021. /**
  83022. * Fired when the secondary button state has changed
  83023. */
  83024. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  83025. /**
  83026. * Fired when the pad state has changed
  83027. */
  83028. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  83029. /**
  83030. * Fired when controllers stick values have changed
  83031. */
  83032. onPadValuesChangedObservable: Observable<StickValues>;
  83033. /**
  83034. * Array of button availible on the controller
  83035. */
  83036. protected _buttons: Array<MutableGamepadButton>;
  83037. private _onButtonStateChange;
  83038. /**
  83039. * Fired when a controller button's state has changed
  83040. * @param callback the callback containing the button that was modified
  83041. */
  83042. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  83043. /**
  83044. * X and Y axis corresponding to the controllers joystick
  83045. */
  83046. pad: StickValues;
  83047. /**
  83048. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  83049. */
  83050. hand: string;
  83051. /**
  83052. * The default controller model for the controller
  83053. */
  83054. readonly defaultModel: Nullable<AbstractMesh>;
  83055. /**
  83056. * Creates a new WebVRController from a gamepad
  83057. * @param vrGamepad the gamepad that the WebVRController should be created from
  83058. */
  83059. constructor(vrGamepad: any);
  83060. /**
  83061. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  83062. */
  83063. update(): void;
  83064. /**
  83065. * Function to be called when a button is modified
  83066. */
  83067. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  83068. /**
  83069. * Loads a mesh and attaches it to the controller
  83070. * @param scene the scene the mesh should be added to
  83071. * @param meshLoaded callback for when the mesh has been loaded
  83072. */
  83073. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  83074. private _setButtonValue;
  83075. private _changes;
  83076. private _checkChanges;
  83077. /**
  83078. * Disposes of th webVRCOntroller
  83079. */
  83080. dispose(): void;
  83081. }
  83082. }
  83083. declare module BABYLON {
  83084. /**
  83085. * The HemisphericLight simulates the ambient environment light,
  83086. * so the passed direction is the light reflection direction, not the incoming direction.
  83087. */
  83088. export class HemisphericLight extends Light {
  83089. /**
  83090. * The groundColor is the light in the opposite direction to the one specified during creation.
  83091. * 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.
  83092. */
  83093. groundColor: Color3;
  83094. /**
  83095. * The light reflection direction, not the incoming direction.
  83096. */
  83097. direction: Vector3;
  83098. /**
  83099. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  83100. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  83101. * The HemisphericLight can't cast shadows.
  83102. * Documentation : https://doc.babylonjs.com/babylon101/lights
  83103. * @param name The friendly name of the light
  83104. * @param direction The direction of the light reflection
  83105. * @param scene The scene the light belongs to
  83106. */
  83107. constructor(name: string, direction: Vector3, scene: Scene);
  83108. protected _buildUniformLayout(): void;
  83109. /**
  83110. * Returns the string "HemisphericLight".
  83111. * @return The class name
  83112. */
  83113. getClassName(): string;
  83114. /**
  83115. * Sets the HemisphericLight direction towards the passed target (Vector3).
  83116. * Returns the updated direction.
  83117. * @param target The target the direction should point to
  83118. * @return The computed direction
  83119. */
  83120. setDirectionToTarget(target: Vector3): Vector3;
  83121. /**
  83122. * Returns the shadow generator associated to the light.
  83123. * @returns Always null for hemispheric lights because it does not support shadows.
  83124. */
  83125. getShadowGenerator(): Nullable<IShadowGenerator>;
  83126. /**
  83127. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  83128. * @param effect The effect to update
  83129. * @param lightIndex The index of the light in the effect to update
  83130. * @returns The hemispheric light
  83131. */
  83132. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  83133. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  83134. /**
  83135. * Computes the world matrix of the node
  83136. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  83137. * @param useWasUpdatedFlag defines a reserved property
  83138. * @returns the world matrix
  83139. */
  83140. computeWorldMatrix(): Matrix;
  83141. /**
  83142. * Returns the integer 3.
  83143. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  83144. */
  83145. getTypeID(): number;
  83146. /**
  83147. * Prepares the list of defines specific to the light type.
  83148. * @param defines the list of defines
  83149. * @param lightIndex defines the index of the light for the effect
  83150. */
  83151. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  83152. }
  83153. }
  83154. declare module BABYLON {
  83155. /** @hidden */
  83156. export var vrMultiviewToSingleviewPixelShader: {
  83157. name: string;
  83158. shader: string;
  83159. };
  83160. }
  83161. declare module BABYLON {
  83162. /**
  83163. * Renders to multiple views with a single draw call
  83164. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  83165. */
  83166. export class MultiviewRenderTarget extends RenderTargetTexture {
  83167. /**
  83168. * Creates a multiview render target
  83169. * @param scene scene used with the render target
  83170. * @param size the size of the render target (used for each view)
  83171. */
  83172. constructor(scene: Scene, size?: number | {
  83173. width: number;
  83174. height: number;
  83175. } | {
  83176. ratio: number;
  83177. });
  83178. /**
  83179. * @hidden
  83180. * @param faceIndex the face index, if its a cube texture
  83181. */
  83182. _bindFrameBuffer(faceIndex?: number): void;
  83183. /**
  83184. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  83185. * @returns the view count
  83186. */
  83187. getViewCount(): number;
  83188. }
  83189. }
  83190. declare module BABYLON {
  83191. /**
  83192. * Represents a camera frustum
  83193. */
  83194. export class Frustum {
  83195. /**
  83196. * Gets the planes representing the frustum
  83197. * @param transform matrix to be applied to the returned planes
  83198. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  83199. */
  83200. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  83201. /**
  83202. * Gets the near frustum plane transformed by the transform matrix
  83203. * @param transform transformation matrix to be applied to the resulting frustum plane
  83204. * @param frustumPlane the resuling frustum plane
  83205. */
  83206. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83207. /**
  83208. * Gets the far frustum plane transformed by the transform matrix
  83209. * @param transform transformation matrix to be applied to the resulting frustum plane
  83210. * @param frustumPlane the resuling frustum plane
  83211. */
  83212. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83213. /**
  83214. * Gets the left frustum plane transformed by the transform matrix
  83215. * @param transform transformation matrix to be applied to the resulting frustum plane
  83216. * @param frustumPlane the resuling frustum plane
  83217. */
  83218. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83219. /**
  83220. * Gets the right frustum plane transformed by the transform matrix
  83221. * @param transform transformation matrix to be applied to the resulting frustum plane
  83222. * @param frustumPlane the resuling frustum plane
  83223. */
  83224. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83225. /**
  83226. * Gets the top frustum plane transformed by the transform matrix
  83227. * @param transform transformation matrix to be applied to the resulting frustum plane
  83228. * @param frustumPlane the resuling frustum plane
  83229. */
  83230. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83231. /**
  83232. * Gets the bottom frustum plane transformed by the transform matrix
  83233. * @param transform transformation matrix to be applied to the resulting frustum plane
  83234. * @param frustumPlane the resuling frustum plane
  83235. */
  83236. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83237. /**
  83238. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  83239. * @param transform transformation matrix to be applied to the resulting frustum planes
  83240. * @param frustumPlanes the resuling frustum planes
  83241. */
  83242. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  83243. }
  83244. }
  83245. declare module BABYLON {
  83246. interface Engine {
  83247. /**
  83248. * Creates a new multiview render target
  83249. * @param width defines the width of the texture
  83250. * @param height defines the height of the texture
  83251. * @returns the created multiview texture
  83252. */
  83253. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  83254. /**
  83255. * Binds a multiview framebuffer to be drawn to
  83256. * @param multiviewTexture texture to bind
  83257. */
  83258. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  83259. }
  83260. interface Camera {
  83261. /**
  83262. * @hidden
  83263. * 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)
  83264. */
  83265. _useMultiviewToSingleView: boolean;
  83266. /**
  83267. * @hidden
  83268. * 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)
  83269. */
  83270. _multiviewTexture: Nullable<RenderTargetTexture>;
  83271. /**
  83272. * @hidden
  83273. * ensures the multiview texture of the camera exists and has the specified width/height
  83274. * @param width height to set on the multiview texture
  83275. * @param height width to set on the multiview texture
  83276. */
  83277. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  83278. }
  83279. interface Scene {
  83280. /** @hidden */
  83281. _transformMatrixR: Matrix;
  83282. /** @hidden */
  83283. _multiviewSceneUbo: Nullable<UniformBuffer>;
  83284. /** @hidden */
  83285. _createMultiviewUbo(): void;
  83286. /** @hidden */
  83287. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  83288. /** @hidden */
  83289. _renderMultiviewToSingleView(camera: Camera): void;
  83290. }
  83291. }
  83292. declare module BABYLON {
  83293. /**
  83294. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  83295. * This will not be used for webXR as it supports displaying texture arrays directly
  83296. */
  83297. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  83298. /**
  83299. * Initializes a VRMultiviewToSingleview
  83300. * @param name name of the post process
  83301. * @param camera camera to be applied to
  83302. * @param scaleFactor scaling factor to the size of the output texture
  83303. */
  83304. constructor(name: string, camera: Camera, scaleFactor: number);
  83305. }
  83306. }
  83307. declare module BABYLON {
  83308. /**
  83309. * Interface used to define additional presentation attributes
  83310. */
  83311. export interface IVRPresentationAttributes {
  83312. /**
  83313. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  83314. */
  83315. highRefreshRate: boolean;
  83316. /**
  83317. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  83318. */
  83319. foveationLevel: number;
  83320. }
  83321. interface Engine {
  83322. /** @hidden */
  83323. _vrDisplay: any;
  83324. /** @hidden */
  83325. _vrSupported: boolean;
  83326. /** @hidden */
  83327. _oldSize: Size;
  83328. /** @hidden */
  83329. _oldHardwareScaleFactor: number;
  83330. /** @hidden */
  83331. _vrExclusivePointerMode: boolean;
  83332. /** @hidden */
  83333. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  83334. /** @hidden */
  83335. _onVRDisplayPointerRestricted: () => void;
  83336. /** @hidden */
  83337. _onVRDisplayPointerUnrestricted: () => void;
  83338. /** @hidden */
  83339. _onVrDisplayConnect: Nullable<(display: any) => void>;
  83340. /** @hidden */
  83341. _onVrDisplayDisconnect: Nullable<() => void>;
  83342. /** @hidden */
  83343. _onVrDisplayPresentChange: Nullable<() => void>;
  83344. /**
  83345. * Observable signaled when VR display mode changes
  83346. */
  83347. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  83348. /**
  83349. * Observable signaled when VR request present is complete
  83350. */
  83351. onVRRequestPresentComplete: Observable<boolean>;
  83352. /**
  83353. * Observable signaled when VR request present starts
  83354. */
  83355. onVRRequestPresentStart: Observable<Engine>;
  83356. /**
  83357. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  83358. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  83359. */
  83360. isInVRExclusivePointerMode: boolean;
  83361. /**
  83362. * Gets a boolean indicating if a webVR device was detected
  83363. * @returns true if a webVR device was detected
  83364. */
  83365. isVRDevicePresent(): boolean;
  83366. /**
  83367. * Gets the current webVR device
  83368. * @returns the current webVR device (or null)
  83369. */
  83370. getVRDevice(): any;
  83371. /**
  83372. * Initializes a webVR display and starts listening to display change events
  83373. * The onVRDisplayChangedObservable will be notified upon these changes
  83374. * @returns A promise containing a VRDisplay and if vr is supported
  83375. */
  83376. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  83377. /** @hidden */
  83378. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  83379. /**
  83380. * Gets or sets the presentation attributes used to configure VR rendering
  83381. */
  83382. vrPresentationAttributes?: IVRPresentationAttributes;
  83383. /**
  83384. * Call this function to switch to webVR mode
  83385. * Will do nothing if webVR is not supported or if there is no webVR device
  83386. * @param options the webvr options provided to the camera. mainly used for multiview
  83387. * @see http://doc.babylonjs.com/how_to/webvr_camera
  83388. */
  83389. enableVR(options: WebVROptions): void;
  83390. /** @hidden */
  83391. _onVRFullScreenTriggered(): void;
  83392. }
  83393. }
  83394. declare module BABYLON {
  83395. /**
  83396. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  83397. * IMPORTANT!! The data is right-hand data.
  83398. * @export
  83399. * @interface DevicePose
  83400. */
  83401. export interface DevicePose {
  83402. /**
  83403. * The position of the device, values in array are [x,y,z].
  83404. */
  83405. readonly position: Nullable<Float32Array>;
  83406. /**
  83407. * The linearVelocity of the device, values in array are [x,y,z].
  83408. */
  83409. readonly linearVelocity: Nullable<Float32Array>;
  83410. /**
  83411. * The linearAcceleration of the device, values in array are [x,y,z].
  83412. */
  83413. readonly linearAcceleration: Nullable<Float32Array>;
  83414. /**
  83415. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  83416. */
  83417. readonly orientation: Nullable<Float32Array>;
  83418. /**
  83419. * The angularVelocity of the device, values in array are [x,y,z].
  83420. */
  83421. readonly angularVelocity: Nullable<Float32Array>;
  83422. /**
  83423. * The angularAcceleration of the device, values in array are [x,y,z].
  83424. */
  83425. readonly angularAcceleration: Nullable<Float32Array>;
  83426. }
  83427. /**
  83428. * Interface representing a pose controlled object in Babylon.
  83429. * A pose controlled object has both regular pose values as well as pose values
  83430. * from an external device such as a VR head mounted display
  83431. */
  83432. export interface PoseControlled {
  83433. /**
  83434. * The position of the object in babylon space.
  83435. */
  83436. position: Vector3;
  83437. /**
  83438. * The rotation quaternion of the object in babylon space.
  83439. */
  83440. rotationQuaternion: Quaternion;
  83441. /**
  83442. * The position of the device in babylon space.
  83443. */
  83444. devicePosition?: Vector3;
  83445. /**
  83446. * The rotation quaternion of the device in babylon space.
  83447. */
  83448. deviceRotationQuaternion: Quaternion;
  83449. /**
  83450. * The raw pose coming from the device.
  83451. */
  83452. rawPose: Nullable<DevicePose>;
  83453. /**
  83454. * The scale of the device to be used when translating from device space to babylon space.
  83455. */
  83456. deviceScaleFactor: number;
  83457. /**
  83458. * Updates the poseControlled values based on the input device pose.
  83459. * @param poseData the pose data to update the object with
  83460. */
  83461. updateFromDevice(poseData: DevicePose): void;
  83462. }
  83463. /**
  83464. * Set of options to customize the webVRCamera
  83465. */
  83466. export interface WebVROptions {
  83467. /**
  83468. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  83469. */
  83470. trackPosition?: boolean;
  83471. /**
  83472. * Sets the scale of the vrDevice in babylon space. (default: 1)
  83473. */
  83474. positionScale?: number;
  83475. /**
  83476. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  83477. */
  83478. displayName?: string;
  83479. /**
  83480. * Should the native controller meshes be initialized. (default: true)
  83481. */
  83482. controllerMeshes?: boolean;
  83483. /**
  83484. * Creating a default HemiLight only on controllers. (default: true)
  83485. */
  83486. defaultLightingOnControllers?: boolean;
  83487. /**
  83488. * If you don't want to use the default VR button of the helper. (default: false)
  83489. */
  83490. useCustomVRButton?: boolean;
  83491. /**
  83492. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  83493. */
  83494. customVRButton?: HTMLButtonElement;
  83495. /**
  83496. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  83497. */
  83498. rayLength?: number;
  83499. /**
  83500. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  83501. */
  83502. defaultHeight?: number;
  83503. /**
  83504. * If multiview should be used if availible (default: false)
  83505. */
  83506. useMultiview?: boolean;
  83507. }
  83508. /**
  83509. * This represents a WebVR camera.
  83510. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  83511. * @example http://doc.babylonjs.com/how_to/webvr_camera
  83512. */
  83513. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  83514. private webVROptions;
  83515. /**
  83516. * @hidden
  83517. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  83518. */
  83519. _vrDevice: any;
  83520. /**
  83521. * The rawPose of the vrDevice.
  83522. */
  83523. rawPose: Nullable<DevicePose>;
  83524. private _onVREnabled;
  83525. private _specsVersion;
  83526. private _attached;
  83527. private _frameData;
  83528. protected _descendants: Array<Node>;
  83529. private _deviceRoomPosition;
  83530. /** @hidden */
  83531. _deviceRoomRotationQuaternion: Quaternion;
  83532. private _standingMatrix;
  83533. /**
  83534. * Represents device position in babylon space.
  83535. */
  83536. devicePosition: Vector3;
  83537. /**
  83538. * Represents device rotation in babylon space.
  83539. */
  83540. deviceRotationQuaternion: Quaternion;
  83541. /**
  83542. * The scale of the device to be used when translating from device space to babylon space.
  83543. */
  83544. deviceScaleFactor: number;
  83545. private _deviceToWorld;
  83546. private _worldToDevice;
  83547. /**
  83548. * References to the webVR controllers for the vrDevice.
  83549. */
  83550. controllers: Array<WebVRController>;
  83551. /**
  83552. * Emits an event when a controller is attached.
  83553. */
  83554. onControllersAttachedObservable: Observable<WebVRController[]>;
  83555. /**
  83556. * Emits an event when a controller's mesh has been loaded;
  83557. */
  83558. onControllerMeshLoadedObservable: Observable<WebVRController>;
  83559. /**
  83560. * Emits an event when the HMD's pose has been updated.
  83561. */
  83562. onPoseUpdatedFromDeviceObservable: Observable<any>;
  83563. private _poseSet;
  83564. /**
  83565. * If the rig cameras be used as parent instead of this camera.
  83566. */
  83567. rigParenting: boolean;
  83568. private _lightOnControllers;
  83569. private _defaultHeight?;
  83570. /**
  83571. * Instantiates a WebVRFreeCamera.
  83572. * @param name The name of the WebVRFreeCamera
  83573. * @param position The starting anchor position for the camera
  83574. * @param scene The scene the camera belongs to
  83575. * @param webVROptions a set of customizable options for the webVRCamera
  83576. */
  83577. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  83578. /**
  83579. * Gets the device distance from the ground in meters.
  83580. * @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.
  83581. */
  83582. deviceDistanceToRoomGround(): number;
  83583. /**
  83584. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  83585. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  83586. */
  83587. useStandingMatrix(callback?: (bool: boolean) => void): void;
  83588. /**
  83589. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  83590. * @returns A promise with a boolean set to if the standing matrix is supported.
  83591. */
  83592. useStandingMatrixAsync(): Promise<boolean>;
  83593. /**
  83594. * Disposes the camera
  83595. */
  83596. dispose(): void;
  83597. /**
  83598. * Gets a vrController by name.
  83599. * @param name The name of the controller to retreive
  83600. * @returns the controller matching the name specified or null if not found
  83601. */
  83602. getControllerByName(name: string): Nullable<WebVRController>;
  83603. private _leftController;
  83604. /**
  83605. * The controller corresponding to the users left hand.
  83606. */
  83607. readonly leftController: Nullable<WebVRController>;
  83608. private _rightController;
  83609. /**
  83610. * The controller corresponding to the users right hand.
  83611. */
  83612. readonly rightController: Nullable<WebVRController>;
  83613. /**
  83614. * Casts a ray forward from the vrCamera's gaze.
  83615. * @param length Length of the ray (default: 100)
  83616. * @returns the ray corresponding to the gaze
  83617. */
  83618. getForwardRay(length?: number): Ray;
  83619. /**
  83620. * @hidden
  83621. * Updates the camera based on device's frame data
  83622. */
  83623. _checkInputs(): void;
  83624. /**
  83625. * Updates the poseControlled values based on the input device pose.
  83626. * @param poseData Pose coming from the device
  83627. */
  83628. updateFromDevice(poseData: DevicePose): void;
  83629. private _htmlElementAttached;
  83630. private _detachIfAttached;
  83631. /**
  83632. * WebVR's attach control will start broadcasting frames to the device.
  83633. * Note that in certain browsers (chrome for example) this function must be called
  83634. * within a user-interaction callback. Example:
  83635. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  83636. *
  83637. * @param element html element to attach the vrDevice to
  83638. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  83639. */
  83640. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  83641. /**
  83642. * Detaches the camera from the html element and disables VR
  83643. *
  83644. * @param element html element to detach from
  83645. */
  83646. detachControl(element: HTMLElement): void;
  83647. /**
  83648. * @returns the name of this class
  83649. */
  83650. getClassName(): string;
  83651. /**
  83652. * Calls resetPose on the vrDisplay
  83653. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  83654. */
  83655. resetToCurrentRotation(): void;
  83656. /**
  83657. * @hidden
  83658. * Updates the rig cameras (left and right eye)
  83659. */
  83660. _updateRigCameras(): void;
  83661. private _workingVector;
  83662. private _oneVector;
  83663. private _workingMatrix;
  83664. private updateCacheCalled;
  83665. private _correctPositionIfNotTrackPosition;
  83666. /**
  83667. * @hidden
  83668. * Updates the cached values of the camera
  83669. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  83670. */
  83671. _updateCache(ignoreParentClass?: boolean): void;
  83672. /**
  83673. * @hidden
  83674. * Get current device position in babylon world
  83675. */
  83676. _computeDevicePosition(): void;
  83677. /**
  83678. * Updates the current device position and rotation in the babylon world
  83679. */
  83680. update(): void;
  83681. /**
  83682. * @hidden
  83683. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  83684. * @returns an identity matrix
  83685. */
  83686. _getViewMatrix(): Matrix;
  83687. private _tmpMatrix;
  83688. /**
  83689. * This function is called by the two RIG cameras.
  83690. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  83691. * @hidden
  83692. */
  83693. _getWebVRViewMatrix(): Matrix;
  83694. /** @hidden */
  83695. _getWebVRProjectionMatrix(): Matrix;
  83696. private _onGamepadConnectedObserver;
  83697. private _onGamepadDisconnectedObserver;
  83698. private _updateCacheWhenTrackingDisabledObserver;
  83699. /**
  83700. * Initializes the controllers and their meshes
  83701. */
  83702. initControllers(): void;
  83703. }
  83704. }
  83705. declare module BABYLON {
  83706. /**
  83707. * Size options for a post process
  83708. */
  83709. export type PostProcessOptions = {
  83710. width: number;
  83711. height: number;
  83712. };
  83713. /**
  83714. * PostProcess can be used to apply a shader to a texture after it has been rendered
  83715. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  83716. */
  83717. export class PostProcess {
  83718. /** Name of the PostProcess. */
  83719. name: string;
  83720. /**
  83721. * Gets or sets the unique id of the post process
  83722. */
  83723. uniqueId: number;
  83724. /**
  83725. * Width of the texture to apply the post process on
  83726. */
  83727. width: number;
  83728. /**
  83729. * Height of the texture to apply the post process on
  83730. */
  83731. height: number;
  83732. /**
  83733. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  83734. * @hidden
  83735. */
  83736. _outputTexture: Nullable<InternalTexture>;
  83737. /**
  83738. * Sampling mode used by the shader
  83739. * See https://doc.babylonjs.com/classes/3.1/texture
  83740. */
  83741. renderTargetSamplingMode: number;
  83742. /**
  83743. * Clear color to use when screen clearing
  83744. */
  83745. clearColor: Color4;
  83746. /**
  83747. * If the buffer needs to be cleared before applying the post process. (default: true)
  83748. * Should be set to false if shader will overwrite all previous pixels.
  83749. */
  83750. autoClear: boolean;
  83751. /**
  83752. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  83753. */
  83754. alphaMode: number;
  83755. /**
  83756. * Sets the setAlphaBlendConstants of the babylon engine
  83757. */
  83758. alphaConstants: Color4;
  83759. /**
  83760. * Animations to be used for the post processing
  83761. */
  83762. animations: Animation[];
  83763. /**
  83764. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  83765. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  83766. */
  83767. enablePixelPerfectMode: boolean;
  83768. /**
  83769. * Force the postprocess to be applied without taking in account viewport
  83770. */
  83771. forceFullscreenViewport: boolean;
  83772. /**
  83773. * List of inspectable custom properties (used by the Inspector)
  83774. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83775. */
  83776. inspectableCustomProperties: IInspectable[];
  83777. /**
  83778. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  83779. *
  83780. * | Value | Type | Description |
  83781. * | ----- | ----------------------------------- | ----------- |
  83782. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  83783. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  83784. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  83785. *
  83786. */
  83787. scaleMode: number;
  83788. /**
  83789. * Force textures to be a power of two (default: false)
  83790. */
  83791. alwaysForcePOT: boolean;
  83792. private _samples;
  83793. /**
  83794. * Number of sample textures (default: 1)
  83795. */
  83796. samples: number;
  83797. /**
  83798. * Modify the scale of the post process to be the same as the viewport (default: false)
  83799. */
  83800. adaptScaleToCurrentViewport: boolean;
  83801. private _camera;
  83802. private _scene;
  83803. private _engine;
  83804. private _options;
  83805. private _reusable;
  83806. private _textureType;
  83807. /**
  83808. * Smart array of input and output textures for the post process.
  83809. * @hidden
  83810. */
  83811. _textures: SmartArray<InternalTexture>;
  83812. /**
  83813. * The index in _textures that corresponds to the output texture.
  83814. * @hidden
  83815. */
  83816. _currentRenderTextureInd: number;
  83817. private _effect;
  83818. private _samplers;
  83819. private _fragmentUrl;
  83820. private _vertexUrl;
  83821. private _parameters;
  83822. private _scaleRatio;
  83823. protected _indexParameters: any;
  83824. private _shareOutputWithPostProcess;
  83825. private _texelSize;
  83826. private _forcedOutputTexture;
  83827. /**
  83828. * Returns the fragment url or shader name used in the post process.
  83829. * @returns the fragment url or name in the shader store.
  83830. */
  83831. getEffectName(): string;
  83832. /**
  83833. * An event triggered when the postprocess is activated.
  83834. */
  83835. onActivateObservable: Observable<Camera>;
  83836. private _onActivateObserver;
  83837. /**
  83838. * A function that is added to the onActivateObservable
  83839. */
  83840. onActivate: Nullable<(camera: Camera) => void>;
  83841. /**
  83842. * An event triggered when the postprocess changes its size.
  83843. */
  83844. onSizeChangedObservable: Observable<PostProcess>;
  83845. private _onSizeChangedObserver;
  83846. /**
  83847. * A function that is added to the onSizeChangedObservable
  83848. */
  83849. onSizeChanged: (postProcess: PostProcess) => void;
  83850. /**
  83851. * An event triggered when the postprocess applies its effect.
  83852. */
  83853. onApplyObservable: Observable<Effect>;
  83854. private _onApplyObserver;
  83855. /**
  83856. * A function that is added to the onApplyObservable
  83857. */
  83858. onApply: (effect: Effect) => void;
  83859. /**
  83860. * An event triggered before rendering the postprocess
  83861. */
  83862. onBeforeRenderObservable: Observable<Effect>;
  83863. private _onBeforeRenderObserver;
  83864. /**
  83865. * A function that is added to the onBeforeRenderObservable
  83866. */
  83867. onBeforeRender: (effect: Effect) => void;
  83868. /**
  83869. * An event triggered after rendering the postprocess
  83870. */
  83871. onAfterRenderObservable: Observable<Effect>;
  83872. private _onAfterRenderObserver;
  83873. /**
  83874. * A function that is added to the onAfterRenderObservable
  83875. */
  83876. onAfterRender: (efect: Effect) => void;
  83877. /**
  83878. * 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
  83879. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  83880. */
  83881. inputTexture: InternalTexture;
  83882. /**
  83883. * Gets the camera which post process is applied to.
  83884. * @returns The camera the post process is applied to.
  83885. */
  83886. getCamera(): Camera;
  83887. /**
  83888. * Gets the texel size of the postprocess.
  83889. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  83890. */
  83891. readonly texelSize: Vector2;
  83892. /**
  83893. * Creates a new instance PostProcess
  83894. * @param name The name of the PostProcess.
  83895. * @param fragmentUrl The url of the fragment shader to be used.
  83896. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  83897. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  83898. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83899. * @param camera The camera to apply the render pass to.
  83900. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83901. * @param engine The engine which the post process will be applied. (default: current engine)
  83902. * @param reusable If the post process can be reused on the same frame. (default: false)
  83903. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  83904. * @param textureType Type of textures used when performing the post process. (default: 0)
  83905. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  83906. * @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
  83907. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  83908. */
  83909. constructor(
  83910. /** Name of the PostProcess. */
  83911. 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);
  83912. /**
  83913. * Gets a string idenfifying the name of the class
  83914. * @returns "PostProcess" string
  83915. */
  83916. getClassName(): string;
  83917. /**
  83918. * Gets the engine which this post process belongs to.
  83919. * @returns The engine the post process was enabled with.
  83920. */
  83921. getEngine(): Engine;
  83922. /**
  83923. * The effect that is created when initializing the post process.
  83924. * @returns The created effect corresponding the the postprocess.
  83925. */
  83926. getEffect(): Effect;
  83927. /**
  83928. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  83929. * @param postProcess The post process to share the output with.
  83930. * @returns This post process.
  83931. */
  83932. shareOutputWith(postProcess: PostProcess): PostProcess;
  83933. /**
  83934. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  83935. * This should be called if the post process that shares output with this post process is disabled/disposed.
  83936. */
  83937. useOwnOutput(): void;
  83938. /**
  83939. * Updates the effect with the current post process compile time values and recompiles the shader.
  83940. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83941. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83942. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83943. * @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
  83944. * @param onCompiled Called when the shader has been compiled.
  83945. * @param onError Called if there is an error when compiling a shader.
  83946. */
  83947. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83948. /**
  83949. * The post process is reusable if it can be used multiple times within one frame.
  83950. * @returns If the post process is reusable
  83951. */
  83952. isReusable(): boolean;
  83953. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  83954. markTextureDirty(): void;
  83955. /**
  83956. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  83957. * 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.
  83958. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  83959. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  83960. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  83961. * @returns The target texture that was bound to be written to.
  83962. */
  83963. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  83964. /**
  83965. * If the post process is supported.
  83966. */
  83967. readonly isSupported: boolean;
  83968. /**
  83969. * The aspect ratio of the output texture.
  83970. */
  83971. readonly aspectRatio: number;
  83972. /**
  83973. * Get a value indicating if the post-process is ready to be used
  83974. * @returns true if the post-process is ready (shader is compiled)
  83975. */
  83976. isReady(): boolean;
  83977. /**
  83978. * Binds all textures and uniforms to the shader, this will be run on every pass.
  83979. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  83980. */
  83981. apply(): Nullable<Effect>;
  83982. private _disposeTextures;
  83983. /**
  83984. * Disposes the post process.
  83985. * @param camera The camera to dispose the post process on.
  83986. */
  83987. dispose(camera?: Camera): void;
  83988. }
  83989. }
  83990. declare module BABYLON {
  83991. /** @hidden */
  83992. export var kernelBlurVaryingDeclaration: {
  83993. name: string;
  83994. shader: string;
  83995. };
  83996. }
  83997. declare module BABYLON {
  83998. /** @hidden */
  83999. export var kernelBlurFragment: {
  84000. name: string;
  84001. shader: string;
  84002. };
  84003. }
  84004. declare module BABYLON {
  84005. /** @hidden */
  84006. export var kernelBlurFragment2: {
  84007. name: string;
  84008. shader: string;
  84009. };
  84010. }
  84011. declare module BABYLON {
  84012. /** @hidden */
  84013. export var kernelBlurPixelShader: {
  84014. name: string;
  84015. shader: string;
  84016. };
  84017. }
  84018. declare module BABYLON {
  84019. /** @hidden */
  84020. export var kernelBlurVertex: {
  84021. name: string;
  84022. shader: string;
  84023. };
  84024. }
  84025. declare module BABYLON {
  84026. /** @hidden */
  84027. export var kernelBlurVertexShader: {
  84028. name: string;
  84029. shader: string;
  84030. };
  84031. }
  84032. declare module BABYLON {
  84033. /**
  84034. * The Blur Post Process which blurs an image based on a kernel and direction.
  84035. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  84036. */
  84037. export class BlurPostProcess extends PostProcess {
  84038. /** The direction in which to blur the image. */
  84039. direction: Vector2;
  84040. private blockCompilation;
  84041. protected _kernel: number;
  84042. protected _idealKernel: number;
  84043. protected _packedFloat: boolean;
  84044. private _staticDefines;
  84045. /**
  84046. * Sets the length in pixels of the blur sample region
  84047. */
  84048. /**
  84049. * Gets the length in pixels of the blur sample region
  84050. */
  84051. kernel: number;
  84052. /**
  84053. * Sets wether or not the blur needs to unpack/repack floats
  84054. */
  84055. /**
  84056. * Gets wether or not the blur is unpacking/repacking floats
  84057. */
  84058. packedFloat: boolean;
  84059. /**
  84060. * Creates a new instance BlurPostProcess
  84061. * @param name The name of the effect.
  84062. * @param direction The direction in which to blur the image.
  84063. * @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.
  84064. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  84065. * @param camera The camera to apply the render pass to.
  84066. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  84067. * @param engine The engine which the post process will be applied. (default: current engine)
  84068. * @param reusable If the post process can be reused on the same frame. (default: false)
  84069. * @param textureType Type of textures used when performing the post process. (default: 0)
  84070. * @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)
  84071. */
  84072. constructor(name: string,
  84073. /** The direction in which to blur the image. */
  84074. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  84075. /**
  84076. * Updates the effect with the current post process compile time values and recompiles the shader.
  84077. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  84078. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  84079. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  84080. * @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
  84081. * @param onCompiled Called when the shader has been compiled.
  84082. * @param onError Called if there is an error when compiling a shader.
  84083. */
  84084. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  84085. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  84086. /**
  84087. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  84088. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  84089. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  84090. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  84091. * The gaps between physical kernels are compensated for in the weighting of the samples
  84092. * @param idealKernel Ideal blur kernel.
  84093. * @return Nearest best kernel.
  84094. */
  84095. protected _nearestBestKernel(idealKernel: number): number;
  84096. /**
  84097. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  84098. * @param x The point on the Gaussian distribution to sample.
  84099. * @return the value of the Gaussian function at x.
  84100. */
  84101. protected _gaussianWeight(x: number): number;
  84102. /**
  84103. * Generates a string that can be used as a floating point number in GLSL.
  84104. * @param x Value to print.
  84105. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  84106. * @return GLSL float string.
  84107. */
  84108. protected _glslFloat(x: number, decimalFigures?: number): string;
  84109. }
  84110. }
  84111. declare module BABYLON {
  84112. /**
  84113. * Mirror texture can be used to simulate the view from a mirror in a scene.
  84114. * It will dynamically be rendered every frame to adapt to the camera point of view.
  84115. * You can then easily use it as a reflectionTexture on a flat surface.
  84116. * In case the surface is not a plane, please consider relying on reflection probes.
  84117. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  84118. */
  84119. export class MirrorTexture extends RenderTargetTexture {
  84120. private scene;
  84121. /**
  84122. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  84123. * 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.
  84124. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  84125. */
  84126. mirrorPlane: Plane;
  84127. /**
  84128. * Define the blur ratio used to blur the reflection if needed.
  84129. */
  84130. blurRatio: number;
  84131. /**
  84132. * Define the adaptive blur kernel used to blur the reflection if needed.
  84133. * This will autocompute the closest best match for the `blurKernel`
  84134. */
  84135. adaptiveBlurKernel: number;
  84136. /**
  84137. * Define the blur kernel used to blur the reflection if needed.
  84138. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  84139. */
  84140. blurKernel: number;
  84141. /**
  84142. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  84143. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  84144. */
  84145. blurKernelX: number;
  84146. /**
  84147. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  84148. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  84149. */
  84150. blurKernelY: number;
  84151. private _autoComputeBlurKernel;
  84152. protected _onRatioRescale(): void;
  84153. private _updateGammaSpace;
  84154. private _imageProcessingConfigChangeObserver;
  84155. private _transformMatrix;
  84156. private _mirrorMatrix;
  84157. private _savedViewMatrix;
  84158. private _blurX;
  84159. private _blurY;
  84160. private _adaptiveBlurKernel;
  84161. private _blurKernelX;
  84162. private _blurKernelY;
  84163. private _blurRatio;
  84164. /**
  84165. * Instantiates a Mirror Texture.
  84166. * Mirror texture can be used to simulate the view from a mirror in a scene.
  84167. * It will dynamically be rendered every frame to adapt to the camera point of view.
  84168. * You can then easily use it as a reflectionTexture on a flat surface.
  84169. * In case the surface is not a plane, please consider relying on reflection probes.
  84170. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  84171. * @param name
  84172. * @param size
  84173. * @param scene
  84174. * @param generateMipMaps
  84175. * @param type
  84176. * @param samplingMode
  84177. * @param generateDepthBuffer
  84178. */
  84179. constructor(name: string, size: number | {
  84180. width: number;
  84181. height: number;
  84182. } | {
  84183. ratio: number;
  84184. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  84185. private _preparePostProcesses;
  84186. /**
  84187. * Clone the mirror texture.
  84188. * @returns the cloned texture
  84189. */
  84190. clone(): MirrorTexture;
  84191. /**
  84192. * Serialize the texture to a JSON representation you could use in Parse later on
  84193. * @returns the serialized JSON representation
  84194. */
  84195. serialize(): any;
  84196. /**
  84197. * Dispose the texture and release its associated resources.
  84198. */
  84199. dispose(): void;
  84200. }
  84201. }
  84202. declare module BABYLON {
  84203. /**
  84204. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  84205. * @see http://doc.babylonjs.com/babylon101/materials#texture
  84206. */
  84207. export class Texture extends BaseTexture {
  84208. /**
  84209. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  84210. */
  84211. static SerializeBuffers: boolean;
  84212. /** @hidden */
  84213. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  84214. /** @hidden */
  84215. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  84216. /** @hidden */
  84217. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  84218. /** nearest is mag = nearest and min = nearest and mip = linear */
  84219. static readonly NEAREST_SAMPLINGMODE: number;
  84220. /** nearest is mag = nearest and min = nearest and mip = linear */
  84221. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  84222. /** Bilinear is mag = linear and min = linear and mip = nearest */
  84223. static readonly BILINEAR_SAMPLINGMODE: number;
  84224. /** Bilinear is mag = linear and min = linear and mip = nearest */
  84225. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  84226. /** Trilinear is mag = linear and min = linear and mip = linear */
  84227. static readonly TRILINEAR_SAMPLINGMODE: number;
  84228. /** Trilinear is mag = linear and min = linear and mip = linear */
  84229. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  84230. /** mag = nearest and min = nearest and mip = nearest */
  84231. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  84232. /** mag = nearest and min = linear and mip = nearest */
  84233. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  84234. /** mag = nearest and min = linear and mip = linear */
  84235. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  84236. /** mag = nearest and min = linear and mip = none */
  84237. static readonly NEAREST_LINEAR: number;
  84238. /** mag = nearest and min = nearest and mip = none */
  84239. static readonly NEAREST_NEAREST: number;
  84240. /** mag = linear and min = nearest and mip = nearest */
  84241. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  84242. /** mag = linear and min = nearest and mip = linear */
  84243. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  84244. /** mag = linear and min = linear and mip = none */
  84245. static readonly LINEAR_LINEAR: number;
  84246. /** mag = linear and min = nearest and mip = none */
  84247. static readonly LINEAR_NEAREST: number;
  84248. /** Explicit coordinates mode */
  84249. static readonly EXPLICIT_MODE: number;
  84250. /** Spherical coordinates mode */
  84251. static readonly SPHERICAL_MODE: number;
  84252. /** Planar coordinates mode */
  84253. static readonly PLANAR_MODE: number;
  84254. /** Cubic coordinates mode */
  84255. static readonly CUBIC_MODE: number;
  84256. /** Projection coordinates mode */
  84257. static readonly PROJECTION_MODE: number;
  84258. /** Inverse Cubic coordinates mode */
  84259. static readonly SKYBOX_MODE: number;
  84260. /** Inverse Cubic coordinates mode */
  84261. static readonly INVCUBIC_MODE: number;
  84262. /** Equirectangular coordinates mode */
  84263. static readonly EQUIRECTANGULAR_MODE: number;
  84264. /** Equirectangular Fixed coordinates mode */
  84265. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  84266. /** Equirectangular Fixed Mirrored coordinates mode */
  84267. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  84268. /** Texture is not repeating outside of 0..1 UVs */
  84269. static readonly CLAMP_ADDRESSMODE: number;
  84270. /** Texture is repeating outside of 0..1 UVs */
  84271. static readonly WRAP_ADDRESSMODE: number;
  84272. /** Texture is repeating and mirrored */
  84273. static readonly MIRROR_ADDRESSMODE: number;
  84274. /**
  84275. * 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
  84276. */
  84277. static UseSerializedUrlIfAny: boolean;
  84278. /**
  84279. * Define the url of the texture.
  84280. */
  84281. url: Nullable<string>;
  84282. /**
  84283. * Define an offset on the texture to offset the u coordinates of the UVs
  84284. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  84285. */
  84286. uOffset: number;
  84287. /**
  84288. * Define an offset on the texture to offset the v coordinates of the UVs
  84289. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  84290. */
  84291. vOffset: number;
  84292. /**
  84293. * Define an offset on the texture to scale the u coordinates of the UVs
  84294. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  84295. */
  84296. uScale: number;
  84297. /**
  84298. * Define an offset on the texture to scale the v coordinates of the UVs
  84299. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  84300. */
  84301. vScale: number;
  84302. /**
  84303. * Define an offset on the texture to rotate around the u coordinates of the UVs
  84304. * @see http://doc.babylonjs.com/how_to/more_materials
  84305. */
  84306. uAng: number;
  84307. /**
  84308. * Define an offset on the texture to rotate around the v coordinates of the UVs
  84309. * @see http://doc.babylonjs.com/how_to/more_materials
  84310. */
  84311. vAng: number;
  84312. /**
  84313. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  84314. * @see http://doc.babylonjs.com/how_to/more_materials
  84315. */
  84316. wAng: number;
  84317. /**
  84318. * Defines the center of rotation (U)
  84319. */
  84320. uRotationCenter: number;
  84321. /**
  84322. * Defines the center of rotation (V)
  84323. */
  84324. vRotationCenter: number;
  84325. /**
  84326. * Defines the center of rotation (W)
  84327. */
  84328. wRotationCenter: number;
  84329. /**
  84330. * Are mip maps generated for this texture or not.
  84331. */
  84332. readonly noMipmap: boolean;
  84333. /**
  84334. * List of inspectable custom properties (used by the Inspector)
  84335. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  84336. */
  84337. inspectableCustomProperties: Nullable<IInspectable[]>;
  84338. private _noMipmap;
  84339. /** @hidden */
  84340. _invertY: boolean;
  84341. private _rowGenerationMatrix;
  84342. private _cachedTextureMatrix;
  84343. private _projectionModeMatrix;
  84344. private _t0;
  84345. private _t1;
  84346. private _t2;
  84347. private _cachedUOffset;
  84348. private _cachedVOffset;
  84349. private _cachedUScale;
  84350. private _cachedVScale;
  84351. private _cachedUAng;
  84352. private _cachedVAng;
  84353. private _cachedWAng;
  84354. private _cachedProjectionMatrixId;
  84355. private _cachedCoordinatesMode;
  84356. /** @hidden */
  84357. protected _initialSamplingMode: number;
  84358. /** @hidden */
  84359. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  84360. private _deleteBuffer;
  84361. protected _format: Nullable<number>;
  84362. private _delayedOnLoad;
  84363. private _delayedOnError;
  84364. private _mimeType?;
  84365. /**
  84366. * Observable triggered once the texture has been loaded.
  84367. */
  84368. onLoadObservable: Observable<Texture>;
  84369. protected _isBlocking: boolean;
  84370. /**
  84371. * Is the texture preventing material to render while loading.
  84372. * If false, a default texture will be used instead of the loading one during the preparation step.
  84373. */
  84374. isBlocking: boolean;
  84375. /**
  84376. * Get the current sampling mode associated with the texture.
  84377. */
  84378. readonly samplingMode: number;
  84379. /**
  84380. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  84381. */
  84382. readonly invertY: boolean;
  84383. /**
  84384. * Instantiates a new texture.
  84385. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  84386. * @see http://doc.babylonjs.com/babylon101/materials#texture
  84387. * @param url defines the url of the picture to load as a texture
  84388. * @param scene defines the scene or engine the texture will belong to
  84389. * @param noMipmap defines if the texture will require mip maps or not
  84390. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  84391. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84392. * @param onLoad defines a callback triggered when the texture has been loaded
  84393. * @param onError defines a callback triggered when an error occurred during the loading session
  84394. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  84395. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  84396. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84397. * @param mimeType defines an optional mime type information
  84398. */
  84399. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  84400. /**
  84401. * Update the url (and optional buffer) of this texture if url was null during construction.
  84402. * @param url the url of the texture
  84403. * @param buffer the buffer of the texture (defaults to null)
  84404. * @param onLoad callback called when the texture is loaded (defaults to null)
  84405. */
  84406. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  84407. /**
  84408. * Finish the loading sequence of a texture flagged as delayed load.
  84409. * @hidden
  84410. */
  84411. delayLoad(): void;
  84412. private _prepareRowForTextureGeneration;
  84413. /**
  84414. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  84415. * @returns the transform matrix of the texture.
  84416. */
  84417. getTextureMatrix(): Matrix;
  84418. /**
  84419. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  84420. * @returns The reflection texture transform
  84421. */
  84422. getReflectionTextureMatrix(): Matrix;
  84423. /**
  84424. * Clones the texture.
  84425. * @returns the cloned texture
  84426. */
  84427. clone(): Texture;
  84428. /**
  84429. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  84430. * @returns The JSON representation of the texture
  84431. */
  84432. serialize(): any;
  84433. /**
  84434. * Get the current class name of the texture useful for serialization or dynamic coding.
  84435. * @returns "Texture"
  84436. */
  84437. getClassName(): string;
  84438. /**
  84439. * Dispose the texture and release its associated resources.
  84440. */
  84441. dispose(): void;
  84442. /**
  84443. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  84444. * @param parsedTexture Define the JSON representation of the texture
  84445. * @param scene Define the scene the parsed texture should be instantiated in
  84446. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  84447. * @returns The parsed texture if successful
  84448. */
  84449. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  84450. /**
  84451. * Creates a texture from its base 64 representation.
  84452. * @param data Define the base64 payload without the data: prefix
  84453. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  84454. * @param scene Define the scene the texture should belong to
  84455. * @param noMipmap Forces the texture to not create mip map information if true
  84456. * @param invertY define if the texture needs to be inverted on the y axis during loading
  84457. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84458. * @param onLoad define a callback triggered when the texture has been loaded
  84459. * @param onError define a callback triggered when an error occurred during the loading session
  84460. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84461. * @returns the created texture
  84462. */
  84463. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  84464. /**
  84465. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  84466. * @param data Define the base64 payload without the data: prefix
  84467. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  84468. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  84469. * @param scene Define the scene the texture should belong to
  84470. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  84471. * @param noMipmap Forces the texture to not create mip map information if true
  84472. * @param invertY define if the texture needs to be inverted on the y axis during loading
  84473. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84474. * @param onLoad define a callback triggered when the texture has been loaded
  84475. * @param onError define a callback triggered when an error occurred during the loading session
  84476. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84477. * @returns the created texture
  84478. */
  84479. 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;
  84480. }
  84481. }
  84482. declare module BABYLON {
  84483. /**
  84484. * PostProcessManager is used to manage one or more post processes or post process pipelines
  84485. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  84486. */
  84487. export class PostProcessManager {
  84488. private _scene;
  84489. private _indexBuffer;
  84490. private _vertexBuffers;
  84491. /**
  84492. * Creates a new instance PostProcess
  84493. * @param scene The scene that the post process is associated with.
  84494. */
  84495. constructor(scene: Scene);
  84496. private _prepareBuffers;
  84497. private _buildIndexBuffer;
  84498. /**
  84499. * Rebuilds the vertex buffers of the manager.
  84500. * @hidden
  84501. */
  84502. _rebuild(): void;
  84503. /**
  84504. * Prepares a frame to be run through a post process.
  84505. * @param sourceTexture The input texture to the post procesess. (default: null)
  84506. * @param postProcesses An array of post processes to be run. (default: null)
  84507. * @returns True if the post processes were able to be run.
  84508. * @hidden
  84509. */
  84510. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  84511. /**
  84512. * Manually render a set of post processes to a texture.
  84513. * @param postProcesses An array of post processes to be run.
  84514. * @param targetTexture The target texture to render to.
  84515. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  84516. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  84517. * @param lodLevel defines which lod of the texture to render to
  84518. */
  84519. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  84520. /**
  84521. * Finalize the result of the output of the postprocesses.
  84522. * @param doNotPresent If true the result will not be displayed to the screen.
  84523. * @param targetTexture The target texture to render to.
  84524. * @param faceIndex The index of the face to bind the target texture to.
  84525. * @param postProcesses The array of post processes to render.
  84526. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  84527. * @hidden
  84528. */
  84529. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  84530. /**
  84531. * Disposes of the post process manager.
  84532. */
  84533. dispose(): void;
  84534. }
  84535. }
  84536. declare module BABYLON {
  84537. /** Interface used by value gradients (color, factor, ...) */
  84538. export interface IValueGradient {
  84539. /**
  84540. * Gets or sets the gradient value (between 0 and 1)
  84541. */
  84542. gradient: number;
  84543. }
  84544. /** Class used to store color4 gradient */
  84545. export class ColorGradient implements IValueGradient {
  84546. /**
  84547. * Gets or sets the gradient value (between 0 and 1)
  84548. */
  84549. gradient: number;
  84550. /**
  84551. * Gets or sets first associated color
  84552. */
  84553. color1: Color4;
  84554. /**
  84555. * Gets or sets second associated color
  84556. */
  84557. color2?: Color4;
  84558. /**
  84559. * Will get a color picked randomly between color1 and color2.
  84560. * If color2 is undefined then color1 will be used
  84561. * @param result defines the target Color4 to store the result in
  84562. */
  84563. getColorToRef(result: Color4): void;
  84564. }
  84565. /** Class used to store color 3 gradient */
  84566. export class Color3Gradient implements IValueGradient {
  84567. /**
  84568. * Gets or sets the gradient value (between 0 and 1)
  84569. */
  84570. gradient: number;
  84571. /**
  84572. * Gets or sets the associated color
  84573. */
  84574. color: Color3;
  84575. }
  84576. /** Class used to store factor gradient */
  84577. export class FactorGradient implements IValueGradient {
  84578. /**
  84579. * Gets or sets the gradient value (between 0 and 1)
  84580. */
  84581. gradient: number;
  84582. /**
  84583. * Gets or sets first associated factor
  84584. */
  84585. factor1: number;
  84586. /**
  84587. * Gets or sets second associated factor
  84588. */
  84589. factor2?: number;
  84590. /**
  84591. * Will get a number picked randomly between factor1 and factor2.
  84592. * If factor2 is undefined then factor1 will be used
  84593. * @returns the picked number
  84594. */
  84595. getFactor(): number;
  84596. }
  84597. /**
  84598. * Helper used to simplify some generic gradient tasks
  84599. */
  84600. export class GradientHelper {
  84601. /**
  84602. * Gets the current gradient from an array of IValueGradient
  84603. * @param ratio defines the current ratio to get
  84604. * @param gradients defines the array of IValueGradient
  84605. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  84606. */
  84607. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  84608. }
  84609. }
  84610. declare module BABYLON {
  84611. interface ThinEngine {
  84612. /**
  84613. * Creates a dynamic texture
  84614. * @param width defines the width of the texture
  84615. * @param height defines the height of the texture
  84616. * @param generateMipMaps defines if the engine should generate the mip levels
  84617. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  84618. * @returns the dynamic texture inside an InternalTexture
  84619. */
  84620. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  84621. /**
  84622. * Update the content of a dynamic texture
  84623. * @param texture defines the texture to update
  84624. * @param canvas defines the canvas containing the source
  84625. * @param invertY defines if data must be stored with Y axis inverted
  84626. * @param premulAlpha defines if alpha is stored as premultiplied
  84627. * @param format defines the format of the data
  84628. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  84629. */
  84630. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  84631. }
  84632. }
  84633. declare module BABYLON {
  84634. /**
  84635. * Helper class used to generate a canvas to manipulate images
  84636. */
  84637. export class CanvasGenerator {
  84638. /**
  84639. * Create a new canvas (or offscreen canvas depending on the context)
  84640. * @param width defines the expected width
  84641. * @param height defines the expected height
  84642. * @return a new canvas or offscreen canvas
  84643. */
  84644. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  84645. }
  84646. }
  84647. declare module BABYLON {
  84648. /**
  84649. * A class extending Texture allowing drawing on a texture
  84650. * @see http://doc.babylonjs.com/how_to/dynamictexture
  84651. */
  84652. export class DynamicTexture extends Texture {
  84653. private _generateMipMaps;
  84654. private _canvas;
  84655. private _context;
  84656. private _engine;
  84657. /**
  84658. * Creates a DynamicTexture
  84659. * @param name defines the name of the texture
  84660. * @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
  84661. * @param scene defines the scene where you want the texture
  84662. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  84663. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  84664. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  84665. */
  84666. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  84667. /**
  84668. * Get the current class name of the texture useful for serialization or dynamic coding.
  84669. * @returns "DynamicTexture"
  84670. */
  84671. getClassName(): string;
  84672. /**
  84673. * Gets the current state of canRescale
  84674. */
  84675. readonly canRescale: boolean;
  84676. private _recreate;
  84677. /**
  84678. * Scales the texture
  84679. * @param ratio the scale factor to apply to both width and height
  84680. */
  84681. scale(ratio: number): void;
  84682. /**
  84683. * Resizes the texture
  84684. * @param width the new width
  84685. * @param height the new height
  84686. */
  84687. scaleTo(width: number, height: number): void;
  84688. /**
  84689. * Gets the context of the canvas used by the texture
  84690. * @returns the canvas context of the dynamic texture
  84691. */
  84692. getContext(): CanvasRenderingContext2D;
  84693. /**
  84694. * Clears the texture
  84695. */
  84696. clear(): void;
  84697. /**
  84698. * Updates the texture
  84699. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  84700. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  84701. */
  84702. update(invertY?: boolean, premulAlpha?: boolean): void;
  84703. /**
  84704. * Draws text onto the texture
  84705. * @param text defines the text to be drawn
  84706. * @param x defines the placement of the text from the left
  84707. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  84708. * @param font defines the font to be used with font-style, font-size, font-name
  84709. * @param color defines the color used for the text
  84710. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  84711. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  84712. * @param update defines whether texture is immediately update (default is true)
  84713. */
  84714. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  84715. /**
  84716. * Clones the texture
  84717. * @returns the clone of the texture.
  84718. */
  84719. clone(): DynamicTexture;
  84720. /**
  84721. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  84722. * @returns a serialized dynamic texture object
  84723. */
  84724. serialize(): any;
  84725. /** @hidden */
  84726. _rebuild(): void;
  84727. }
  84728. }
  84729. declare module BABYLON {
  84730. interface AbstractScene {
  84731. /**
  84732. * The list of procedural textures added to the scene
  84733. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84734. */
  84735. proceduralTextures: Array<ProceduralTexture>;
  84736. }
  84737. /**
  84738. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  84739. * in a given scene.
  84740. */
  84741. export class ProceduralTextureSceneComponent implements ISceneComponent {
  84742. /**
  84743. * The component name helpfull to identify the component in the list of scene components.
  84744. */
  84745. readonly name: string;
  84746. /**
  84747. * The scene the component belongs to.
  84748. */
  84749. scene: Scene;
  84750. /**
  84751. * Creates a new instance of the component for the given scene
  84752. * @param scene Defines the scene to register the component in
  84753. */
  84754. constructor(scene: Scene);
  84755. /**
  84756. * Registers the component in a given scene
  84757. */
  84758. register(): void;
  84759. /**
  84760. * Rebuilds the elements related to this component in case of
  84761. * context lost for instance.
  84762. */
  84763. rebuild(): void;
  84764. /**
  84765. * Disposes the component and the associated ressources.
  84766. */
  84767. dispose(): void;
  84768. private _beforeClear;
  84769. }
  84770. }
  84771. declare module BABYLON {
  84772. interface ThinEngine {
  84773. /**
  84774. * Creates a new render target cube texture
  84775. * @param size defines the size of the texture
  84776. * @param options defines the options used to create the texture
  84777. * @returns a new render target cube texture stored in an InternalTexture
  84778. */
  84779. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  84780. }
  84781. }
  84782. declare module BABYLON {
  84783. /** @hidden */
  84784. export var proceduralVertexShader: {
  84785. name: string;
  84786. shader: string;
  84787. };
  84788. }
  84789. declare module BABYLON {
  84790. /**
  84791. * 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.
  84792. * This is the base class of any Procedural texture and contains most of the shareable code.
  84793. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84794. */
  84795. export class ProceduralTexture extends Texture {
  84796. isCube: boolean;
  84797. /**
  84798. * Define if the texture is enabled or not (disabled texture will not render)
  84799. */
  84800. isEnabled: boolean;
  84801. /**
  84802. * Define if the texture must be cleared before rendering (default is true)
  84803. */
  84804. autoClear: boolean;
  84805. /**
  84806. * Callback called when the texture is generated
  84807. */
  84808. onGenerated: () => void;
  84809. /**
  84810. * Event raised when the texture is generated
  84811. */
  84812. onGeneratedObservable: Observable<ProceduralTexture>;
  84813. /** @hidden */
  84814. _generateMipMaps: boolean;
  84815. /** @hidden **/
  84816. _effect: Effect;
  84817. /** @hidden */
  84818. _textures: {
  84819. [key: string]: Texture;
  84820. };
  84821. private _size;
  84822. private _currentRefreshId;
  84823. private _refreshRate;
  84824. private _vertexBuffers;
  84825. private _indexBuffer;
  84826. private _uniforms;
  84827. private _samplers;
  84828. private _fragment;
  84829. private _floats;
  84830. private _ints;
  84831. private _floatsArrays;
  84832. private _colors3;
  84833. private _colors4;
  84834. private _vectors2;
  84835. private _vectors3;
  84836. private _matrices;
  84837. private _fallbackTexture;
  84838. private _fallbackTextureUsed;
  84839. private _engine;
  84840. private _cachedDefines;
  84841. private _contentUpdateId;
  84842. private _contentData;
  84843. /**
  84844. * Instantiates a new procedural texture.
  84845. * 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.
  84846. * This is the base class of any Procedural texture and contains most of the shareable code.
  84847. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84848. * @param name Define the name of the texture
  84849. * @param size Define the size of the texture to create
  84850. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  84851. * @param scene Define the scene the texture belongs to
  84852. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  84853. * @param generateMipMaps Define if the texture should creates mip maps or not
  84854. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  84855. */
  84856. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  84857. /**
  84858. * The effect that is created when initializing the post process.
  84859. * @returns The created effect corresponding the the postprocess.
  84860. */
  84861. getEffect(): Effect;
  84862. /**
  84863. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  84864. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  84865. */
  84866. getContent(): Nullable<ArrayBufferView>;
  84867. private _createIndexBuffer;
  84868. /** @hidden */
  84869. _rebuild(): void;
  84870. /**
  84871. * Resets the texture in order to recreate its associated resources.
  84872. * This can be called in case of context loss
  84873. */
  84874. reset(): void;
  84875. protected _getDefines(): string;
  84876. /**
  84877. * Is the texture ready to be used ? (rendered at least once)
  84878. * @returns true if ready, otherwise, false.
  84879. */
  84880. isReady(): boolean;
  84881. /**
  84882. * Resets the refresh counter of the texture and start bak from scratch.
  84883. * Could be useful to regenerate the texture if it is setup to render only once.
  84884. */
  84885. resetRefreshCounter(): void;
  84886. /**
  84887. * Set the fragment shader to use in order to render the texture.
  84888. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  84889. */
  84890. setFragment(fragment: any): void;
  84891. /**
  84892. * Define the refresh rate of the texture or the rendering frequency.
  84893. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  84894. */
  84895. refreshRate: number;
  84896. /** @hidden */
  84897. _shouldRender(): boolean;
  84898. /**
  84899. * Get the size the texture is rendering at.
  84900. * @returns the size (texture is always squared)
  84901. */
  84902. getRenderSize(): number;
  84903. /**
  84904. * Resize the texture to new value.
  84905. * @param size Define the new size the texture should have
  84906. * @param generateMipMaps Define whether the new texture should create mip maps
  84907. */
  84908. resize(size: number, generateMipMaps: boolean): void;
  84909. private _checkUniform;
  84910. /**
  84911. * Set a texture in the shader program used to render.
  84912. * @param name Define the name of the uniform samplers as defined in the shader
  84913. * @param texture Define the texture to bind to this sampler
  84914. * @return the texture itself allowing "fluent" like uniform updates
  84915. */
  84916. setTexture(name: string, texture: Texture): ProceduralTexture;
  84917. /**
  84918. * Set a float in the shader.
  84919. * @param name Define the name of the uniform as defined in the shader
  84920. * @param value Define the value to give to the uniform
  84921. * @return the texture itself allowing "fluent" like uniform updates
  84922. */
  84923. setFloat(name: string, value: number): ProceduralTexture;
  84924. /**
  84925. * Set a int in the shader.
  84926. * @param name Define the name of the uniform as defined in the shader
  84927. * @param value Define the value to give to the uniform
  84928. * @return the texture itself allowing "fluent" like uniform updates
  84929. */
  84930. setInt(name: string, value: number): ProceduralTexture;
  84931. /**
  84932. * Set an array of floats in the shader.
  84933. * @param name Define the name of the uniform as defined in the shader
  84934. * @param value Define the value to give to the uniform
  84935. * @return the texture itself allowing "fluent" like uniform updates
  84936. */
  84937. setFloats(name: string, value: number[]): ProceduralTexture;
  84938. /**
  84939. * Set a vec3 in the shader from a Color3.
  84940. * @param name Define the name of the uniform as defined in the shader
  84941. * @param value Define the value to give to the uniform
  84942. * @return the texture itself allowing "fluent" like uniform updates
  84943. */
  84944. setColor3(name: string, value: Color3): ProceduralTexture;
  84945. /**
  84946. * Set a vec4 in the shader from a Color4.
  84947. * @param name Define the name of the uniform as defined in the shader
  84948. * @param value Define the value to give to the uniform
  84949. * @return the texture itself allowing "fluent" like uniform updates
  84950. */
  84951. setColor4(name: string, value: Color4): ProceduralTexture;
  84952. /**
  84953. * Set a vec2 in the shader from a Vector2.
  84954. * @param name Define the name of the uniform as defined in the shader
  84955. * @param value Define the value to give to the uniform
  84956. * @return the texture itself allowing "fluent" like uniform updates
  84957. */
  84958. setVector2(name: string, value: Vector2): ProceduralTexture;
  84959. /**
  84960. * Set a vec3 in the shader from a Vector3.
  84961. * @param name Define the name of the uniform as defined in the shader
  84962. * @param value Define the value to give to the uniform
  84963. * @return the texture itself allowing "fluent" like uniform updates
  84964. */
  84965. setVector3(name: string, value: Vector3): ProceduralTexture;
  84966. /**
  84967. * Set a mat4 in the shader from a MAtrix.
  84968. * @param name Define the name of the uniform as defined in the shader
  84969. * @param value Define the value to give to the uniform
  84970. * @return the texture itself allowing "fluent" like uniform updates
  84971. */
  84972. setMatrix(name: string, value: Matrix): ProceduralTexture;
  84973. /**
  84974. * Render the texture to its associated render target.
  84975. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  84976. */
  84977. render(useCameraPostProcess?: boolean): void;
  84978. /**
  84979. * Clone the texture.
  84980. * @returns the cloned texture
  84981. */
  84982. clone(): ProceduralTexture;
  84983. /**
  84984. * Dispose the texture and release its asoociated resources.
  84985. */
  84986. dispose(): void;
  84987. }
  84988. }
  84989. declare module BABYLON {
  84990. /**
  84991. * This represents the base class for particle system in Babylon.
  84992. * 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.
  84993. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84994. * @example https://doc.babylonjs.com/babylon101/particles
  84995. */
  84996. export class BaseParticleSystem {
  84997. /**
  84998. * Source color is added to the destination color without alpha affecting the result
  84999. */
  85000. static BLENDMODE_ONEONE: number;
  85001. /**
  85002. * Blend current color and particle color using particle’s alpha
  85003. */
  85004. static BLENDMODE_STANDARD: number;
  85005. /**
  85006. * Add current color and particle color multiplied by particle’s alpha
  85007. */
  85008. static BLENDMODE_ADD: number;
  85009. /**
  85010. * Multiply current color with particle color
  85011. */
  85012. static BLENDMODE_MULTIPLY: number;
  85013. /**
  85014. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  85015. */
  85016. static BLENDMODE_MULTIPLYADD: number;
  85017. /**
  85018. * List of animations used by the particle system.
  85019. */
  85020. animations: Animation[];
  85021. /**
  85022. * The id of the Particle system.
  85023. */
  85024. id: string;
  85025. /**
  85026. * The friendly name of the Particle system.
  85027. */
  85028. name: string;
  85029. /**
  85030. * The rendering group used by the Particle system to chose when to render.
  85031. */
  85032. renderingGroupId: number;
  85033. /**
  85034. * The emitter represents the Mesh or position we are attaching the particle system to.
  85035. */
  85036. emitter: Nullable<AbstractMesh | Vector3>;
  85037. /**
  85038. * The maximum number of particles to emit per frame
  85039. */
  85040. emitRate: number;
  85041. /**
  85042. * If you want to launch only a few particles at once, that can be done, as well.
  85043. */
  85044. manualEmitCount: number;
  85045. /**
  85046. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  85047. */
  85048. updateSpeed: number;
  85049. /**
  85050. * The amount of time the particle system is running (depends of the overall update speed).
  85051. */
  85052. targetStopDuration: number;
  85053. /**
  85054. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  85055. */
  85056. disposeOnStop: boolean;
  85057. /**
  85058. * Minimum power of emitting particles.
  85059. */
  85060. minEmitPower: number;
  85061. /**
  85062. * Maximum power of emitting particles.
  85063. */
  85064. maxEmitPower: number;
  85065. /**
  85066. * Minimum life time of emitting particles.
  85067. */
  85068. minLifeTime: number;
  85069. /**
  85070. * Maximum life time of emitting particles.
  85071. */
  85072. maxLifeTime: number;
  85073. /**
  85074. * Minimum Size of emitting particles.
  85075. */
  85076. minSize: number;
  85077. /**
  85078. * Maximum Size of emitting particles.
  85079. */
  85080. maxSize: number;
  85081. /**
  85082. * Minimum scale of emitting particles on X axis.
  85083. */
  85084. minScaleX: number;
  85085. /**
  85086. * Maximum scale of emitting particles on X axis.
  85087. */
  85088. maxScaleX: number;
  85089. /**
  85090. * Minimum scale of emitting particles on Y axis.
  85091. */
  85092. minScaleY: number;
  85093. /**
  85094. * Maximum scale of emitting particles on Y axis.
  85095. */
  85096. maxScaleY: number;
  85097. /**
  85098. * Gets or sets the minimal initial rotation in radians.
  85099. */
  85100. minInitialRotation: number;
  85101. /**
  85102. * Gets or sets the maximal initial rotation in radians.
  85103. */
  85104. maxInitialRotation: number;
  85105. /**
  85106. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  85107. */
  85108. minAngularSpeed: number;
  85109. /**
  85110. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  85111. */
  85112. maxAngularSpeed: number;
  85113. /**
  85114. * The texture used to render each particle. (this can be a spritesheet)
  85115. */
  85116. particleTexture: Nullable<Texture>;
  85117. /**
  85118. * The layer mask we are rendering the particles through.
  85119. */
  85120. layerMask: number;
  85121. /**
  85122. * This can help using your own shader to render the particle system.
  85123. * The according effect will be created
  85124. */
  85125. customShader: any;
  85126. /**
  85127. * By default particle system starts as soon as they are created. This prevents the
  85128. * automatic start to happen and let you decide when to start emitting particles.
  85129. */
  85130. preventAutoStart: boolean;
  85131. private _noiseTexture;
  85132. /**
  85133. * Gets or sets a texture used to add random noise to particle positions
  85134. */
  85135. noiseTexture: Nullable<ProceduralTexture>;
  85136. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  85137. noiseStrength: Vector3;
  85138. /**
  85139. * Callback triggered when the particle animation is ending.
  85140. */
  85141. onAnimationEnd: Nullable<() => void>;
  85142. /**
  85143. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  85144. */
  85145. blendMode: number;
  85146. /**
  85147. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  85148. * to override the particles.
  85149. */
  85150. forceDepthWrite: boolean;
  85151. /** 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 */
  85152. preWarmCycles: number;
  85153. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  85154. preWarmStepOffset: number;
  85155. /**
  85156. * 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)
  85157. */
  85158. spriteCellChangeSpeed: number;
  85159. /**
  85160. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  85161. */
  85162. startSpriteCellID: number;
  85163. /**
  85164. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  85165. */
  85166. endSpriteCellID: number;
  85167. /**
  85168. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  85169. */
  85170. spriteCellWidth: number;
  85171. /**
  85172. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  85173. */
  85174. spriteCellHeight: number;
  85175. /**
  85176. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  85177. */
  85178. spriteRandomStartCell: boolean;
  85179. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  85180. translationPivot: Vector2;
  85181. /** @hidden */
  85182. protected _isAnimationSheetEnabled: boolean;
  85183. /**
  85184. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  85185. */
  85186. beginAnimationOnStart: boolean;
  85187. /**
  85188. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  85189. */
  85190. beginAnimationFrom: number;
  85191. /**
  85192. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  85193. */
  85194. beginAnimationTo: number;
  85195. /**
  85196. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  85197. */
  85198. beginAnimationLoop: boolean;
  85199. /**
  85200. * Gets or sets a world offset applied to all particles
  85201. */
  85202. worldOffset: Vector3;
  85203. /**
  85204. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  85205. */
  85206. isAnimationSheetEnabled: boolean;
  85207. /**
  85208. * Get hosting scene
  85209. * @returns the scene
  85210. */
  85211. getScene(): Scene;
  85212. /**
  85213. * You can use gravity if you want to give an orientation to your particles.
  85214. */
  85215. gravity: Vector3;
  85216. protected _colorGradients: Nullable<Array<ColorGradient>>;
  85217. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  85218. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  85219. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  85220. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  85221. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  85222. protected _dragGradients: Nullable<Array<FactorGradient>>;
  85223. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  85224. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  85225. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  85226. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  85227. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  85228. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  85229. /**
  85230. * Defines the delay in milliseconds before starting the system (0 by default)
  85231. */
  85232. startDelay: number;
  85233. /**
  85234. * Gets the current list of drag gradients.
  85235. * You must use addDragGradient and removeDragGradient to udpate this list
  85236. * @returns the list of drag gradients
  85237. */
  85238. getDragGradients(): Nullable<Array<FactorGradient>>;
  85239. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  85240. limitVelocityDamping: number;
  85241. /**
  85242. * Gets the current list of limit velocity gradients.
  85243. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  85244. * @returns the list of limit velocity gradients
  85245. */
  85246. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  85247. /**
  85248. * Gets the current list of color gradients.
  85249. * You must use addColorGradient and removeColorGradient to udpate this list
  85250. * @returns the list of color gradients
  85251. */
  85252. getColorGradients(): Nullable<Array<ColorGradient>>;
  85253. /**
  85254. * Gets the current list of size gradients.
  85255. * You must use addSizeGradient and removeSizeGradient to udpate this list
  85256. * @returns the list of size gradients
  85257. */
  85258. getSizeGradients(): Nullable<Array<FactorGradient>>;
  85259. /**
  85260. * Gets the current list of color remap gradients.
  85261. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  85262. * @returns the list of color remap gradients
  85263. */
  85264. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  85265. /**
  85266. * Gets the current list of alpha remap gradients.
  85267. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  85268. * @returns the list of alpha remap gradients
  85269. */
  85270. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  85271. /**
  85272. * Gets the current list of life time gradients.
  85273. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  85274. * @returns the list of life time gradients
  85275. */
  85276. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  85277. /**
  85278. * Gets the current list of angular speed gradients.
  85279. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  85280. * @returns the list of angular speed gradients
  85281. */
  85282. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  85283. /**
  85284. * Gets the current list of velocity gradients.
  85285. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  85286. * @returns the list of velocity gradients
  85287. */
  85288. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  85289. /**
  85290. * Gets the current list of start size gradients.
  85291. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  85292. * @returns the list of start size gradients
  85293. */
  85294. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  85295. /**
  85296. * Gets the current list of emit rate gradients.
  85297. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  85298. * @returns the list of emit rate gradients
  85299. */
  85300. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  85301. /**
  85302. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85303. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85304. */
  85305. direction1: Vector3;
  85306. /**
  85307. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85308. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85309. */
  85310. direction2: Vector3;
  85311. /**
  85312. * 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.
  85313. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85314. */
  85315. minEmitBox: Vector3;
  85316. /**
  85317. * 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.
  85318. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85319. */
  85320. maxEmitBox: Vector3;
  85321. /**
  85322. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  85323. */
  85324. color1: Color4;
  85325. /**
  85326. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  85327. */
  85328. color2: Color4;
  85329. /**
  85330. * Color the particle will have at the end of its lifetime
  85331. */
  85332. colorDead: Color4;
  85333. /**
  85334. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  85335. */
  85336. textureMask: Color4;
  85337. /**
  85338. * The particle emitter type defines the emitter used by the particle system.
  85339. * It can be for example box, sphere, or cone...
  85340. */
  85341. particleEmitterType: IParticleEmitterType;
  85342. /** @hidden */
  85343. _isSubEmitter: boolean;
  85344. /**
  85345. * Gets or sets the billboard mode to use when isBillboardBased = true.
  85346. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  85347. */
  85348. billboardMode: number;
  85349. protected _isBillboardBased: boolean;
  85350. /**
  85351. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  85352. */
  85353. isBillboardBased: boolean;
  85354. /**
  85355. * The scene the particle system belongs to.
  85356. */
  85357. protected _scene: Scene;
  85358. /**
  85359. * Local cache of defines for image processing.
  85360. */
  85361. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  85362. /**
  85363. * Default configuration related to image processing available in the standard Material.
  85364. */
  85365. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  85366. /**
  85367. * Gets the image processing configuration used either in this material.
  85368. */
  85369. /**
  85370. * Sets the Default image processing configuration used either in the this material.
  85371. *
  85372. * If sets to null, the scene one is in use.
  85373. */
  85374. imageProcessingConfiguration: ImageProcessingConfiguration;
  85375. /**
  85376. * Attaches a new image processing configuration to the Standard Material.
  85377. * @param configuration
  85378. */
  85379. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  85380. /** @hidden */
  85381. protected _reset(): void;
  85382. /** @hidden */
  85383. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  85384. /**
  85385. * Instantiates a particle system.
  85386. * 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.
  85387. * @param name The name of the particle system
  85388. */
  85389. constructor(name: string);
  85390. /**
  85391. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  85392. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  85393. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  85394. * @returns the emitter
  85395. */
  85396. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  85397. /**
  85398. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  85399. * @param radius The radius of the hemisphere to emit from
  85400. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  85401. * @returns the emitter
  85402. */
  85403. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  85404. /**
  85405. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  85406. * @param radius The radius of the sphere to emit from
  85407. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  85408. * @returns the emitter
  85409. */
  85410. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  85411. /**
  85412. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  85413. * @param radius The radius of the sphere to emit from
  85414. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  85415. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  85416. * @returns the emitter
  85417. */
  85418. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  85419. /**
  85420. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  85421. * @param radius The radius of the emission cylinder
  85422. * @param height The height of the emission cylinder
  85423. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  85424. * @param directionRandomizer How much to randomize the particle direction [0-1]
  85425. * @returns the emitter
  85426. */
  85427. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  85428. /**
  85429. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  85430. * @param radius The radius of the cylinder to emit from
  85431. * @param height The height of the emission cylinder
  85432. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85433. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  85434. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  85435. * @returns the emitter
  85436. */
  85437. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  85438. /**
  85439. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  85440. * @param radius The radius of the cone to emit from
  85441. * @param angle The base angle of the cone
  85442. * @returns the emitter
  85443. */
  85444. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  85445. /**
  85446. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  85447. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  85448. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  85449. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  85450. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  85451. * @returns the emitter
  85452. */
  85453. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  85454. }
  85455. }
  85456. declare module BABYLON {
  85457. /**
  85458. * Type of sub emitter
  85459. */
  85460. export enum SubEmitterType {
  85461. /**
  85462. * Attached to the particle over it's lifetime
  85463. */
  85464. ATTACHED = 0,
  85465. /**
  85466. * Created when the particle dies
  85467. */
  85468. END = 1
  85469. }
  85470. /**
  85471. * Sub emitter class used to emit particles from an existing particle
  85472. */
  85473. export class SubEmitter {
  85474. /**
  85475. * the particle system to be used by the sub emitter
  85476. */
  85477. particleSystem: ParticleSystem;
  85478. /**
  85479. * Type of the submitter (Default: END)
  85480. */
  85481. type: SubEmitterType;
  85482. /**
  85483. * 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)
  85484. * Note: This only is supported when using an emitter of type Mesh
  85485. */
  85486. inheritDirection: boolean;
  85487. /**
  85488. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  85489. */
  85490. inheritedVelocityAmount: number;
  85491. /**
  85492. * Creates a sub emitter
  85493. * @param particleSystem the particle system to be used by the sub emitter
  85494. */
  85495. constructor(
  85496. /**
  85497. * the particle system to be used by the sub emitter
  85498. */
  85499. particleSystem: ParticleSystem);
  85500. /**
  85501. * Clones the sub emitter
  85502. * @returns the cloned sub emitter
  85503. */
  85504. clone(): SubEmitter;
  85505. /**
  85506. * Serialize current object to a JSON object
  85507. * @returns the serialized object
  85508. */
  85509. serialize(): any;
  85510. /** @hidden */
  85511. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  85512. /**
  85513. * Creates a new SubEmitter from a serialized JSON version
  85514. * @param serializationObject defines the JSON object to read from
  85515. * @param scene defines the hosting scene
  85516. * @param rootUrl defines the rootUrl for data loading
  85517. * @returns a new SubEmitter
  85518. */
  85519. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  85520. /** Release associated resources */
  85521. dispose(): void;
  85522. }
  85523. }
  85524. declare module BABYLON {
  85525. /** @hidden */
  85526. export var clipPlaneFragmentDeclaration: {
  85527. name: string;
  85528. shader: string;
  85529. };
  85530. }
  85531. declare module BABYLON {
  85532. /** @hidden */
  85533. export var imageProcessingDeclaration: {
  85534. name: string;
  85535. shader: string;
  85536. };
  85537. }
  85538. declare module BABYLON {
  85539. /** @hidden */
  85540. export var imageProcessingFunctions: {
  85541. name: string;
  85542. shader: string;
  85543. };
  85544. }
  85545. declare module BABYLON {
  85546. /** @hidden */
  85547. export var clipPlaneFragment: {
  85548. name: string;
  85549. shader: string;
  85550. };
  85551. }
  85552. declare module BABYLON {
  85553. /** @hidden */
  85554. export var particlesPixelShader: {
  85555. name: string;
  85556. shader: string;
  85557. };
  85558. }
  85559. declare module BABYLON {
  85560. /** @hidden */
  85561. export var clipPlaneVertexDeclaration: {
  85562. name: string;
  85563. shader: string;
  85564. };
  85565. }
  85566. declare module BABYLON {
  85567. /** @hidden */
  85568. export var clipPlaneVertex: {
  85569. name: string;
  85570. shader: string;
  85571. };
  85572. }
  85573. declare module BABYLON {
  85574. /** @hidden */
  85575. export var particlesVertexShader: {
  85576. name: string;
  85577. shader: string;
  85578. };
  85579. }
  85580. declare module BABYLON {
  85581. /**
  85582. * This represents a particle system in Babylon.
  85583. * 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.
  85584. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  85585. * @example https://doc.babylonjs.com/babylon101/particles
  85586. */
  85587. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  85588. /**
  85589. * Billboard mode will only apply to Y axis
  85590. */
  85591. static readonly BILLBOARDMODE_Y: number;
  85592. /**
  85593. * Billboard mode will apply to all axes
  85594. */
  85595. static readonly BILLBOARDMODE_ALL: number;
  85596. /**
  85597. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  85598. */
  85599. static readonly BILLBOARDMODE_STRETCHED: number;
  85600. /**
  85601. * This function can be defined to provide custom update for active particles.
  85602. * This function will be called instead of regular update (age, position, color, etc.).
  85603. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  85604. */
  85605. updateFunction: (particles: Particle[]) => void;
  85606. private _emitterWorldMatrix;
  85607. /**
  85608. * This function can be defined to specify initial direction for every new particle.
  85609. * It by default use the emitterType defined function
  85610. */
  85611. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  85612. /**
  85613. * This function can be defined to specify initial position for every new particle.
  85614. * It by default use the emitterType defined function
  85615. */
  85616. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  85617. /**
  85618. * @hidden
  85619. */
  85620. _inheritedVelocityOffset: Vector3;
  85621. /**
  85622. * An event triggered when the system is disposed
  85623. */
  85624. onDisposeObservable: Observable<ParticleSystem>;
  85625. private _onDisposeObserver;
  85626. /**
  85627. * Sets a callback that will be triggered when the system is disposed
  85628. */
  85629. onDispose: () => void;
  85630. private _particles;
  85631. private _epsilon;
  85632. private _capacity;
  85633. private _stockParticles;
  85634. private _newPartsExcess;
  85635. private _vertexData;
  85636. private _vertexBuffer;
  85637. private _vertexBuffers;
  85638. private _spriteBuffer;
  85639. private _indexBuffer;
  85640. private _effect;
  85641. private _customEffect;
  85642. private _cachedDefines;
  85643. private _scaledColorStep;
  85644. private _colorDiff;
  85645. private _scaledDirection;
  85646. private _scaledGravity;
  85647. private _currentRenderId;
  85648. private _alive;
  85649. private _useInstancing;
  85650. private _started;
  85651. private _stopped;
  85652. private _actualFrame;
  85653. private _scaledUpdateSpeed;
  85654. private _vertexBufferSize;
  85655. /** @hidden */
  85656. _currentEmitRateGradient: Nullable<FactorGradient>;
  85657. /** @hidden */
  85658. _currentEmitRate1: number;
  85659. /** @hidden */
  85660. _currentEmitRate2: number;
  85661. /** @hidden */
  85662. _currentStartSizeGradient: Nullable<FactorGradient>;
  85663. /** @hidden */
  85664. _currentStartSize1: number;
  85665. /** @hidden */
  85666. _currentStartSize2: number;
  85667. private readonly _rawTextureWidth;
  85668. private _rampGradientsTexture;
  85669. private _useRampGradients;
  85670. /** Gets or sets a boolean indicating that ramp gradients must be used
  85671. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  85672. */
  85673. useRampGradients: boolean;
  85674. /**
  85675. * 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.
  85676. * 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: [])
  85677. */
  85678. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  85679. private _subEmitters;
  85680. /**
  85681. * @hidden
  85682. * If the particle systems emitter should be disposed when the particle system is disposed
  85683. */
  85684. _disposeEmitterOnDispose: boolean;
  85685. /**
  85686. * The current active Sub-systems, this property is used by the root particle system only.
  85687. */
  85688. activeSubSystems: Array<ParticleSystem>;
  85689. private _rootParticleSystem;
  85690. /**
  85691. * Gets the current list of active particles
  85692. */
  85693. readonly particles: Particle[];
  85694. /**
  85695. * Returns the string "ParticleSystem"
  85696. * @returns a string containing the class name
  85697. */
  85698. getClassName(): string;
  85699. /**
  85700. * Instantiates a particle system.
  85701. * 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.
  85702. * @param name The name of the particle system
  85703. * @param capacity The max number of particles alive at the same time
  85704. * @param scene The scene the particle system belongs to
  85705. * @param customEffect a custom effect used to change the way particles are rendered by default
  85706. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  85707. * @param epsilon Offset used to render the particles
  85708. */
  85709. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  85710. private _addFactorGradient;
  85711. private _removeFactorGradient;
  85712. /**
  85713. * Adds a new life time gradient
  85714. * @param gradient defines the gradient to use (between 0 and 1)
  85715. * @param factor defines the life time factor to affect to the specified gradient
  85716. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85717. * @returns the current particle system
  85718. */
  85719. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85720. /**
  85721. * Remove a specific life time gradient
  85722. * @param gradient defines the gradient to remove
  85723. * @returns the current particle system
  85724. */
  85725. removeLifeTimeGradient(gradient: number): IParticleSystem;
  85726. /**
  85727. * Adds a new size gradient
  85728. * @param gradient defines the gradient to use (between 0 and 1)
  85729. * @param factor defines the size factor to affect to the specified gradient
  85730. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85731. * @returns the current particle system
  85732. */
  85733. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85734. /**
  85735. * Remove a specific size gradient
  85736. * @param gradient defines the gradient to remove
  85737. * @returns the current particle system
  85738. */
  85739. removeSizeGradient(gradient: number): IParticleSystem;
  85740. /**
  85741. * Adds a new color remap gradient
  85742. * @param gradient defines the gradient to use (between 0 and 1)
  85743. * @param min defines the color remap minimal range
  85744. * @param max defines the color remap maximal range
  85745. * @returns the current particle system
  85746. */
  85747. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  85748. /**
  85749. * Remove a specific color remap gradient
  85750. * @param gradient defines the gradient to remove
  85751. * @returns the current particle system
  85752. */
  85753. removeColorRemapGradient(gradient: number): IParticleSystem;
  85754. /**
  85755. * Adds a new alpha remap gradient
  85756. * @param gradient defines the gradient to use (between 0 and 1)
  85757. * @param min defines the alpha remap minimal range
  85758. * @param max defines the alpha remap maximal range
  85759. * @returns the current particle system
  85760. */
  85761. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  85762. /**
  85763. * Remove a specific alpha remap gradient
  85764. * @param gradient defines the gradient to remove
  85765. * @returns the current particle system
  85766. */
  85767. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  85768. /**
  85769. * Adds a new angular speed gradient
  85770. * @param gradient defines the gradient to use (between 0 and 1)
  85771. * @param factor defines the angular speed to affect to the specified gradient
  85772. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85773. * @returns the current particle system
  85774. */
  85775. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85776. /**
  85777. * Remove a specific angular speed gradient
  85778. * @param gradient defines the gradient to remove
  85779. * @returns the current particle system
  85780. */
  85781. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  85782. /**
  85783. * Adds a new velocity gradient
  85784. * @param gradient defines the gradient to use (between 0 and 1)
  85785. * @param factor defines the velocity to affect to the specified gradient
  85786. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85787. * @returns the current particle system
  85788. */
  85789. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85790. /**
  85791. * Remove a specific velocity gradient
  85792. * @param gradient defines the gradient to remove
  85793. * @returns the current particle system
  85794. */
  85795. removeVelocityGradient(gradient: number): IParticleSystem;
  85796. /**
  85797. * Adds a new limit velocity gradient
  85798. * @param gradient defines the gradient to use (between 0 and 1)
  85799. * @param factor defines the limit velocity value to affect to the specified gradient
  85800. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85801. * @returns the current particle system
  85802. */
  85803. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85804. /**
  85805. * Remove a specific limit velocity gradient
  85806. * @param gradient defines the gradient to remove
  85807. * @returns the current particle system
  85808. */
  85809. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  85810. /**
  85811. * Adds a new drag gradient
  85812. * @param gradient defines the gradient to use (between 0 and 1)
  85813. * @param factor defines the drag value to affect to the specified gradient
  85814. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85815. * @returns the current particle system
  85816. */
  85817. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85818. /**
  85819. * Remove a specific drag gradient
  85820. * @param gradient defines the gradient to remove
  85821. * @returns the current particle system
  85822. */
  85823. removeDragGradient(gradient: number): IParticleSystem;
  85824. /**
  85825. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  85826. * @param gradient defines the gradient to use (between 0 and 1)
  85827. * @param factor defines the emit rate value to affect to the specified gradient
  85828. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85829. * @returns the current particle system
  85830. */
  85831. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85832. /**
  85833. * Remove a specific emit rate gradient
  85834. * @param gradient defines the gradient to remove
  85835. * @returns the current particle system
  85836. */
  85837. removeEmitRateGradient(gradient: number): IParticleSystem;
  85838. /**
  85839. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  85840. * @param gradient defines the gradient to use (between 0 and 1)
  85841. * @param factor defines the start size value to affect to the specified gradient
  85842. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85843. * @returns the current particle system
  85844. */
  85845. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85846. /**
  85847. * Remove a specific start size gradient
  85848. * @param gradient defines the gradient to remove
  85849. * @returns the current particle system
  85850. */
  85851. removeStartSizeGradient(gradient: number): IParticleSystem;
  85852. private _createRampGradientTexture;
  85853. /**
  85854. * Gets the current list of ramp gradients.
  85855. * You must use addRampGradient and removeRampGradient to udpate this list
  85856. * @returns the list of ramp gradients
  85857. */
  85858. getRampGradients(): Nullable<Array<Color3Gradient>>;
  85859. /**
  85860. * Adds a new ramp gradient used to remap particle colors
  85861. * @param gradient defines the gradient to use (between 0 and 1)
  85862. * @param color defines the color to affect to the specified gradient
  85863. * @returns the current particle system
  85864. */
  85865. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  85866. /**
  85867. * Remove a specific ramp gradient
  85868. * @param gradient defines the gradient to remove
  85869. * @returns the current particle system
  85870. */
  85871. removeRampGradient(gradient: number): ParticleSystem;
  85872. /**
  85873. * Adds a new color gradient
  85874. * @param gradient defines the gradient to use (between 0 and 1)
  85875. * @param color1 defines the color to affect to the specified gradient
  85876. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  85877. * @returns this particle system
  85878. */
  85879. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  85880. /**
  85881. * Remove a specific color gradient
  85882. * @param gradient defines the gradient to remove
  85883. * @returns this particle system
  85884. */
  85885. removeColorGradient(gradient: number): IParticleSystem;
  85886. private _fetchR;
  85887. protected _reset(): void;
  85888. private _resetEffect;
  85889. private _createVertexBuffers;
  85890. private _createIndexBuffer;
  85891. /**
  85892. * Gets the maximum number of particles active at the same time.
  85893. * @returns The max number of active particles.
  85894. */
  85895. getCapacity(): number;
  85896. /**
  85897. * Gets whether there are still active particles in the system.
  85898. * @returns True if it is alive, otherwise false.
  85899. */
  85900. isAlive(): boolean;
  85901. /**
  85902. * Gets if the system has been started. (Note: this will still be true after stop is called)
  85903. * @returns True if it has been started, otherwise false.
  85904. */
  85905. isStarted(): boolean;
  85906. private _prepareSubEmitterInternalArray;
  85907. /**
  85908. * Starts the particle system and begins to emit
  85909. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  85910. */
  85911. start(delay?: number): void;
  85912. /**
  85913. * Stops the particle system.
  85914. * @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.
  85915. */
  85916. stop(stopSubEmitters?: boolean): void;
  85917. /**
  85918. * Remove all active particles
  85919. */
  85920. reset(): void;
  85921. /**
  85922. * @hidden (for internal use only)
  85923. */
  85924. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  85925. /**
  85926. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  85927. * Its lifetime will start back at 0.
  85928. */
  85929. recycleParticle: (particle: Particle) => void;
  85930. private _stopSubEmitters;
  85931. private _createParticle;
  85932. private _removeFromRoot;
  85933. private _emitFromParticle;
  85934. private _update;
  85935. /** @hidden */
  85936. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  85937. /** @hidden */
  85938. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  85939. /** @hidden */
  85940. private _getEffect;
  85941. /**
  85942. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  85943. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  85944. */
  85945. animate(preWarmOnly?: boolean): void;
  85946. private _appendParticleVertices;
  85947. /**
  85948. * Rebuilds the particle system.
  85949. */
  85950. rebuild(): void;
  85951. /**
  85952. * Is this system ready to be used/rendered
  85953. * @return true if the system is ready
  85954. */
  85955. isReady(): boolean;
  85956. private _render;
  85957. /**
  85958. * Renders the particle system in its current state.
  85959. * @returns the current number of particles
  85960. */
  85961. render(): number;
  85962. /**
  85963. * Disposes the particle system and free the associated resources
  85964. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  85965. */
  85966. dispose(disposeTexture?: boolean): void;
  85967. /**
  85968. * Clones the particle system.
  85969. * @param name The name of the cloned object
  85970. * @param newEmitter The new emitter to use
  85971. * @returns the cloned particle system
  85972. */
  85973. clone(name: string, newEmitter: any): ParticleSystem;
  85974. /**
  85975. * Serializes the particle system to a JSON object.
  85976. * @returns the JSON object
  85977. */
  85978. serialize(): any;
  85979. /** @hidden */
  85980. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  85981. /** @hidden */
  85982. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  85983. /**
  85984. * Parses a JSON object to create a particle system.
  85985. * @param parsedParticleSystem The JSON object to parse
  85986. * @param scene The scene to create the particle system in
  85987. * @param rootUrl The root url to use to load external dependencies like texture
  85988. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  85989. * @returns the Parsed particle system
  85990. */
  85991. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  85992. }
  85993. }
  85994. declare module BABYLON {
  85995. /**
  85996. * A particle represents one of the element emitted by a particle system.
  85997. * This is mainly define by its coordinates, direction, velocity and age.
  85998. */
  85999. export class Particle {
  86000. /**
  86001. * The particle system the particle belongs to.
  86002. */
  86003. particleSystem: ParticleSystem;
  86004. private static _Count;
  86005. /**
  86006. * Unique ID of the particle
  86007. */
  86008. id: number;
  86009. /**
  86010. * The world position of the particle in the scene.
  86011. */
  86012. position: Vector3;
  86013. /**
  86014. * The world direction of the particle in the scene.
  86015. */
  86016. direction: Vector3;
  86017. /**
  86018. * The color of the particle.
  86019. */
  86020. color: Color4;
  86021. /**
  86022. * The color change of the particle per step.
  86023. */
  86024. colorStep: Color4;
  86025. /**
  86026. * Defines how long will the life of the particle be.
  86027. */
  86028. lifeTime: number;
  86029. /**
  86030. * The current age of the particle.
  86031. */
  86032. age: number;
  86033. /**
  86034. * The current size of the particle.
  86035. */
  86036. size: number;
  86037. /**
  86038. * The current scale of the particle.
  86039. */
  86040. scale: Vector2;
  86041. /**
  86042. * The current angle of the particle.
  86043. */
  86044. angle: number;
  86045. /**
  86046. * Defines how fast is the angle changing.
  86047. */
  86048. angularSpeed: number;
  86049. /**
  86050. * Defines the cell index used by the particle to be rendered from a sprite.
  86051. */
  86052. cellIndex: number;
  86053. /**
  86054. * The information required to support color remapping
  86055. */
  86056. remapData: Vector4;
  86057. /** @hidden */
  86058. _randomCellOffset?: number;
  86059. /** @hidden */
  86060. _initialDirection: Nullable<Vector3>;
  86061. /** @hidden */
  86062. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  86063. /** @hidden */
  86064. _initialStartSpriteCellID: number;
  86065. /** @hidden */
  86066. _initialEndSpriteCellID: number;
  86067. /** @hidden */
  86068. _currentColorGradient: Nullable<ColorGradient>;
  86069. /** @hidden */
  86070. _currentColor1: Color4;
  86071. /** @hidden */
  86072. _currentColor2: Color4;
  86073. /** @hidden */
  86074. _currentSizeGradient: Nullable<FactorGradient>;
  86075. /** @hidden */
  86076. _currentSize1: number;
  86077. /** @hidden */
  86078. _currentSize2: number;
  86079. /** @hidden */
  86080. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  86081. /** @hidden */
  86082. _currentAngularSpeed1: number;
  86083. /** @hidden */
  86084. _currentAngularSpeed2: number;
  86085. /** @hidden */
  86086. _currentVelocityGradient: Nullable<FactorGradient>;
  86087. /** @hidden */
  86088. _currentVelocity1: number;
  86089. /** @hidden */
  86090. _currentVelocity2: number;
  86091. /** @hidden */
  86092. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  86093. /** @hidden */
  86094. _currentLimitVelocity1: number;
  86095. /** @hidden */
  86096. _currentLimitVelocity2: number;
  86097. /** @hidden */
  86098. _currentDragGradient: Nullable<FactorGradient>;
  86099. /** @hidden */
  86100. _currentDrag1: number;
  86101. /** @hidden */
  86102. _currentDrag2: number;
  86103. /** @hidden */
  86104. _randomNoiseCoordinates1: Vector3;
  86105. /** @hidden */
  86106. _randomNoiseCoordinates2: Vector3;
  86107. /**
  86108. * Creates a new instance Particle
  86109. * @param particleSystem the particle system the particle belongs to
  86110. */
  86111. constructor(
  86112. /**
  86113. * The particle system the particle belongs to.
  86114. */
  86115. particleSystem: ParticleSystem);
  86116. private updateCellInfoFromSystem;
  86117. /**
  86118. * Defines how the sprite cell index is updated for the particle
  86119. */
  86120. updateCellIndex(): void;
  86121. /** @hidden */
  86122. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  86123. /** @hidden */
  86124. _inheritParticleInfoToSubEmitters(): void;
  86125. /** @hidden */
  86126. _reset(): void;
  86127. /**
  86128. * Copy the properties of particle to another one.
  86129. * @param other the particle to copy the information to.
  86130. */
  86131. copyTo(other: Particle): void;
  86132. }
  86133. }
  86134. declare module BABYLON {
  86135. /**
  86136. * Particle emitter represents a volume emitting particles.
  86137. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  86138. */
  86139. export interface IParticleEmitterType {
  86140. /**
  86141. * Called by the particle System when the direction is computed for the created particle.
  86142. * @param worldMatrix is the world matrix of the particle system
  86143. * @param directionToUpdate is the direction vector to update with the result
  86144. * @param particle is the particle we are computed the direction for
  86145. */
  86146. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86147. /**
  86148. * Called by the particle System when the position is computed for the created particle.
  86149. * @param worldMatrix is the world matrix of the particle system
  86150. * @param positionToUpdate is the position vector to update with the result
  86151. * @param particle is the particle we are computed the position for
  86152. */
  86153. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86154. /**
  86155. * Clones the current emitter and returns a copy of it
  86156. * @returns the new emitter
  86157. */
  86158. clone(): IParticleEmitterType;
  86159. /**
  86160. * Called by the GPUParticleSystem to setup the update shader
  86161. * @param effect defines the update shader
  86162. */
  86163. applyToShader(effect: Effect): void;
  86164. /**
  86165. * Returns a string to use to update the GPU particles update shader
  86166. * @returns the effect defines string
  86167. */
  86168. getEffectDefines(): string;
  86169. /**
  86170. * Returns a string representing the class name
  86171. * @returns a string containing the class name
  86172. */
  86173. getClassName(): string;
  86174. /**
  86175. * Serializes the particle system to a JSON object.
  86176. * @returns the JSON object
  86177. */
  86178. serialize(): any;
  86179. /**
  86180. * Parse properties from a JSON object
  86181. * @param serializationObject defines the JSON object
  86182. */
  86183. parse(serializationObject: any): void;
  86184. }
  86185. }
  86186. declare module BABYLON {
  86187. /**
  86188. * Particle emitter emitting particles from the inside of a box.
  86189. * It emits the particles randomly between 2 given directions.
  86190. */
  86191. export class BoxParticleEmitter implements IParticleEmitterType {
  86192. /**
  86193. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86194. */
  86195. direction1: Vector3;
  86196. /**
  86197. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86198. */
  86199. direction2: Vector3;
  86200. /**
  86201. * 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.
  86202. */
  86203. minEmitBox: Vector3;
  86204. /**
  86205. * 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.
  86206. */
  86207. maxEmitBox: Vector3;
  86208. /**
  86209. * Creates a new instance BoxParticleEmitter
  86210. */
  86211. constructor();
  86212. /**
  86213. * Called by the particle System when the direction is computed for the created particle.
  86214. * @param worldMatrix is the world matrix of the particle system
  86215. * @param directionToUpdate is the direction vector to update with the result
  86216. * @param particle is the particle we are computed the direction for
  86217. */
  86218. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86219. /**
  86220. * Called by the particle System when the position is computed for the created particle.
  86221. * @param worldMatrix is the world matrix of the particle system
  86222. * @param positionToUpdate is the position vector to update with the result
  86223. * @param particle is the particle we are computed the position for
  86224. */
  86225. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86226. /**
  86227. * Clones the current emitter and returns a copy of it
  86228. * @returns the new emitter
  86229. */
  86230. clone(): BoxParticleEmitter;
  86231. /**
  86232. * Called by the GPUParticleSystem to setup the update shader
  86233. * @param effect defines the update shader
  86234. */
  86235. applyToShader(effect: Effect): void;
  86236. /**
  86237. * Returns a string to use to update the GPU particles update shader
  86238. * @returns a string containng the defines string
  86239. */
  86240. getEffectDefines(): string;
  86241. /**
  86242. * Returns the string "BoxParticleEmitter"
  86243. * @returns a string containing the class name
  86244. */
  86245. getClassName(): string;
  86246. /**
  86247. * Serializes the particle system to a JSON object.
  86248. * @returns the JSON object
  86249. */
  86250. serialize(): any;
  86251. /**
  86252. * Parse properties from a JSON object
  86253. * @param serializationObject defines the JSON object
  86254. */
  86255. parse(serializationObject: any): void;
  86256. }
  86257. }
  86258. declare module BABYLON {
  86259. /**
  86260. * Particle emitter emitting particles from the inside of a cone.
  86261. * It emits the particles alongside the cone volume from the base to the particle.
  86262. * The emission direction might be randomized.
  86263. */
  86264. export class ConeParticleEmitter implements IParticleEmitterType {
  86265. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  86266. directionRandomizer: number;
  86267. private _radius;
  86268. private _angle;
  86269. private _height;
  86270. /**
  86271. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  86272. */
  86273. radiusRange: number;
  86274. /**
  86275. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  86276. */
  86277. heightRange: number;
  86278. /**
  86279. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  86280. */
  86281. emitFromSpawnPointOnly: boolean;
  86282. /**
  86283. * Gets or sets the radius of the emission cone
  86284. */
  86285. radius: number;
  86286. /**
  86287. * Gets or sets the angle of the emission cone
  86288. */
  86289. angle: number;
  86290. private _buildHeight;
  86291. /**
  86292. * Creates a new instance ConeParticleEmitter
  86293. * @param radius the radius of the emission cone (1 by default)
  86294. * @param angle the cone base angle (PI by default)
  86295. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  86296. */
  86297. constructor(radius?: number, angle?: number,
  86298. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  86299. directionRandomizer?: number);
  86300. /**
  86301. * Called by the particle System when the direction is computed for the created particle.
  86302. * @param worldMatrix is the world matrix of the particle system
  86303. * @param directionToUpdate is the direction vector to update with the result
  86304. * @param particle is the particle we are computed the direction for
  86305. */
  86306. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86307. /**
  86308. * Called by the particle System when the position is computed for the created particle.
  86309. * @param worldMatrix is the world matrix of the particle system
  86310. * @param positionToUpdate is the position vector to update with the result
  86311. * @param particle is the particle we are computed the position for
  86312. */
  86313. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86314. /**
  86315. * Clones the current emitter and returns a copy of it
  86316. * @returns the new emitter
  86317. */
  86318. clone(): ConeParticleEmitter;
  86319. /**
  86320. * Called by the GPUParticleSystem to setup the update shader
  86321. * @param effect defines the update shader
  86322. */
  86323. applyToShader(effect: Effect): void;
  86324. /**
  86325. * Returns a string to use to update the GPU particles update shader
  86326. * @returns a string containng the defines string
  86327. */
  86328. getEffectDefines(): string;
  86329. /**
  86330. * Returns the string "ConeParticleEmitter"
  86331. * @returns a string containing the class name
  86332. */
  86333. getClassName(): string;
  86334. /**
  86335. * Serializes the particle system to a JSON object.
  86336. * @returns the JSON object
  86337. */
  86338. serialize(): any;
  86339. /**
  86340. * Parse properties from a JSON object
  86341. * @param serializationObject defines the JSON object
  86342. */
  86343. parse(serializationObject: any): void;
  86344. }
  86345. }
  86346. declare module BABYLON {
  86347. /**
  86348. * Particle emitter emitting particles from the inside of a cylinder.
  86349. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  86350. */
  86351. export class CylinderParticleEmitter implements IParticleEmitterType {
  86352. /**
  86353. * The radius of the emission cylinder.
  86354. */
  86355. radius: number;
  86356. /**
  86357. * The height of the emission cylinder.
  86358. */
  86359. height: number;
  86360. /**
  86361. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86362. */
  86363. radiusRange: number;
  86364. /**
  86365. * How much to randomize the particle direction [0-1].
  86366. */
  86367. directionRandomizer: number;
  86368. /**
  86369. * Creates a new instance CylinderParticleEmitter
  86370. * @param radius the radius of the emission cylinder (1 by default)
  86371. * @param height the height of the emission cylinder (1 by default)
  86372. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86373. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86374. */
  86375. constructor(
  86376. /**
  86377. * The radius of the emission cylinder.
  86378. */
  86379. radius?: number,
  86380. /**
  86381. * The height of the emission cylinder.
  86382. */
  86383. height?: number,
  86384. /**
  86385. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86386. */
  86387. radiusRange?: number,
  86388. /**
  86389. * How much to randomize the particle direction [0-1].
  86390. */
  86391. directionRandomizer?: number);
  86392. /**
  86393. * Called by the particle System when the direction is computed for the created particle.
  86394. * @param worldMatrix is the world matrix of the particle system
  86395. * @param directionToUpdate is the direction vector to update with the result
  86396. * @param particle is the particle we are computed the direction for
  86397. */
  86398. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86399. /**
  86400. * Called by the particle System when the position is computed for the created particle.
  86401. * @param worldMatrix is the world matrix of the particle system
  86402. * @param positionToUpdate is the position vector to update with the result
  86403. * @param particle is the particle we are computed the position for
  86404. */
  86405. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86406. /**
  86407. * Clones the current emitter and returns a copy of it
  86408. * @returns the new emitter
  86409. */
  86410. clone(): CylinderParticleEmitter;
  86411. /**
  86412. * Called by the GPUParticleSystem to setup the update shader
  86413. * @param effect defines the update shader
  86414. */
  86415. applyToShader(effect: Effect): void;
  86416. /**
  86417. * Returns a string to use to update the GPU particles update shader
  86418. * @returns a string containng the defines string
  86419. */
  86420. getEffectDefines(): string;
  86421. /**
  86422. * Returns the string "CylinderParticleEmitter"
  86423. * @returns a string containing the class name
  86424. */
  86425. getClassName(): string;
  86426. /**
  86427. * Serializes the particle system to a JSON object.
  86428. * @returns the JSON object
  86429. */
  86430. serialize(): any;
  86431. /**
  86432. * Parse properties from a JSON object
  86433. * @param serializationObject defines the JSON object
  86434. */
  86435. parse(serializationObject: any): void;
  86436. }
  86437. /**
  86438. * Particle emitter emitting particles from the inside of a cylinder.
  86439. * It emits the particles randomly between two vectors.
  86440. */
  86441. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  86442. /**
  86443. * The min limit of the emission direction.
  86444. */
  86445. direction1: Vector3;
  86446. /**
  86447. * The max limit of the emission direction.
  86448. */
  86449. direction2: Vector3;
  86450. /**
  86451. * Creates a new instance CylinderDirectedParticleEmitter
  86452. * @param radius the radius of the emission cylinder (1 by default)
  86453. * @param height the height of the emission cylinder (1 by default)
  86454. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86455. * @param direction1 the min limit of the emission direction (up vector by default)
  86456. * @param direction2 the max limit of the emission direction (up vector by default)
  86457. */
  86458. constructor(radius?: number, height?: number, radiusRange?: number,
  86459. /**
  86460. * The min limit of the emission direction.
  86461. */
  86462. direction1?: Vector3,
  86463. /**
  86464. * The max limit of the emission direction.
  86465. */
  86466. direction2?: Vector3);
  86467. /**
  86468. * Called by the particle System when the direction is computed for the created particle.
  86469. * @param worldMatrix is the world matrix of the particle system
  86470. * @param directionToUpdate is the direction vector to update with the result
  86471. * @param particle is the particle we are computed the direction for
  86472. */
  86473. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86474. /**
  86475. * Clones the current emitter and returns a copy of it
  86476. * @returns the new emitter
  86477. */
  86478. clone(): CylinderDirectedParticleEmitter;
  86479. /**
  86480. * Called by the GPUParticleSystem to setup the update shader
  86481. * @param effect defines the update shader
  86482. */
  86483. applyToShader(effect: Effect): void;
  86484. /**
  86485. * Returns a string to use to update the GPU particles update shader
  86486. * @returns a string containng the defines string
  86487. */
  86488. getEffectDefines(): string;
  86489. /**
  86490. * Returns the string "CylinderDirectedParticleEmitter"
  86491. * @returns a string containing the class name
  86492. */
  86493. getClassName(): string;
  86494. /**
  86495. * Serializes the particle system to a JSON object.
  86496. * @returns the JSON object
  86497. */
  86498. serialize(): any;
  86499. /**
  86500. * Parse properties from a JSON object
  86501. * @param serializationObject defines the JSON object
  86502. */
  86503. parse(serializationObject: any): void;
  86504. }
  86505. }
  86506. declare module BABYLON {
  86507. /**
  86508. * Particle emitter emitting particles from the inside of a hemisphere.
  86509. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  86510. */
  86511. export class HemisphericParticleEmitter implements IParticleEmitterType {
  86512. /**
  86513. * The radius of the emission hemisphere.
  86514. */
  86515. radius: number;
  86516. /**
  86517. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86518. */
  86519. radiusRange: number;
  86520. /**
  86521. * How much to randomize the particle direction [0-1].
  86522. */
  86523. directionRandomizer: number;
  86524. /**
  86525. * Creates a new instance HemisphericParticleEmitter
  86526. * @param radius the radius of the emission hemisphere (1 by default)
  86527. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86528. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86529. */
  86530. constructor(
  86531. /**
  86532. * The radius of the emission hemisphere.
  86533. */
  86534. radius?: number,
  86535. /**
  86536. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86537. */
  86538. radiusRange?: number,
  86539. /**
  86540. * How much to randomize the particle direction [0-1].
  86541. */
  86542. directionRandomizer?: number);
  86543. /**
  86544. * Called by the particle System when the direction is computed for the created particle.
  86545. * @param worldMatrix is the world matrix of the particle system
  86546. * @param directionToUpdate is the direction vector to update with the result
  86547. * @param particle is the particle we are computed the direction for
  86548. */
  86549. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86550. /**
  86551. * Called by the particle System when the position is computed for the created particle.
  86552. * @param worldMatrix is the world matrix of the particle system
  86553. * @param positionToUpdate is the position vector to update with the result
  86554. * @param particle is the particle we are computed the position for
  86555. */
  86556. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86557. /**
  86558. * Clones the current emitter and returns a copy of it
  86559. * @returns the new emitter
  86560. */
  86561. clone(): HemisphericParticleEmitter;
  86562. /**
  86563. * Called by the GPUParticleSystem to setup the update shader
  86564. * @param effect defines the update shader
  86565. */
  86566. applyToShader(effect: Effect): void;
  86567. /**
  86568. * Returns a string to use to update the GPU particles update shader
  86569. * @returns a string containng the defines string
  86570. */
  86571. getEffectDefines(): string;
  86572. /**
  86573. * Returns the string "HemisphericParticleEmitter"
  86574. * @returns a string containing the class name
  86575. */
  86576. getClassName(): string;
  86577. /**
  86578. * Serializes the particle system to a JSON object.
  86579. * @returns the JSON object
  86580. */
  86581. serialize(): any;
  86582. /**
  86583. * Parse properties from a JSON object
  86584. * @param serializationObject defines the JSON object
  86585. */
  86586. parse(serializationObject: any): void;
  86587. }
  86588. }
  86589. declare module BABYLON {
  86590. /**
  86591. * Particle emitter emitting particles from a point.
  86592. * It emits the particles randomly between 2 given directions.
  86593. */
  86594. export class PointParticleEmitter implements IParticleEmitterType {
  86595. /**
  86596. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86597. */
  86598. direction1: Vector3;
  86599. /**
  86600. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86601. */
  86602. direction2: Vector3;
  86603. /**
  86604. * Creates a new instance PointParticleEmitter
  86605. */
  86606. constructor();
  86607. /**
  86608. * Called by the particle System when the direction is computed for the created particle.
  86609. * @param worldMatrix is the world matrix of the particle system
  86610. * @param directionToUpdate is the direction vector to update with the result
  86611. * @param particle is the particle we are computed the direction for
  86612. */
  86613. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86614. /**
  86615. * Called by the particle System when the position is computed for the created particle.
  86616. * @param worldMatrix is the world matrix of the particle system
  86617. * @param positionToUpdate is the position vector to update with the result
  86618. * @param particle is the particle we are computed the position for
  86619. */
  86620. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86621. /**
  86622. * Clones the current emitter and returns a copy of it
  86623. * @returns the new emitter
  86624. */
  86625. clone(): PointParticleEmitter;
  86626. /**
  86627. * Called by the GPUParticleSystem to setup the update shader
  86628. * @param effect defines the update shader
  86629. */
  86630. applyToShader(effect: Effect): void;
  86631. /**
  86632. * Returns a string to use to update the GPU particles update shader
  86633. * @returns a string containng the defines string
  86634. */
  86635. getEffectDefines(): string;
  86636. /**
  86637. * Returns the string "PointParticleEmitter"
  86638. * @returns a string containing the class name
  86639. */
  86640. getClassName(): string;
  86641. /**
  86642. * Serializes the particle system to a JSON object.
  86643. * @returns the JSON object
  86644. */
  86645. serialize(): any;
  86646. /**
  86647. * Parse properties from a JSON object
  86648. * @param serializationObject defines the JSON object
  86649. */
  86650. parse(serializationObject: any): void;
  86651. }
  86652. }
  86653. declare module BABYLON {
  86654. /**
  86655. * Particle emitter emitting particles from the inside of a sphere.
  86656. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  86657. */
  86658. export class SphereParticleEmitter implements IParticleEmitterType {
  86659. /**
  86660. * The radius of the emission sphere.
  86661. */
  86662. radius: number;
  86663. /**
  86664. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86665. */
  86666. radiusRange: number;
  86667. /**
  86668. * How much to randomize the particle direction [0-1].
  86669. */
  86670. directionRandomizer: number;
  86671. /**
  86672. * Creates a new instance SphereParticleEmitter
  86673. * @param radius the radius of the emission sphere (1 by default)
  86674. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86675. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86676. */
  86677. constructor(
  86678. /**
  86679. * The radius of the emission sphere.
  86680. */
  86681. radius?: number,
  86682. /**
  86683. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86684. */
  86685. radiusRange?: number,
  86686. /**
  86687. * How much to randomize the particle direction [0-1].
  86688. */
  86689. directionRandomizer?: number);
  86690. /**
  86691. * Called by the particle System when the direction is computed for the created particle.
  86692. * @param worldMatrix is the world matrix of the particle system
  86693. * @param directionToUpdate is the direction vector to update with the result
  86694. * @param particle is the particle we are computed the direction for
  86695. */
  86696. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86697. /**
  86698. * Called by the particle System when the position is computed for the created particle.
  86699. * @param worldMatrix is the world matrix of the particle system
  86700. * @param positionToUpdate is the position vector to update with the result
  86701. * @param particle is the particle we are computed the position for
  86702. */
  86703. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86704. /**
  86705. * Clones the current emitter and returns a copy of it
  86706. * @returns the new emitter
  86707. */
  86708. clone(): SphereParticleEmitter;
  86709. /**
  86710. * Called by the GPUParticleSystem to setup the update shader
  86711. * @param effect defines the update shader
  86712. */
  86713. applyToShader(effect: Effect): void;
  86714. /**
  86715. * Returns a string to use to update the GPU particles update shader
  86716. * @returns a string containng the defines string
  86717. */
  86718. getEffectDefines(): string;
  86719. /**
  86720. * Returns the string "SphereParticleEmitter"
  86721. * @returns a string containing the class name
  86722. */
  86723. getClassName(): string;
  86724. /**
  86725. * Serializes the particle system to a JSON object.
  86726. * @returns the JSON object
  86727. */
  86728. serialize(): any;
  86729. /**
  86730. * Parse properties from a JSON object
  86731. * @param serializationObject defines the JSON object
  86732. */
  86733. parse(serializationObject: any): void;
  86734. }
  86735. /**
  86736. * Particle emitter emitting particles from the inside of a sphere.
  86737. * It emits the particles randomly between two vectors.
  86738. */
  86739. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  86740. /**
  86741. * The min limit of the emission direction.
  86742. */
  86743. direction1: Vector3;
  86744. /**
  86745. * The max limit of the emission direction.
  86746. */
  86747. direction2: Vector3;
  86748. /**
  86749. * Creates a new instance SphereDirectedParticleEmitter
  86750. * @param radius the radius of the emission sphere (1 by default)
  86751. * @param direction1 the min limit of the emission direction (up vector by default)
  86752. * @param direction2 the max limit of the emission direction (up vector by default)
  86753. */
  86754. constructor(radius?: number,
  86755. /**
  86756. * The min limit of the emission direction.
  86757. */
  86758. direction1?: Vector3,
  86759. /**
  86760. * The max limit of the emission direction.
  86761. */
  86762. direction2?: Vector3);
  86763. /**
  86764. * Called by the particle System when the direction is computed for the created particle.
  86765. * @param worldMatrix is the world matrix of the particle system
  86766. * @param directionToUpdate is the direction vector to update with the result
  86767. * @param particle is the particle we are computed the direction for
  86768. */
  86769. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86770. /**
  86771. * Clones the current emitter and returns a copy of it
  86772. * @returns the new emitter
  86773. */
  86774. clone(): SphereDirectedParticleEmitter;
  86775. /**
  86776. * Called by the GPUParticleSystem to setup the update shader
  86777. * @param effect defines the update shader
  86778. */
  86779. applyToShader(effect: Effect): void;
  86780. /**
  86781. * Returns a string to use to update the GPU particles update shader
  86782. * @returns a string containng the defines string
  86783. */
  86784. getEffectDefines(): string;
  86785. /**
  86786. * Returns the string "SphereDirectedParticleEmitter"
  86787. * @returns a string containing the class name
  86788. */
  86789. getClassName(): string;
  86790. /**
  86791. * Serializes the particle system to a JSON object.
  86792. * @returns the JSON object
  86793. */
  86794. serialize(): any;
  86795. /**
  86796. * Parse properties from a JSON object
  86797. * @param serializationObject defines the JSON object
  86798. */
  86799. parse(serializationObject: any): void;
  86800. }
  86801. }
  86802. declare module BABYLON {
  86803. /**
  86804. * Interface representing a particle system in Babylon.js.
  86805. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  86806. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  86807. */
  86808. export interface IParticleSystem {
  86809. /**
  86810. * List of animations used by the particle system.
  86811. */
  86812. animations: Animation[];
  86813. /**
  86814. * The id of the Particle system.
  86815. */
  86816. id: string;
  86817. /**
  86818. * The name of the Particle system.
  86819. */
  86820. name: string;
  86821. /**
  86822. * The emitter represents the Mesh or position we are attaching the particle system to.
  86823. */
  86824. emitter: Nullable<AbstractMesh | Vector3>;
  86825. /**
  86826. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  86827. */
  86828. isBillboardBased: boolean;
  86829. /**
  86830. * The rendering group used by the Particle system to chose when to render.
  86831. */
  86832. renderingGroupId: number;
  86833. /**
  86834. * The layer mask we are rendering the particles through.
  86835. */
  86836. layerMask: number;
  86837. /**
  86838. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  86839. */
  86840. updateSpeed: number;
  86841. /**
  86842. * The amount of time the particle system is running (depends of the overall update speed).
  86843. */
  86844. targetStopDuration: number;
  86845. /**
  86846. * The texture used to render each particle. (this can be a spritesheet)
  86847. */
  86848. particleTexture: Nullable<Texture>;
  86849. /**
  86850. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  86851. */
  86852. blendMode: number;
  86853. /**
  86854. * Minimum life time of emitting particles.
  86855. */
  86856. minLifeTime: number;
  86857. /**
  86858. * Maximum life time of emitting particles.
  86859. */
  86860. maxLifeTime: number;
  86861. /**
  86862. * Minimum Size of emitting particles.
  86863. */
  86864. minSize: number;
  86865. /**
  86866. * Maximum Size of emitting particles.
  86867. */
  86868. maxSize: number;
  86869. /**
  86870. * Minimum scale of emitting particles on X axis.
  86871. */
  86872. minScaleX: number;
  86873. /**
  86874. * Maximum scale of emitting particles on X axis.
  86875. */
  86876. maxScaleX: number;
  86877. /**
  86878. * Minimum scale of emitting particles on Y axis.
  86879. */
  86880. minScaleY: number;
  86881. /**
  86882. * Maximum scale of emitting particles on Y axis.
  86883. */
  86884. maxScaleY: number;
  86885. /**
  86886. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86887. */
  86888. color1: Color4;
  86889. /**
  86890. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86891. */
  86892. color2: Color4;
  86893. /**
  86894. * Color the particle will have at the end of its lifetime.
  86895. */
  86896. colorDead: Color4;
  86897. /**
  86898. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  86899. */
  86900. emitRate: number;
  86901. /**
  86902. * You can use gravity if you want to give an orientation to your particles.
  86903. */
  86904. gravity: Vector3;
  86905. /**
  86906. * Minimum power of emitting particles.
  86907. */
  86908. minEmitPower: number;
  86909. /**
  86910. * Maximum power of emitting particles.
  86911. */
  86912. maxEmitPower: number;
  86913. /**
  86914. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  86915. */
  86916. minAngularSpeed: number;
  86917. /**
  86918. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  86919. */
  86920. maxAngularSpeed: number;
  86921. /**
  86922. * Gets or sets the minimal initial rotation in radians.
  86923. */
  86924. minInitialRotation: number;
  86925. /**
  86926. * Gets or sets the maximal initial rotation in radians.
  86927. */
  86928. maxInitialRotation: number;
  86929. /**
  86930. * The particle emitter type defines the emitter used by the particle system.
  86931. * It can be for example box, sphere, or cone...
  86932. */
  86933. particleEmitterType: Nullable<IParticleEmitterType>;
  86934. /**
  86935. * Defines the delay in milliseconds before starting the system (0 by default)
  86936. */
  86937. startDelay: number;
  86938. /**
  86939. * 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
  86940. */
  86941. preWarmCycles: number;
  86942. /**
  86943. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  86944. */
  86945. preWarmStepOffset: number;
  86946. /**
  86947. * 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)
  86948. */
  86949. spriteCellChangeSpeed: number;
  86950. /**
  86951. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  86952. */
  86953. startSpriteCellID: number;
  86954. /**
  86955. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  86956. */
  86957. endSpriteCellID: number;
  86958. /**
  86959. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  86960. */
  86961. spriteCellWidth: number;
  86962. /**
  86963. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  86964. */
  86965. spriteCellHeight: number;
  86966. /**
  86967. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  86968. */
  86969. spriteRandomStartCell: boolean;
  86970. /**
  86971. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  86972. */
  86973. isAnimationSheetEnabled: boolean;
  86974. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  86975. translationPivot: Vector2;
  86976. /**
  86977. * Gets or sets a texture used to add random noise to particle positions
  86978. */
  86979. noiseTexture: Nullable<BaseTexture>;
  86980. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  86981. noiseStrength: Vector3;
  86982. /**
  86983. * Gets or sets the billboard mode to use when isBillboardBased = true.
  86984. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  86985. */
  86986. billboardMode: number;
  86987. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  86988. limitVelocityDamping: number;
  86989. /**
  86990. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  86991. */
  86992. beginAnimationOnStart: boolean;
  86993. /**
  86994. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  86995. */
  86996. beginAnimationFrom: number;
  86997. /**
  86998. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  86999. */
  87000. beginAnimationTo: number;
  87001. /**
  87002. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  87003. */
  87004. beginAnimationLoop: boolean;
  87005. /**
  87006. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  87007. */
  87008. disposeOnStop: boolean;
  87009. /**
  87010. * Gets the maximum number of particles active at the same time.
  87011. * @returns The max number of active particles.
  87012. */
  87013. getCapacity(): number;
  87014. /**
  87015. * Gets if the system has been started. (Note: this will still be true after stop is called)
  87016. * @returns True if it has been started, otherwise false.
  87017. */
  87018. isStarted(): boolean;
  87019. /**
  87020. * Animates the particle system for this frame.
  87021. */
  87022. animate(): void;
  87023. /**
  87024. * Renders the particle system in its current state.
  87025. * @returns the current number of particles
  87026. */
  87027. render(): number;
  87028. /**
  87029. * Dispose the particle system and frees its associated resources.
  87030. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  87031. */
  87032. dispose(disposeTexture?: boolean): void;
  87033. /**
  87034. * Clones the particle system.
  87035. * @param name The name of the cloned object
  87036. * @param newEmitter The new emitter to use
  87037. * @returns the cloned particle system
  87038. */
  87039. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  87040. /**
  87041. * Serializes the particle system to a JSON object.
  87042. * @returns the JSON object
  87043. */
  87044. serialize(): any;
  87045. /**
  87046. * Rebuild the particle system
  87047. */
  87048. rebuild(): void;
  87049. /**
  87050. * Starts the particle system and begins to emit
  87051. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  87052. */
  87053. start(delay?: number): void;
  87054. /**
  87055. * Stops the particle system.
  87056. */
  87057. stop(): void;
  87058. /**
  87059. * Remove all active particles
  87060. */
  87061. reset(): void;
  87062. /**
  87063. * Is this system ready to be used/rendered
  87064. * @return true if the system is ready
  87065. */
  87066. isReady(): boolean;
  87067. /**
  87068. * Adds a new color gradient
  87069. * @param gradient defines the gradient to use (between 0 and 1)
  87070. * @param color1 defines the color to affect to the specified gradient
  87071. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  87072. * @returns the current particle system
  87073. */
  87074. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  87075. /**
  87076. * Remove a specific color gradient
  87077. * @param gradient defines the gradient to remove
  87078. * @returns the current particle system
  87079. */
  87080. removeColorGradient(gradient: number): IParticleSystem;
  87081. /**
  87082. * Adds a new size gradient
  87083. * @param gradient defines the gradient to use (between 0 and 1)
  87084. * @param factor defines the size factor to affect to the specified gradient
  87085. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87086. * @returns the current particle system
  87087. */
  87088. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87089. /**
  87090. * Remove a specific size gradient
  87091. * @param gradient defines the gradient to remove
  87092. * @returns the current particle system
  87093. */
  87094. removeSizeGradient(gradient: number): IParticleSystem;
  87095. /**
  87096. * Gets the current list of color gradients.
  87097. * You must use addColorGradient and removeColorGradient to udpate this list
  87098. * @returns the list of color gradients
  87099. */
  87100. getColorGradients(): Nullable<Array<ColorGradient>>;
  87101. /**
  87102. * Gets the current list of size gradients.
  87103. * You must use addSizeGradient and removeSizeGradient to udpate this list
  87104. * @returns the list of size gradients
  87105. */
  87106. getSizeGradients(): Nullable<Array<FactorGradient>>;
  87107. /**
  87108. * Gets the current list of angular speed gradients.
  87109. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  87110. * @returns the list of angular speed gradients
  87111. */
  87112. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  87113. /**
  87114. * Adds a new angular speed gradient
  87115. * @param gradient defines the gradient to use (between 0 and 1)
  87116. * @param factor defines the angular speed to affect to the specified gradient
  87117. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87118. * @returns the current particle system
  87119. */
  87120. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87121. /**
  87122. * Remove a specific angular speed gradient
  87123. * @param gradient defines the gradient to remove
  87124. * @returns the current particle system
  87125. */
  87126. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  87127. /**
  87128. * Gets the current list of velocity gradients.
  87129. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  87130. * @returns the list of velocity gradients
  87131. */
  87132. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  87133. /**
  87134. * Adds a new velocity gradient
  87135. * @param gradient defines the gradient to use (between 0 and 1)
  87136. * @param factor defines the velocity to affect to the specified gradient
  87137. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87138. * @returns the current particle system
  87139. */
  87140. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87141. /**
  87142. * Remove a specific velocity gradient
  87143. * @param gradient defines the gradient to remove
  87144. * @returns the current particle system
  87145. */
  87146. removeVelocityGradient(gradient: number): IParticleSystem;
  87147. /**
  87148. * Gets the current list of limit velocity gradients.
  87149. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  87150. * @returns the list of limit velocity gradients
  87151. */
  87152. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  87153. /**
  87154. * Adds a new limit velocity gradient
  87155. * @param gradient defines the gradient to use (between 0 and 1)
  87156. * @param factor defines the limit velocity to affect to the specified gradient
  87157. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87158. * @returns the current particle system
  87159. */
  87160. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87161. /**
  87162. * Remove a specific limit velocity gradient
  87163. * @param gradient defines the gradient to remove
  87164. * @returns the current particle system
  87165. */
  87166. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  87167. /**
  87168. * Adds a new drag gradient
  87169. * @param gradient defines the gradient to use (between 0 and 1)
  87170. * @param factor defines the drag to affect to the specified gradient
  87171. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87172. * @returns the current particle system
  87173. */
  87174. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87175. /**
  87176. * Remove a specific drag gradient
  87177. * @param gradient defines the gradient to remove
  87178. * @returns the current particle system
  87179. */
  87180. removeDragGradient(gradient: number): IParticleSystem;
  87181. /**
  87182. * Gets the current list of drag gradients.
  87183. * You must use addDragGradient and removeDragGradient to udpate this list
  87184. * @returns the list of drag gradients
  87185. */
  87186. getDragGradients(): Nullable<Array<FactorGradient>>;
  87187. /**
  87188. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  87189. * @param gradient defines the gradient to use (between 0 and 1)
  87190. * @param factor defines the emit rate to affect to the specified gradient
  87191. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87192. * @returns the current particle system
  87193. */
  87194. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87195. /**
  87196. * Remove a specific emit rate gradient
  87197. * @param gradient defines the gradient to remove
  87198. * @returns the current particle system
  87199. */
  87200. removeEmitRateGradient(gradient: number): IParticleSystem;
  87201. /**
  87202. * Gets the current list of emit rate gradients.
  87203. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  87204. * @returns the list of emit rate gradients
  87205. */
  87206. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  87207. /**
  87208. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  87209. * @param gradient defines the gradient to use (between 0 and 1)
  87210. * @param factor defines the start size to affect to the specified gradient
  87211. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87212. * @returns the current particle system
  87213. */
  87214. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87215. /**
  87216. * Remove a specific start size gradient
  87217. * @param gradient defines the gradient to remove
  87218. * @returns the current particle system
  87219. */
  87220. removeStartSizeGradient(gradient: number): IParticleSystem;
  87221. /**
  87222. * Gets the current list of start size gradients.
  87223. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  87224. * @returns the list of start size gradients
  87225. */
  87226. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  87227. /**
  87228. * Adds a new life time gradient
  87229. * @param gradient defines the gradient to use (between 0 and 1)
  87230. * @param factor defines the life time factor to affect to the specified gradient
  87231. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87232. * @returns the current particle system
  87233. */
  87234. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87235. /**
  87236. * Remove a specific life time gradient
  87237. * @param gradient defines the gradient to remove
  87238. * @returns the current particle system
  87239. */
  87240. removeLifeTimeGradient(gradient: number): IParticleSystem;
  87241. /**
  87242. * Gets the current list of life time gradients.
  87243. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  87244. * @returns the list of life time gradients
  87245. */
  87246. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  87247. /**
  87248. * Gets the current list of color gradients.
  87249. * You must use addColorGradient and removeColorGradient to udpate this list
  87250. * @returns the list of color gradients
  87251. */
  87252. getColorGradients(): Nullable<Array<ColorGradient>>;
  87253. /**
  87254. * Adds a new ramp gradient used to remap particle colors
  87255. * @param gradient defines the gradient to use (between 0 and 1)
  87256. * @param color defines the color to affect to the specified gradient
  87257. * @returns the current particle system
  87258. */
  87259. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  87260. /**
  87261. * Gets the current list of ramp gradients.
  87262. * You must use addRampGradient and removeRampGradient to udpate this list
  87263. * @returns the list of ramp gradients
  87264. */
  87265. getRampGradients(): Nullable<Array<Color3Gradient>>;
  87266. /** Gets or sets a boolean indicating that ramp gradients must be used
  87267. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  87268. */
  87269. useRampGradients: boolean;
  87270. /**
  87271. * Adds a new color remap gradient
  87272. * @param gradient defines the gradient to use (between 0 and 1)
  87273. * @param min defines the color remap minimal range
  87274. * @param max defines the color remap maximal range
  87275. * @returns the current particle system
  87276. */
  87277. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  87278. /**
  87279. * Gets the current list of color remap gradients.
  87280. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  87281. * @returns the list of color remap gradients
  87282. */
  87283. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  87284. /**
  87285. * Adds a new alpha remap gradient
  87286. * @param gradient defines the gradient to use (between 0 and 1)
  87287. * @param min defines the alpha remap minimal range
  87288. * @param max defines the alpha remap maximal range
  87289. * @returns the current particle system
  87290. */
  87291. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  87292. /**
  87293. * Gets the current list of alpha remap gradients.
  87294. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  87295. * @returns the list of alpha remap gradients
  87296. */
  87297. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  87298. /**
  87299. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  87300. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  87301. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  87302. * @returns the emitter
  87303. */
  87304. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  87305. /**
  87306. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  87307. * @param radius The radius of the hemisphere to emit from
  87308. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  87309. * @returns the emitter
  87310. */
  87311. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  87312. /**
  87313. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  87314. * @param radius The radius of the sphere to emit from
  87315. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  87316. * @returns the emitter
  87317. */
  87318. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  87319. /**
  87320. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  87321. * @param radius The radius of the sphere to emit from
  87322. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  87323. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  87324. * @returns the emitter
  87325. */
  87326. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  87327. /**
  87328. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  87329. * @param radius The radius of the emission cylinder
  87330. * @param height The height of the emission cylinder
  87331. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  87332. * @param directionRandomizer How much to randomize the particle direction [0-1]
  87333. * @returns the emitter
  87334. */
  87335. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  87336. /**
  87337. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  87338. * @param radius The radius of the cylinder to emit from
  87339. * @param height The height of the emission cylinder
  87340. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  87341. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  87342. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  87343. * @returns the emitter
  87344. */
  87345. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  87346. /**
  87347. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  87348. * @param radius The radius of the cone to emit from
  87349. * @param angle The base angle of the cone
  87350. * @returns the emitter
  87351. */
  87352. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  87353. /**
  87354. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  87355. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  87356. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  87357. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  87358. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  87359. * @returns the emitter
  87360. */
  87361. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  87362. /**
  87363. * Get hosting scene
  87364. * @returns the scene
  87365. */
  87366. getScene(): Scene;
  87367. }
  87368. }
  87369. declare module BABYLON {
  87370. /**
  87371. * Creates an instance based on a source mesh.
  87372. */
  87373. export class InstancedMesh extends AbstractMesh {
  87374. private _sourceMesh;
  87375. private _currentLOD;
  87376. /** @hidden */
  87377. _indexInSourceMeshInstanceArray: number;
  87378. constructor(name: string, source: Mesh);
  87379. /**
  87380. * Returns the string "InstancedMesh".
  87381. */
  87382. getClassName(): string;
  87383. /** Gets the list of lights affecting that mesh */
  87384. readonly lightSources: Light[];
  87385. _resyncLightSources(): void;
  87386. _resyncLighSource(light: Light): void;
  87387. _removeLightSource(light: Light, dispose: boolean): void;
  87388. /**
  87389. * If the source mesh receives shadows
  87390. */
  87391. readonly receiveShadows: boolean;
  87392. /**
  87393. * The material of the source mesh
  87394. */
  87395. readonly material: Nullable<Material>;
  87396. /**
  87397. * Visibility of the source mesh
  87398. */
  87399. readonly visibility: number;
  87400. /**
  87401. * Skeleton of the source mesh
  87402. */
  87403. readonly skeleton: Nullable<Skeleton>;
  87404. /**
  87405. * Rendering ground id of the source mesh
  87406. */
  87407. renderingGroupId: number;
  87408. /**
  87409. * Returns the total number of vertices (integer).
  87410. */
  87411. getTotalVertices(): number;
  87412. /**
  87413. * Returns a positive integer : the total number of indices in this mesh geometry.
  87414. * @returns the numner of indices or zero if the mesh has no geometry.
  87415. */
  87416. getTotalIndices(): number;
  87417. /**
  87418. * The source mesh of the instance
  87419. */
  87420. readonly sourceMesh: Mesh;
  87421. /**
  87422. * Is this node ready to be used/rendered
  87423. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  87424. * @return {boolean} is it ready
  87425. */
  87426. isReady(completeCheck?: boolean): boolean;
  87427. /**
  87428. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  87429. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  87430. * @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.
  87431. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  87432. */
  87433. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  87434. /**
  87435. * Sets the vertex data of the mesh geometry for the requested `kind`.
  87436. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  87437. * The `data` are either a numeric array either a Float32Array.
  87438. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  87439. * 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).
  87440. * Note that a new underlying VertexBuffer object is created each call.
  87441. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  87442. *
  87443. * Possible `kind` values :
  87444. * - VertexBuffer.PositionKind
  87445. * - VertexBuffer.UVKind
  87446. * - VertexBuffer.UV2Kind
  87447. * - VertexBuffer.UV3Kind
  87448. * - VertexBuffer.UV4Kind
  87449. * - VertexBuffer.UV5Kind
  87450. * - VertexBuffer.UV6Kind
  87451. * - VertexBuffer.ColorKind
  87452. * - VertexBuffer.MatricesIndicesKind
  87453. * - VertexBuffer.MatricesIndicesExtraKind
  87454. * - VertexBuffer.MatricesWeightsKind
  87455. * - VertexBuffer.MatricesWeightsExtraKind
  87456. *
  87457. * Returns the Mesh.
  87458. */
  87459. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  87460. /**
  87461. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  87462. * If the mesh has no geometry, it is simply returned as it is.
  87463. * The `data` are either a numeric array either a Float32Array.
  87464. * No new underlying VertexBuffer object is created.
  87465. * 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.
  87466. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  87467. *
  87468. * Possible `kind` values :
  87469. * - VertexBuffer.PositionKind
  87470. * - VertexBuffer.UVKind
  87471. * - VertexBuffer.UV2Kind
  87472. * - VertexBuffer.UV3Kind
  87473. * - VertexBuffer.UV4Kind
  87474. * - VertexBuffer.UV5Kind
  87475. * - VertexBuffer.UV6Kind
  87476. * - VertexBuffer.ColorKind
  87477. * - VertexBuffer.MatricesIndicesKind
  87478. * - VertexBuffer.MatricesIndicesExtraKind
  87479. * - VertexBuffer.MatricesWeightsKind
  87480. * - VertexBuffer.MatricesWeightsExtraKind
  87481. *
  87482. * Returns the Mesh.
  87483. */
  87484. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  87485. /**
  87486. * Sets the mesh indices.
  87487. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  87488. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  87489. * This method creates a new index buffer each call.
  87490. * Returns the Mesh.
  87491. */
  87492. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  87493. /**
  87494. * Boolean : True if the mesh owns the requested kind of data.
  87495. */
  87496. isVerticesDataPresent(kind: string): boolean;
  87497. /**
  87498. * Returns an array of indices (IndicesArray).
  87499. */
  87500. getIndices(): Nullable<IndicesArray>;
  87501. readonly _positions: Nullable<Vector3[]>;
  87502. /**
  87503. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  87504. * This means the mesh underlying bounding box and sphere are recomputed.
  87505. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  87506. * @returns the current mesh
  87507. */
  87508. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  87509. /** @hidden */
  87510. _preActivate(): InstancedMesh;
  87511. /** @hidden */
  87512. _activate(renderId: number, intermediateRendering: boolean): boolean;
  87513. /** @hidden */
  87514. _postActivate(): void;
  87515. getWorldMatrix(): Matrix;
  87516. readonly isAnInstance: boolean;
  87517. /**
  87518. * Returns the current associated LOD AbstractMesh.
  87519. */
  87520. getLOD(camera: Camera): AbstractMesh;
  87521. /** @hidden */
  87522. _syncSubMeshes(): InstancedMesh;
  87523. /** @hidden */
  87524. _generatePointsArray(): boolean;
  87525. /**
  87526. * Creates a new InstancedMesh from the current mesh.
  87527. * - name (string) : the cloned mesh name
  87528. * - newParent (optional Node) : the optional Node to parent the clone to.
  87529. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  87530. *
  87531. * Returns the clone.
  87532. */
  87533. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87534. /**
  87535. * Disposes the InstancedMesh.
  87536. * Returns nothing.
  87537. */
  87538. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  87539. }
  87540. interface Mesh {
  87541. /**
  87542. * Register a custom buffer that will be instanced
  87543. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  87544. * @param kind defines the buffer kind
  87545. * @param stride defines the stride in floats
  87546. */
  87547. registerInstancedBuffer(kind: string, stride: number): void;
  87548. /** @hidden */
  87549. _userInstancedBuffersStorage: {
  87550. data: {
  87551. [key: string]: Float32Array;
  87552. };
  87553. sizes: {
  87554. [key: string]: number;
  87555. };
  87556. vertexBuffers: {
  87557. [key: string]: Nullable<VertexBuffer>;
  87558. };
  87559. strides: {
  87560. [key: string]: number;
  87561. };
  87562. };
  87563. }
  87564. interface AbstractMesh {
  87565. /**
  87566. * Object used to store instanced buffers defined by user
  87567. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  87568. */
  87569. instancedBuffers: {
  87570. [key: string]: any;
  87571. };
  87572. }
  87573. }
  87574. declare module BABYLON {
  87575. /**
  87576. * Defines the options associated with the creation of a shader material.
  87577. */
  87578. export interface IShaderMaterialOptions {
  87579. /**
  87580. * Does the material work in alpha blend mode
  87581. */
  87582. needAlphaBlending: boolean;
  87583. /**
  87584. * Does the material work in alpha test mode
  87585. */
  87586. needAlphaTesting: boolean;
  87587. /**
  87588. * The list of attribute names used in the shader
  87589. */
  87590. attributes: string[];
  87591. /**
  87592. * The list of unifrom names used in the shader
  87593. */
  87594. uniforms: string[];
  87595. /**
  87596. * The list of UBO names used in the shader
  87597. */
  87598. uniformBuffers: string[];
  87599. /**
  87600. * The list of sampler names used in the shader
  87601. */
  87602. samplers: string[];
  87603. /**
  87604. * The list of defines used in the shader
  87605. */
  87606. defines: string[];
  87607. }
  87608. /**
  87609. * 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.
  87610. *
  87611. * This returned material effects how the mesh will look based on the code in the shaders.
  87612. *
  87613. * @see http://doc.babylonjs.com/how_to/shader_material
  87614. */
  87615. export class ShaderMaterial extends Material {
  87616. private _shaderPath;
  87617. private _options;
  87618. private _textures;
  87619. private _textureArrays;
  87620. private _floats;
  87621. private _ints;
  87622. private _floatsArrays;
  87623. private _colors3;
  87624. private _colors3Arrays;
  87625. private _colors4;
  87626. private _colors4Arrays;
  87627. private _vectors2;
  87628. private _vectors3;
  87629. private _vectors4;
  87630. private _matrices;
  87631. private _matrixArrays;
  87632. private _matrices3x3;
  87633. private _matrices2x2;
  87634. private _vectors2Arrays;
  87635. private _vectors3Arrays;
  87636. private _vectors4Arrays;
  87637. private _cachedWorldViewMatrix;
  87638. private _cachedWorldViewProjectionMatrix;
  87639. private _renderId;
  87640. private _multiview;
  87641. /**
  87642. * Instantiate a new shader material.
  87643. * 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.
  87644. * This returned material effects how the mesh will look based on the code in the shaders.
  87645. * @see http://doc.babylonjs.com/how_to/shader_material
  87646. * @param name Define the name of the material in the scene
  87647. * @param scene Define the scene the material belongs to
  87648. * @param shaderPath Defines the route to the shader code in one of three ways:
  87649. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  87650. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  87651. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  87652. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  87653. * @param options Define the options used to create the shader
  87654. */
  87655. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  87656. /**
  87657. * Gets the shader path used to define the shader code
  87658. * It can be modified to trigger a new compilation
  87659. */
  87660. /**
  87661. * Sets the shader path used to define the shader code
  87662. * It can be modified to trigger a new compilation
  87663. */
  87664. shaderPath: any;
  87665. /**
  87666. * Gets the options used to compile the shader.
  87667. * They can be modified to trigger a new compilation
  87668. */
  87669. readonly options: IShaderMaterialOptions;
  87670. /**
  87671. * Gets the current class name of the material e.g. "ShaderMaterial"
  87672. * Mainly use in serialization.
  87673. * @returns the class name
  87674. */
  87675. getClassName(): string;
  87676. /**
  87677. * Specifies if the material will require alpha blending
  87678. * @returns a boolean specifying if alpha blending is needed
  87679. */
  87680. needAlphaBlending(): boolean;
  87681. /**
  87682. * Specifies if this material should be rendered in alpha test mode
  87683. * @returns a boolean specifying if an alpha test is needed.
  87684. */
  87685. needAlphaTesting(): boolean;
  87686. private _checkUniform;
  87687. /**
  87688. * Set a texture in the shader.
  87689. * @param name Define the name of the uniform samplers as defined in the shader
  87690. * @param texture Define the texture to bind to this sampler
  87691. * @return the material itself allowing "fluent" like uniform updates
  87692. */
  87693. setTexture(name: string, texture: Texture): ShaderMaterial;
  87694. /**
  87695. * Set a texture array in the shader.
  87696. * @param name Define the name of the uniform sampler array as defined in the shader
  87697. * @param textures Define the list of textures to bind to this sampler
  87698. * @return the material itself allowing "fluent" like uniform updates
  87699. */
  87700. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  87701. /**
  87702. * Set a float in the shader.
  87703. * @param name Define the name of the uniform as defined in the shader
  87704. * @param value Define the value to give to the uniform
  87705. * @return the material itself allowing "fluent" like uniform updates
  87706. */
  87707. setFloat(name: string, value: number): ShaderMaterial;
  87708. /**
  87709. * Set a int in the shader.
  87710. * @param name Define the name of the uniform as defined in the shader
  87711. * @param value Define the value to give to the uniform
  87712. * @return the material itself allowing "fluent" like uniform updates
  87713. */
  87714. setInt(name: string, value: number): ShaderMaterial;
  87715. /**
  87716. * Set an array of floats in the shader.
  87717. * @param name Define the name of the uniform as defined in the shader
  87718. * @param value Define the value to give to the uniform
  87719. * @return the material itself allowing "fluent" like uniform updates
  87720. */
  87721. setFloats(name: string, value: number[]): ShaderMaterial;
  87722. /**
  87723. * Set a vec3 in the shader from a Color3.
  87724. * @param name Define the name of the uniform as defined in the shader
  87725. * @param value Define the value to give to the uniform
  87726. * @return the material itself allowing "fluent" like uniform updates
  87727. */
  87728. setColor3(name: string, value: Color3): ShaderMaterial;
  87729. /**
  87730. * Set a vec3 array in the shader from a Color3 array.
  87731. * @param name Define the name of the uniform as defined in the shader
  87732. * @param value Define the value to give to the uniform
  87733. * @return the material itself allowing "fluent" like uniform updates
  87734. */
  87735. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  87736. /**
  87737. * Set a vec4 in the shader from a Color4.
  87738. * @param name Define the name of the uniform as defined in the shader
  87739. * @param value Define the value to give to the uniform
  87740. * @return the material itself allowing "fluent" like uniform updates
  87741. */
  87742. setColor4(name: string, value: Color4): ShaderMaterial;
  87743. /**
  87744. * Set a vec4 array in the shader from a Color4 array.
  87745. * @param name Define the name of the uniform as defined in the shader
  87746. * @param value Define the value to give to the uniform
  87747. * @return the material itself allowing "fluent" like uniform updates
  87748. */
  87749. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  87750. /**
  87751. * Set a vec2 in the shader from a Vector2.
  87752. * @param name Define the name of the uniform as defined in the shader
  87753. * @param value Define the value to give to the uniform
  87754. * @return the material itself allowing "fluent" like uniform updates
  87755. */
  87756. setVector2(name: string, value: Vector2): ShaderMaterial;
  87757. /**
  87758. * Set a vec3 in the shader from a Vector3.
  87759. * @param name Define the name of the uniform as defined in the shader
  87760. * @param value Define the value to give to the uniform
  87761. * @return the material itself allowing "fluent" like uniform updates
  87762. */
  87763. setVector3(name: string, value: Vector3): ShaderMaterial;
  87764. /**
  87765. * Set a vec4 in the shader from a Vector4.
  87766. * @param name Define the name of the uniform as defined in the shader
  87767. * @param value Define the value to give to the uniform
  87768. * @return the material itself allowing "fluent" like uniform updates
  87769. */
  87770. setVector4(name: string, value: Vector4): ShaderMaterial;
  87771. /**
  87772. * Set a mat4 in the shader from a Matrix.
  87773. * @param name Define the name of the uniform as defined in the shader
  87774. * @param value Define the value to give to the uniform
  87775. * @return the material itself allowing "fluent" like uniform updates
  87776. */
  87777. setMatrix(name: string, value: Matrix): ShaderMaterial;
  87778. /**
  87779. * Set a float32Array in the shader from a matrix array.
  87780. * @param name Define the name of the uniform as defined in the shader
  87781. * @param value Define the value to give to the uniform
  87782. * @return the material itself allowing "fluent" like uniform updates
  87783. */
  87784. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  87785. /**
  87786. * Set a mat3 in the shader from a Float32Array.
  87787. * @param name Define the name of the uniform as defined in the shader
  87788. * @param value Define the value to give to the uniform
  87789. * @return the material itself allowing "fluent" like uniform updates
  87790. */
  87791. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  87792. /**
  87793. * Set a mat2 in the shader from a Float32Array.
  87794. * @param name Define the name of the uniform as defined in the shader
  87795. * @param value Define the value to give to the uniform
  87796. * @return the material itself allowing "fluent" like uniform updates
  87797. */
  87798. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  87799. /**
  87800. * Set a vec2 array in the shader from a number array.
  87801. * @param name Define the name of the uniform as defined in the shader
  87802. * @param value Define the value to give to the uniform
  87803. * @return the material itself allowing "fluent" like uniform updates
  87804. */
  87805. setArray2(name: string, value: number[]): ShaderMaterial;
  87806. /**
  87807. * Set a vec3 array in the shader from a number array.
  87808. * @param name Define the name of the uniform as defined in the shader
  87809. * @param value Define the value to give to the uniform
  87810. * @return the material itself allowing "fluent" like uniform updates
  87811. */
  87812. setArray3(name: string, value: number[]): ShaderMaterial;
  87813. /**
  87814. * Set a vec4 array in the shader from a number array.
  87815. * @param name Define the name of the uniform as defined in the shader
  87816. * @param value Define the value to give to the uniform
  87817. * @return the material itself allowing "fluent" like uniform updates
  87818. */
  87819. setArray4(name: string, value: number[]): ShaderMaterial;
  87820. private _checkCache;
  87821. /**
  87822. * Specifies that the submesh is ready to be used
  87823. * @param mesh defines the mesh to check
  87824. * @param subMesh defines which submesh to check
  87825. * @param useInstances specifies that instances should be used
  87826. * @returns a boolean indicating that the submesh is ready or not
  87827. */
  87828. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  87829. /**
  87830. * Checks if the material is ready to render the requested mesh
  87831. * @param mesh Define the mesh to render
  87832. * @param useInstances Define whether or not the material is used with instances
  87833. * @returns true if ready, otherwise false
  87834. */
  87835. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  87836. /**
  87837. * Binds the world matrix to the material
  87838. * @param world defines the world transformation matrix
  87839. */
  87840. bindOnlyWorldMatrix(world: Matrix): void;
  87841. /**
  87842. * Binds the material to the mesh
  87843. * @param world defines the world transformation matrix
  87844. * @param mesh defines the mesh to bind the material to
  87845. */
  87846. bind(world: Matrix, mesh?: Mesh): void;
  87847. /**
  87848. * Gets the active textures from the material
  87849. * @returns an array of textures
  87850. */
  87851. getActiveTextures(): BaseTexture[];
  87852. /**
  87853. * Specifies if the material uses a texture
  87854. * @param texture defines the texture to check against the material
  87855. * @returns a boolean specifying if the material uses the texture
  87856. */
  87857. hasTexture(texture: BaseTexture): boolean;
  87858. /**
  87859. * Makes a duplicate of the material, and gives it a new name
  87860. * @param name defines the new name for the duplicated material
  87861. * @returns the cloned material
  87862. */
  87863. clone(name: string): ShaderMaterial;
  87864. /**
  87865. * Disposes the material
  87866. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  87867. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  87868. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  87869. */
  87870. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  87871. /**
  87872. * Serializes this material in a JSON representation
  87873. * @returns the serialized material object
  87874. */
  87875. serialize(): any;
  87876. /**
  87877. * Creates a shader material from parsed shader material data
  87878. * @param source defines the JSON represnetation of the material
  87879. * @param scene defines the hosting scene
  87880. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  87881. * @returns a new material
  87882. */
  87883. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  87884. }
  87885. }
  87886. declare module BABYLON {
  87887. /** @hidden */
  87888. export var colorPixelShader: {
  87889. name: string;
  87890. shader: string;
  87891. };
  87892. }
  87893. declare module BABYLON {
  87894. /** @hidden */
  87895. export var colorVertexShader: {
  87896. name: string;
  87897. shader: string;
  87898. };
  87899. }
  87900. declare module BABYLON {
  87901. /**
  87902. * Line mesh
  87903. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  87904. */
  87905. export class LinesMesh extends Mesh {
  87906. /**
  87907. * If vertex color should be applied to the mesh
  87908. */
  87909. readonly useVertexColor?: boolean | undefined;
  87910. /**
  87911. * If vertex alpha should be applied to the mesh
  87912. */
  87913. readonly useVertexAlpha?: boolean | undefined;
  87914. /**
  87915. * Color of the line (Default: White)
  87916. */
  87917. color: Color3;
  87918. /**
  87919. * Alpha of the line (Default: 1)
  87920. */
  87921. alpha: number;
  87922. /**
  87923. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87924. * This margin is expressed in world space coordinates, so its value may vary.
  87925. * Default value is 0.1
  87926. */
  87927. intersectionThreshold: number;
  87928. private _colorShader;
  87929. private color4;
  87930. /**
  87931. * Creates a new LinesMesh
  87932. * @param name defines the name
  87933. * @param scene defines the hosting scene
  87934. * @param parent defines the parent mesh if any
  87935. * @param source defines the optional source LinesMesh used to clone data from
  87936. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  87937. * When false, achieved by calling a clone(), also passing False.
  87938. * This will make creation of children, recursive.
  87939. * @param useVertexColor defines if this LinesMesh supports vertex color
  87940. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  87941. */
  87942. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  87943. /**
  87944. * If vertex color should be applied to the mesh
  87945. */
  87946. useVertexColor?: boolean | undefined,
  87947. /**
  87948. * If vertex alpha should be applied to the mesh
  87949. */
  87950. useVertexAlpha?: boolean | undefined);
  87951. private _addClipPlaneDefine;
  87952. private _removeClipPlaneDefine;
  87953. isReady(): boolean;
  87954. /**
  87955. * Returns the string "LineMesh"
  87956. */
  87957. getClassName(): string;
  87958. /**
  87959. * @hidden
  87960. */
  87961. /**
  87962. * @hidden
  87963. */
  87964. material: Material;
  87965. /**
  87966. * @hidden
  87967. */
  87968. readonly checkCollisions: boolean;
  87969. /** @hidden */
  87970. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  87971. /** @hidden */
  87972. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  87973. /**
  87974. * Disposes of the line mesh
  87975. * @param doNotRecurse If children should be disposed
  87976. */
  87977. dispose(doNotRecurse?: boolean): void;
  87978. /**
  87979. * Returns a new LineMesh object cloned from the current one.
  87980. */
  87981. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87982. /**
  87983. * Creates a new InstancedLinesMesh object from the mesh model.
  87984. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  87985. * @param name defines the name of the new instance
  87986. * @returns a new InstancedLinesMesh
  87987. */
  87988. createInstance(name: string): InstancedLinesMesh;
  87989. }
  87990. /**
  87991. * Creates an instance based on a source LinesMesh
  87992. */
  87993. export class InstancedLinesMesh extends InstancedMesh {
  87994. /**
  87995. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87996. * This margin is expressed in world space coordinates, so its value may vary.
  87997. * Initilized with the intersectionThreshold value of the source LinesMesh
  87998. */
  87999. intersectionThreshold: number;
  88000. constructor(name: string, source: LinesMesh);
  88001. /**
  88002. * Returns the string "InstancedLinesMesh".
  88003. */
  88004. getClassName(): string;
  88005. }
  88006. }
  88007. declare module BABYLON {
  88008. /** @hidden */
  88009. export var linePixelShader: {
  88010. name: string;
  88011. shader: string;
  88012. };
  88013. }
  88014. declare module BABYLON {
  88015. /** @hidden */
  88016. export var lineVertexShader: {
  88017. name: string;
  88018. shader: string;
  88019. };
  88020. }
  88021. declare module BABYLON {
  88022. interface AbstractMesh {
  88023. /**
  88024. * Gets the edgesRenderer associated with the mesh
  88025. */
  88026. edgesRenderer: Nullable<EdgesRenderer>;
  88027. }
  88028. interface LinesMesh {
  88029. /**
  88030. * Enables the edge rendering mode on the mesh.
  88031. * This mode makes the mesh edges visible
  88032. * @param epsilon defines the maximal distance between two angles to detect a face
  88033. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  88034. * @returns the currentAbstractMesh
  88035. * @see https://www.babylonjs-playground.com/#19O9TU#0
  88036. */
  88037. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  88038. }
  88039. interface InstancedLinesMesh {
  88040. /**
  88041. * Enables the edge rendering mode on the mesh.
  88042. * This mode makes the mesh edges visible
  88043. * @param epsilon defines the maximal distance between two angles to detect a face
  88044. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  88045. * @returns the current InstancedLinesMesh
  88046. * @see https://www.babylonjs-playground.com/#19O9TU#0
  88047. */
  88048. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  88049. }
  88050. /**
  88051. * Defines the minimum contract an Edges renderer should follow.
  88052. */
  88053. export interface IEdgesRenderer extends IDisposable {
  88054. /**
  88055. * Gets or sets a boolean indicating if the edgesRenderer is active
  88056. */
  88057. isEnabled: boolean;
  88058. /**
  88059. * Renders the edges of the attached mesh,
  88060. */
  88061. render(): void;
  88062. /**
  88063. * Checks wether or not the edges renderer is ready to render.
  88064. * @return true if ready, otherwise false.
  88065. */
  88066. isReady(): boolean;
  88067. }
  88068. /**
  88069. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  88070. */
  88071. export class EdgesRenderer implements IEdgesRenderer {
  88072. /**
  88073. * Define the size of the edges with an orthographic camera
  88074. */
  88075. edgesWidthScalerForOrthographic: number;
  88076. /**
  88077. * Define the size of the edges with a perspective camera
  88078. */
  88079. edgesWidthScalerForPerspective: number;
  88080. protected _source: AbstractMesh;
  88081. protected _linesPositions: number[];
  88082. protected _linesNormals: number[];
  88083. protected _linesIndices: number[];
  88084. protected _epsilon: number;
  88085. protected _indicesCount: number;
  88086. protected _lineShader: ShaderMaterial;
  88087. protected _ib: DataBuffer;
  88088. protected _buffers: {
  88089. [key: string]: Nullable<VertexBuffer>;
  88090. };
  88091. protected _checkVerticesInsteadOfIndices: boolean;
  88092. private _meshRebuildObserver;
  88093. private _meshDisposeObserver;
  88094. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  88095. isEnabled: boolean;
  88096. /**
  88097. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  88098. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  88099. * @param source Mesh used to create edges
  88100. * @param epsilon sum of angles in adjacency to check for edge
  88101. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  88102. * @param generateEdgesLines - should generate Lines or only prepare resources.
  88103. */
  88104. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  88105. protected _prepareRessources(): void;
  88106. /** @hidden */
  88107. _rebuild(): void;
  88108. /**
  88109. * Releases the required resources for the edges renderer
  88110. */
  88111. dispose(): void;
  88112. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  88113. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  88114. /**
  88115. * Checks if the pair of p0 and p1 is en edge
  88116. * @param faceIndex
  88117. * @param edge
  88118. * @param faceNormals
  88119. * @param p0
  88120. * @param p1
  88121. * @private
  88122. */
  88123. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  88124. /**
  88125. * push line into the position, normal and index buffer
  88126. * @protected
  88127. */
  88128. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  88129. /**
  88130. * Generates lines edges from adjacencjes
  88131. * @private
  88132. */
  88133. _generateEdgesLines(): void;
  88134. /**
  88135. * Checks wether or not the edges renderer is ready to render.
  88136. * @return true if ready, otherwise false.
  88137. */
  88138. isReady(): boolean;
  88139. /**
  88140. * Renders the edges of the attached mesh,
  88141. */
  88142. render(): void;
  88143. }
  88144. /**
  88145. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  88146. */
  88147. export class LineEdgesRenderer extends EdgesRenderer {
  88148. /**
  88149. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  88150. * @param source LineMesh used to generate edges
  88151. * @param epsilon not important (specified angle for edge detection)
  88152. * @param checkVerticesInsteadOfIndices not important for LineMesh
  88153. */
  88154. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  88155. /**
  88156. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  88157. */
  88158. _generateEdgesLines(): void;
  88159. }
  88160. }
  88161. declare module BABYLON {
  88162. /**
  88163. * This represents the object necessary to create a rendering group.
  88164. * This is exclusively used and created by the rendering manager.
  88165. * To modify the behavior, you use the available helpers in your scene or meshes.
  88166. * @hidden
  88167. */
  88168. export class RenderingGroup {
  88169. index: number;
  88170. private static _zeroVector;
  88171. private _scene;
  88172. private _opaqueSubMeshes;
  88173. private _transparentSubMeshes;
  88174. private _alphaTestSubMeshes;
  88175. private _depthOnlySubMeshes;
  88176. private _particleSystems;
  88177. private _spriteManagers;
  88178. private _opaqueSortCompareFn;
  88179. private _alphaTestSortCompareFn;
  88180. private _transparentSortCompareFn;
  88181. private _renderOpaque;
  88182. private _renderAlphaTest;
  88183. private _renderTransparent;
  88184. /** @hidden */
  88185. _edgesRenderers: SmartArray<IEdgesRenderer>;
  88186. onBeforeTransparentRendering: () => void;
  88187. /**
  88188. * Set the opaque sort comparison function.
  88189. * If null the sub meshes will be render in the order they were created
  88190. */
  88191. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  88192. /**
  88193. * Set the alpha test sort comparison function.
  88194. * If null the sub meshes will be render in the order they were created
  88195. */
  88196. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  88197. /**
  88198. * Set the transparent sort comparison function.
  88199. * If null the sub meshes will be render in the order they were created
  88200. */
  88201. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  88202. /**
  88203. * Creates a new rendering group.
  88204. * @param index The rendering group index
  88205. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  88206. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  88207. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  88208. */
  88209. 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>);
  88210. /**
  88211. * Render all the sub meshes contained in the group.
  88212. * @param customRenderFunction Used to override the default render behaviour of the group.
  88213. * @returns true if rendered some submeshes.
  88214. */
  88215. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  88216. /**
  88217. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  88218. * @param subMeshes The submeshes to render
  88219. */
  88220. private renderOpaqueSorted;
  88221. /**
  88222. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  88223. * @param subMeshes The submeshes to render
  88224. */
  88225. private renderAlphaTestSorted;
  88226. /**
  88227. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  88228. * @param subMeshes The submeshes to render
  88229. */
  88230. private renderTransparentSorted;
  88231. /**
  88232. * Renders the submeshes in a specified order.
  88233. * @param subMeshes The submeshes to sort before render
  88234. * @param sortCompareFn The comparison function use to sort
  88235. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  88236. * @param transparent Specifies to activate blending if true
  88237. */
  88238. private static renderSorted;
  88239. /**
  88240. * Renders the submeshes in the order they were dispatched (no sort applied).
  88241. * @param subMeshes The submeshes to render
  88242. */
  88243. private static renderUnsorted;
  88244. /**
  88245. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  88246. * are rendered back to front if in the same alpha index.
  88247. *
  88248. * @param a The first submesh
  88249. * @param b The second submesh
  88250. * @returns The result of the comparison
  88251. */
  88252. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  88253. /**
  88254. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  88255. * are rendered back to front.
  88256. *
  88257. * @param a The first submesh
  88258. * @param b The second submesh
  88259. * @returns The result of the comparison
  88260. */
  88261. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  88262. /**
  88263. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  88264. * are rendered front to back (prevent overdraw).
  88265. *
  88266. * @param a The first submesh
  88267. * @param b The second submesh
  88268. * @returns The result of the comparison
  88269. */
  88270. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  88271. /**
  88272. * Resets the different lists of submeshes to prepare a new frame.
  88273. */
  88274. prepare(): void;
  88275. dispose(): void;
  88276. /**
  88277. * Inserts the submesh in its correct queue depending on its material.
  88278. * @param subMesh The submesh to dispatch
  88279. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  88280. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  88281. */
  88282. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  88283. dispatchSprites(spriteManager: ISpriteManager): void;
  88284. dispatchParticles(particleSystem: IParticleSystem): void;
  88285. private _renderParticles;
  88286. private _renderSprites;
  88287. }
  88288. }
  88289. declare module BABYLON {
  88290. /**
  88291. * Interface describing the different options available in the rendering manager
  88292. * regarding Auto Clear between groups.
  88293. */
  88294. export interface IRenderingManagerAutoClearSetup {
  88295. /**
  88296. * Defines whether or not autoclear is enable.
  88297. */
  88298. autoClear: boolean;
  88299. /**
  88300. * Defines whether or not to autoclear the depth buffer.
  88301. */
  88302. depth: boolean;
  88303. /**
  88304. * Defines whether or not to autoclear the stencil buffer.
  88305. */
  88306. stencil: boolean;
  88307. }
  88308. /**
  88309. * This class is used by the onRenderingGroupObservable
  88310. */
  88311. export class RenderingGroupInfo {
  88312. /**
  88313. * The Scene that being rendered
  88314. */
  88315. scene: Scene;
  88316. /**
  88317. * The camera currently used for the rendering pass
  88318. */
  88319. camera: Nullable<Camera>;
  88320. /**
  88321. * The ID of the renderingGroup being processed
  88322. */
  88323. renderingGroupId: number;
  88324. }
  88325. /**
  88326. * This is the manager responsible of all the rendering for meshes sprites and particles.
  88327. * It is enable to manage the different groups as well as the different necessary sort functions.
  88328. * This should not be used directly aside of the few static configurations
  88329. */
  88330. export class RenderingManager {
  88331. /**
  88332. * The max id used for rendering groups (not included)
  88333. */
  88334. static MAX_RENDERINGGROUPS: number;
  88335. /**
  88336. * The min id used for rendering groups (included)
  88337. */
  88338. static MIN_RENDERINGGROUPS: number;
  88339. /**
  88340. * Used to globally prevent autoclearing scenes.
  88341. */
  88342. static AUTOCLEAR: boolean;
  88343. /**
  88344. * @hidden
  88345. */
  88346. _useSceneAutoClearSetup: boolean;
  88347. private _scene;
  88348. private _renderingGroups;
  88349. private _depthStencilBufferAlreadyCleaned;
  88350. private _autoClearDepthStencil;
  88351. private _customOpaqueSortCompareFn;
  88352. private _customAlphaTestSortCompareFn;
  88353. private _customTransparentSortCompareFn;
  88354. private _renderingGroupInfo;
  88355. /**
  88356. * Instantiates a new rendering group for a particular scene
  88357. * @param scene Defines the scene the groups belongs to
  88358. */
  88359. constructor(scene: Scene);
  88360. private _clearDepthStencilBuffer;
  88361. /**
  88362. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  88363. * @hidden
  88364. */
  88365. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  88366. /**
  88367. * Resets the different information of the group to prepare a new frame
  88368. * @hidden
  88369. */
  88370. reset(): void;
  88371. /**
  88372. * Dispose and release the group and its associated resources.
  88373. * @hidden
  88374. */
  88375. dispose(): void;
  88376. /**
  88377. * Clear the info related to rendering groups preventing retention points during dispose.
  88378. */
  88379. freeRenderingGroups(): void;
  88380. private _prepareRenderingGroup;
  88381. /**
  88382. * Add a sprite manager to the rendering manager in order to render it this frame.
  88383. * @param spriteManager Define the sprite manager to render
  88384. */
  88385. dispatchSprites(spriteManager: ISpriteManager): void;
  88386. /**
  88387. * Add a particle system to the rendering manager in order to render it this frame.
  88388. * @param particleSystem Define the particle system to render
  88389. */
  88390. dispatchParticles(particleSystem: IParticleSystem): void;
  88391. /**
  88392. * Add a submesh to the manager in order to render it this frame
  88393. * @param subMesh The submesh to dispatch
  88394. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  88395. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  88396. */
  88397. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  88398. /**
  88399. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  88400. * This allowed control for front to back rendering or reversly depending of the special needs.
  88401. *
  88402. * @param renderingGroupId The rendering group id corresponding to its index
  88403. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  88404. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  88405. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  88406. */
  88407. 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;
  88408. /**
  88409. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  88410. *
  88411. * @param renderingGroupId The rendering group id corresponding to its index
  88412. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  88413. * @param depth Automatically clears depth between groups if true and autoClear is true.
  88414. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  88415. */
  88416. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  88417. /**
  88418. * Gets the current auto clear configuration for one rendering group of the rendering
  88419. * manager.
  88420. * @param index the rendering group index to get the information for
  88421. * @returns The auto clear setup for the requested rendering group
  88422. */
  88423. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  88424. }
  88425. }
  88426. declare module BABYLON {
  88427. /**
  88428. * This Helps creating a texture that will be created from a camera in your scene.
  88429. * It is basically a dynamic texture that could be used to create special effects for instance.
  88430. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  88431. */
  88432. export class RenderTargetTexture extends Texture {
  88433. isCube: boolean;
  88434. /**
  88435. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  88436. */
  88437. static readonly REFRESHRATE_RENDER_ONCE: number;
  88438. /**
  88439. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  88440. */
  88441. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  88442. /**
  88443. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  88444. * the central point of your effect and can save a lot of performances.
  88445. */
  88446. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  88447. /**
  88448. * Use this predicate to dynamically define the list of mesh you want to render.
  88449. * If set, the renderList property will be overwritten.
  88450. */
  88451. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  88452. private _renderList;
  88453. /**
  88454. * Use this list to define the list of mesh you want to render.
  88455. */
  88456. renderList: Nullable<Array<AbstractMesh>>;
  88457. private _hookArray;
  88458. /**
  88459. * Define if particles should be rendered in your texture.
  88460. */
  88461. renderParticles: boolean;
  88462. /**
  88463. * Define if sprites should be rendered in your texture.
  88464. */
  88465. renderSprites: boolean;
  88466. /**
  88467. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  88468. */
  88469. coordinatesMode: number;
  88470. /**
  88471. * Define the camera used to render the texture.
  88472. */
  88473. activeCamera: Nullable<Camera>;
  88474. /**
  88475. * Override the render function of the texture with your own one.
  88476. */
  88477. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  88478. /**
  88479. * Define if camera post processes should be use while rendering the texture.
  88480. */
  88481. useCameraPostProcesses: boolean;
  88482. /**
  88483. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  88484. */
  88485. ignoreCameraViewport: boolean;
  88486. private _postProcessManager;
  88487. private _postProcesses;
  88488. private _resizeObserver;
  88489. /**
  88490. * An event triggered when the texture is unbind.
  88491. */
  88492. onBeforeBindObservable: Observable<RenderTargetTexture>;
  88493. /**
  88494. * An event triggered when the texture is unbind.
  88495. */
  88496. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  88497. private _onAfterUnbindObserver;
  88498. /**
  88499. * Set a after unbind callback in the texture.
  88500. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  88501. */
  88502. onAfterUnbind: () => void;
  88503. /**
  88504. * An event triggered before rendering the texture
  88505. */
  88506. onBeforeRenderObservable: Observable<number>;
  88507. private _onBeforeRenderObserver;
  88508. /**
  88509. * Set a before render callback in the texture.
  88510. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  88511. */
  88512. onBeforeRender: (faceIndex: number) => void;
  88513. /**
  88514. * An event triggered after rendering the texture
  88515. */
  88516. onAfterRenderObservable: Observable<number>;
  88517. private _onAfterRenderObserver;
  88518. /**
  88519. * Set a after render callback in the texture.
  88520. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  88521. */
  88522. onAfterRender: (faceIndex: number) => void;
  88523. /**
  88524. * An event triggered after the texture clear
  88525. */
  88526. onClearObservable: Observable<Engine>;
  88527. private _onClearObserver;
  88528. /**
  88529. * Set a clear callback in the texture.
  88530. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  88531. */
  88532. onClear: (Engine: Engine) => void;
  88533. /**
  88534. * An event triggered when the texture is resized.
  88535. */
  88536. onResizeObservable: Observable<RenderTargetTexture>;
  88537. /**
  88538. * Define the clear color of the Render Target if it should be different from the scene.
  88539. */
  88540. clearColor: Color4;
  88541. protected _size: number | {
  88542. width: number;
  88543. height: number;
  88544. };
  88545. protected _initialSizeParameter: number | {
  88546. width: number;
  88547. height: number;
  88548. } | {
  88549. ratio: number;
  88550. };
  88551. protected _sizeRatio: Nullable<number>;
  88552. /** @hidden */
  88553. _generateMipMaps: boolean;
  88554. protected _renderingManager: RenderingManager;
  88555. /** @hidden */
  88556. _waitingRenderList: string[];
  88557. protected _doNotChangeAspectRatio: boolean;
  88558. protected _currentRefreshId: number;
  88559. protected _refreshRate: number;
  88560. protected _textureMatrix: Matrix;
  88561. protected _samples: number;
  88562. protected _renderTargetOptions: RenderTargetCreationOptions;
  88563. /**
  88564. * Gets render target creation options that were used.
  88565. */
  88566. readonly renderTargetOptions: RenderTargetCreationOptions;
  88567. protected _engine: Engine;
  88568. protected _onRatioRescale(): void;
  88569. /**
  88570. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  88571. * It must define where the camera used to render the texture is set
  88572. */
  88573. boundingBoxPosition: Vector3;
  88574. private _boundingBoxSize;
  88575. /**
  88576. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  88577. * When defined, the cubemap will switch to local mode
  88578. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  88579. * @example https://www.babylonjs-playground.com/#RNASML
  88580. */
  88581. boundingBoxSize: Vector3;
  88582. /**
  88583. * In case the RTT has been created with a depth texture, get the associated
  88584. * depth texture.
  88585. * Otherwise, return null.
  88586. */
  88587. depthStencilTexture: Nullable<InternalTexture>;
  88588. /**
  88589. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  88590. * or used a shadow, depth texture...
  88591. * @param name The friendly name of the texture
  88592. * @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)
  88593. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  88594. * @param generateMipMaps True if mip maps need to be generated after render.
  88595. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  88596. * @param type The type of the buffer in the RTT (int, half float, float...)
  88597. * @param isCube True if a cube texture needs to be created
  88598. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  88599. * @param generateDepthBuffer True to generate a depth buffer
  88600. * @param generateStencilBuffer True to generate a stencil buffer
  88601. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  88602. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  88603. * @param delayAllocation if the texture allocation should be delayed (default: false)
  88604. */
  88605. constructor(name: string, size: number | {
  88606. width: number;
  88607. height: number;
  88608. } | {
  88609. ratio: number;
  88610. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  88611. /**
  88612. * Creates a depth stencil texture.
  88613. * This is only available in WebGL 2 or with the depth texture extension available.
  88614. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  88615. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  88616. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  88617. */
  88618. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  88619. private _processSizeParameter;
  88620. /**
  88621. * Define the number of samples to use in case of MSAA.
  88622. * It defaults to one meaning no MSAA has been enabled.
  88623. */
  88624. samples: number;
  88625. /**
  88626. * Resets the refresh counter of the texture and start bak from scratch.
  88627. * Could be useful to regenerate the texture if it is setup to render only once.
  88628. */
  88629. resetRefreshCounter(): void;
  88630. /**
  88631. * Define the refresh rate of the texture or the rendering frequency.
  88632. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  88633. */
  88634. refreshRate: number;
  88635. /**
  88636. * Adds a post process to the render target rendering passes.
  88637. * @param postProcess define the post process to add
  88638. */
  88639. addPostProcess(postProcess: PostProcess): void;
  88640. /**
  88641. * Clear all the post processes attached to the render target
  88642. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  88643. */
  88644. clearPostProcesses(dispose?: boolean): void;
  88645. /**
  88646. * Remove one of the post process from the list of attached post processes to the texture
  88647. * @param postProcess define the post process to remove from the list
  88648. */
  88649. removePostProcess(postProcess: PostProcess): void;
  88650. /** @hidden */
  88651. _shouldRender(): boolean;
  88652. /**
  88653. * Gets the actual render size of the texture.
  88654. * @returns the width of the render size
  88655. */
  88656. getRenderSize(): number;
  88657. /**
  88658. * Gets the actual render width of the texture.
  88659. * @returns the width of the render size
  88660. */
  88661. getRenderWidth(): number;
  88662. /**
  88663. * Gets the actual render height of the texture.
  88664. * @returns the height of the render size
  88665. */
  88666. getRenderHeight(): number;
  88667. /**
  88668. * Get if the texture can be rescaled or not.
  88669. */
  88670. readonly canRescale: boolean;
  88671. /**
  88672. * Resize the texture using a ratio.
  88673. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  88674. */
  88675. scale(ratio: number): void;
  88676. /**
  88677. * Get the texture reflection matrix used to rotate/transform the reflection.
  88678. * @returns the reflection matrix
  88679. */
  88680. getReflectionTextureMatrix(): Matrix;
  88681. /**
  88682. * Resize the texture to a new desired size.
  88683. * Be carrefull as it will recreate all the data in the new texture.
  88684. * @param size Define the new size. It can be:
  88685. * - a number for squared texture,
  88686. * - an object containing { width: number, height: number }
  88687. * - or an object containing a ratio { ratio: number }
  88688. */
  88689. resize(size: number | {
  88690. width: number;
  88691. height: number;
  88692. } | {
  88693. ratio: number;
  88694. }): void;
  88695. /**
  88696. * Renders all the objects from the render list into the texture.
  88697. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  88698. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  88699. */
  88700. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  88701. private _bestReflectionRenderTargetDimension;
  88702. /**
  88703. * @hidden
  88704. * @param faceIndex face index to bind to if this is a cubetexture
  88705. */
  88706. _bindFrameBuffer(faceIndex?: number): void;
  88707. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  88708. private renderToTarget;
  88709. /**
  88710. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  88711. * This allowed control for front to back rendering or reversly depending of the special needs.
  88712. *
  88713. * @param renderingGroupId The rendering group id corresponding to its index
  88714. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  88715. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  88716. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  88717. */
  88718. 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;
  88719. /**
  88720. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  88721. *
  88722. * @param renderingGroupId The rendering group id corresponding to its index
  88723. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  88724. */
  88725. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  88726. /**
  88727. * Clones the texture.
  88728. * @returns the cloned texture
  88729. */
  88730. clone(): RenderTargetTexture;
  88731. /**
  88732. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  88733. * @returns The JSON representation of the texture
  88734. */
  88735. serialize(): any;
  88736. /**
  88737. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  88738. */
  88739. disposeFramebufferObjects(): void;
  88740. /**
  88741. * Dispose the texture and release its associated resources.
  88742. */
  88743. dispose(): void;
  88744. /** @hidden */
  88745. _rebuild(): void;
  88746. /**
  88747. * Clear the info related to rendering groups preventing retention point in material dispose.
  88748. */
  88749. freeRenderingGroups(): void;
  88750. /**
  88751. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  88752. * @returns the view count
  88753. */
  88754. getViewCount(): number;
  88755. }
  88756. }
  88757. declare module BABYLON {
  88758. /**
  88759. * Options for compiling materials.
  88760. */
  88761. export interface IMaterialCompilationOptions {
  88762. /**
  88763. * Defines whether clip planes are enabled.
  88764. */
  88765. clipPlane: boolean;
  88766. /**
  88767. * Defines whether instances are enabled.
  88768. */
  88769. useInstances: boolean;
  88770. }
  88771. /**
  88772. * Base class for the main features of a material in Babylon.js
  88773. */
  88774. export class Material implements IAnimatable {
  88775. /**
  88776. * Returns the triangle fill mode
  88777. */
  88778. static readonly TriangleFillMode: number;
  88779. /**
  88780. * Returns the wireframe mode
  88781. */
  88782. static readonly WireFrameFillMode: number;
  88783. /**
  88784. * Returns the point fill mode
  88785. */
  88786. static readonly PointFillMode: number;
  88787. /**
  88788. * Returns the point list draw mode
  88789. */
  88790. static readonly PointListDrawMode: number;
  88791. /**
  88792. * Returns the line list draw mode
  88793. */
  88794. static readonly LineListDrawMode: number;
  88795. /**
  88796. * Returns the line loop draw mode
  88797. */
  88798. static readonly LineLoopDrawMode: number;
  88799. /**
  88800. * Returns the line strip draw mode
  88801. */
  88802. static readonly LineStripDrawMode: number;
  88803. /**
  88804. * Returns the triangle strip draw mode
  88805. */
  88806. static readonly TriangleStripDrawMode: number;
  88807. /**
  88808. * Returns the triangle fan draw mode
  88809. */
  88810. static readonly TriangleFanDrawMode: number;
  88811. /**
  88812. * Stores the clock-wise side orientation
  88813. */
  88814. static readonly ClockWiseSideOrientation: number;
  88815. /**
  88816. * Stores the counter clock-wise side orientation
  88817. */
  88818. static readonly CounterClockWiseSideOrientation: number;
  88819. /**
  88820. * The dirty texture flag value
  88821. */
  88822. static readonly TextureDirtyFlag: number;
  88823. /**
  88824. * The dirty light flag value
  88825. */
  88826. static readonly LightDirtyFlag: number;
  88827. /**
  88828. * The dirty fresnel flag value
  88829. */
  88830. static readonly FresnelDirtyFlag: number;
  88831. /**
  88832. * The dirty attribute flag value
  88833. */
  88834. static readonly AttributesDirtyFlag: number;
  88835. /**
  88836. * The dirty misc flag value
  88837. */
  88838. static readonly MiscDirtyFlag: number;
  88839. /**
  88840. * The all dirty flag value
  88841. */
  88842. static readonly AllDirtyFlag: number;
  88843. /**
  88844. * The ID of the material
  88845. */
  88846. id: string;
  88847. /**
  88848. * Gets or sets the unique id of the material
  88849. */
  88850. uniqueId: number;
  88851. /**
  88852. * The name of the material
  88853. */
  88854. name: string;
  88855. /**
  88856. * Gets or sets user defined metadata
  88857. */
  88858. metadata: any;
  88859. /**
  88860. * For internal use only. Please do not use.
  88861. */
  88862. reservedDataStore: any;
  88863. /**
  88864. * Specifies if the ready state should be checked on each call
  88865. */
  88866. checkReadyOnEveryCall: boolean;
  88867. /**
  88868. * Specifies if the ready state should be checked once
  88869. */
  88870. checkReadyOnlyOnce: boolean;
  88871. /**
  88872. * The state of the material
  88873. */
  88874. state: string;
  88875. /**
  88876. * The alpha value of the material
  88877. */
  88878. protected _alpha: number;
  88879. /**
  88880. * List of inspectable custom properties (used by the Inspector)
  88881. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  88882. */
  88883. inspectableCustomProperties: IInspectable[];
  88884. /**
  88885. * Sets the alpha value of the material
  88886. */
  88887. /**
  88888. * Gets the alpha value of the material
  88889. */
  88890. alpha: number;
  88891. /**
  88892. * Specifies if back face culling is enabled
  88893. */
  88894. protected _backFaceCulling: boolean;
  88895. /**
  88896. * Sets the back-face culling state
  88897. */
  88898. /**
  88899. * Gets the back-face culling state
  88900. */
  88901. backFaceCulling: boolean;
  88902. /**
  88903. * Stores the value for side orientation
  88904. */
  88905. sideOrientation: number;
  88906. /**
  88907. * Callback triggered when the material is compiled
  88908. */
  88909. onCompiled: Nullable<(effect: Effect) => void>;
  88910. /**
  88911. * Callback triggered when an error occurs
  88912. */
  88913. onError: Nullable<(effect: Effect, errors: string) => void>;
  88914. /**
  88915. * Callback triggered to get the render target textures
  88916. */
  88917. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  88918. /**
  88919. * Gets a boolean indicating that current material needs to register RTT
  88920. */
  88921. readonly hasRenderTargetTextures: boolean;
  88922. /**
  88923. * Specifies if the material should be serialized
  88924. */
  88925. doNotSerialize: boolean;
  88926. /**
  88927. * @hidden
  88928. */
  88929. _storeEffectOnSubMeshes: boolean;
  88930. /**
  88931. * Stores the animations for the material
  88932. */
  88933. animations: Nullable<Array<Animation>>;
  88934. /**
  88935. * An event triggered when the material is disposed
  88936. */
  88937. onDisposeObservable: Observable<Material>;
  88938. /**
  88939. * An observer which watches for dispose events
  88940. */
  88941. private _onDisposeObserver;
  88942. private _onUnBindObservable;
  88943. /**
  88944. * Called during a dispose event
  88945. */
  88946. onDispose: () => void;
  88947. private _onBindObservable;
  88948. /**
  88949. * An event triggered when the material is bound
  88950. */
  88951. readonly onBindObservable: Observable<AbstractMesh>;
  88952. /**
  88953. * An observer which watches for bind events
  88954. */
  88955. private _onBindObserver;
  88956. /**
  88957. * Called during a bind event
  88958. */
  88959. onBind: (Mesh: AbstractMesh) => void;
  88960. /**
  88961. * An event triggered when the material is unbound
  88962. */
  88963. readonly onUnBindObservable: Observable<Material>;
  88964. /**
  88965. * Stores the value of the alpha mode
  88966. */
  88967. private _alphaMode;
  88968. /**
  88969. * Sets the value of the alpha mode.
  88970. *
  88971. * | Value | Type | Description |
  88972. * | --- | --- | --- |
  88973. * | 0 | ALPHA_DISABLE | |
  88974. * | 1 | ALPHA_ADD | |
  88975. * | 2 | ALPHA_COMBINE | |
  88976. * | 3 | ALPHA_SUBTRACT | |
  88977. * | 4 | ALPHA_MULTIPLY | |
  88978. * | 5 | ALPHA_MAXIMIZED | |
  88979. * | 6 | ALPHA_ONEONE | |
  88980. * | 7 | ALPHA_PREMULTIPLIED | |
  88981. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  88982. * | 9 | ALPHA_INTERPOLATE | |
  88983. * | 10 | ALPHA_SCREENMODE | |
  88984. *
  88985. */
  88986. /**
  88987. * Gets the value of the alpha mode
  88988. */
  88989. alphaMode: number;
  88990. /**
  88991. * Stores the state of the need depth pre-pass value
  88992. */
  88993. private _needDepthPrePass;
  88994. /**
  88995. * Sets the need depth pre-pass value
  88996. */
  88997. /**
  88998. * Gets the depth pre-pass value
  88999. */
  89000. needDepthPrePass: boolean;
  89001. /**
  89002. * Specifies if depth writing should be disabled
  89003. */
  89004. disableDepthWrite: boolean;
  89005. /**
  89006. * Specifies if depth writing should be forced
  89007. */
  89008. forceDepthWrite: boolean;
  89009. /**
  89010. * Specifies the depth function that should be used. 0 means the default engine function
  89011. */
  89012. depthFunction: number;
  89013. /**
  89014. * Specifies if there should be a separate pass for culling
  89015. */
  89016. separateCullingPass: boolean;
  89017. /**
  89018. * Stores the state specifing if fog should be enabled
  89019. */
  89020. private _fogEnabled;
  89021. /**
  89022. * Sets the state for enabling fog
  89023. */
  89024. /**
  89025. * Gets the value of the fog enabled state
  89026. */
  89027. fogEnabled: boolean;
  89028. /**
  89029. * Stores the size of points
  89030. */
  89031. pointSize: number;
  89032. /**
  89033. * Stores the z offset value
  89034. */
  89035. zOffset: number;
  89036. /**
  89037. * Gets a value specifying if wireframe mode is enabled
  89038. */
  89039. /**
  89040. * Sets the state of wireframe mode
  89041. */
  89042. wireframe: boolean;
  89043. /**
  89044. * Gets the value specifying if point clouds are enabled
  89045. */
  89046. /**
  89047. * Sets the state of point cloud mode
  89048. */
  89049. pointsCloud: boolean;
  89050. /**
  89051. * Gets the material fill mode
  89052. */
  89053. /**
  89054. * Sets the material fill mode
  89055. */
  89056. fillMode: number;
  89057. /**
  89058. * @hidden
  89059. * Stores the effects for the material
  89060. */
  89061. _effect: Nullable<Effect>;
  89062. /**
  89063. * @hidden
  89064. * Specifies if the material was previously ready
  89065. */
  89066. _wasPreviouslyReady: boolean;
  89067. /**
  89068. * Specifies if uniform buffers should be used
  89069. */
  89070. private _useUBO;
  89071. /**
  89072. * Stores a reference to the scene
  89073. */
  89074. private _scene;
  89075. /**
  89076. * Stores the fill mode state
  89077. */
  89078. private _fillMode;
  89079. /**
  89080. * Specifies if the depth write state should be cached
  89081. */
  89082. private _cachedDepthWriteState;
  89083. /**
  89084. * Specifies if the depth function state should be cached
  89085. */
  89086. private _cachedDepthFunctionState;
  89087. /**
  89088. * Stores the uniform buffer
  89089. */
  89090. protected _uniformBuffer: UniformBuffer;
  89091. /** @hidden */
  89092. _indexInSceneMaterialArray: number;
  89093. /** @hidden */
  89094. meshMap: Nullable<{
  89095. [id: string]: AbstractMesh | undefined;
  89096. }>;
  89097. /**
  89098. * Creates a material instance
  89099. * @param name defines the name of the material
  89100. * @param scene defines the scene to reference
  89101. * @param doNotAdd specifies if the material should be added to the scene
  89102. */
  89103. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  89104. /**
  89105. * Returns a string representation of the current material
  89106. * @param fullDetails defines a boolean indicating which levels of logging is desired
  89107. * @returns a string with material information
  89108. */
  89109. toString(fullDetails?: boolean): string;
  89110. /**
  89111. * Gets the class name of the material
  89112. * @returns a string with the class name of the material
  89113. */
  89114. getClassName(): string;
  89115. /**
  89116. * Specifies if updates for the material been locked
  89117. */
  89118. readonly isFrozen: boolean;
  89119. /**
  89120. * Locks updates for the material
  89121. */
  89122. freeze(): void;
  89123. /**
  89124. * Unlocks updates for the material
  89125. */
  89126. unfreeze(): void;
  89127. /**
  89128. * Specifies if the material is ready to be used
  89129. * @param mesh defines the mesh to check
  89130. * @param useInstances specifies if instances should be used
  89131. * @returns a boolean indicating if the material is ready to be used
  89132. */
  89133. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  89134. /**
  89135. * Specifies that the submesh is ready to be used
  89136. * @param mesh defines the mesh to check
  89137. * @param subMesh defines which submesh to check
  89138. * @param useInstances specifies that instances should be used
  89139. * @returns a boolean indicating that the submesh is ready or not
  89140. */
  89141. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  89142. /**
  89143. * Returns the material effect
  89144. * @returns the effect associated with the material
  89145. */
  89146. getEffect(): Nullable<Effect>;
  89147. /**
  89148. * Returns the current scene
  89149. * @returns a Scene
  89150. */
  89151. getScene(): Scene;
  89152. /**
  89153. * Specifies if the material will require alpha blending
  89154. * @returns a boolean specifying if alpha blending is needed
  89155. */
  89156. needAlphaBlending(): boolean;
  89157. /**
  89158. * Specifies if the mesh will require alpha blending
  89159. * @param mesh defines the mesh to check
  89160. * @returns a boolean specifying if alpha blending is needed for the mesh
  89161. */
  89162. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  89163. /**
  89164. * Specifies if this material should be rendered in alpha test mode
  89165. * @returns a boolean specifying if an alpha test is needed.
  89166. */
  89167. needAlphaTesting(): boolean;
  89168. /**
  89169. * Gets the texture used for the alpha test
  89170. * @returns the texture to use for alpha testing
  89171. */
  89172. getAlphaTestTexture(): Nullable<BaseTexture>;
  89173. /**
  89174. * Marks the material to indicate that it needs to be re-calculated
  89175. */
  89176. markDirty(): void;
  89177. /** @hidden */
  89178. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  89179. /**
  89180. * Binds the material to the mesh
  89181. * @param world defines the world transformation matrix
  89182. * @param mesh defines the mesh to bind the material to
  89183. */
  89184. bind(world: Matrix, mesh?: Mesh): void;
  89185. /**
  89186. * Binds the submesh to the material
  89187. * @param world defines the world transformation matrix
  89188. * @param mesh defines the mesh containing the submesh
  89189. * @param subMesh defines the submesh to bind the material to
  89190. */
  89191. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  89192. /**
  89193. * Binds the world matrix to the material
  89194. * @param world defines the world transformation matrix
  89195. */
  89196. bindOnlyWorldMatrix(world: Matrix): void;
  89197. /**
  89198. * Binds the scene's uniform buffer to the effect.
  89199. * @param effect defines the effect to bind to the scene uniform buffer
  89200. * @param sceneUbo defines the uniform buffer storing scene data
  89201. */
  89202. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  89203. /**
  89204. * Binds the view matrix to the effect
  89205. * @param effect defines the effect to bind the view matrix to
  89206. */
  89207. bindView(effect: Effect): void;
  89208. /**
  89209. * Binds the view projection matrix to the effect
  89210. * @param effect defines the effect to bind the view projection matrix to
  89211. */
  89212. bindViewProjection(effect: Effect): void;
  89213. /**
  89214. * Specifies if material alpha testing should be turned on for the mesh
  89215. * @param mesh defines the mesh to check
  89216. */
  89217. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  89218. /**
  89219. * Processes to execute after binding the material to a mesh
  89220. * @param mesh defines the rendered mesh
  89221. */
  89222. protected _afterBind(mesh?: Mesh): void;
  89223. /**
  89224. * Unbinds the material from the mesh
  89225. */
  89226. unbind(): void;
  89227. /**
  89228. * Gets the active textures from the material
  89229. * @returns an array of textures
  89230. */
  89231. getActiveTextures(): BaseTexture[];
  89232. /**
  89233. * Specifies if the material uses a texture
  89234. * @param texture defines the texture to check against the material
  89235. * @returns a boolean specifying if the material uses the texture
  89236. */
  89237. hasTexture(texture: BaseTexture): boolean;
  89238. /**
  89239. * Makes a duplicate of the material, and gives it a new name
  89240. * @param name defines the new name for the duplicated material
  89241. * @returns the cloned material
  89242. */
  89243. clone(name: string): Nullable<Material>;
  89244. /**
  89245. * Gets the meshes bound to the material
  89246. * @returns an array of meshes bound to the material
  89247. */
  89248. getBindedMeshes(): AbstractMesh[];
  89249. /**
  89250. * Force shader compilation
  89251. * @param mesh defines the mesh associated with this material
  89252. * @param onCompiled defines a function to execute once the material is compiled
  89253. * @param options defines the options to configure the compilation
  89254. * @param onError defines a function to execute if the material fails compiling
  89255. */
  89256. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  89257. /**
  89258. * Force shader compilation
  89259. * @param mesh defines the mesh that will use this material
  89260. * @param options defines additional options for compiling the shaders
  89261. * @returns a promise that resolves when the compilation completes
  89262. */
  89263. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  89264. private static readonly _AllDirtyCallBack;
  89265. private static readonly _ImageProcessingDirtyCallBack;
  89266. private static readonly _TextureDirtyCallBack;
  89267. private static readonly _FresnelDirtyCallBack;
  89268. private static readonly _MiscDirtyCallBack;
  89269. private static readonly _LightsDirtyCallBack;
  89270. private static readonly _AttributeDirtyCallBack;
  89271. private static _FresnelAndMiscDirtyCallBack;
  89272. private static _TextureAndMiscDirtyCallBack;
  89273. private static readonly _DirtyCallbackArray;
  89274. private static readonly _RunDirtyCallBacks;
  89275. /**
  89276. * Marks a define in the material to indicate that it needs to be re-computed
  89277. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  89278. */
  89279. markAsDirty(flag: number): void;
  89280. /**
  89281. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  89282. * @param func defines a function which checks material defines against the submeshes
  89283. */
  89284. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  89285. /**
  89286. * Indicates that we need to re-calculated for all submeshes
  89287. */
  89288. protected _markAllSubMeshesAsAllDirty(): void;
  89289. /**
  89290. * Indicates that image processing needs to be re-calculated for all submeshes
  89291. */
  89292. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  89293. /**
  89294. * Indicates that textures need to be re-calculated for all submeshes
  89295. */
  89296. protected _markAllSubMeshesAsTexturesDirty(): void;
  89297. /**
  89298. * Indicates that fresnel needs to be re-calculated for all submeshes
  89299. */
  89300. protected _markAllSubMeshesAsFresnelDirty(): void;
  89301. /**
  89302. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  89303. */
  89304. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  89305. /**
  89306. * Indicates that lights need to be re-calculated for all submeshes
  89307. */
  89308. protected _markAllSubMeshesAsLightsDirty(): void;
  89309. /**
  89310. * Indicates that attributes need to be re-calculated for all submeshes
  89311. */
  89312. protected _markAllSubMeshesAsAttributesDirty(): void;
  89313. /**
  89314. * Indicates that misc needs to be re-calculated for all submeshes
  89315. */
  89316. protected _markAllSubMeshesAsMiscDirty(): void;
  89317. /**
  89318. * Indicates that textures and misc need to be re-calculated for all submeshes
  89319. */
  89320. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  89321. /**
  89322. * Disposes the material
  89323. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  89324. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  89325. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  89326. */
  89327. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  89328. /** @hidden */
  89329. private releaseVertexArrayObject;
  89330. /**
  89331. * Serializes this material
  89332. * @returns the serialized material object
  89333. */
  89334. serialize(): any;
  89335. /**
  89336. * Creates a material from parsed material data
  89337. * @param parsedMaterial defines parsed material data
  89338. * @param scene defines the hosting scene
  89339. * @param rootUrl defines the root URL to use to load textures
  89340. * @returns a new material
  89341. */
  89342. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  89343. }
  89344. }
  89345. declare module BABYLON {
  89346. /**
  89347. * A multi-material is used to apply different materials to different parts of the same object without the need of
  89348. * separate meshes. This can be use to improve performances.
  89349. * @see http://doc.babylonjs.com/how_to/multi_materials
  89350. */
  89351. export class MultiMaterial extends Material {
  89352. private _subMaterials;
  89353. /**
  89354. * Gets or Sets the list of Materials used within the multi material.
  89355. * They need to be ordered according to the submeshes order in the associated mesh
  89356. */
  89357. subMaterials: Nullable<Material>[];
  89358. /**
  89359. * Function used to align with Node.getChildren()
  89360. * @returns the list of Materials used within the multi material
  89361. */
  89362. getChildren(): Nullable<Material>[];
  89363. /**
  89364. * Instantiates a new Multi Material
  89365. * A multi-material is used to apply different materials to different parts of the same object without the need of
  89366. * separate meshes. This can be use to improve performances.
  89367. * @see http://doc.babylonjs.com/how_to/multi_materials
  89368. * @param name Define the name in the scene
  89369. * @param scene Define the scene the material belongs to
  89370. */
  89371. constructor(name: string, scene: Scene);
  89372. private _hookArray;
  89373. /**
  89374. * Get one of the submaterial by its index in the submaterials array
  89375. * @param index The index to look the sub material at
  89376. * @returns The Material if the index has been defined
  89377. */
  89378. getSubMaterial(index: number): Nullable<Material>;
  89379. /**
  89380. * Get the list of active textures for the whole sub materials list.
  89381. * @returns All the textures that will be used during the rendering
  89382. */
  89383. getActiveTextures(): BaseTexture[];
  89384. /**
  89385. * Gets the current class name of the material e.g. "MultiMaterial"
  89386. * Mainly use in serialization.
  89387. * @returns the class name
  89388. */
  89389. getClassName(): string;
  89390. /**
  89391. * Checks if the material is ready to render the requested sub mesh
  89392. * @param mesh Define the mesh the submesh belongs to
  89393. * @param subMesh Define the sub mesh to look readyness for
  89394. * @param useInstances Define whether or not the material is used with instances
  89395. * @returns true if ready, otherwise false
  89396. */
  89397. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  89398. /**
  89399. * Clones the current material and its related sub materials
  89400. * @param name Define the name of the newly cloned material
  89401. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  89402. * @returns the cloned material
  89403. */
  89404. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  89405. /**
  89406. * Serializes the materials into a JSON representation.
  89407. * @returns the JSON representation
  89408. */
  89409. serialize(): any;
  89410. /**
  89411. * Dispose the material and release its associated resources
  89412. * @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)
  89413. * @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)
  89414. * @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)
  89415. */
  89416. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  89417. /**
  89418. * Creates a MultiMaterial from parsed MultiMaterial data.
  89419. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  89420. * @param scene defines the hosting scene
  89421. * @returns a new MultiMaterial
  89422. */
  89423. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  89424. }
  89425. }
  89426. declare module BABYLON {
  89427. /**
  89428. * Base class for submeshes
  89429. */
  89430. export class BaseSubMesh {
  89431. /** @hidden */
  89432. _materialDefines: Nullable<MaterialDefines>;
  89433. /** @hidden */
  89434. _materialEffect: Nullable<Effect>;
  89435. /**
  89436. * Gets associated effect
  89437. */
  89438. readonly effect: Nullable<Effect>;
  89439. /**
  89440. * Sets associated effect (effect used to render this submesh)
  89441. * @param effect defines the effect to associate with
  89442. * @param defines defines the set of defines used to compile this effect
  89443. */
  89444. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  89445. }
  89446. /**
  89447. * Defines a subdivision inside a mesh
  89448. */
  89449. export class SubMesh extends BaseSubMesh implements ICullable {
  89450. /** the material index to use */
  89451. materialIndex: number;
  89452. /** vertex index start */
  89453. verticesStart: number;
  89454. /** vertices count */
  89455. verticesCount: number;
  89456. /** index start */
  89457. indexStart: number;
  89458. /** indices count */
  89459. indexCount: number;
  89460. /** @hidden */
  89461. _linesIndexCount: number;
  89462. private _mesh;
  89463. private _renderingMesh;
  89464. private _boundingInfo;
  89465. private _linesIndexBuffer;
  89466. /** @hidden */
  89467. _lastColliderWorldVertices: Nullable<Vector3[]>;
  89468. /** @hidden */
  89469. _trianglePlanes: Plane[];
  89470. /** @hidden */
  89471. _lastColliderTransformMatrix: Nullable<Matrix>;
  89472. /** @hidden */
  89473. _renderId: number;
  89474. /** @hidden */
  89475. _alphaIndex: number;
  89476. /** @hidden */
  89477. _distanceToCamera: number;
  89478. /** @hidden */
  89479. _id: number;
  89480. private _currentMaterial;
  89481. /**
  89482. * Add a new submesh to a mesh
  89483. * @param materialIndex defines the material index to use
  89484. * @param verticesStart defines vertex index start
  89485. * @param verticesCount defines vertices count
  89486. * @param indexStart defines index start
  89487. * @param indexCount defines indices count
  89488. * @param mesh defines the parent mesh
  89489. * @param renderingMesh defines an optional rendering mesh
  89490. * @param createBoundingBox defines if bounding box should be created for this submesh
  89491. * @returns the new submesh
  89492. */
  89493. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  89494. /**
  89495. * Creates a new submesh
  89496. * @param materialIndex defines the material index to use
  89497. * @param verticesStart defines vertex index start
  89498. * @param verticesCount defines vertices count
  89499. * @param indexStart defines index start
  89500. * @param indexCount defines indices count
  89501. * @param mesh defines the parent mesh
  89502. * @param renderingMesh defines an optional rendering mesh
  89503. * @param createBoundingBox defines if bounding box should be created for this submesh
  89504. */
  89505. constructor(
  89506. /** the material index to use */
  89507. materialIndex: number,
  89508. /** vertex index start */
  89509. verticesStart: number,
  89510. /** vertices count */
  89511. verticesCount: number,
  89512. /** index start */
  89513. indexStart: number,
  89514. /** indices count */
  89515. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  89516. /**
  89517. * Returns true if this submesh covers the entire parent mesh
  89518. * @ignorenaming
  89519. */
  89520. readonly IsGlobal: boolean;
  89521. /**
  89522. * Returns the submesh BoudingInfo object
  89523. * @returns current bounding info (or mesh's one if the submesh is global)
  89524. */
  89525. getBoundingInfo(): BoundingInfo;
  89526. /**
  89527. * Sets the submesh BoundingInfo
  89528. * @param boundingInfo defines the new bounding info to use
  89529. * @returns the SubMesh
  89530. */
  89531. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  89532. /**
  89533. * Returns the mesh of the current submesh
  89534. * @return the parent mesh
  89535. */
  89536. getMesh(): AbstractMesh;
  89537. /**
  89538. * Returns the rendering mesh of the submesh
  89539. * @returns the rendering mesh (could be different from parent mesh)
  89540. */
  89541. getRenderingMesh(): Mesh;
  89542. /**
  89543. * Returns the submesh material
  89544. * @returns null or the current material
  89545. */
  89546. getMaterial(): Nullable<Material>;
  89547. /**
  89548. * Sets a new updated BoundingInfo object to the submesh
  89549. * @param data defines an optional position array to use to determine the bounding info
  89550. * @returns the SubMesh
  89551. */
  89552. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  89553. /** @hidden */
  89554. _checkCollision(collider: Collider): boolean;
  89555. /**
  89556. * Updates the submesh BoundingInfo
  89557. * @param world defines the world matrix to use to update the bounding info
  89558. * @returns the submesh
  89559. */
  89560. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  89561. /**
  89562. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  89563. * @param frustumPlanes defines the frustum planes
  89564. * @returns true if the submesh is intersecting with the frustum
  89565. */
  89566. isInFrustum(frustumPlanes: Plane[]): boolean;
  89567. /**
  89568. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  89569. * @param frustumPlanes defines the frustum planes
  89570. * @returns true if the submesh is inside the frustum
  89571. */
  89572. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  89573. /**
  89574. * Renders the submesh
  89575. * @param enableAlphaMode defines if alpha needs to be used
  89576. * @returns the submesh
  89577. */
  89578. render(enableAlphaMode: boolean): SubMesh;
  89579. /**
  89580. * @hidden
  89581. */
  89582. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  89583. /**
  89584. * Checks if the submesh intersects with a ray
  89585. * @param ray defines the ray to test
  89586. * @returns true is the passed ray intersects the submesh bounding box
  89587. */
  89588. canIntersects(ray: Ray): boolean;
  89589. /**
  89590. * Intersects current submesh with a ray
  89591. * @param ray defines the ray to test
  89592. * @param positions defines mesh's positions array
  89593. * @param indices defines mesh's indices array
  89594. * @param fastCheck defines if only bounding info should be used
  89595. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  89596. * @returns intersection info or null if no intersection
  89597. */
  89598. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  89599. /** @hidden */
  89600. private _intersectLines;
  89601. /** @hidden */
  89602. private _intersectUnIndexedLines;
  89603. /** @hidden */
  89604. private _intersectTriangles;
  89605. /** @hidden */
  89606. private _intersectUnIndexedTriangles;
  89607. /** @hidden */
  89608. _rebuild(): void;
  89609. /**
  89610. * Creates a new submesh from the passed mesh
  89611. * @param newMesh defines the new hosting mesh
  89612. * @param newRenderingMesh defines an optional rendering mesh
  89613. * @returns the new submesh
  89614. */
  89615. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  89616. /**
  89617. * Release associated resources
  89618. */
  89619. dispose(): void;
  89620. /**
  89621. * Gets the class name
  89622. * @returns the string "SubMesh".
  89623. */
  89624. getClassName(): string;
  89625. /**
  89626. * Creates a new submesh from indices data
  89627. * @param materialIndex the index of the main mesh material
  89628. * @param startIndex the index where to start the copy in the mesh indices array
  89629. * @param indexCount the number of indices to copy then from the startIndex
  89630. * @param mesh the main mesh to create the submesh from
  89631. * @param renderingMesh the optional rendering mesh
  89632. * @returns a new submesh
  89633. */
  89634. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  89635. }
  89636. }
  89637. declare module BABYLON {
  89638. /**
  89639. * Class used to represent data loading progression
  89640. */
  89641. export class SceneLoaderFlags {
  89642. private static _ForceFullSceneLoadingForIncremental;
  89643. private static _ShowLoadingScreen;
  89644. private static _CleanBoneMatrixWeights;
  89645. private static _loggingLevel;
  89646. /**
  89647. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  89648. */
  89649. static ForceFullSceneLoadingForIncremental: boolean;
  89650. /**
  89651. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  89652. */
  89653. static ShowLoadingScreen: boolean;
  89654. /**
  89655. * Defines the current logging level (while loading the scene)
  89656. * @ignorenaming
  89657. */
  89658. static loggingLevel: number;
  89659. /**
  89660. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  89661. */
  89662. static CleanBoneMatrixWeights: boolean;
  89663. }
  89664. }
  89665. declare module BABYLON {
  89666. /**
  89667. * Class used to store geometry data (vertex buffers + index buffer)
  89668. */
  89669. export class Geometry implements IGetSetVerticesData {
  89670. /**
  89671. * Gets or sets the ID of the geometry
  89672. */
  89673. id: string;
  89674. /**
  89675. * Gets or sets the unique ID of the geometry
  89676. */
  89677. uniqueId: number;
  89678. /**
  89679. * Gets the delay loading state of the geometry (none by default which means not delayed)
  89680. */
  89681. delayLoadState: number;
  89682. /**
  89683. * Gets the file containing the data to load when running in delay load state
  89684. */
  89685. delayLoadingFile: Nullable<string>;
  89686. /**
  89687. * Callback called when the geometry is updated
  89688. */
  89689. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  89690. private _scene;
  89691. private _engine;
  89692. private _meshes;
  89693. private _totalVertices;
  89694. /** @hidden */
  89695. _indices: IndicesArray;
  89696. /** @hidden */
  89697. _vertexBuffers: {
  89698. [key: string]: VertexBuffer;
  89699. };
  89700. private _isDisposed;
  89701. private _extend;
  89702. private _boundingBias;
  89703. /** @hidden */
  89704. _delayInfo: Array<string>;
  89705. private _indexBuffer;
  89706. private _indexBufferIsUpdatable;
  89707. /** @hidden */
  89708. _boundingInfo: Nullable<BoundingInfo>;
  89709. /** @hidden */
  89710. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  89711. /** @hidden */
  89712. _softwareSkinningFrameId: number;
  89713. private _vertexArrayObjects;
  89714. private _updatable;
  89715. /** @hidden */
  89716. _positions: Nullable<Vector3[]>;
  89717. /**
  89718. * 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
  89719. */
  89720. /**
  89721. * 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
  89722. */
  89723. boundingBias: Vector2;
  89724. /**
  89725. * Static function used to attach a new empty geometry to a mesh
  89726. * @param mesh defines the mesh to attach the geometry to
  89727. * @returns the new Geometry
  89728. */
  89729. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  89730. /**
  89731. * Creates a new geometry
  89732. * @param id defines the unique ID
  89733. * @param scene defines the hosting scene
  89734. * @param vertexData defines the VertexData used to get geometry data
  89735. * @param updatable defines if geometry must be updatable (false by default)
  89736. * @param mesh defines the mesh that will be associated with the geometry
  89737. */
  89738. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  89739. /**
  89740. * Gets the current extend of the geometry
  89741. */
  89742. readonly extend: {
  89743. minimum: Vector3;
  89744. maximum: Vector3;
  89745. };
  89746. /**
  89747. * Gets the hosting scene
  89748. * @returns the hosting Scene
  89749. */
  89750. getScene(): Scene;
  89751. /**
  89752. * Gets the hosting engine
  89753. * @returns the hosting Engine
  89754. */
  89755. getEngine(): Engine;
  89756. /**
  89757. * Defines if the geometry is ready to use
  89758. * @returns true if the geometry is ready to be used
  89759. */
  89760. isReady(): boolean;
  89761. /**
  89762. * Gets a value indicating that the geometry should not be serialized
  89763. */
  89764. readonly doNotSerialize: boolean;
  89765. /** @hidden */
  89766. _rebuild(): void;
  89767. /**
  89768. * Affects all geometry data in one call
  89769. * @param vertexData defines the geometry data
  89770. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  89771. */
  89772. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  89773. /**
  89774. * Set specific vertex data
  89775. * @param kind defines the data kind (Position, normal, etc...)
  89776. * @param data defines the vertex data to use
  89777. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89778. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89779. */
  89780. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  89781. /**
  89782. * Removes a specific vertex data
  89783. * @param kind defines the data kind (Position, normal, etc...)
  89784. */
  89785. removeVerticesData(kind: string): void;
  89786. /**
  89787. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  89788. * @param buffer defines the vertex buffer to use
  89789. * @param totalVertices defines the total number of vertices for position kind (could be null)
  89790. */
  89791. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  89792. /**
  89793. * Update a specific vertex buffer
  89794. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  89795. * It will do nothing if the buffer is not updatable
  89796. * @param kind defines the data kind (Position, normal, etc...)
  89797. * @param data defines the data to use
  89798. * @param offset defines the offset in the target buffer where to store the data
  89799. * @param useBytes set to true if the offset is in bytes
  89800. */
  89801. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  89802. /**
  89803. * Update a specific vertex buffer
  89804. * This function will create a new buffer if the current one is not updatable
  89805. * @param kind defines the data kind (Position, normal, etc...)
  89806. * @param data defines the data to use
  89807. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  89808. */
  89809. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  89810. private _updateBoundingInfo;
  89811. /** @hidden */
  89812. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  89813. /**
  89814. * Gets total number of vertices
  89815. * @returns the total number of vertices
  89816. */
  89817. getTotalVertices(): number;
  89818. /**
  89819. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89820. * @param kind defines the data kind (Position, normal, etc...)
  89821. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89822. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89823. * @returns a float array containing vertex data
  89824. */
  89825. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89826. /**
  89827. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  89828. * @param kind defines the data kind (Position, normal, etc...)
  89829. * @returns true if the vertex buffer with the specified kind is updatable
  89830. */
  89831. isVertexBufferUpdatable(kind: string): boolean;
  89832. /**
  89833. * Gets a specific vertex buffer
  89834. * @param kind defines the data kind (Position, normal, etc...)
  89835. * @returns a VertexBuffer
  89836. */
  89837. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  89838. /**
  89839. * Returns all vertex buffers
  89840. * @return an object holding all vertex buffers indexed by kind
  89841. */
  89842. getVertexBuffers(): Nullable<{
  89843. [key: string]: VertexBuffer;
  89844. }>;
  89845. /**
  89846. * Gets a boolean indicating if specific vertex buffer is present
  89847. * @param kind defines the data kind (Position, normal, etc...)
  89848. * @returns true if data is present
  89849. */
  89850. isVerticesDataPresent(kind: string): boolean;
  89851. /**
  89852. * Gets a list of all attached data kinds (Position, normal, etc...)
  89853. * @returns a list of string containing all kinds
  89854. */
  89855. getVerticesDataKinds(): string[];
  89856. /**
  89857. * Update index buffer
  89858. * @param indices defines the indices to store in the index buffer
  89859. * @param offset defines the offset in the target buffer where to store the data
  89860. * @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)
  89861. */
  89862. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  89863. /**
  89864. * Creates a new index buffer
  89865. * @param indices defines the indices to store in the index buffer
  89866. * @param totalVertices defines the total number of vertices (could be null)
  89867. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89868. */
  89869. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  89870. /**
  89871. * Return the total number of indices
  89872. * @returns the total number of indices
  89873. */
  89874. getTotalIndices(): number;
  89875. /**
  89876. * Gets the index buffer array
  89877. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89878. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89879. * @returns the index buffer array
  89880. */
  89881. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89882. /**
  89883. * Gets the index buffer
  89884. * @return the index buffer
  89885. */
  89886. getIndexBuffer(): Nullable<DataBuffer>;
  89887. /** @hidden */
  89888. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  89889. /**
  89890. * Release the associated resources for a specific mesh
  89891. * @param mesh defines the source mesh
  89892. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  89893. */
  89894. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  89895. /**
  89896. * Apply current geometry to a given mesh
  89897. * @param mesh defines the mesh to apply geometry to
  89898. */
  89899. applyToMesh(mesh: Mesh): void;
  89900. private _updateExtend;
  89901. private _applyToMesh;
  89902. private notifyUpdate;
  89903. /**
  89904. * Load the geometry if it was flagged as delay loaded
  89905. * @param scene defines the hosting scene
  89906. * @param onLoaded defines a callback called when the geometry is loaded
  89907. */
  89908. load(scene: Scene, onLoaded?: () => void): void;
  89909. private _queueLoad;
  89910. /**
  89911. * Invert the geometry to move from a right handed system to a left handed one.
  89912. */
  89913. toLeftHanded(): void;
  89914. /** @hidden */
  89915. _resetPointsArrayCache(): void;
  89916. /** @hidden */
  89917. _generatePointsArray(): boolean;
  89918. /**
  89919. * Gets a value indicating if the geometry is disposed
  89920. * @returns true if the geometry was disposed
  89921. */
  89922. isDisposed(): boolean;
  89923. private _disposeVertexArrayObjects;
  89924. /**
  89925. * Free all associated resources
  89926. */
  89927. dispose(): void;
  89928. /**
  89929. * Clone the current geometry into a new geometry
  89930. * @param id defines the unique ID of the new geometry
  89931. * @returns a new geometry object
  89932. */
  89933. copy(id: string): Geometry;
  89934. /**
  89935. * Serialize the current geometry info (and not the vertices data) into a JSON object
  89936. * @return a JSON representation of the current geometry data (without the vertices data)
  89937. */
  89938. serialize(): any;
  89939. private toNumberArray;
  89940. /**
  89941. * Serialize all vertices data into a JSON oject
  89942. * @returns a JSON representation of the current geometry data
  89943. */
  89944. serializeVerticeData(): any;
  89945. /**
  89946. * Extracts a clone of a mesh geometry
  89947. * @param mesh defines the source mesh
  89948. * @param id defines the unique ID of the new geometry object
  89949. * @returns the new geometry object
  89950. */
  89951. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  89952. /**
  89953. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  89954. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  89955. * Be aware Math.random() could cause collisions, but:
  89956. * "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"
  89957. * @returns a string containing a new GUID
  89958. */
  89959. static RandomId(): string;
  89960. /** @hidden */
  89961. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  89962. private static _CleanMatricesWeights;
  89963. /**
  89964. * Create a new geometry from persisted data (Using .babylon file format)
  89965. * @param parsedVertexData defines the persisted data
  89966. * @param scene defines the hosting scene
  89967. * @param rootUrl defines the root url to use to load assets (like delayed data)
  89968. * @returns the new geometry object
  89969. */
  89970. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  89971. }
  89972. }
  89973. declare module BABYLON {
  89974. /**
  89975. * Define an interface for all classes that will get and set the data on vertices
  89976. */
  89977. export interface IGetSetVerticesData {
  89978. /**
  89979. * Gets a boolean indicating if specific vertex data is present
  89980. * @param kind defines the vertex data kind to use
  89981. * @returns true is data kind is present
  89982. */
  89983. isVerticesDataPresent(kind: string): boolean;
  89984. /**
  89985. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89986. * @param kind defines the data kind (Position, normal, etc...)
  89987. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89988. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89989. * @returns a float array containing vertex data
  89990. */
  89991. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89992. /**
  89993. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  89994. * @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.
  89995. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89996. * @returns the indices array or an empty array if the mesh has no geometry
  89997. */
  89998. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89999. /**
  90000. * Set specific vertex data
  90001. * @param kind defines the data kind (Position, normal, etc...)
  90002. * @param data defines the vertex data to use
  90003. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  90004. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  90005. */
  90006. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  90007. /**
  90008. * Update a specific associated vertex buffer
  90009. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  90010. * - VertexBuffer.PositionKind
  90011. * - VertexBuffer.UVKind
  90012. * - VertexBuffer.UV2Kind
  90013. * - VertexBuffer.UV3Kind
  90014. * - VertexBuffer.UV4Kind
  90015. * - VertexBuffer.UV5Kind
  90016. * - VertexBuffer.UV6Kind
  90017. * - VertexBuffer.ColorKind
  90018. * - VertexBuffer.MatricesIndicesKind
  90019. * - VertexBuffer.MatricesIndicesExtraKind
  90020. * - VertexBuffer.MatricesWeightsKind
  90021. * - VertexBuffer.MatricesWeightsExtraKind
  90022. * @param data defines the data source
  90023. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  90024. * @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)
  90025. */
  90026. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  90027. /**
  90028. * Creates a new index buffer
  90029. * @param indices defines the indices to store in the index buffer
  90030. * @param totalVertices defines the total number of vertices (could be null)
  90031. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  90032. */
  90033. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  90034. }
  90035. /**
  90036. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  90037. */
  90038. export class VertexData {
  90039. /**
  90040. * Mesh side orientation : usually the external or front surface
  90041. */
  90042. static readonly FRONTSIDE: number;
  90043. /**
  90044. * Mesh side orientation : usually the internal or back surface
  90045. */
  90046. static readonly BACKSIDE: number;
  90047. /**
  90048. * Mesh side orientation : both internal and external or front and back surfaces
  90049. */
  90050. static readonly DOUBLESIDE: number;
  90051. /**
  90052. * Mesh side orientation : by default, `FRONTSIDE`
  90053. */
  90054. static readonly DEFAULTSIDE: number;
  90055. /**
  90056. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  90057. */
  90058. positions: Nullable<FloatArray>;
  90059. /**
  90060. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  90061. */
  90062. normals: Nullable<FloatArray>;
  90063. /**
  90064. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  90065. */
  90066. tangents: Nullable<FloatArray>;
  90067. /**
  90068. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  90069. */
  90070. uvs: Nullable<FloatArray>;
  90071. /**
  90072. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  90073. */
  90074. uvs2: Nullable<FloatArray>;
  90075. /**
  90076. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  90077. */
  90078. uvs3: Nullable<FloatArray>;
  90079. /**
  90080. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  90081. */
  90082. uvs4: Nullable<FloatArray>;
  90083. /**
  90084. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  90085. */
  90086. uvs5: Nullable<FloatArray>;
  90087. /**
  90088. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  90089. */
  90090. uvs6: Nullable<FloatArray>;
  90091. /**
  90092. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  90093. */
  90094. colors: Nullable<FloatArray>;
  90095. /**
  90096. * 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).
  90097. */
  90098. matricesIndices: Nullable<FloatArray>;
  90099. /**
  90100. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  90101. */
  90102. matricesWeights: Nullable<FloatArray>;
  90103. /**
  90104. * An array extending the number of possible indices
  90105. */
  90106. matricesIndicesExtra: Nullable<FloatArray>;
  90107. /**
  90108. * An array extending the number of possible weights when the number of indices is extended
  90109. */
  90110. matricesWeightsExtra: Nullable<FloatArray>;
  90111. /**
  90112. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  90113. */
  90114. indices: Nullable<IndicesArray>;
  90115. /**
  90116. * Uses the passed data array to set the set the values for the specified kind of data
  90117. * @param data a linear array of floating numbers
  90118. * @param kind the type of data that is being set, eg positions, colors etc
  90119. */
  90120. set(data: FloatArray, kind: string): void;
  90121. /**
  90122. * Associates the vertexData to the passed Mesh.
  90123. * Sets it as updatable or not (default `false`)
  90124. * @param mesh the mesh the vertexData is applied to
  90125. * @param updatable when used and having the value true allows new data to update the vertexData
  90126. * @returns the VertexData
  90127. */
  90128. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  90129. /**
  90130. * Associates the vertexData to the passed Geometry.
  90131. * Sets it as updatable or not (default `false`)
  90132. * @param geometry the geometry the vertexData is applied to
  90133. * @param updatable when used and having the value true allows new data to update the vertexData
  90134. * @returns VertexData
  90135. */
  90136. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  90137. /**
  90138. * Updates the associated mesh
  90139. * @param mesh the mesh to be updated
  90140. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  90141. * @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
  90142. * @returns VertexData
  90143. */
  90144. updateMesh(mesh: Mesh): VertexData;
  90145. /**
  90146. * Updates the associated geometry
  90147. * @param geometry the geometry to be updated
  90148. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  90149. * @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
  90150. * @returns VertexData.
  90151. */
  90152. updateGeometry(geometry: Geometry): VertexData;
  90153. private _applyTo;
  90154. private _update;
  90155. /**
  90156. * Transforms each position and each normal of the vertexData according to the passed Matrix
  90157. * @param matrix the transforming matrix
  90158. * @returns the VertexData
  90159. */
  90160. transform(matrix: Matrix): VertexData;
  90161. /**
  90162. * Merges the passed VertexData into the current one
  90163. * @param other the VertexData to be merged into the current one
  90164. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  90165. * @returns the modified VertexData
  90166. */
  90167. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  90168. private _mergeElement;
  90169. private _validate;
  90170. /**
  90171. * Serializes the VertexData
  90172. * @returns a serialized object
  90173. */
  90174. serialize(): any;
  90175. /**
  90176. * Extracts the vertexData from a mesh
  90177. * @param mesh the mesh from which to extract the VertexData
  90178. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  90179. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  90180. * @returns the object VertexData associated to the passed mesh
  90181. */
  90182. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  90183. /**
  90184. * Extracts the vertexData from the geometry
  90185. * @param geometry the geometry from which to extract the VertexData
  90186. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  90187. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  90188. * @returns the object VertexData associated to the passed mesh
  90189. */
  90190. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  90191. private static _ExtractFrom;
  90192. /**
  90193. * Creates the VertexData for a Ribbon
  90194. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  90195. * * pathArray array of paths, each of which an array of successive Vector3
  90196. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  90197. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  90198. * * 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
  90199. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90200. * * 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)
  90201. * * 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)
  90202. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  90203. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  90204. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  90205. * @returns the VertexData of the ribbon
  90206. */
  90207. static CreateRibbon(options: {
  90208. pathArray: Vector3[][];
  90209. closeArray?: boolean;
  90210. closePath?: boolean;
  90211. offset?: number;
  90212. sideOrientation?: number;
  90213. frontUVs?: Vector4;
  90214. backUVs?: Vector4;
  90215. invertUV?: boolean;
  90216. uvs?: Vector2[];
  90217. colors?: Color4[];
  90218. }): VertexData;
  90219. /**
  90220. * Creates the VertexData for a box
  90221. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90222. * * size sets the width, height and depth of the box to the value of size, optional default 1
  90223. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  90224. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  90225. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  90226. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  90227. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  90228. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90229. * * 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)
  90230. * * 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)
  90231. * @returns the VertexData of the box
  90232. */
  90233. static CreateBox(options: {
  90234. size?: number;
  90235. width?: number;
  90236. height?: number;
  90237. depth?: number;
  90238. faceUV?: Vector4[];
  90239. faceColors?: Color4[];
  90240. sideOrientation?: number;
  90241. frontUVs?: Vector4;
  90242. backUVs?: Vector4;
  90243. }): VertexData;
  90244. /**
  90245. * Creates the VertexData for a tiled box
  90246. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90247. * * faceTiles sets the pattern, tile size and number of tiles for a face
  90248. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  90249. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  90250. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90251. * @returns the VertexData of the box
  90252. */
  90253. static CreateTiledBox(options: {
  90254. pattern?: number;
  90255. width?: number;
  90256. height?: number;
  90257. depth?: number;
  90258. tileSize?: number;
  90259. tileWidth?: number;
  90260. tileHeight?: number;
  90261. alignHorizontal?: number;
  90262. alignVertical?: number;
  90263. faceUV?: Vector4[];
  90264. faceColors?: Color4[];
  90265. sideOrientation?: number;
  90266. }): VertexData;
  90267. /**
  90268. * Creates the VertexData for a tiled plane
  90269. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90270. * * pattern a limited pattern arrangement depending on the number
  90271. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  90272. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  90273. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  90274. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90275. * * 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)
  90276. * * 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)
  90277. * @returns the VertexData of the tiled plane
  90278. */
  90279. static CreateTiledPlane(options: {
  90280. pattern?: number;
  90281. tileSize?: number;
  90282. tileWidth?: number;
  90283. tileHeight?: number;
  90284. size?: number;
  90285. width?: number;
  90286. height?: number;
  90287. alignHorizontal?: number;
  90288. alignVertical?: number;
  90289. sideOrientation?: number;
  90290. frontUVs?: Vector4;
  90291. backUVs?: Vector4;
  90292. }): VertexData;
  90293. /**
  90294. * Creates the VertexData for an ellipsoid, defaults to a sphere
  90295. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90296. * * segments sets the number of horizontal strips optional, default 32
  90297. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  90298. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  90299. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  90300. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  90301. * * 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
  90302. * * 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
  90303. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90304. * * 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)
  90305. * * 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)
  90306. * @returns the VertexData of the ellipsoid
  90307. */
  90308. static CreateSphere(options: {
  90309. segments?: number;
  90310. diameter?: number;
  90311. diameterX?: number;
  90312. diameterY?: number;
  90313. diameterZ?: number;
  90314. arc?: number;
  90315. slice?: number;
  90316. sideOrientation?: number;
  90317. frontUVs?: Vector4;
  90318. backUVs?: Vector4;
  90319. }): VertexData;
  90320. /**
  90321. * Creates the VertexData for a cylinder, cone or prism
  90322. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90323. * * height sets the height (y direction) of the cylinder, optional, default 2
  90324. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  90325. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  90326. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  90327. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  90328. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  90329. * * 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
  90330. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90331. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90332. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  90333. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  90334. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90335. * * 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)
  90336. * * 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)
  90337. * @returns the VertexData of the cylinder, cone or prism
  90338. */
  90339. static CreateCylinder(options: {
  90340. height?: number;
  90341. diameterTop?: number;
  90342. diameterBottom?: number;
  90343. diameter?: number;
  90344. tessellation?: number;
  90345. subdivisions?: number;
  90346. arc?: number;
  90347. faceColors?: Color4[];
  90348. faceUV?: Vector4[];
  90349. hasRings?: boolean;
  90350. enclose?: boolean;
  90351. sideOrientation?: number;
  90352. frontUVs?: Vector4;
  90353. backUVs?: Vector4;
  90354. }): VertexData;
  90355. /**
  90356. * Creates the VertexData for a torus
  90357. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90358. * * diameter the diameter of the torus, optional default 1
  90359. * * thickness the diameter of the tube forming the torus, optional default 0.5
  90360. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  90361. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90362. * * 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)
  90363. * * 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)
  90364. * @returns the VertexData of the torus
  90365. */
  90366. static CreateTorus(options: {
  90367. diameter?: number;
  90368. thickness?: number;
  90369. tessellation?: number;
  90370. sideOrientation?: number;
  90371. frontUVs?: Vector4;
  90372. backUVs?: Vector4;
  90373. }): VertexData;
  90374. /**
  90375. * Creates the VertexData of the LineSystem
  90376. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  90377. * - lines an array of lines, each line being an array of successive Vector3
  90378. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  90379. * @returns the VertexData of the LineSystem
  90380. */
  90381. static CreateLineSystem(options: {
  90382. lines: Vector3[][];
  90383. colors?: Nullable<Color4[][]>;
  90384. }): VertexData;
  90385. /**
  90386. * Create the VertexData for a DashedLines
  90387. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  90388. * - points an array successive Vector3
  90389. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  90390. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  90391. * - dashNb the intended total number of dashes, optional, default 200
  90392. * @returns the VertexData for the DashedLines
  90393. */
  90394. static CreateDashedLines(options: {
  90395. points: Vector3[];
  90396. dashSize?: number;
  90397. gapSize?: number;
  90398. dashNb?: number;
  90399. }): VertexData;
  90400. /**
  90401. * Creates the VertexData for a Ground
  90402. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  90403. * - width the width (x direction) of the ground, optional, default 1
  90404. * - height the height (z direction) of the ground, optional, default 1
  90405. * - subdivisions the number of subdivisions per side, optional, default 1
  90406. * @returns the VertexData of the Ground
  90407. */
  90408. static CreateGround(options: {
  90409. width?: number;
  90410. height?: number;
  90411. subdivisions?: number;
  90412. subdivisionsX?: number;
  90413. subdivisionsY?: number;
  90414. }): VertexData;
  90415. /**
  90416. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  90417. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  90418. * * xmin the ground minimum X coordinate, optional, default -1
  90419. * * zmin the ground minimum Z coordinate, optional, default -1
  90420. * * xmax the ground maximum X coordinate, optional, default 1
  90421. * * zmax the ground maximum Z coordinate, optional, default 1
  90422. * * 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}
  90423. * * 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}
  90424. * @returns the VertexData of the TiledGround
  90425. */
  90426. static CreateTiledGround(options: {
  90427. xmin: number;
  90428. zmin: number;
  90429. xmax: number;
  90430. zmax: number;
  90431. subdivisions?: {
  90432. w: number;
  90433. h: number;
  90434. };
  90435. precision?: {
  90436. w: number;
  90437. h: number;
  90438. };
  90439. }): VertexData;
  90440. /**
  90441. * Creates the VertexData of the Ground designed from a heightmap
  90442. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  90443. * * width the width (x direction) of the ground
  90444. * * height the height (z direction) of the ground
  90445. * * subdivisions the number of subdivisions per side
  90446. * * minHeight the minimum altitude on the ground, optional, default 0
  90447. * * maxHeight the maximum altitude on the ground, optional default 1
  90448. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  90449. * * buffer the array holding the image color data
  90450. * * bufferWidth the width of image
  90451. * * bufferHeight the height of image
  90452. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  90453. * @returns the VertexData of the Ground designed from a heightmap
  90454. */
  90455. static CreateGroundFromHeightMap(options: {
  90456. width: number;
  90457. height: number;
  90458. subdivisions: number;
  90459. minHeight: number;
  90460. maxHeight: number;
  90461. colorFilter: Color3;
  90462. buffer: Uint8Array;
  90463. bufferWidth: number;
  90464. bufferHeight: number;
  90465. alphaFilter: number;
  90466. }): VertexData;
  90467. /**
  90468. * Creates the VertexData for a Plane
  90469. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  90470. * * size sets the width and height of the plane to the value of size, optional default 1
  90471. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  90472. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  90473. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90474. * * 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)
  90475. * * 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)
  90476. * @returns the VertexData of the box
  90477. */
  90478. static CreatePlane(options: {
  90479. size?: number;
  90480. width?: number;
  90481. height?: number;
  90482. sideOrientation?: number;
  90483. frontUVs?: Vector4;
  90484. backUVs?: Vector4;
  90485. }): VertexData;
  90486. /**
  90487. * Creates the VertexData of the Disc or regular Polygon
  90488. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  90489. * * radius the radius of the disc, optional default 0.5
  90490. * * tessellation the number of polygon sides, optional, default 64
  90491. * * 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
  90492. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90493. * * 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)
  90494. * * 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)
  90495. * @returns the VertexData of the box
  90496. */
  90497. static CreateDisc(options: {
  90498. radius?: number;
  90499. tessellation?: number;
  90500. arc?: number;
  90501. sideOrientation?: number;
  90502. frontUVs?: Vector4;
  90503. backUVs?: Vector4;
  90504. }): VertexData;
  90505. /**
  90506. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  90507. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  90508. * @param polygon a mesh built from polygonTriangulation.build()
  90509. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90510. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90511. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90512. * @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)
  90513. * @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)
  90514. * @returns the VertexData of the Polygon
  90515. */
  90516. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  90517. /**
  90518. * Creates the VertexData of the IcoSphere
  90519. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  90520. * * radius the radius of the IcoSphere, optional default 1
  90521. * * radiusX allows stretching in the x direction, optional, default radius
  90522. * * radiusY allows stretching in the y direction, optional, default radius
  90523. * * radiusZ allows stretching in the z direction, optional, default radius
  90524. * * flat when true creates a flat shaded mesh, optional, default true
  90525. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  90526. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90527. * * 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)
  90528. * * 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)
  90529. * @returns the VertexData of the IcoSphere
  90530. */
  90531. static CreateIcoSphere(options: {
  90532. radius?: number;
  90533. radiusX?: number;
  90534. radiusY?: number;
  90535. radiusZ?: number;
  90536. flat?: boolean;
  90537. subdivisions?: number;
  90538. sideOrientation?: number;
  90539. frontUVs?: Vector4;
  90540. backUVs?: Vector4;
  90541. }): VertexData;
  90542. /**
  90543. * Creates the VertexData for a Polyhedron
  90544. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  90545. * * type provided types are:
  90546. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  90547. * * 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)
  90548. * * size the size of the IcoSphere, optional default 1
  90549. * * sizeX allows stretching in the x direction, optional, default size
  90550. * * sizeY allows stretching in the y direction, optional, default size
  90551. * * sizeZ allows stretching in the z direction, optional, default size
  90552. * * 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
  90553. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90554. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90555. * * flat when true creates a flat shaded mesh, optional, default true
  90556. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  90557. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90558. * * 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)
  90559. * * 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)
  90560. * @returns the VertexData of the Polyhedron
  90561. */
  90562. static CreatePolyhedron(options: {
  90563. type?: number;
  90564. size?: number;
  90565. sizeX?: number;
  90566. sizeY?: number;
  90567. sizeZ?: number;
  90568. custom?: any;
  90569. faceUV?: Vector4[];
  90570. faceColors?: Color4[];
  90571. flat?: boolean;
  90572. sideOrientation?: number;
  90573. frontUVs?: Vector4;
  90574. backUVs?: Vector4;
  90575. }): VertexData;
  90576. /**
  90577. * Creates the VertexData for a TorusKnot
  90578. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  90579. * * radius the radius of the torus knot, optional, default 2
  90580. * * tube the thickness of the tube, optional, default 0.5
  90581. * * radialSegments the number of sides on each tube segments, optional, default 32
  90582. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  90583. * * p the number of windings around the z axis, optional, default 2
  90584. * * q the number of windings around the x axis, optional, default 3
  90585. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90586. * * 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)
  90587. * * 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)
  90588. * @returns the VertexData of the Torus Knot
  90589. */
  90590. static CreateTorusKnot(options: {
  90591. radius?: number;
  90592. tube?: number;
  90593. radialSegments?: number;
  90594. tubularSegments?: number;
  90595. p?: number;
  90596. q?: number;
  90597. sideOrientation?: number;
  90598. frontUVs?: Vector4;
  90599. backUVs?: Vector4;
  90600. }): VertexData;
  90601. /**
  90602. * Compute normals for given positions and indices
  90603. * @param positions an array of vertex positions, [...., x, y, z, ......]
  90604. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  90605. * @param normals an array of vertex normals, [...., x, y, z, ......]
  90606. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  90607. * * facetNormals : optional array of facet normals (vector3)
  90608. * * facetPositions : optional array of facet positions (vector3)
  90609. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  90610. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  90611. * * bInfo : optional bounding info, required for facetPartitioning computation
  90612. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  90613. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  90614. * * useRightHandedSystem: optional boolean to for right handed system computation
  90615. * * depthSort : optional boolean to enable the facet depth sort computation
  90616. * * distanceTo : optional Vector3 to compute the facet depth from this location
  90617. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  90618. */
  90619. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  90620. facetNormals?: any;
  90621. facetPositions?: any;
  90622. facetPartitioning?: any;
  90623. ratio?: number;
  90624. bInfo?: any;
  90625. bbSize?: Vector3;
  90626. subDiv?: any;
  90627. useRightHandedSystem?: boolean;
  90628. depthSort?: boolean;
  90629. distanceTo?: Vector3;
  90630. depthSortedFacets?: any;
  90631. }): void;
  90632. /** @hidden */
  90633. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  90634. /**
  90635. * Applies VertexData created from the imported parameters to the geometry
  90636. * @param parsedVertexData the parsed data from an imported file
  90637. * @param geometry the geometry to apply the VertexData to
  90638. */
  90639. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  90640. }
  90641. }
  90642. declare module BABYLON {
  90643. /**
  90644. * Defines a target to use with MorphTargetManager
  90645. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  90646. */
  90647. export class MorphTarget implements IAnimatable {
  90648. /** defines the name of the target */
  90649. name: string;
  90650. /**
  90651. * Gets or sets the list of animations
  90652. */
  90653. animations: Animation[];
  90654. private _scene;
  90655. private _positions;
  90656. private _normals;
  90657. private _tangents;
  90658. private _uvs;
  90659. private _influence;
  90660. private _uniqueId;
  90661. /**
  90662. * Observable raised when the influence changes
  90663. */
  90664. onInfluenceChanged: Observable<boolean>;
  90665. /** @hidden */
  90666. _onDataLayoutChanged: Observable<void>;
  90667. /**
  90668. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  90669. */
  90670. influence: number;
  90671. /**
  90672. * Gets or sets the id of the morph Target
  90673. */
  90674. id: string;
  90675. private _animationPropertiesOverride;
  90676. /**
  90677. * Gets or sets the animation properties override
  90678. */
  90679. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  90680. /**
  90681. * Creates a new MorphTarget
  90682. * @param name defines the name of the target
  90683. * @param influence defines the influence to use
  90684. * @param scene defines the scene the morphtarget belongs to
  90685. */
  90686. constructor(
  90687. /** defines the name of the target */
  90688. name: string, influence?: number, scene?: Nullable<Scene>);
  90689. /**
  90690. * Gets the unique ID of this manager
  90691. */
  90692. readonly uniqueId: number;
  90693. /**
  90694. * Gets a boolean defining if the target contains position data
  90695. */
  90696. readonly hasPositions: boolean;
  90697. /**
  90698. * Gets a boolean defining if the target contains normal data
  90699. */
  90700. readonly hasNormals: boolean;
  90701. /**
  90702. * Gets a boolean defining if the target contains tangent data
  90703. */
  90704. readonly hasTangents: boolean;
  90705. /**
  90706. * Gets a boolean defining if the target contains texture coordinates data
  90707. */
  90708. readonly hasUVs: boolean;
  90709. /**
  90710. * Affects position data to this target
  90711. * @param data defines the position data to use
  90712. */
  90713. setPositions(data: Nullable<FloatArray>): void;
  90714. /**
  90715. * Gets the position data stored in this target
  90716. * @returns a FloatArray containing the position data (or null if not present)
  90717. */
  90718. getPositions(): Nullable<FloatArray>;
  90719. /**
  90720. * Affects normal data to this target
  90721. * @param data defines the normal data to use
  90722. */
  90723. setNormals(data: Nullable<FloatArray>): void;
  90724. /**
  90725. * Gets the normal data stored in this target
  90726. * @returns a FloatArray containing the normal data (or null if not present)
  90727. */
  90728. getNormals(): Nullable<FloatArray>;
  90729. /**
  90730. * Affects tangent data to this target
  90731. * @param data defines the tangent data to use
  90732. */
  90733. setTangents(data: Nullable<FloatArray>): void;
  90734. /**
  90735. * Gets the tangent data stored in this target
  90736. * @returns a FloatArray containing the tangent data (or null if not present)
  90737. */
  90738. getTangents(): Nullable<FloatArray>;
  90739. /**
  90740. * Affects texture coordinates data to this target
  90741. * @param data defines the texture coordinates data to use
  90742. */
  90743. setUVs(data: Nullable<FloatArray>): void;
  90744. /**
  90745. * Gets the texture coordinates data stored in this target
  90746. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  90747. */
  90748. getUVs(): Nullable<FloatArray>;
  90749. /**
  90750. * Clone the current target
  90751. * @returns a new MorphTarget
  90752. */
  90753. clone(): MorphTarget;
  90754. /**
  90755. * Serializes the current target into a Serialization object
  90756. * @returns the serialized object
  90757. */
  90758. serialize(): any;
  90759. /**
  90760. * Returns the string "MorphTarget"
  90761. * @returns "MorphTarget"
  90762. */
  90763. getClassName(): string;
  90764. /**
  90765. * Creates a new target from serialized data
  90766. * @param serializationObject defines the serialized data to use
  90767. * @returns a new MorphTarget
  90768. */
  90769. static Parse(serializationObject: any): MorphTarget;
  90770. /**
  90771. * Creates a MorphTarget from mesh data
  90772. * @param mesh defines the source mesh
  90773. * @param name defines the name to use for the new target
  90774. * @param influence defines the influence to attach to the target
  90775. * @returns a new MorphTarget
  90776. */
  90777. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  90778. }
  90779. }
  90780. declare module BABYLON {
  90781. /**
  90782. * This class is used to deform meshes using morphing between different targets
  90783. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  90784. */
  90785. export class MorphTargetManager {
  90786. private _targets;
  90787. private _targetInfluenceChangedObservers;
  90788. private _targetDataLayoutChangedObservers;
  90789. private _activeTargets;
  90790. private _scene;
  90791. private _influences;
  90792. private _supportsNormals;
  90793. private _supportsTangents;
  90794. private _supportsUVs;
  90795. private _vertexCount;
  90796. private _uniqueId;
  90797. private _tempInfluences;
  90798. /**
  90799. * Gets or sets a boolean indicating if normals must be morphed
  90800. */
  90801. enableNormalMorphing: boolean;
  90802. /**
  90803. * Gets or sets a boolean indicating if tangents must be morphed
  90804. */
  90805. enableTangentMorphing: boolean;
  90806. /**
  90807. * Gets or sets a boolean indicating if UV must be morphed
  90808. */
  90809. enableUVMorphing: boolean;
  90810. /**
  90811. * Creates a new MorphTargetManager
  90812. * @param scene defines the current scene
  90813. */
  90814. constructor(scene?: Nullable<Scene>);
  90815. /**
  90816. * Gets the unique ID of this manager
  90817. */
  90818. readonly uniqueId: number;
  90819. /**
  90820. * Gets the number of vertices handled by this manager
  90821. */
  90822. readonly vertexCount: number;
  90823. /**
  90824. * Gets a boolean indicating if this manager supports morphing of normals
  90825. */
  90826. readonly supportsNormals: boolean;
  90827. /**
  90828. * Gets a boolean indicating if this manager supports morphing of tangents
  90829. */
  90830. readonly supportsTangents: boolean;
  90831. /**
  90832. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  90833. */
  90834. readonly supportsUVs: boolean;
  90835. /**
  90836. * Gets the number of targets stored in this manager
  90837. */
  90838. readonly numTargets: number;
  90839. /**
  90840. * Gets the number of influencers (ie. the number of targets with influences > 0)
  90841. */
  90842. readonly numInfluencers: number;
  90843. /**
  90844. * Gets the list of influences (one per target)
  90845. */
  90846. readonly influences: Float32Array;
  90847. /**
  90848. * Gets the active target at specified index. An active target is a target with an influence > 0
  90849. * @param index defines the index to check
  90850. * @returns the requested target
  90851. */
  90852. getActiveTarget(index: number): MorphTarget;
  90853. /**
  90854. * Gets the target at specified index
  90855. * @param index defines the index to check
  90856. * @returns the requested target
  90857. */
  90858. getTarget(index: number): MorphTarget;
  90859. /**
  90860. * Add a new target to this manager
  90861. * @param target defines the target to add
  90862. */
  90863. addTarget(target: MorphTarget): void;
  90864. /**
  90865. * Removes a target from the manager
  90866. * @param target defines the target to remove
  90867. */
  90868. removeTarget(target: MorphTarget): void;
  90869. /**
  90870. * Clone the current manager
  90871. * @returns a new MorphTargetManager
  90872. */
  90873. clone(): MorphTargetManager;
  90874. /**
  90875. * Serializes the current manager into a Serialization object
  90876. * @returns the serialized object
  90877. */
  90878. serialize(): any;
  90879. private _syncActiveTargets;
  90880. /**
  90881. * Syncrhonize the targets with all the meshes using this morph target manager
  90882. */
  90883. synchronize(): void;
  90884. /**
  90885. * Creates a new MorphTargetManager from serialized data
  90886. * @param serializationObject defines the serialized data
  90887. * @param scene defines the hosting scene
  90888. * @returns the new MorphTargetManager
  90889. */
  90890. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  90891. }
  90892. }
  90893. declare module BABYLON {
  90894. /**
  90895. * Class used to represent a specific level of detail of a mesh
  90896. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  90897. */
  90898. export class MeshLODLevel {
  90899. /** Defines the distance where this level should start being displayed */
  90900. distance: number;
  90901. /** Defines the mesh to use to render this level */
  90902. mesh: Nullable<Mesh>;
  90903. /**
  90904. * Creates a new LOD level
  90905. * @param distance defines the distance where this level should star being displayed
  90906. * @param mesh defines the mesh to use to render this level
  90907. */
  90908. constructor(
  90909. /** Defines the distance where this level should start being displayed */
  90910. distance: number,
  90911. /** Defines the mesh to use to render this level */
  90912. mesh: Nullable<Mesh>);
  90913. }
  90914. }
  90915. declare module BABYLON {
  90916. /**
  90917. * Mesh representing the gorund
  90918. */
  90919. export class GroundMesh extends Mesh {
  90920. /** If octree should be generated */
  90921. generateOctree: boolean;
  90922. private _heightQuads;
  90923. /** @hidden */
  90924. _subdivisionsX: number;
  90925. /** @hidden */
  90926. _subdivisionsY: number;
  90927. /** @hidden */
  90928. _width: number;
  90929. /** @hidden */
  90930. _height: number;
  90931. /** @hidden */
  90932. _minX: number;
  90933. /** @hidden */
  90934. _maxX: number;
  90935. /** @hidden */
  90936. _minZ: number;
  90937. /** @hidden */
  90938. _maxZ: number;
  90939. constructor(name: string, scene: Scene);
  90940. /**
  90941. * "GroundMesh"
  90942. * @returns "GroundMesh"
  90943. */
  90944. getClassName(): string;
  90945. /**
  90946. * The minimum of x and y subdivisions
  90947. */
  90948. readonly subdivisions: number;
  90949. /**
  90950. * X subdivisions
  90951. */
  90952. readonly subdivisionsX: number;
  90953. /**
  90954. * Y subdivisions
  90955. */
  90956. readonly subdivisionsY: number;
  90957. /**
  90958. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  90959. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  90960. * @param chunksCount the number of subdivisions for x and y
  90961. * @param octreeBlocksSize (Default: 32)
  90962. */
  90963. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  90964. /**
  90965. * Returns a height (y) value in the Worl system :
  90966. * the ground altitude at the coordinates (x, z) expressed in the World system.
  90967. * @param x x coordinate
  90968. * @param z z coordinate
  90969. * @returns the ground y position if (x, z) are outside the ground surface.
  90970. */
  90971. getHeightAtCoordinates(x: number, z: number): number;
  90972. /**
  90973. * Returns a normalized vector (Vector3) orthogonal to the ground
  90974. * at the ground coordinates (x, z) expressed in the World system.
  90975. * @param x x coordinate
  90976. * @param z z coordinate
  90977. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  90978. */
  90979. getNormalAtCoordinates(x: number, z: number): Vector3;
  90980. /**
  90981. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  90982. * at the ground coordinates (x, z) expressed in the World system.
  90983. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  90984. * @param x x coordinate
  90985. * @param z z coordinate
  90986. * @param ref vector to store the result
  90987. * @returns the GroundMesh.
  90988. */
  90989. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  90990. /**
  90991. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  90992. * if the ground has been updated.
  90993. * This can be used in the render loop.
  90994. * @returns the GroundMesh.
  90995. */
  90996. updateCoordinateHeights(): GroundMesh;
  90997. private _getFacetAt;
  90998. private _initHeightQuads;
  90999. private _computeHeightQuads;
  91000. /**
  91001. * Serializes this ground mesh
  91002. * @param serializationObject object to write serialization to
  91003. */
  91004. serialize(serializationObject: any): void;
  91005. /**
  91006. * Parses a serialized ground mesh
  91007. * @param parsedMesh the serialized mesh
  91008. * @param scene the scene to create the ground mesh in
  91009. * @returns the created ground mesh
  91010. */
  91011. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  91012. }
  91013. }
  91014. declare module BABYLON {
  91015. /**
  91016. * Interface for Physics-Joint data
  91017. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91018. */
  91019. export interface PhysicsJointData {
  91020. /**
  91021. * The main pivot of the joint
  91022. */
  91023. mainPivot?: Vector3;
  91024. /**
  91025. * The connected pivot of the joint
  91026. */
  91027. connectedPivot?: Vector3;
  91028. /**
  91029. * The main axis of the joint
  91030. */
  91031. mainAxis?: Vector3;
  91032. /**
  91033. * The connected axis of the joint
  91034. */
  91035. connectedAxis?: Vector3;
  91036. /**
  91037. * The collision of the joint
  91038. */
  91039. collision?: boolean;
  91040. /**
  91041. * Native Oimo/Cannon/Energy data
  91042. */
  91043. nativeParams?: any;
  91044. }
  91045. /**
  91046. * This is a holder class for the physics joint created by the physics plugin
  91047. * It holds a set of functions to control the underlying joint
  91048. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91049. */
  91050. export class PhysicsJoint {
  91051. /**
  91052. * The type of the physics joint
  91053. */
  91054. type: number;
  91055. /**
  91056. * The data for the physics joint
  91057. */
  91058. jointData: PhysicsJointData;
  91059. private _physicsJoint;
  91060. protected _physicsPlugin: IPhysicsEnginePlugin;
  91061. /**
  91062. * Initializes the physics joint
  91063. * @param type The type of the physics joint
  91064. * @param jointData The data for the physics joint
  91065. */
  91066. constructor(
  91067. /**
  91068. * The type of the physics joint
  91069. */
  91070. type: number,
  91071. /**
  91072. * The data for the physics joint
  91073. */
  91074. jointData: PhysicsJointData);
  91075. /**
  91076. * Gets the physics joint
  91077. */
  91078. /**
  91079. * Sets the physics joint
  91080. */
  91081. physicsJoint: any;
  91082. /**
  91083. * Sets the physics plugin
  91084. */
  91085. physicsPlugin: IPhysicsEnginePlugin;
  91086. /**
  91087. * Execute a function that is physics-plugin specific.
  91088. * @param {Function} func the function that will be executed.
  91089. * It accepts two parameters: the physics world and the physics joint
  91090. */
  91091. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  91092. /**
  91093. * Distance-Joint type
  91094. */
  91095. static DistanceJoint: number;
  91096. /**
  91097. * Hinge-Joint type
  91098. */
  91099. static HingeJoint: number;
  91100. /**
  91101. * Ball-and-Socket joint type
  91102. */
  91103. static BallAndSocketJoint: number;
  91104. /**
  91105. * Wheel-Joint type
  91106. */
  91107. static WheelJoint: number;
  91108. /**
  91109. * Slider-Joint type
  91110. */
  91111. static SliderJoint: number;
  91112. /**
  91113. * Prismatic-Joint type
  91114. */
  91115. static PrismaticJoint: number;
  91116. /**
  91117. * Universal-Joint type
  91118. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  91119. */
  91120. static UniversalJoint: number;
  91121. /**
  91122. * Hinge-Joint 2 type
  91123. */
  91124. static Hinge2Joint: number;
  91125. /**
  91126. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  91127. */
  91128. static PointToPointJoint: number;
  91129. /**
  91130. * Spring-Joint type
  91131. */
  91132. static SpringJoint: number;
  91133. /**
  91134. * Lock-Joint type
  91135. */
  91136. static LockJoint: number;
  91137. }
  91138. /**
  91139. * A class representing a physics distance joint
  91140. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91141. */
  91142. export class DistanceJoint extends PhysicsJoint {
  91143. /**
  91144. *
  91145. * @param jointData The data for the Distance-Joint
  91146. */
  91147. constructor(jointData: DistanceJointData);
  91148. /**
  91149. * Update the predefined distance.
  91150. * @param maxDistance The maximum preferred distance
  91151. * @param minDistance The minimum preferred distance
  91152. */
  91153. updateDistance(maxDistance: number, minDistance?: number): void;
  91154. }
  91155. /**
  91156. * Represents a Motor-Enabled Joint
  91157. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91158. */
  91159. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  91160. /**
  91161. * Initializes the Motor-Enabled Joint
  91162. * @param type The type of the joint
  91163. * @param jointData The physica joint data for the joint
  91164. */
  91165. constructor(type: number, jointData: PhysicsJointData);
  91166. /**
  91167. * Set the motor values.
  91168. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91169. * @param force the force to apply
  91170. * @param maxForce max force for this motor.
  91171. */
  91172. setMotor(force?: number, maxForce?: number): void;
  91173. /**
  91174. * Set the motor's limits.
  91175. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91176. * @param upperLimit The upper limit of the motor
  91177. * @param lowerLimit The lower limit of the motor
  91178. */
  91179. setLimit(upperLimit: number, lowerLimit?: number): void;
  91180. }
  91181. /**
  91182. * This class represents a single physics Hinge-Joint
  91183. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91184. */
  91185. export class HingeJoint extends MotorEnabledJoint {
  91186. /**
  91187. * Initializes the Hinge-Joint
  91188. * @param jointData The joint data for the Hinge-Joint
  91189. */
  91190. constructor(jointData: PhysicsJointData);
  91191. /**
  91192. * Set the motor values.
  91193. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91194. * @param {number} force the force to apply
  91195. * @param {number} maxForce max force for this motor.
  91196. */
  91197. setMotor(force?: number, maxForce?: number): void;
  91198. /**
  91199. * Set the motor's limits.
  91200. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91201. * @param upperLimit The upper limit of the motor
  91202. * @param lowerLimit The lower limit of the motor
  91203. */
  91204. setLimit(upperLimit: number, lowerLimit?: number): void;
  91205. }
  91206. /**
  91207. * This class represents a dual hinge physics joint (same as wheel joint)
  91208. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91209. */
  91210. export class Hinge2Joint extends MotorEnabledJoint {
  91211. /**
  91212. * Initializes the Hinge2-Joint
  91213. * @param jointData The joint data for the Hinge2-Joint
  91214. */
  91215. constructor(jointData: PhysicsJointData);
  91216. /**
  91217. * Set the motor values.
  91218. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91219. * @param {number} targetSpeed the speed the motor is to reach
  91220. * @param {number} maxForce max force for this motor.
  91221. * @param {motorIndex} the motor's index, 0 or 1.
  91222. */
  91223. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  91224. /**
  91225. * Set the motor limits.
  91226. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91227. * @param {number} upperLimit the upper limit
  91228. * @param {number} lowerLimit lower limit
  91229. * @param {motorIndex} the motor's index, 0 or 1.
  91230. */
  91231. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  91232. }
  91233. /**
  91234. * Interface for a motor enabled joint
  91235. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91236. */
  91237. export interface IMotorEnabledJoint {
  91238. /**
  91239. * Physics joint
  91240. */
  91241. physicsJoint: any;
  91242. /**
  91243. * Sets the motor of the motor-enabled joint
  91244. * @param force The force of the motor
  91245. * @param maxForce The maximum force of the motor
  91246. * @param motorIndex The index of the motor
  91247. */
  91248. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  91249. /**
  91250. * Sets the limit of the motor
  91251. * @param upperLimit The upper limit of the motor
  91252. * @param lowerLimit The lower limit of the motor
  91253. * @param motorIndex The index of the motor
  91254. */
  91255. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  91256. }
  91257. /**
  91258. * Joint data for a Distance-Joint
  91259. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91260. */
  91261. export interface DistanceJointData extends PhysicsJointData {
  91262. /**
  91263. * Max distance the 2 joint objects can be apart
  91264. */
  91265. maxDistance: number;
  91266. }
  91267. /**
  91268. * Joint data from a spring joint
  91269. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91270. */
  91271. export interface SpringJointData extends PhysicsJointData {
  91272. /**
  91273. * Length of the spring
  91274. */
  91275. length: number;
  91276. /**
  91277. * Stiffness of the spring
  91278. */
  91279. stiffness: number;
  91280. /**
  91281. * Damping of the spring
  91282. */
  91283. damping: number;
  91284. /** this callback will be called when applying the force to the impostors. */
  91285. forceApplicationCallback: () => void;
  91286. }
  91287. }
  91288. declare module BABYLON {
  91289. /**
  91290. * Holds the data for the raycast result
  91291. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91292. */
  91293. export class PhysicsRaycastResult {
  91294. private _hasHit;
  91295. private _hitDistance;
  91296. private _hitNormalWorld;
  91297. private _hitPointWorld;
  91298. private _rayFromWorld;
  91299. private _rayToWorld;
  91300. /**
  91301. * Gets if there was a hit
  91302. */
  91303. readonly hasHit: boolean;
  91304. /**
  91305. * Gets the distance from the hit
  91306. */
  91307. readonly hitDistance: number;
  91308. /**
  91309. * Gets the hit normal/direction in the world
  91310. */
  91311. readonly hitNormalWorld: Vector3;
  91312. /**
  91313. * Gets the hit point in the world
  91314. */
  91315. readonly hitPointWorld: Vector3;
  91316. /**
  91317. * Gets the ray "start point" of the ray in the world
  91318. */
  91319. readonly rayFromWorld: Vector3;
  91320. /**
  91321. * Gets the ray "end point" of the ray in the world
  91322. */
  91323. readonly rayToWorld: Vector3;
  91324. /**
  91325. * Sets the hit data (normal & point in world space)
  91326. * @param hitNormalWorld defines the normal in world space
  91327. * @param hitPointWorld defines the point in world space
  91328. */
  91329. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  91330. /**
  91331. * Sets the distance from the start point to the hit point
  91332. * @param distance
  91333. */
  91334. setHitDistance(distance: number): void;
  91335. /**
  91336. * Calculates the distance manually
  91337. */
  91338. calculateHitDistance(): void;
  91339. /**
  91340. * Resets all the values to default
  91341. * @param from The from point on world space
  91342. * @param to The to point on world space
  91343. */
  91344. reset(from?: Vector3, to?: Vector3): void;
  91345. }
  91346. /**
  91347. * Interface for the size containing width and height
  91348. */
  91349. interface IXYZ {
  91350. /**
  91351. * X
  91352. */
  91353. x: number;
  91354. /**
  91355. * Y
  91356. */
  91357. y: number;
  91358. /**
  91359. * Z
  91360. */
  91361. z: number;
  91362. }
  91363. }
  91364. declare module BABYLON {
  91365. /**
  91366. * Interface used to describe a physics joint
  91367. */
  91368. export interface PhysicsImpostorJoint {
  91369. /** Defines the main impostor to which the joint is linked */
  91370. mainImpostor: PhysicsImpostor;
  91371. /** Defines the impostor that is connected to the main impostor using this joint */
  91372. connectedImpostor: PhysicsImpostor;
  91373. /** Defines the joint itself */
  91374. joint: PhysicsJoint;
  91375. }
  91376. /** @hidden */
  91377. export interface IPhysicsEnginePlugin {
  91378. world: any;
  91379. name: string;
  91380. setGravity(gravity: Vector3): void;
  91381. setTimeStep(timeStep: number): void;
  91382. getTimeStep(): number;
  91383. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  91384. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  91385. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  91386. generatePhysicsBody(impostor: PhysicsImpostor): void;
  91387. removePhysicsBody(impostor: PhysicsImpostor): void;
  91388. generateJoint(joint: PhysicsImpostorJoint): void;
  91389. removeJoint(joint: PhysicsImpostorJoint): void;
  91390. isSupported(): boolean;
  91391. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  91392. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  91393. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  91394. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  91395. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  91396. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  91397. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  91398. getBodyMass(impostor: PhysicsImpostor): number;
  91399. getBodyFriction(impostor: PhysicsImpostor): number;
  91400. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  91401. getBodyRestitution(impostor: PhysicsImpostor): number;
  91402. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  91403. getBodyPressure?(impostor: PhysicsImpostor): number;
  91404. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  91405. getBodyStiffness?(impostor: PhysicsImpostor): number;
  91406. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  91407. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  91408. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  91409. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  91410. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  91411. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  91412. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  91413. sleepBody(impostor: PhysicsImpostor): void;
  91414. wakeUpBody(impostor: PhysicsImpostor): void;
  91415. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  91416. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  91417. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  91418. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  91419. getRadius(impostor: PhysicsImpostor): number;
  91420. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  91421. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  91422. dispose(): void;
  91423. }
  91424. /**
  91425. * Interface used to define a physics engine
  91426. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  91427. */
  91428. export interface IPhysicsEngine {
  91429. /**
  91430. * Gets the gravity vector used by the simulation
  91431. */
  91432. gravity: Vector3;
  91433. /**
  91434. * Sets the gravity vector used by the simulation
  91435. * @param gravity defines the gravity vector to use
  91436. */
  91437. setGravity(gravity: Vector3): void;
  91438. /**
  91439. * Set the time step of the physics engine.
  91440. * Default is 1/60.
  91441. * To slow it down, enter 1/600 for example.
  91442. * To speed it up, 1/30
  91443. * @param newTimeStep the new timestep to apply to this world.
  91444. */
  91445. setTimeStep(newTimeStep: number): void;
  91446. /**
  91447. * Get the time step of the physics engine.
  91448. * @returns the current time step
  91449. */
  91450. getTimeStep(): number;
  91451. /**
  91452. * Release all resources
  91453. */
  91454. dispose(): void;
  91455. /**
  91456. * Gets the name of the current physics plugin
  91457. * @returns the name of the plugin
  91458. */
  91459. getPhysicsPluginName(): string;
  91460. /**
  91461. * Adding a new impostor for the impostor tracking.
  91462. * This will be done by the impostor itself.
  91463. * @param impostor the impostor to add
  91464. */
  91465. addImpostor(impostor: PhysicsImpostor): void;
  91466. /**
  91467. * Remove an impostor from the engine.
  91468. * This impostor and its mesh will not longer be updated by the physics engine.
  91469. * @param impostor the impostor to remove
  91470. */
  91471. removeImpostor(impostor: PhysicsImpostor): void;
  91472. /**
  91473. * Add a joint to the physics engine
  91474. * @param mainImpostor defines the main impostor to which the joint is added.
  91475. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  91476. * @param joint defines the joint that will connect both impostors.
  91477. */
  91478. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  91479. /**
  91480. * Removes a joint from the simulation
  91481. * @param mainImpostor defines the impostor used with the joint
  91482. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  91483. * @param joint defines the joint to remove
  91484. */
  91485. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  91486. /**
  91487. * Gets the current plugin used to run the simulation
  91488. * @returns current plugin
  91489. */
  91490. getPhysicsPlugin(): IPhysicsEnginePlugin;
  91491. /**
  91492. * Gets the list of physic impostors
  91493. * @returns an array of PhysicsImpostor
  91494. */
  91495. getImpostors(): Array<PhysicsImpostor>;
  91496. /**
  91497. * Gets the impostor for a physics enabled object
  91498. * @param object defines the object impersonated by the impostor
  91499. * @returns the PhysicsImpostor or null if not found
  91500. */
  91501. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91502. /**
  91503. * Gets the impostor for a physics body object
  91504. * @param body defines physics body used by the impostor
  91505. * @returns the PhysicsImpostor or null if not found
  91506. */
  91507. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  91508. /**
  91509. * Does a raycast in the physics world
  91510. * @param from when should the ray start?
  91511. * @param to when should the ray end?
  91512. * @returns PhysicsRaycastResult
  91513. */
  91514. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  91515. /**
  91516. * Called by the scene. No need to call it.
  91517. * @param delta defines the timespam between frames
  91518. */
  91519. _step(delta: number): void;
  91520. }
  91521. }
  91522. declare module BABYLON {
  91523. /**
  91524. * The interface for the physics imposter parameters
  91525. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91526. */
  91527. export interface PhysicsImpostorParameters {
  91528. /**
  91529. * The mass of the physics imposter
  91530. */
  91531. mass: number;
  91532. /**
  91533. * The friction of the physics imposter
  91534. */
  91535. friction?: number;
  91536. /**
  91537. * The coefficient of restitution of the physics imposter
  91538. */
  91539. restitution?: number;
  91540. /**
  91541. * The native options of the physics imposter
  91542. */
  91543. nativeOptions?: any;
  91544. /**
  91545. * Specifies if the parent should be ignored
  91546. */
  91547. ignoreParent?: boolean;
  91548. /**
  91549. * Specifies if bi-directional transformations should be disabled
  91550. */
  91551. disableBidirectionalTransformation?: boolean;
  91552. /**
  91553. * The pressure inside the physics imposter, soft object only
  91554. */
  91555. pressure?: number;
  91556. /**
  91557. * The stiffness the physics imposter, soft object only
  91558. */
  91559. stiffness?: number;
  91560. /**
  91561. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  91562. */
  91563. velocityIterations?: number;
  91564. /**
  91565. * The number of iterations used in maintaining consistent vertex positions, soft object only
  91566. */
  91567. positionIterations?: number;
  91568. /**
  91569. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  91570. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  91571. * Add to fix multiple points
  91572. */
  91573. fixedPoints?: number;
  91574. /**
  91575. * The collision margin around a soft object
  91576. */
  91577. margin?: number;
  91578. /**
  91579. * The collision margin around a soft object
  91580. */
  91581. damping?: number;
  91582. /**
  91583. * The path for a rope based on an extrusion
  91584. */
  91585. path?: any;
  91586. /**
  91587. * The shape of an extrusion used for a rope based on an extrusion
  91588. */
  91589. shape?: any;
  91590. }
  91591. /**
  91592. * Interface for a physics-enabled object
  91593. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91594. */
  91595. export interface IPhysicsEnabledObject {
  91596. /**
  91597. * The position of the physics-enabled object
  91598. */
  91599. position: Vector3;
  91600. /**
  91601. * The rotation of the physics-enabled object
  91602. */
  91603. rotationQuaternion: Nullable<Quaternion>;
  91604. /**
  91605. * The scale of the physics-enabled object
  91606. */
  91607. scaling: Vector3;
  91608. /**
  91609. * The rotation of the physics-enabled object
  91610. */
  91611. rotation?: Vector3;
  91612. /**
  91613. * The parent of the physics-enabled object
  91614. */
  91615. parent?: any;
  91616. /**
  91617. * The bounding info of the physics-enabled object
  91618. * @returns The bounding info of the physics-enabled object
  91619. */
  91620. getBoundingInfo(): BoundingInfo;
  91621. /**
  91622. * Computes the world matrix
  91623. * @param force Specifies if the world matrix should be computed by force
  91624. * @returns A world matrix
  91625. */
  91626. computeWorldMatrix(force: boolean): Matrix;
  91627. /**
  91628. * Gets the world matrix
  91629. * @returns A world matrix
  91630. */
  91631. getWorldMatrix?(): Matrix;
  91632. /**
  91633. * Gets the child meshes
  91634. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  91635. * @returns An array of abstract meshes
  91636. */
  91637. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  91638. /**
  91639. * Gets the vertex data
  91640. * @param kind The type of vertex data
  91641. * @returns A nullable array of numbers, or a float32 array
  91642. */
  91643. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  91644. /**
  91645. * Gets the indices from the mesh
  91646. * @returns A nullable array of index arrays
  91647. */
  91648. getIndices?(): Nullable<IndicesArray>;
  91649. /**
  91650. * Gets the scene from the mesh
  91651. * @returns the indices array or null
  91652. */
  91653. getScene?(): Scene;
  91654. /**
  91655. * Gets the absolute position from the mesh
  91656. * @returns the absolute position
  91657. */
  91658. getAbsolutePosition(): Vector3;
  91659. /**
  91660. * Gets the absolute pivot point from the mesh
  91661. * @returns the absolute pivot point
  91662. */
  91663. getAbsolutePivotPoint(): Vector3;
  91664. /**
  91665. * Rotates the mesh
  91666. * @param axis The axis of rotation
  91667. * @param amount The amount of rotation
  91668. * @param space The space of the rotation
  91669. * @returns The rotation transform node
  91670. */
  91671. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  91672. /**
  91673. * Translates the mesh
  91674. * @param axis The axis of translation
  91675. * @param distance The distance of translation
  91676. * @param space The space of the translation
  91677. * @returns The transform node
  91678. */
  91679. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  91680. /**
  91681. * Sets the absolute position of the mesh
  91682. * @param absolutePosition The absolute position of the mesh
  91683. * @returns The transform node
  91684. */
  91685. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  91686. /**
  91687. * Gets the class name of the mesh
  91688. * @returns The class name
  91689. */
  91690. getClassName(): string;
  91691. }
  91692. /**
  91693. * Represents a physics imposter
  91694. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91695. */
  91696. export class PhysicsImpostor {
  91697. /**
  91698. * The physics-enabled object used as the physics imposter
  91699. */
  91700. object: IPhysicsEnabledObject;
  91701. /**
  91702. * The type of the physics imposter
  91703. */
  91704. type: number;
  91705. private _options;
  91706. private _scene?;
  91707. /**
  91708. * The default object size of the imposter
  91709. */
  91710. static DEFAULT_OBJECT_SIZE: Vector3;
  91711. /**
  91712. * The identity quaternion of the imposter
  91713. */
  91714. static IDENTITY_QUATERNION: Quaternion;
  91715. /** @hidden */
  91716. _pluginData: any;
  91717. private _physicsEngine;
  91718. private _physicsBody;
  91719. private _bodyUpdateRequired;
  91720. private _onBeforePhysicsStepCallbacks;
  91721. private _onAfterPhysicsStepCallbacks;
  91722. /** @hidden */
  91723. _onPhysicsCollideCallbacks: Array<{
  91724. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  91725. otherImpostors: Array<PhysicsImpostor>;
  91726. }>;
  91727. private _deltaPosition;
  91728. private _deltaRotation;
  91729. private _deltaRotationConjugated;
  91730. /** @hidden */
  91731. _isFromLine: boolean;
  91732. private _parent;
  91733. private _isDisposed;
  91734. private static _tmpVecs;
  91735. private static _tmpQuat;
  91736. /**
  91737. * Specifies if the physics imposter is disposed
  91738. */
  91739. readonly isDisposed: boolean;
  91740. /**
  91741. * Gets the mass of the physics imposter
  91742. */
  91743. mass: number;
  91744. /**
  91745. * Gets the coefficient of friction
  91746. */
  91747. /**
  91748. * Sets the coefficient of friction
  91749. */
  91750. friction: number;
  91751. /**
  91752. * Gets the coefficient of restitution
  91753. */
  91754. /**
  91755. * Sets the coefficient of restitution
  91756. */
  91757. restitution: number;
  91758. /**
  91759. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  91760. */
  91761. /**
  91762. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  91763. */
  91764. pressure: number;
  91765. /**
  91766. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  91767. */
  91768. /**
  91769. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  91770. */
  91771. stiffness: number;
  91772. /**
  91773. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  91774. */
  91775. /**
  91776. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  91777. */
  91778. velocityIterations: number;
  91779. /**
  91780. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  91781. */
  91782. /**
  91783. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  91784. */
  91785. positionIterations: number;
  91786. /**
  91787. * The unique id of the physics imposter
  91788. * set by the physics engine when adding this impostor to the array
  91789. */
  91790. uniqueId: number;
  91791. /**
  91792. * @hidden
  91793. */
  91794. soft: boolean;
  91795. /**
  91796. * @hidden
  91797. */
  91798. segments: number;
  91799. private _joints;
  91800. /**
  91801. * Initializes the physics imposter
  91802. * @param object The physics-enabled object used as the physics imposter
  91803. * @param type The type of the physics imposter
  91804. * @param _options The options for the physics imposter
  91805. * @param _scene The Babylon scene
  91806. */
  91807. constructor(
  91808. /**
  91809. * The physics-enabled object used as the physics imposter
  91810. */
  91811. object: IPhysicsEnabledObject,
  91812. /**
  91813. * The type of the physics imposter
  91814. */
  91815. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  91816. /**
  91817. * This function will completly initialize this impostor.
  91818. * It will create a new body - but only if this mesh has no parent.
  91819. * If it has, this impostor will not be used other than to define the impostor
  91820. * of the child mesh.
  91821. * @hidden
  91822. */
  91823. _init(): void;
  91824. private _getPhysicsParent;
  91825. /**
  91826. * Should a new body be generated.
  91827. * @returns boolean specifying if body initialization is required
  91828. */
  91829. isBodyInitRequired(): boolean;
  91830. /**
  91831. * Sets the updated scaling
  91832. * @param updated Specifies if the scaling is updated
  91833. */
  91834. setScalingUpdated(): void;
  91835. /**
  91836. * Force a regeneration of this or the parent's impostor's body.
  91837. * Use under cautious - This will remove all joints already implemented.
  91838. */
  91839. forceUpdate(): void;
  91840. /**
  91841. * Gets the body that holds this impostor. Either its own, or its parent.
  91842. */
  91843. /**
  91844. * Set the physics body. Used mainly by the physics engine/plugin
  91845. */
  91846. physicsBody: any;
  91847. /**
  91848. * Get the parent of the physics imposter
  91849. * @returns Physics imposter or null
  91850. */
  91851. /**
  91852. * Sets the parent of the physics imposter
  91853. */
  91854. parent: Nullable<PhysicsImpostor>;
  91855. /**
  91856. * Resets the update flags
  91857. */
  91858. resetUpdateFlags(): void;
  91859. /**
  91860. * Gets the object extend size
  91861. * @returns the object extend size
  91862. */
  91863. getObjectExtendSize(): Vector3;
  91864. /**
  91865. * Gets the object center
  91866. * @returns The object center
  91867. */
  91868. getObjectCenter(): Vector3;
  91869. /**
  91870. * Get a specific parametes from the options parameter
  91871. * @param paramName The object parameter name
  91872. * @returns The object parameter
  91873. */
  91874. getParam(paramName: string): any;
  91875. /**
  91876. * Sets a specific parameter in the options given to the physics plugin
  91877. * @param paramName The parameter name
  91878. * @param value The value of the parameter
  91879. */
  91880. setParam(paramName: string, value: number): void;
  91881. /**
  91882. * Specifically change the body's mass option. Won't recreate the physics body object
  91883. * @param mass The mass of the physics imposter
  91884. */
  91885. setMass(mass: number): void;
  91886. /**
  91887. * Gets the linear velocity
  91888. * @returns linear velocity or null
  91889. */
  91890. getLinearVelocity(): Nullable<Vector3>;
  91891. /**
  91892. * Sets the linear velocity
  91893. * @param velocity linear velocity or null
  91894. */
  91895. setLinearVelocity(velocity: Nullable<Vector3>): void;
  91896. /**
  91897. * Gets the angular velocity
  91898. * @returns angular velocity or null
  91899. */
  91900. getAngularVelocity(): Nullable<Vector3>;
  91901. /**
  91902. * Sets the angular velocity
  91903. * @param velocity The velocity or null
  91904. */
  91905. setAngularVelocity(velocity: Nullable<Vector3>): void;
  91906. /**
  91907. * Execute a function with the physics plugin native code
  91908. * Provide a function the will have two variables - the world object and the physics body object
  91909. * @param func The function to execute with the physics plugin native code
  91910. */
  91911. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  91912. /**
  91913. * Register a function that will be executed before the physics world is stepping forward
  91914. * @param func The function to execute before the physics world is stepped forward
  91915. */
  91916. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91917. /**
  91918. * Unregister a function that will be executed before the physics world is stepping forward
  91919. * @param func The function to execute before the physics world is stepped forward
  91920. */
  91921. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91922. /**
  91923. * Register a function that will be executed after the physics step
  91924. * @param func The function to execute after physics step
  91925. */
  91926. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91927. /**
  91928. * Unregisters a function that will be executed after the physics step
  91929. * @param func The function to execute after physics step
  91930. */
  91931. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91932. /**
  91933. * register a function that will be executed when this impostor collides against a different body
  91934. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  91935. * @param func Callback that is executed on collision
  91936. */
  91937. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  91938. /**
  91939. * Unregisters the physics imposter on contact
  91940. * @param collideAgainst The physics object to collide against
  91941. * @param func Callback to execute on collision
  91942. */
  91943. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  91944. private _tmpQuat;
  91945. private _tmpQuat2;
  91946. /**
  91947. * Get the parent rotation
  91948. * @returns The parent rotation
  91949. */
  91950. getParentsRotation(): Quaternion;
  91951. /**
  91952. * this function is executed by the physics engine.
  91953. */
  91954. beforeStep: () => void;
  91955. /**
  91956. * this function is executed by the physics engine
  91957. */
  91958. afterStep: () => void;
  91959. /**
  91960. * Legacy collision detection event support
  91961. */
  91962. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  91963. /**
  91964. * event and body object due to cannon's event-based architecture.
  91965. */
  91966. onCollide: (e: {
  91967. body: any;
  91968. }) => void;
  91969. /**
  91970. * Apply a force
  91971. * @param force The force to apply
  91972. * @param contactPoint The contact point for the force
  91973. * @returns The physics imposter
  91974. */
  91975. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91976. /**
  91977. * Apply an impulse
  91978. * @param force The impulse force
  91979. * @param contactPoint The contact point for the impulse force
  91980. * @returns The physics imposter
  91981. */
  91982. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91983. /**
  91984. * A help function to create a joint
  91985. * @param otherImpostor A physics imposter used to create a joint
  91986. * @param jointType The type of joint
  91987. * @param jointData The data for the joint
  91988. * @returns The physics imposter
  91989. */
  91990. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  91991. /**
  91992. * Add a joint to this impostor with a different impostor
  91993. * @param otherImpostor A physics imposter used to add a joint
  91994. * @param joint The joint to add
  91995. * @returns The physics imposter
  91996. */
  91997. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  91998. /**
  91999. * Add an anchor to a cloth impostor
  92000. * @param otherImpostor rigid impostor to anchor to
  92001. * @param width ratio across width from 0 to 1
  92002. * @param height ratio up height from 0 to 1
  92003. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  92004. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  92005. * @returns impostor the soft imposter
  92006. */
  92007. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  92008. /**
  92009. * Add a hook to a rope impostor
  92010. * @param otherImpostor rigid impostor to anchor to
  92011. * @param length ratio across rope from 0 to 1
  92012. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  92013. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  92014. * @returns impostor the rope imposter
  92015. */
  92016. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  92017. /**
  92018. * Will keep this body still, in a sleep mode.
  92019. * @returns the physics imposter
  92020. */
  92021. sleep(): PhysicsImpostor;
  92022. /**
  92023. * Wake the body up.
  92024. * @returns The physics imposter
  92025. */
  92026. wakeUp(): PhysicsImpostor;
  92027. /**
  92028. * Clones the physics imposter
  92029. * @param newObject The physics imposter clones to this physics-enabled object
  92030. * @returns A nullable physics imposter
  92031. */
  92032. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  92033. /**
  92034. * Disposes the physics imposter
  92035. */
  92036. dispose(): void;
  92037. /**
  92038. * Sets the delta position
  92039. * @param position The delta position amount
  92040. */
  92041. setDeltaPosition(position: Vector3): void;
  92042. /**
  92043. * Sets the delta rotation
  92044. * @param rotation The delta rotation amount
  92045. */
  92046. setDeltaRotation(rotation: Quaternion): void;
  92047. /**
  92048. * Gets the box size of the physics imposter and stores the result in the input parameter
  92049. * @param result Stores the box size
  92050. * @returns The physics imposter
  92051. */
  92052. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  92053. /**
  92054. * Gets the radius of the physics imposter
  92055. * @returns Radius of the physics imposter
  92056. */
  92057. getRadius(): number;
  92058. /**
  92059. * Sync a bone with this impostor
  92060. * @param bone The bone to sync to the impostor.
  92061. * @param boneMesh The mesh that the bone is influencing.
  92062. * @param jointPivot The pivot of the joint / bone in local space.
  92063. * @param distToJoint Optional distance from the impostor to the joint.
  92064. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  92065. */
  92066. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  92067. /**
  92068. * Sync impostor to a bone
  92069. * @param bone The bone that the impostor will be synced to.
  92070. * @param boneMesh The mesh that the bone is influencing.
  92071. * @param jointPivot The pivot of the joint / bone in local space.
  92072. * @param distToJoint Optional distance from the impostor to the joint.
  92073. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  92074. * @param boneAxis Optional vector3 axis the bone is aligned with
  92075. */
  92076. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  92077. /**
  92078. * No-Imposter type
  92079. */
  92080. static NoImpostor: number;
  92081. /**
  92082. * Sphere-Imposter type
  92083. */
  92084. static SphereImpostor: number;
  92085. /**
  92086. * Box-Imposter type
  92087. */
  92088. static BoxImpostor: number;
  92089. /**
  92090. * Plane-Imposter type
  92091. */
  92092. static PlaneImpostor: number;
  92093. /**
  92094. * Mesh-imposter type
  92095. */
  92096. static MeshImpostor: number;
  92097. /**
  92098. * Capsule-Impostor type (Ammo.js plugin only)
  92099. */
  92100. static CapsuleImpostor: number;
  92101. /**
  92102. * Cylinder-Imposter type
  92103. */
  92104. static CylinderImpostor: number;
  92105. /**
  92106. * Particle-Imposter type
  92107. */
  92108. static ParticleImpostor: number;
  92109. /**
  92110. * Heightmap-Imposter type
  92111. */
  92112. static HeightmapImpostor: number;
  92113. /**
  92114. * ConvexHull-Impostor type (Ammo.js plugin only)
  92115. */
  92116. static ConvexHullImpostor: number;
  92117. /**
  92118. * Rope-Imposter type
  92119. */
  92120. static RopeImpostor: number;
  92121. /**
  92122. * Cloth-Imposter type
  92123. */
  92124. static ClothImpostor: number;
  92125. /**
  92126. * Softbody-Imposter type
  92127. */
  92128. static SoftbodyImpostor: number;
  92129. }
  92130. }
  92131. declare module BABYLON {
  92132. /**
  92133. * @hidden
  92134. **/
  92135. export class _CreationDataStorage {
  92136. closePath?: boolean;
  92137. closeArray?: boolean;
  92138. idx: number[];
  92139. dashSize: number;
  92140. gapSize: number;
  92141. path3D: Path3D;
  92142. pathArray: Vector3[][];
  92143. arc: number;
  92144. radius: number;
  92145. cap: number;
  92146. tessellation: number;
  92147. }
  92148. /**
  92149. * @hidden
  92150. **/
  92151. class _InstanceDataStorage {
  92152. visibleInstances: any;
  92153. batchCache: _InstancesBatch;
  92154. instancesBufferSize: number;
  92155. instancesBuffer: Nullable<Buffer>;
  92156. instancesData: Float32Array;
  92157. overridenInstanceCount: number;
  92158. isFrozen: boolean;
  92159. previousBatch: Nullable<_InstancesBatch>;
  92160. hardwareInstancedRendering: boolean;
  92161. sideOrientation: number;
  92162. manualUpdate: boolean;
  92163. }
  92164. /**
  92165. * @hidden
  92166. **/
  92167. export class _InstancesBatch {
  92168. mustReturn: boolean;
  92169. visibleInstances: Nullable<InstancedMesh[]>[];
  92170. renderSelf: boolean[];
  92171. hardwareInstancedRendering: boolean[];
  92172. }
  92173. /**
  92174. * Class used to represent renderable models
  92175. */
  92176. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  92177. /**
  92178. * Mesh side orientation : usually the external or front surface
  92179. */
  92180. static readonly FRONTSIDE: number;
  92181. /**
  92182. * Mesh side orientation : usually the internal or back surface
  92183. */
  92184. static readonly BACKSIDE: number;
  92185. /**
  92186. * Mesh side orientation : both internal and external or front and back surfaces
  92187. */
  92188. static readonly DOUBLESIDE: number;
  92189. /**
  92190. * Mesh side orientation : by default, `FRONTSIDE`
  92191. */
  92192. static readonly DEFAULTSIDE: number;
  92193. /**
  92194. * Mesh cap setting : no cap
  92195. */
  92196. static readonly NO_CAP: number;
  92197. /**
  92198. * Mesh cap setting : one cap at the beginning of the mesh
  92199. */
  92200. static readonly CAP_START: number;
  92201. /**
  92202. * Mesh cap setting : one cap at the end of the mesh
  92203. */
  92204. static readonly CAP_END: number;
  92205. /**
  92206. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  92207. */
  92208. static readonly CAP_ALL: number;
  92209. /**
  92210. * Mesh pattern setting : no flip or rotate
  92211. */
  92212. static readonly NO_FLIP: number;
  92213. /**
  92214. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  92215. */
  92216. static readonly FLIP_TILE: number;
  92217. /**
  92218. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  92219. */
  92220. static readonly ROTATE_TILE: number;
  92221. /**
  92222. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  92223. */
  92224. static readonly FLIP_ROW: number;
  92225. /**
  92226. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  92227. */
  92228. static readonly ROTATE_ROW: number;
  92229. /**
  92230. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  92231. */
  92232. static readonly FLIP_N_ROTATE_TILE: number;
  92233. /**
  92234. * Mesh pattern setting : rotate pattern and rotate
  92235. */
  92236. static readonly FLIP_N_ROTATE_ROW: number;
  92237. /**
  92238. * Mesh tile positioning : part tiles same on left/right or top/bottom
  92239. */
  92240. static readonly CENTER: number;
  92241. /**
  92242. * Mesh tile positioning : part tiles on left
  92243. */
  92244. static readonly LEFT: number;
  92245. /**
  92246. * Mesh tile positioning : part tiles on right
  92247. */
  92248. static readonly RIGHT: number;
  92249. /**
  92250. * Mesh tile positioning : part tiles on top
  92251. */
  92252. static readonly TOP: number;
  92253. /**
  92254. * Mesh tile positioning : part tiles on bottom
  92255. */
  92256. static readonly BOTTOM: number;
  92257. /**
  92258. * Gets the default side orientation.
  92259. * @param orientation the orientation to value to attempt to get
  92260. * @returns the default orientation
  92261. * @hidden
  92262. */
  92263. static _GetDefaultSideOrientation(orientation?: number): number;
  92264. private _internalMeshDataInfo;
  92265. /**
  92266. * An event triggered before rendering the mesh
  92267. */
  92268. readonly onBeforeRenderObservable: Observable<Mesh>;
  92269. /**
  92270. * An event triggered before binding the mesh
  92271. */
  92272. readonly onBeforeBindObservable: Observable<Mesh>;
  92273. /**
  92274. * An event triggered after rendering the mesh
  92275. */
  92276. readonly onAfterRenderObservable: Observable<Mesh>;
  92277. /**
  92278. * An event triggered before drawing the mesh
  92279. */
  92280. readonly onBeforeDrawObservable: Observable<Mesh>;
  92281. private _onBeforeDrawObserver;
  92282. /**
  92283. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  92284. */
  92285. onBeforeDraw: () => void;
  92286. readonly hasInstances: boolean;
  92287. /**
  92288. * Gets the delay loading state of the mesh (when delay loading is turned on)
  92289. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  92290. */
  92291. delayLoadState: number;
  92292. /**
  92293. * Gets the list of instances created from this mesh
  92294. * it is not supposed to be modified manually.
  92295. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  92296. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92297. */
  92298. instances: InstancedMesh[];
  92299. /**
  92300. * Gets the file containing delay loading data for this mesh
  92301. */
  92302. delayLoadingFile: string;
  92303. /** @hidden */
  92304. _binaryInfo: any;
  92305. /**
  92306. * User defined function used to change how LOD level selection is done
  92307. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  92308. */
  92309. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  92310. /**
  92311. * Gets or sets the morph target manager
  92312. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  92313. */
  92314. morphTargetManager: Nullable<MorphTargetManager>;
  92315. /** @hidden */
  92316. _creationDataStorage: Nullable<_CreationDataStorage>;
  92317. /** @hidden */
  92318. _geometry: Nullable<Geometry>;
  92319. /** @hidden */
  92320. _delayInfo: Array<string>;
  92321. /** @hidden */
  92322. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  92323. /** @hidden */
  92324. _instanceDataStorage: _InstanceDataStorage;
  92325. private _effectiveMaterial;
  92326. /** @hidden */
  92327. _shouldGenerateFlatShading: boolean;
  92328. /** @hidden */
  92329. _originalBuilderSideOrientation: number;
  92330. /**
  92331. * Use this property to change the original side orientation defined at construction time
  92332. */
  92333. overrideMaterialSideOrientation: Nullable<number>;
  92334. /**
  92335. * Gets the source mesh (the one used to clone this one from)
  92336. */
  92337. readonly source: Nullable<Mesh>;
  92338. /**
  92339. * Gets or sets a boolean indicating that this mesh does not use index buffer
  92340. */
  92341. isUnIndexed: boolean;
  92342. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  92343. readonly worldMatrixInstancedBuffer: Float32Array;
  92344. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  92345. manualUpdateOfWorldMatrixInstancedBuffer: boolean;
  92346. /**
  92347. * @constructor
  92348. * @param name The value used by scene.getMeshByName() to do a lookup.
  92349. * @param scene The scene to add this mesh to.
  92350. * @param parent The parent of this mesh, if it has one
  92351. * @param source An optional Mesh from which geometry is shared, cloned.
  92352. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  92353. * When false, achieved by calling a clone(), also passing False.
  92354. * This will make creation of children, recursive.
  92355. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  92356. */
  92357. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  92358. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  92359. doNotInstantiate: boolean;
  92360. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  92361. /**
  92362. * Gets the class name
  92363. * @returns the string "Mesh".
  92364. */
  92365. getClassName(): string;
  92366. /** @hidden */
  92367. readonly _isMesh: boolean;
  92368. /**
  92369. * Returns a description of this mesh
  92370. * @param fullDetails define if full details about this mesh must be used
  92371. * @returns a descriptive string representing this mesh
  92372. */
  92373. toString(fullDetails?: boolean): string;
  92374. /** @hidden */
  92375. _unBindEffect(): void;
  92376. /**
  92377. * Gets a boolean indicating if this mesh has LOD
  92378. */
  92379. readonly hasLODLevels: boolean;
  92380. /**
  92381. * Gets the list of MeshLODLevel associated with the current mesh
  92382. * @returns an array of MeshLODLevel
  92383. */
  92384. getLODLevels(): MeshLODLevel[];
  92385. private _sortLODLevels;
  92386. /**
  92387. * Add a mesh as LOD level triggered at the given distance.
  92388. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92389. * @param distance The distance from the center of the object to show this level
  92390. * @param mesh The mesh to be added as LOD level (can be null)
  92391. * @return This mesh (for chaining)
  92392. */
  92393. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  92394. /**
  92395. * Returns the LOD level mesh at the passed distance or null if not found.
  92396. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92397. * @param distance The distance from the center of the object to show this level
  92398. * @returns a Mesh or `null`
  92399. */
  92400. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  92401. /**
  92402. * Remove a mesh from the LOD array
  92403. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92404. * @param mesh defines the mesh to be removed
  92405. * @return This mesh (for chaining)
  92406. */
  92407. removeLODLevel(mesh: Mesh): Mesh;
  92408. /**
  92409. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  92410. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92411. * @param camera defines the camera to use to compute distance
  92412. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  92413. * @return This mesh (for chaining)
  92414. */
  92415. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  92416. /**
  92417. * Gets the mesh internal Geometry object
  92418. */
  92419. readonly geometry: Nullable<Geometry>;
  92420. /**
  92421. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  92422. * @returns the total number of vertices
  92423. */
  92424. getTotalVertices(): number;
  92425. /**
  92426. * Returns the content of an associated vertex buffer
  92427. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92428. * - VertexBuffer.PositionKind
  92429. * - VertexBuffer.UVKind
  92430. * - VertexBuffer.UV2Kind
  92431. * - VertexBuffer.UV3Kind
  92432. * - VertexBuffer.UV4Kind
  92433. * - VertexBuffer.UV5Kind
  92434. * - VertexBuffer.UV6Kind
  92435. * - VertexBuffer.ColorKind
  92436. * - VertexBuffer.MatricesIndicesKind
  92437. * - VertexBuffer.MatricesIndicesExtraKind
  92438. * - VertexBuffer.MatricesWeightsKind
  92439. * - VertexBuffer.MatricesWeightsExtraKind
  92440. * @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
  92441. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  92442. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  92443. */
  92444. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  92445. /**
  92446. * Returns the mesh VertexBuffer object from the requested `kind`
  92447. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92448. * - VertexBuffer.PositionKind
  92449. * - VertexBuffer.NormalKind
  92450. * - VertexBuffer.UVKind
  92451. * - VertexBuffer.UV2Kind
  92452. * - VertexBuffer.UV3Kind
  92453. * - VertexBuffer.UV4Kind
  92454. * - VertexBuffer.UV5Kind
  92455. * - VertexBuffer.UV6Kind
  92456. * - VertexBuffer.ColorKind
  92457. * - VertexBuffer.MatricesIndicesKind
  92458. * - VertexBuffer.MatricesIndicesExtraKind
  92459. * - VertexBuffer.MatricesWeightsKind
  92460. * - VertexBuffer.MatricesWeightsExtraKind
  92461. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  92462. */
  92463. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  92464. /**
  92465. * Tests if a specific vertex buffer is associated with this mesh
  92466. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  92467. * - VertexBuffer.PositionKind
  92468. * - VertexBuffer.NormalKind
  92469. * - VertexBuffer.UVKind
  92470. * - VertexBuffer.UV2Kind
  92471. * - VertexBuffer.UV3Kind
  92472. * - VertexBuffer.UV4Kind
  92473. * - VertexBuffer.UV5Kind
  92474. * - VertexBuffer.UV6Kind
  92475. * - VertexBuffer.ColorKind
  92476. * - VertexBuffer.MatricesIndicesKind
  92477. * - VertexBuffer.MatricesIndicesExtraKind
  92478. * - VertexBuffer.MatricesWeightsKind
  92479. * - VertexBuffer.MatricesWeightsExtraKind
  92480. * @returns a boolean
  92481. */
  92482. isVerticesDataPresent(kind: string): boolean;
  92483. /**
  92484. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  92485. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  92486. * - VertexBuffer.PositionKind
  92487. * - VertexBuffer.UVKind
  92488. * - VertexBuffer.UV2Kind
  92489. * - VertexBuffer.UV3Kind
  92490. * - VertexBuffer.UV4Kind
  92491. * - VertexBuffer.UV5Kind
  92492. * - VertexBuffer.UV6Kind
  92493. * - VertexBuffer.ColorKind
  92494. * - VertexBuffer.MatricesIndicesKind
  92495. * - VertexBuffer.MatricesIndicesExtraKind
  92496. * - VertexBuffer.MatricesWeightsKind
  92497. * - VertexBuffer.MatricesWeightsExtraKind
  92498. * @returns a boolean
  92499. */
  92500. isVertexBufferUpdatable(kind: string): boolean;
  92501. /**
  92502. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  92503. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92504. * - VertexBuffer.PositionKind
  92505. * - VertexBuffer.NormalKind
  92506. * - VertexBuffer.UVKind
  92507. * - VertexBuffer.UV2Kind
  92508. * - VertexBuffer.UV3Kind
  92509. * - VertexBuffer.UV4Kind
  92510. * - VertexBuffer.UV5Kind
  92511. * - VertexBuffer.UV6Kind
  92512. * - VertexBuffer.ColorKind
  92513. * - VertexBuffer.MatricesIndicesKind
  92514. * - VertexBuffer.MatricesIndicesExtraKind
  92515. * - VertexBuffer.MatricesWeightsKind
  92516. * - VertexBuffer.MatricesWeightsExtraKind
  92517. * @returns an array of strings
  92518. */
  92519. getVerticesDataKinds(): string[];
  92520. /**
  92521. * Returns a positive integer : the total number of indices in this mesh geometry.
  92522. * @returns the numner of indices or zero if the mesh has no geometry.
  92523. */
  92524. getTotalIndices(): number;
  92525. /**
  92526. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  92527. * @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.
  92528. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  92529. * @returns the indices array or an empty array if the mesh has no geometry
  92530. */
  92531. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  92532. readonly isBlocked: boolean;
  92533. /**
  92534. * Determine if the current mesh is ready to be rendered
  92535. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  92536. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  92537. * @returns true if all associated assets are ready (material, textures, shaders)
  92538. */
  92539. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  92540. /**
  92541. * 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.
  92542. */
  92543. readonly areNormalsFrozen: boolean;
  92544. /**
  92545. * 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.
  92546. * @returns the current mesh
  92547. */
  92548. freezeNormals(): Mesh;
  92549. /**
  92550. * 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
  92551. * @returns the current mesh
  92552. */
  92553. unfreezeNormals(): Mesh;
  92554. /**
  92555. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  92556. */
  92557. overridenInstanceCount: number;
  92558. /** @hidden */
  92559. _preActivate(): Mesh;
  92560. /** @hidden */
  92561. _preActivateForIntermediateRendering(renderId: number): Mesh;
  92562. /** @hidden */
  92563. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  92564. /**
  92565. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  92566. * This means the mesh underlying bounding box and sphere are recomputed.
  92567. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  92568. * @returns the current mesh
  92569. */
  92570. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  92571. /** @hidden */
  92572. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  92573. /**
  92574. * This function will subdivide the mesh into multiple submeshes
  92575. * @param count defines the expected number of submeshes
  92576. */
  92577. subdivide(count: number): void;
  92578. /**
  92579. * Copy a FloatArray into a specific associated vertex buffer
  92580. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  92581. * - VertexBuffer.PositionKind
  92582. * - VertexBuffer.UVKind
  92583. * - VertexBuffer.UV2Kind
  92584. * - VertexBuffer.UV3Kind
  92585. * - VertexBuffer.UV4Kind
  92586. * - VertexBuffer.UV5Kind
  92587. * - VertexBuffer.UV6Kind
  92588. * - VertexBuffer.ColorKind
  92589. * - VertexBuffer.MatricesIndicesKind
  92590. * - VertexBuffer.MatricesIndicesExtraKind
  92591. * - VertexBuffer.MatricesWeightsKind
  92592. * - VertexBuffer.MatricesWeightsExtraKind
  92593. * @param data defines the data source
  92594. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  92595. * @param stride defines the data stride size (can be null)
  92596. * @returns the current mesh
  92597. */
  92598. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  92599. /**
  92600. * Delete a vertex buffer associated with this mesh
  92601. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  92602. * - VertexBuffer.PositionKind
  92603. * - VertexBuffer.UVKind
  92604. * - VertexBuffer.UV2Kind
  92605. * - VertexBuffer.UV3Kind
  92606. * - VertexBuffer.UV4Kind
  92607. * - VertexBuffer.UV5Kind
  92608. * - VertexBuffer.UV6Kind
  92609. * - VertexBuffer.ColorKind
  92610. * - VertexBuffer.MatricesIndicesKind
  92611. * - VertexBuffer.MatricesIndicesExtraKind
  92612. * - VertexBuffer.MatricesWeightsKind
  92613. * - VertexBuffer.MatricesWeightsExtraKind
  92614. */
  92615. removeVerticesData(kind: string): void;
  92616. /**
  92617. * Flags an associated vertex buffer as updatable
  92618. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  92619. * - VertexBuffer.PositionKind
  92620. * - VertexBuffer.UVKind
  92621. * - VertexBuffer.UV2Kind
  92622. * - VertexBuffer.UV3Kind
  92623. * - VertexBuffer.UV4Kind
  92624. * - VertexBuffer.UV5Kind
  92625. * - VertexBuffer.UV6Kind
  92626. * - VertexBuffer.ColorKind
  92627. * - VertexBuffer.MatricesIndicesKind
  92628. * - VertexBuffer.MatricesIndicesExtraKind
  92629. * - VertexBuffer.MatricesWeightsKind
  92630. * - VertexBuffer.MatricesWeightsExtraKind
  92631. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  92632. */
  92633. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  92634. /**
  92635. * Sets the mesh global Vertex Buffer
  92636. * @param buffer defines the buffer to use
  92637. * @returns the current mesh
  92638. */
  92639. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  92640. /**
  92641. * Update a specific associated vertex buffer
  92642. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  92643. * - VertexBuffer.PositionKind
  92644. * - VertexBuffer.UVKind
  92645. * - VertexBuffer.UV2Kind
  92646. * - VertexBuffer.UV3Kind
  92647. * - VertexBuffer.UV4Kind
  92648. * - VertexBuffer.UV5Kind
  92649. * - VertexBuffer.UV6Kind
  92650. * - VertexBuffer.ColorKind
  92651. * - VertexBuffer.MatricesIndicesKind
  92652. * - VertexBuffer.MatricesIndicesExtraKind
  92653. * - VertexBuffer.MatricesWeightsKind
  92654. * - VertexBuffer.MatricesWeightsExtraKind
  92655. * @param data defines the data source
  92656. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  92657. * @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)
  92658. * @returns the current mesh
  92659. */
  92660. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  92661. /**
  92662. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  92663. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  92664. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  92665. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  92666. * @returns the current mesh
  92667. */
  92668. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  92669. /**
  92670. * Creates a un-shared specific occurence of the geometry for the mesh.
  92671. * @returns the current mesh
  92672. */
  92673. makeGeometryUnique(): Mesh;
  92674. /**
  92675. * Set the index buffer of this mesh
  92676. * @param indices defines the source data
  92677. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  92678. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  92679. * @returns the current mesh
  92680. */
  92681. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  92682. /**
  92683. * Update the current index buffer
  92684. * @param indices defines the source data
  92685. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  92686. * @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)
  92687. * @returns the current mesh
  92688. */
  92689. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  92690. /**
  92691. * Invert the geometry to move from a right handed system to a left handed one.
  92692. * @returns the current mesh
  92693. */
  92694. toLeftHanded(): Mesh;
  92695. /** @hidden */
  92696. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  92697. /** @hidden */
  92698. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  92699. /**
  92700. * Registers for this mesh a javascript function called just before the rendering process
  92701. * @param func defines the function to call before rendering this mesh
  92702. * @returns the current mesh
  92703. */
  92704. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  92705. /**
  92706. * Disposes a previously registered javascript function called before the rendering
  92707. * @param func defines the function to remove
  92708. * @returns the current mesh
  92709. */
  92710. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  92711. /**
  92712. * Registers for this mesh a javascript function called just after the rendering is complete
  92713. * @param func defines the function to call after rendering this mesh
  92714. * @returns the current mesh
  92715. */
  92716. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  92717. /**
  92718. * Disposes a previously registered javascript function called after the rendering.
  92719. * @param func defines the function to remove
  92720. * @returns the current mesh
  92721. */
  92722. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  92723. /** @hidden */
  92724. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  92725. /** @hidden */
  92726. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  92727. /** @hidden */
  92728. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  92729. /** @hidden */
  92730. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  92731. /** @hidden */
  92732. _rebuild(): void;
  92733. /** @hidden */
  92734. _freeze(): void;
  92735. /** @hidden */
  92736. _unFreeze(): void;
  92737. /**
  92738. * 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
  92739. * @param subMesh defines the subMesh to render
  92740. * @param enableAlphaMode defines if alpha mode can be changed
  92741. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  92742. * @returns the current mesh
  92743. */
  92744. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  92745. private _onBeforeDraw;
  92746. /**
  92747. * Renormalize the mesh and patch it up if there are no weights
  92748. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  92749. * However in the case of zero weights then we set just a single influence to 1.
  92750. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  92751. */
  92752. cleanMatrixWeights(): void;
  92753. private normalizeSkinFourWeights;
  92754. private normalizeSkinWeightsAndExtra;
  92755. /**
  92756. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  92757. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  92758. * the user know there was an issue with importing the mesh
  92759. * @returns a validation object with skinned, valid and report string
  92760. */
  92761. validateSkinning(): {
  92762. skinned: boolean;
  92763. valid: boolean;
  92764. report: string;
  92765. };
  92766. /** @hidden */
  92767. _checkDelayState(): Mesh;
  92768. private _queueLoad;
  92769. /**
  92770. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  92771. * A mesh is in the frustum if its bounding box intersects the frustum
  92772. * @param frustumPlanes defines the frustum to test
  92773. * @returns true if the mesh is in the frustum planes
  92774. */
  92775. isInFrustum(frustumPlanes: Plane[]): boolean;
  92776. /**
  92777. * Sets the mesh material by the material or multiMaterial `id` property
  92778. * @param id is a string identifying the material or the multiMaterial
  92779. * @returns the current mesh
  92780. */
  92781. setMaterialByID(id: string): Mesh;
  92782. /**
  92783. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  92784. * @returns an array of IAnimatable
  92785. */
  92786. getAnimatables(): IAnimatable[];
  92787. /**
  92788. * Modifies the mesh geometry according to the passed transformation matrix.
  92789. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  92790. * The mesh normals are modified using the same transformation.
  92791. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92792. * @param transform defines the transform matrix to use
  92793. * @see http://doc.babylonjs.com/resources/baking_transformations
  92794. * @returns the current mesh
  92795. */
  92796. bakeTransformIntoVertices(transform: Matrix): Mesh;
  92797. /**
  92798. * Modifies the mesh geometry according to its own current World Matrix.
  92799. * The mesh World Matrix is then reset.
  92800. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  92801. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92802. * @see http://doc.babylonjs.com/resources/baking_transformations
  92803. * @returns the current mesh
  92804. */
  92805. bakeCurrentTransformIntoVertices(): Mesh;
  92806. /** @hidden */
  92807. readonly _positions: Nullable<Vector3[]>;
  92808. /** @hidden */
  92809. _resetPointsArrayCache(): Mesh;
  92810. /** @hidden */
  92811. _generatePointsArray(): boolean;
  92812. /**
  92813. * Returns a new Mesh object generated from the current mesh properties.
  92814. * This method must not get confused with createInstance()
  92815. * @param name is a string, the name given to the new mesh
  92816. * @param newParent can be any Node object (default `null`)
  92817. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  92818. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  92819. * @returns a new mesh
  92820. */
  92821. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  92822. /**
  92823. * Releases resources associated with this mesh.
  92824. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92825. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92826. */
  92827. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92828. /** @hidden */
  92829. _disposeInstanceSpecificData(): void;
  92830. /**
  92831. * Modifies the mesh geometry according to a displacement map.
  92832. * 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.
  92833. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92834. * @param url is a string, the URL from the image file is to be downloaded.
  92835. * @param minHeight is the lower limit of the displacement.
  92836. * @param maxHeight is the upper limit of the displacement.
  92837. * @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.
  92838. * @param uvOffset is an optional vector2 used to offset UV.
  92839. * @param uvScale is an optional vector2 used to scale UV.
  92840. * @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.
  92841. * @returns the Mesh.
  92842. */
  92843. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92844. /**
  92845. * Modifies the mesh geometry according to a displacementMap buffer.
  92846. * 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.
  92847. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92848. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  92849. * @param heightMapWidth is the width of the buffer image.
  92850. * @param heightMapHeight is the height of the buffer image.
  92851. * @param minHeight is the lower limit of the displacement.
  92852. * @param maxHeight is the upper limit of the displacement.
  92853. * @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.
  92854. * @param uvOffset is an optional vector2 used to offset UV.
  92855. * @param uvScale is an optional vector2 used to scale UV.
  92856. * @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.
  92857. * @returns the Mesh.
  92858. */
  92859. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92860. /**
  92861. * Modify the mesh to get a flat shading rendering.
  92862. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  92863. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  92864. * @returns current mesh
  92865. */
  92866. convertToFlatShadedMesh(): Mesh;
  92867. /**
  92868. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  92869. * In other words, more vertices, no more indices and a single bigger VBO.
  92870. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  92871. * @returns current mesh
  92872. */
  92873. convertToUnIndexedMesh(): Mesh;
  92874. /**
  92875. * Inverses facet orientations.
  92876. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92877. * @param flipNormals will also inverts the normals
  92878. * @returns current mesh
  92879. */
  92880. flipFaces(flipNormals?: boolean): Mesh;
  92881. /**
  92882. * Increase the number of facets and hence vertices in a mesh
  92883. * Vertex normals are interpolated from existing vertex normals
  92884. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92885. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  92886. */
  92887. increaseVertices(numberPerEdge: number): void;
  92888. /**
  92889. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  92890. * This will undo any application of covertToFlatShadedMesh
  92891. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92892. */
  92893. forceSharedVertices(): void;
  92894. /** @hidden */
  92895. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  92896. /** @hidden */
  92897. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  92898. /**
  92899. * Creates a new InstancedMesh object from the mesh model.
  92900. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92901. * @param name defines the name of the new instance
  92902. * @returns a new InstancedMesh
  92903. */
  92904. createInstance(name: string): InstancedMesh;
  92905. /**
  92906. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  92907. * After this call, all the mesh instances have the same submeshes than the current mesh.
  92908. * @returns the current mesh
  92909. */
  92910. synchronizeInstances(): Mesh;
  92911. /**
  92912. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  92913. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  92914. * This should be used together with the simplification to avoid disappearing triangles.
  92915. * @param successCallback an optional success callback to be called after the optimization finished.
  92916. * @returns the current mesh
  92917. */
  92918. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  92919. /**
  92920. * Serialize current mesh
  92921. * @param serializationObject defines the object which will receive the serialization data
  92922. */
  92923. serialize(serializationObject: any): void;
  92924. /** @hidden */
  92925. _syncGeometryWithMorphTargetManager(): void;
  92926. /** @hidden */
  92927. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  92928. /**
  92929. * Returns a new Mesh object parsed from the source provided.
  92930. * @param parsedMesh is the source
  92931. * @param scene defines the hosting scene
  92932. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  92933. * @returns a new Mesh
  92934. */
  92935. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  92936. /**
  92937. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  92938. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92939. * @param name defines the name of the mesh to create
  92940. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  92941. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  92942. * @param closePath creates a seam between the first and the last points of each path of the path array
  92943. * @param offset is taken in account only if the `pathArray` is containing a single path
  92944. * @param scene defines the hosting scene
  92945. * @param updatable defines if the mesh must be flagged as updatable
  92946. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92947. * @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)
  92948. * @returns a new Mesh
  92949. */
  92950. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92951. /**
  92952. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  92953. * @param name defines the name of the mesh to create
  92954. * @param radius sets the radius size (float) of the polygon (default 0.5)
  92955. * @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
  92956. * @param scene defines the hosting scene
  92957. * @param updatable defines if the mesh must be flagged as updatable
  92958. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92959. * @returns a new Mesh
  92960. */
  92961. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92962. /**
  92963. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  92964. * @param name defines the name of the mesh to create
  92965. * @param size sets the size (float) of each box side (default 1)
  92966. * @param scene defines the hosting scene
  92967. * @param updatable defines if the mesh must be flagged as updatable
  92968. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92969. * @returns a new Mesh
  92970. */
  92971. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92972. /**
  92973. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  92974. * @param name defines the name of the mesh to create
  92975. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92976. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92977. * @param scene defines the hosting scene
  92978. * @param updatable defines if the mesh must be flagged as updatable
  92979. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92980. * @returns a new Mesh
  92981. */
  92982. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92983. /**
  92984. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  92985. * @param name defines the name of the mesh to create
  92986. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92987. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92988. * @param scene defines the hosting scene
  92989. * @returns a new Mesh
  92990. */
  92991. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  92992. /**
  92993. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  92994. * @param name defines the name of the mesh to create
  92995. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  92996. * @param diameterTop set the top cap diameter (floats, default 1)
  92997. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  92998. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  92999. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  93000. * @param scene defines the hosting scene
  93001. * @param updatable defines if the mesh must be flagged as updatable
  93002. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93003. * @returns a new Mesh
  93004. */
  93005. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  93006. /**
  93007. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  93008. * @param name defines the name of the mesh to create
  93009. * @param diameter sets the diameter size (float) of the torus (default 1)
  93010. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  93011. * @param tessellation sets the number of torus sides (postive integer, default 16)
  93012. * @param scene defines the hosting scene
  93013. * @param updatable defines if the mesh must be flagged as updatable
  93014. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93015. * @returns a new Mesh
  93016. */
  93017. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  93018. /**
  93019. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  93020. * @param name defines the name of the mesh to create
  93021. * @param radius sets the global radius size (float) of the torus knot (default 2)
  93022. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  93023. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  93024. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  93025. * @param p the number of windings on X axis (positive integers, default 2)
  93026. * @param q the number of windings on Y axis (positive integers, default 3)
  93027. * @param scene defines the hosting scene
  93028. * @param updatable defines if the mesh must be flagged as updatable
  93029. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93030. * @returns a new Mesh
  93031. */
  93032. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  93033. /**
  93034. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  93035. * @param name defines the name of the mesh to create
  93036. * @param points is an array successive Vector3
  93037. * @param scene defines the hosting scene
  93038. * @param updatable defines if the mesh must be flagged as updatable
  93039. * @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).
  93040. * @returns a new Mesh
  93041. */
  93042. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  93043. /**
  93044. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  93045. * @param name defines the name of the mesh to create
  93046. * @param points is an array successive Vector3
  93047. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  93048. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  93049. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  93050. * @param scene defines the hosting scene
  93051. * @param updatable defines if the mesh must be flagged as updatable
  93052. * @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)
  93053. * @returns a new Mesh
  93054. */
  93055. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  93056. /**
  93057. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  93058. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  93059. * 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.
  93060. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  93061. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  93062. * Remember you can only change the shape positions, not their number when updating a polygon.
  93063. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  93064. * @param name defines the name of the mesh to create
  93065. * @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
  93066. * @param scene defines the hosting scene
  93067. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  93068. * @param updatable defines if the mesh must be flagged as updatable
  93069. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93070. * @param earcutInjection can be used to inject your own earcut reference
  93071. * @returns a new Mesh
  93072. */
  93073. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  93074. /**
  93075. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  93076. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  93077. * @param name defines the name of the mesh to create
  93078. * @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
  93079. * @param depth defines the height of extrusion
  93080. * @param scene defines the hosting scene
  93081. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  93082. * @param updatable defines if the mesh must be flagged as updatable
  93083. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93084. * @param earcutInjection can be used to inject your own earcut reference
  93085. * @returns a new Mesh
  93086. */
  93087. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  93088. /**
  93089. * Creates an extruded shape mesh.
  93090. * 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
  93091. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  93092. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  93093. * @param name defines the name of the mesh to create
  93094. * @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
  93095. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  93096. * @param scale is the value to scale the shape
  93097. * @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
  93098. * @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
  93099. * @param scene defines the hosting scene
  93100. * @param updatable defines if the mesh must be flagged as updatable
  93101. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93102. * @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)
  93103. * @returns a new Mesh
  93104. */
  93105. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  93106. /**
  93107. * Creates an custom extruded shape mesh.
  93108. * The custom extrusion is a parametric shape.
  93109. * It has no predefined shape. Its final shape will depend on the input parameters.
  93110. * Please consider using the same method from the MeshBuilder class instead
  93111. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  93112. * @param name defines the name of the mesh to create
  93113. * @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
  93114. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  93115. * @param scaleFunction is a custom Javascript function called on each path point
  93116. * @param rotationFunction is a custom Javascript function called on each path point
  93117. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  93118. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  93119. * @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
  93120. * @param scene defines the hosting scene
  93121. * @param updatable defines if the mesh must be flagged as updatable
  93122. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93123. * @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)
  93124. * @returns a new Mesh
  93125. */
  93126. 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;
  93127. /**
  93128. * Creates lathe mesh.
  93129. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  93130. * Please consider using the same method from the MeshBuilder class instead
  93131. * @param name defines the name of the mesh to create
  93132. * @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
  93133. * @param radius is the radius value of the lathe
  93134. * @param tessellation is the side number of the lathe.
  93135. * @param scene defines the hosting scene
  93136. * @param updatable defines if the mesh must be flagged as updatable
  93137. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93138. * @returns a new Mesh
  93139. */
  93140. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  93141. /**
  93142. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  93143. * @param name defines the name of the mesh to create
  93144. * @param size sets the size (float) of both sides of the plane at once (default 1)
  93145. * @param scene defines the hosting scene
  93146. * @param updatable defines if the mesh must be flagged as updatable
  93147. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93148. * @returns a new Mesh
  93149. */
  93150. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  93151. /**
  93152. * Creates a ground mesh.
  93153. * Please consider using the same method from the MeshBuilder class instead
  93154. * @param name defines the name of the mesh to create
  93155. * @param width set the width of the ground
  93156. * @param height set the height of the ground
  93157. * @param subdivisions sets the number of subdivisions per side
  93158. * @param scene defines the hosting scene
  93159. * @param updatable defines if the mesh must be flagged as updatable
  93160. * @returns a new Mesh
  93161. */
  93162. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  93163. /**
  93164. * Creates a tiled ground mesh.
  93165. * Please consider using the same method from the MeshBuilder class instead
  93166. * @param name defines the name of the mesh to create
  93167. * @param xmin set the ground minimum X coordinate
  93168. * @param zmin set the ground minimum Y coordinate
  93169. * @param xmax set the ground maximum X coordinate
  93170. * @param zmax set the ground maximum Z coordinate
  93171. * @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
  93172. * @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
  93173. * @param scene defines the hosting scene
  93174. * @param updatable defines if the mesh must be flagged as updatable
  93175. * @returns a new Mesh
  93176. */
  93177. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  93178. w: number;
  93179. h: number;
  93180. }, precision: {
  93181. w: number;
  93182. h: number;
  93183. }, scene: Scene, updatable?: boolean): Mesh;
  93184. /**
  93185. * Creates a ground mesh from a height map.
  93186. * Please consider using the same method from the MeshBuilder class instead
  93187. * @see http://doc.babylonjs.com/babylon101/height_map
  93188. * @param name defines the name of the mesh to create
  93189. * @param url sets the URL of the height map image resource
  93190. * @param width set the ground width size
  93191. * @param height set the ground height size
  93192. * @param subdivisions sets the number of subdivision per side
  93193. * @param minHeight is the minimum altitude on the ground
  93194. * @param maxHeight is the maximum altitude on the ground
  93195. * @param scene defines the hosting scene
  93196. * @param updatable defines if the mesh must be flagged as updatable
  93197. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  93198. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  93199. * @returns a new Mesh
  93200. */
  93201. 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;
  93202. /**
  93203. * Creates a tube mesh.
  93204. * The tube is a parametric shape.
  93205. * It has no predefined shape. Its final shape will depend on the input parameters.
  93206. * Please consider using the same method from the MeshBuilder class instead
  93207. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  93208. * @param name defines the name of the mesh to create
  93209. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  93210. * @param radius sets the tube radius size
  93211. * @param tessellation is the number of sides on the tubular surface
  93212. * @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
  93213. * @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
  93214. * @param scene defines the hosting scene
  93215. * @param updatable defines if the mesh must be flagged as updatable
  93216. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93217. * @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)
  93218. * @returns a new Mesh
  93219. */
  93220. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  93221. (i: number, distance: number): number;
  93222. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  93223. /**
  93224. * Creates a polyhedron mesh.
  93225. * Please consider using the same method from the MeshBuilder class instead.
  93226. * * 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
  93227. * * The parameter `size` (positive float, default 1) sets the polygon size
  93228. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  93229. * * 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`
  93230. * * 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
  93231. * * 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)`)
  93232. * * 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
  93233. * * 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
  93234. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  93235. * * If you create a double-sided mesh, you can choose what parts of 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
  93236. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93237. * @param name defines the name of the mesh to create
  93238. * @param options defines the options used to create the mesh
  93239. * @param scene defines the hosting scene
  93240. * @returns a new Mesh
  93241. */
  93242. static CreatePolyhedron(name: string, options: {
  93243. type?: number;
  93244. size?: number;
  93245. sizeX?: number;
  93246. sizeY?: number;
  93247. sizeZ?: number;
  93248. custom?: any;
  93249. faceUV?: Vector4[];
  93250. faceColors?: Color4[];
  93251. updatable?: boolean;
  93252. sideOrientation?: number;
  93253. }, scene: Scene): Mesh;
  93254. /**
  93255. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  93256. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  93257. * * 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`)
  93258. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  93259. * * 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
  93260. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  93261. * * If you create a double-sided mesh, you can choose what parts of 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
  93262. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93263. * @param name defines the name of the mesh
  93264. * @param options defines the options used to create the mesh
  93265. * @param scene defines the hosting scene
  93266. * @returns a new Mesh
  93267. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  93268. */
  93269. static CreateIcoSphere(name: string, options: {
  93270. radius?: number;
  93271. flat?: boolean;
  93272. subdivisions?: number;
  93273. sideOrientation?: number;
  93274. updatable?: boolean;
  93275. }, scene: Scene): Mesh;
  93276. /**
  93277. * Creates a decal mesh.
  93278. * Please consider using the same method from the MeshBuilder class instead.
  93279. * A decal is a mesh usually applied as a model onto the surface of another mesh
  93280. * @param name defines the name of the mesh
  93281. * @param sourceMesh defines the mesh receiving the decal
  93282. * @param position sets the position of the decal in world coordinates
  93283. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  93284. * @param size sets the decal scaling
  93285. * @param angle sets the angle to rotate the decal
  93286. * @returns a new Mesh
  93287. */
  93288. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  93289. /**
  93290. * Prepare internal position array for software CPU skinning
  93291. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  93292. */
  93293. setPositionsForCPUSkinning(): Float32Array;
  93294. /**
  93295. * Prepare internal normal array for software CPU skinning
  93296. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  93297. */
  93298. setNormalsForCPUSkinning(): Float32Array;
  93299. /**
  93300. * Updates the vertex buffer by applying transformation from the bones
  93301. * @param skeleton defines the skeleton to apply to current mesh
  93302. * @returns the current mesh
  93303. */
  93304. applySkeleton(skeleton: Skeleton): Mesh;
  93305. /**
  93306. * 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
  93307. * @param meshes defines the list of meshes to scan
  93308. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  93309. */
  93310. static MinMax(meshes: AbstractMesh[]): {
  93311. min: Vector3;
  93312. max: Vector3;
  93313. };
  93314. /**
  93315. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  93316. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  93317. * @returns a vector3
  93318. */
  93319. static Center(meshesOrMinMaxVector: {
  93320. min: Vector3;
  93321. max: Vector3;
  93322. } | AbstractMesh[]): Vector3;
  93323. /**
  93324. * Merge the array of meshes into a single mesh for performance reasons.
  93325. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  93326. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  93327. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  93328. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  93329. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  93330. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  93331. * @returns a new mesh
  93332. */
  93333. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  93334. /** @hidden */
  93335. addInstance(instance: InstancedMesh): void;
  93336. /** @hidden */
  93337. removeInstance(instance: InstancedMesh): void;
  93338. }
  93339. }
  93340. declare module BABYLON {
  93341. /**
  93342. * This is the base class of all the camera used in the application.
  93343. * @see http://doc.babylonjs.com/features/cameras
  93344. */
  93345. export class Camera extends Node {
  93346. /** @hidden */
  93347. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  93348. /**
  93349. * This is the default projection mode used by the cameras.
  93350. * It helps recreating a feeling of perspective and better appreciate depth.
  93351. * This is the best way to simulate real life cameras.
  93352. */
  93353. static readonly PERSPECTIVE_CAMERA: number;
  93354. /**
  93355. * This helps creating camera with an orthographic mode.
  93356. * 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.
  93357. */
  93358. static readonly ORTHOGRAPHIC_CAMERA: number;
  93359. /**
  93360. * This is the default FOV mode for perspective cameras.
  93361. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  93362. */
  93363. static readonly FOVMODE_VERTICAL_FIXED: number;
  93364. /**
  93365. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  93366. */
  93367. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  93368. /**
  93369. * This specifies ther is no need for a camera rig.
  93370. * Basically only one eye is rendered corresponding to the camera.
  93371. */
  93372. static readonly RIG_MODE_NONE: number;
  93373. /**
  93374. * Simulates a camera Rig with one blue eye and one red eye.
  93375. * This can be use with 3d blue and red glasses.
  93376. */
  93377. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  93378. /**
  93379. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  93380. */
  93381. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  93382. /**
  93383. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  93384. */
  93385. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  93386. /**
  93387. * Defines that both eyes of the camera will be rendered over under each other.
  93388. */
  93389. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  93390. /**
  93391. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  93392. */
  93393. static readonly RIG_MODE_VR: number;
  93394. /**
  93395. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  93396. */
  93397. static readonly RIG_MODE_WEBVR: number;
  93398. /**
  93399. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  93400. */
  93401. static readonly RIG_MODE_CUSTOM: number;
  93402. /**
  93403. * Defines if by default attaching controls should prevent the default javascript event to continue.
  93404. */
  93405. static ForceAttachControlToAlwaysPreventDefault: boolean;
  93406. /**
  93407. * Define the input manager associated with the camera.
  93408. */
  93409. inputs: CameraInputsManager<Camera>;
  93410. /** @hidden */
  93411. _position: Vector3;
  93412. /**
  93413. * Define the current local position of the camera in the scene
  93414. */
  93415. position: Vector3;
  93416. /**
  93417. * The vector the camera should consider as up.
  93418. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  93419. */
  93420. upVector: Vector3;
  93421. /**
  93422. * Define the current limit on the left side for an orthographic camera
  93423. * In scene unit
  93424. */
  93425. orthoLeft: Nullable<number>;
  93426. /**
  93427. * Define the current limit on the right side for an orthographic camera
  93428. * In scene unit
  93429. */
  93430. orthoRight: Nullable<number>;
  93431. /**
  93432. * Define the current limit on the bottom side for an orthographic camera
  93433. * In scene unit
  93434. */
  93435. orthoBottom: Nullable<number>;
  93436. /**
  93437. * Define the current limit on the top side for an orthographic camera
  93438. * In scene unit
  93439. */
  93440. orthoTop: Nullable<number>;
  93441. /**
  93442. * Field Of View is set in Radians. (default is 0.8)
  93443. */
  93444. fov: number;
  93445. /**
  93446. * Define the minimum distance the camera can see from.
  93447. * This is important to note that the depth buffer are not infinite and the closer it starts
  93448. * the more your scene might encounter depth fighting issue.
  93449. */
  93450. minZ: number;
  93451. /**
  93452. * Define the maximum distance the camera can see to.
  93453. * This is important to note that the depth buffer are not infinite and the further it end
  93454. * the more your scene might encounter depth fighting issue.
  93455. */
  93456. maxZ: number;
  93457. /**
  93458. * Define the default inertia of the camera.
  93459. * This helps giving a smooth feeling to the camera movement.
  93460. */
  93461. inertia: number;
  93462. /**
  93463. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  93464. */
  93465. mode: number;
  93466. /**
  93467. * Define wether the camera is intermediate.
  93468. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  93469. */
  93470. isIntermediate: boolean;
  93471. /**
  93472. * Define the viewport of the camera.
  93473. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  93474. */
  93475. viewport: Viewport;
  93476. /**
  93477. * Restricts the camera to viewing objects with the same layerMask.
  93478. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  93479. */
  93480. layerMask: number;
  93481. /**
  93482. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  93483. */
  93484. fovMode: number;
  93485. /**
  93486. * Rig mode of the camera.
  93487. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  93488. * This is normally controlled byt the camera themselves as internal use.
  93489. */
  93490. cameraRigMode: number;
  93491. /**
  93492. * Defines the distance between both "eyes" in case of a RIG
  93493. */
  93494. interaxialDistance: number;
  93495. /**
  93496. * Defines if stereoscopic rendering is done side by side or over under.
  93497. */
  93498. isStereoscopicSideBySide: boolean;
  93499. /**
  93500. * 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
  93501. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  93502. * else in the scene. (Eg. security camera)
  93503. *
  93504. * 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)
  93505. */
  93506. customRenderTargets: RenderTargetTexture[];
  93507. /**
  93508. * When set, the camera will render to this render target instead of the default canvas
  93509. *
  93510. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  93511. */
  93512. outputRenderTarget: Nullable<RenderTargetTexture>;
  93513. /**
  93514. * Observable triggered when the camera view matrix has changed.
  93515. */
  93516. onViewMatrixChangedObservable: Observable<Camera>;
  93517. /**
  93518. * Observable triggered when the camera Projection matrix has changed.
  93519. */
  93520. onProjectionMatrixChangedObservable: Observable<Camera>;
  93521. /**
  93522. * Observable triggered when the inputs have been processed.
  93523. */
  93524. onAfterCheckInputsObservable: Observable<Camera>;
  93525. /**
  93526. * Observable triggered when reset has been called and applied to the camera.
  93527. */
  93528. onRestoreStateObservable: Observable<Camera>;
  93529. /** @hidden */
  93530. _cameraRigParams: any;
  93531. /** @hidden */
  93532. _rigCameras: Camera[];
  93533. /** @hidden */
  93534. _rigPostProcess: Nullable<PostProcess>;
  93535. protected _webvrViewMatrix: Matrix;
  93536. /** @hidden */
  93537. _skipRendering: boolean;
  93538. /** @hidden */
  93539. _projectionMatrix: Matrix;
  93540. /** @hidden */
  93541. _postProcesses: Nullable<PostProcess>[];
  93542. /** @hidden */
  93543. _activeMeshes: SmartArray<AbstractMesh>;
  93544. protected _globalPosition: Vector3;
  93545. /** @hidden */
  93546. _computedViewMatrix: Matrix;
  93547. private _doNotComputeProjectionMatrix;
  93548. private _transformMatrix;
  93549. private _frustumPlanes;
  93550. private _refreshFrustumPlanes;
  93551. private _storedFov;
  93552. private _stateStored;
  93553. /**
  93554. * Instantiates a new camera object.
  93555. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  93556. * @see http://doc.babylonjs.com/features/cameras
  93557. * @param name Defines the name of the camera in the scene
  93558. * @param position Defines the position of the camera
  93559. * @param scene Defines the scene the camera belongs too
  93560. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  93561. */
  93562. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  93563. /**
  93564. * Store current camera state (fov, position, etc..)
  93565. * @returns the camera
  93566. */
  93567. storeState(): Camera;
  93568. /**
  93569. * Restores the camera state values if it has been stored. You must call storeState() first
  93570. */
  93571. protected _restoreStateValues(): boolean;
  93572. /**
  93573. * Restored camera state. You must call storeState() first.
  93574. * @returns true if restored and false otherwise
  93575. */
  93576. restoreState(): boolean;
  93577. /**
  93578. * Gets the class name of the camera.
  93579. * @returns the class name
  93580. */
  93581. getClassName(): string;
  93582. /** @hidden */
  93583. readonly _isCamera: boolean;
  93584. /**
  93585. * Gets a string representation of the camera useful for debug purpose.
  93586. * @param fullDetails Defines that a more verboe level of logging is required
  93587. * @returns the string representation
  93588. */
  93589. toString(fullDetails?: boolean): string;
  93590. /**
  93591. * Gets the current world space position of the camera.
  93592. */
  93593. readonly globalPosition: Vector3;
  93594. /**
  93595. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  93596. * @returns the active meshe list
  93597. */
  93598. getActiveMeshes(): SmartArray<AbstractMesh>;
  93599. /**
  93600. * Check wether a mesh is part of the current active mesh list of the camera
  93601. * @param mesh Defines the mesh to check
  93602. * @returns true if active, false otherwise
  93603. */
  93604. isActiveMesh(mesh: Mesh): boolean;
  93605. /**
  93606. * Is this camera ready to be used/rendered
  93607. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  93608. * @return true if the camera is ready
  93609. */
  93610. isReady(completeCheck?: boolean): boolean;
  93611. /** @hidden */
  93612. _initCache(): void;
  93613. /** @hidden */
  93614. _updateCache(ignoreParentClass?: boolean): void;
  93615. /** @hidden */
  93616. _isSynchronized(): boolean;
  93617. /** @hidden */
  93618. _isSynchronizedViewMatrix(): boolean;
  93619. /** @hidden */
  93620. _isSynchronizedProjectionMatrix(): boolean;
  93621. /**
  93622. * Attach the input controls to a specific dom element to get the input from.
  93623. * @param element Defines the element the controls should be listened from
  93624. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  93625. */
  93626. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  93627. /**
  93628. * Detach the current controls from the specified dom element.
  93629. * @param element Defines the element to stop listening the inputs from
  93630. */
  93631. detachControl(element: HTMLElement): void;
  93632. /**
  93633. * Update the camera state according to the different inputs gathered during the frame.
  93634. */
  93635. update(): void;
  93636. /** @hidden */
  93637. _checkInputs(): void;
  93638. /** @hidden */
  93639. readonly rigCameras: Camera[];
  93640. /**
  93641. * Gets the post process used by the rig cameras
  93642. */
  93643. readonly rigPostProcess: Nullable<PostProcess>;
  93644. /**
  93645. * Internal, gets the first post proces.
  93646. * @returns the first post process to be run on this camera.
  93647. */
  93648. _getFirstPostProcess(): Nullable<PostProcess>;
  93649. private _cascadePostProcessesToRigCams;
  93650. /**
  93651. * Attach a post process to the camera.
  93652. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  93653. * @param postProcess The post process to attach to the camera
  93654. * @param insertAt The position of the post process in case several of them are in use in the scene
  93655. * @returns the position the post process has been inserted at
  93656. */
  93657. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  93658. /**
  93659. * Detach a post process to the camera.
  93660. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  93661. * @param postProcess The post process to detach from the camera
  93662. */
  93663. detachPostProcess(postProcess: PostProcess): void;
  93664. /**
  93665. * Gets the current world matrix of the camera
  93666. */
  93667. getWorldMatrix(): Matrix;
  93668. /** @hidden */
  93669. _getViewMatrix(): Matrix;
  93670. /**
  93671. * Gets the current view matrix of the camera.
  93672. * @param force forces the camera to recompute the matrix without looking at the cached state
  93673. * @returns the view matrix
  93674. */
  93675. getViewMatrix(force?: boolean): Matrix;
  93676. /**
  93677. * Freeze the projection matrix.
  93678. * It will prevent the cache check of the camera projection compute and can speed up perf
  93679. * if no parameter of the camera are meant to change
  93680. * @param projection Defines manually a projection if necessary
  93681. */
  93682. freezeProjectionMatrix(projection?: Matrix): void;
  93683. /**
  93684. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  93685. */
  93686. unfreezeProjectionMatrix(): void;
  93687. /**
  93688. * Gets the current projection matrix of the camera.
  93689. * @param force forces the camera to recompute the matrix without looking at the cached state
  93690. * @returns the projection matrix
  93691. */
  93692. getProjectionMatrix(force?: boolean): Matrix;
  93693. /**
  93694. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  93695. * @returns a Matrix
  93696. */
  93697. getTransformationMatrix(): Matrix;
  93698. private _updateFrustumPlanes;
  93699. /**
  93700. * Checks if a cullable object (mesh...) is in the camera frustum
  93701. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  93702. * @param target The object to check
  93703. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  93704. * @returns true if the object is in frustum otherwise false
  93705. */
  93706. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  93707. /**
  93708. * Checks if a cullable object (mesh...) is in the camera frustum
  93709. * Unlike isInFrustum this cheks the full bounding box
  93710. * @param target The object to check
  93711. * @returns true if the object is in frustum otherwise false
  93712. */
  93713. isCompletelyInFrustum(target: ICullable): boolean;
  93714. /**
  93715. * Gets a ray in the forward direction from the camera.
  93716. * @param length Defines the length of the ray to create
  93717. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  93718. * @param origin Defines the start point of the ray which defaults to the camera position
  93719. * @returns the forward ray
  93720. */
  93721. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  93722. /**
  93723. * Releases resources associated with this node.
  93724. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  93725. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  93726. */
  93727. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  93728. /** @hidden */
  93729. _isLeftCamera: boolean;
  93730. /**
  93731. * Gets the left camera of a rig setup in case of Rigged Camera
  93732. */
  93733. readonly isLeftCamera: boolean;
  93734. /** @hidden */
  93735. _isRightCamera: boolean;
  93736. /**
  93737. * Gets the right camera of a rig setup in case of Rigged Camera
  93738. */
  93739. readonly isRightCamera: boolean;
  93740. /**
  93741. * Gets the left camera of a rig setup in case of Rigged Camera
  93742. */
  93743. readonly leftCamera: Nullable<FreeCamera>;
  93744. /**
  93745. * Gets the right camera of a rig setup in case of Rigged Camera
  93746. */
  93747. readonly rightCamera: Nullable<FreeCamera>;
  93748. /**
  93749. * Gets the left camera target of a rig setup in case of Rigged Camera
  93750. * @returns the target position
  93751. */
  93752. getLeftTarget(): Nullable<Vector3>;
  93753. /**
  93754. * Gets the right camera target of a rig setup in case of Rigged Camera
  93755. * @returns the target position
  93756. */
  93757. getRightTarget(): Nullable<Vector3>;
  93758. /**
  93759. * @hidden
  93760. */
  93761. setCameraRigMode(mode: number, rigParams: any): void;
  93762. /** @hidden */
  93763. static _setStereoscopicRigMode(camera: Camera): void;
  93764. /** @hidden */
  93765. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  93766. /** @hidden */
  93767. static _setVRRigMode(camera: Camera, rigParams: any): void;
  93768. /** @hidden */
  93769. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  93770. /** @hidden */
  93771. _getVRProjectionMatrix(): Matrix;
  93772. protected _updateCameraRotationMatrix(): void;
  93773. protected _updateWebVRCameraRotationMatrix(): void;
  93774. /**
  93775. * This function MUST be overwritten by the different WebVR cameras available.
  93776. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  93777. * @hidden
  93778. */
  93779. _getWebVRProjectionMatrix(): Matrix;
  93780. /**
  93781. * This function MUST be overwritten by the different WebVR cameras available.
  93782. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  93783. * @hidden
  93784. */
  93785. _getWebVRViewMatrix(): Matrix;
  93786. /** @hidden */
  93787. setCameraRigParameter(name: string, value: any): void;
  93788. /**
  93789. * needs to be overridden by children so sub has required properties to be copied
  93790. * @hidden
  93791. */
  93792. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  93793. /**
  93794. * May need to be overridden by children
  93795. * @hidden
  93796. */
  93797. _updateRigCameras(): void;
  93798. /** @hidden */
  93799. _setupInputs(): void;
  93800. /**
  93801. * Serialiaze the camera setup to a json represention
  93802. * @returns the JSON representation
  93803. */
  93804. serialize(): any;
  93805. /**
  93806. * Clones the current camera.
  93807. * @param name The cloned camera name
  93808. * @returns the cloned camera
  93809. */
  93810. clone(name: string): Camera;
  93811. /**
  93812. * Gets the direction of the camera relative to a given local axis.
  93813. * @param localAxis Defines the reference axis to provide a relative direction.
  93814. * @return the direction
  93815. */
  93816. getDirection(localAxis: Vector3): Vector3;
  93817. /**
  93818. * Returns the current camera absolute rotation
  93819. */
  93820. readonly absoluteRotation: Quaternion;
  93821. /**
  93822. * Gets the direction of the camera relative to a given local axis into a passed vector.
  93823. * @param localAxis Defines the reference axis to provide a relative direction.
  93824. * @param result Defines the vector to store the result in
  93825. */
  93826. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  93827. /**
  93828. * Gets a camera constructor for a given camera type
  93829. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  93830. * @param name The name of the camera the result will be able to instantiate
  93831. * @param scene The scene the result will construct the camera in
  93832. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  93833. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  93834. * @returns a factory method to construc the camera
  93835. */
  93836. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  93837. /**
  93838. * Compute the world matrix of the camera.
  93839. * @returns the camera world matrix
  93840. */
  93841. computeWorldMatrix(): Matrix;
  93842. /**
  93843. * Parse a JSON and creates the camera from the parsed information
  93844. * @param parsedCamera The JSON to parse
  93845. * @param scene The scene to instantiate the camera in
  93846. * @returns the newly constructed camera
  93847. */
  93848. static Parse(parsedCamera: any, scene: Scene): Camera;
  93849. }
  93850. }
  93851. declare module BABYLON {
  93852. /**
  93853. * Class containing static functions to help procedurally build meshes
  93854. */
  93855. export class DiscBuilder {
  93856. /**
  93857. * Creates a plane polygonal mesh. By default, this is a disc
  93858. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  93859. * * 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
  93860. * * 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
  93861. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  93862. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  93863. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93864. * @param name defines the name of the mesh
  93865. * @param options defines the options used to create the mesh
  93866. * @param scene defines the hosting scene
  93867. * @returns the plane polygonal mesh
  93868. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  93869. */
  93870. static CreateDisc(name: string, options: {
  93871. radius?: number;
  93872. tessellation?: number;
  93873. arc?: number;
  93874. updatable?: boolean;
  93875. sideOrientation?: number;
  93876. frontUVs?: Vector4;
  93877. backUVs?: Vector4;
  93878. }, scene?: Nullable<Scene>): Mesh;
  93879. }
  93880. }
  93881. declare module BABYLON {
  93882. /**
  93883. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  93884. *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.
  93885. * The SPS is also a particle system. It provides some methods to manage the particles.
  93886. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  93887. *
  93888. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  93889. */
  93890. export class SolidParticleSystem implements IDisposable {
  93891. /**
  93892. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  93893. * Example : var p = SPS.particles[i];
  93894. */
  93895. particles: SolidParticle[];
  93896. /**
  93897. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  93898. */
  93899. nbParticles: number;
  93900. /**
  93901. * If the particles must ever face the camera (default false). Useful for planar particles.
  93902. */
  93903. billboard: boolean;
  93904. /**
  93905. * Recompute normals when adding a shape
  93906. */
  93907. recomputeNormals: boolean;
  93908. /**
  93909. * This a counter ofr your own usage. It's not set by any SPS functions.
  93910. */
  93911. counter: number;
  93912. /**
  93913. * The SPS name. This name is also given to the underlying mesh.
  93914. */
  93915. name: string;
  93916. /**
  93917. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  93918. */
  93919. mesh: Mesh;
  93920. /**
  93921. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  93922. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  93923. */
  93924. vars: any;
  93925. /**
  93926. * This array is populated when the SPS is set as 'pickable'.
  93927. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  93928. * Each element of this array is an object `{idx: int, faceId: int}`.
  93929. * `idx` is the picked particle index in the `SPS.particles` array
  93930. * `faceId` is the picked face index counted within this particle.
  93931. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  93932. */
  93933. pickedParticles: {
  93934. idx: number;
  93935. faceId: number;
  93936. }[];
  93937. /**
  93938. * This array is populated when `enableDepthSort` is set to true.
  93939. * Each element of this array is an instance of the class DepthSortedParticle.
  93940. */
  93941. depthSortedParticles: DepthSortedParticle[];
  93942. /**
  93943. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  93944. * @hidden
  93945. */
  93946. _bSphereOnly: boolean;
  93947. /**
  93948. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  93949. * @hidden
  93950. */
  93951. _bSphereRadiusFactor: number;
  93952. private _scene;
  93953. private _positions;
  93954. private _indices;
  93955. private _normals;
  93956. private _colors;
  93957. private _uvs;
  93958. private _indices32;
  93959. private _positions32;
  93960. private _normals32;
  93961. private _fixedNormal32;
  93962. private _colors32;
  93963. private _uvs32;
  93964. private _index;
  93965. private _updatable;
  93966. private _pickable;
  93967. private _isVisibilityBoxLocked;
  93968. private _alwaysVisible;
  93969. private _depthSort;
  93970. private _expandable;
  93971. private _shapeCounter;
  93972. private _copy;
  93973. private _color;
  93974. private _computeParticleColor;
  93975. private _computeParticleTexture;
  93976. private _computeParticleRotation;
  93977. private _computeParticleVertex;
  93978. private _computeBoundingBox;
  93979. private _depthSortParticles;
  93980. private _camera;
  93981. private _mustUnrotateFixedNormals;
  93982. private _particlesIntersect;
  93983. private _needs32Bits;
  93984. private _isNotBuilt;
  93985. private _lastParticleId;
  93986. private _idxOfId;
  93987. /**
  93988. * Creates a SPS (Solid Particle System) object.
  93989. * @param name (String) is the SPS name, this will be the underlying mesh name.
  93990. * @param scene (Scene) is the scene in which the SPS is added.
  93991. * @param options defines the options of the sps e.g.
  93992. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  93993. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  93994. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  93995. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  93996. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  93997. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  93998. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  93999. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  94000. */
  94001. constructor(name: string, scene: Scene, options?: {
  94002. updatable?: boolean;
  94003. isPickable?: boolean;
  94004. enableDepthSort?: boolean;
  94005. particleIntersection?: boolean;
  94006. boundingSphereOnly?: boolean;
  94007. bSphereRadiusFactor?: number;
  94008. expandable?: boolean;
  94009. });
  94010. /**
  94011. * Builds the SPS underlying mesh. Returns a standard Mesh.
  94012. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  94013. * @returns the created mesh
  94014. */
  94015. buildMesh(): Mesh;
  94016. /**
  94017. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  94018. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  94019. * Thus the particles generated from `digest()` have their property `position` set yet.
  94020. * @param mesh ( Mesh ) is the mesh to be digested
  94021. * @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
  94022. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  94023. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  94024. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  94025. * @returns the current SPS
  94026. */
  94027. digest(mesh: Mesh, options?: {
  94028. facetNb?: number;
  94029. number?: number;
  94030. delta?: number;
  94031. storage?: [];
  94032. }): SolidParticleSystem;
  94033. /**
  94034. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  94035. * @hidden
  94036. */
  94037. private _unrotateFixedNormals;
  94038. /**
  94039. * Resets the temporary working copy particle
  94040. * @hidden
  94041. */
  94042. private _resetCopy;
  94043. /**
  94044. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  94045. * @param p the current index in the positions array to be updated
  94046. * @param shape a Vector3 array, the shape geometry
  94047. * @param positions the positions array to be updated
  94048. * @param meshInd the shape indices array
  94049. * @param indices the indices array to be updated
  94050. * @param meshUV the shape uv array
  94051. * @param uvs the uv array to be updated
  94052. * @param meshCol the shape color array
  94053. * @param colors the color array to be updated
  94054. * @param meshNor the shape normals array
  94055. * @param normals the normals array to be updated
  94056. * @param idx the particle index
  94057. * @param idxInShape the particle index in its shape
  94058. * @param options the addShape() method passed options
  94059. * @hidden
  94060. */
  94061. private _meshBuilder;
  94062. /**
  94063. * Returns a shape Vector3 array from positions float array
  94064. * @param positions float array
  94065. * @returns a vector3 array
  94066. * @hidden
  94067. */
  94068. private _posToShape;
  94069. /**
  94070. * Returns a shapeUV array from a float uvs (array deep copy)
  94071. * @param uvs as a float array
  94072. * @returns a shapeUV array
  94073. * @hidden
  94074. */
  94075. private _uvsToShapeUV;
  94076. /**
  94077. * Adds a new particle object in the particles array
  94078. * @param idx particle index in particles array
  94079. * @param id particle id
  94080. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  94081. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  94082. * @param model particle ModelShape object
  94083. * @param shapeId model shape identifier
  94084. * @param idxInShape index of the particle in the current model
  94085. * @param bInfo model bounding info object
  94086. * @param storage target storage array, if any
  94087. * @hidden
  94088. */
  94089. private _addParticle;
  94090. /**
  94091. * Adds some particles to the SPS from the model shape. Returns the shape id.
  94092. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  94093. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  94094. * @param nb (positive integer) the number of particles to be created from this model
  94095. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  94096. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  94097. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  94098. * @returns the number of shapes in the system
  94099. */
  94100. addShape(mesh: Mesh, nb: number, options?: {
  94101. positionFunction?: any;
  94102. vertexFunction?: any;
  94103. storage?: [];
  94104. }): number;
  94105. /**
  94106. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  94107. * @hidden
  94108. */
  94109. private _rebuildParticle;
  94110. /**
  94111. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  94112. * @param reset boolean, default false : if the particles must be reset at position and rotation zero, scaling 1, color white, initial UVs and not parented.
  94113. * @returns the SPS.
  94114. */
  94115. rebuildMesh(reset?: boolean): SolidParticleSystem;
  94116. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  94117. * Returns an array with the removed particles.
  94118. * If the number of particles to remove is lower than zero or greater than the global remaining particle number, then an empty array is returned.
  94119. * The SPS can't be empty so at least one particle needs to remain in place.
  94120. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  94121. * @param start index of the first particle to remove
  94122. * @param end index of the last particle to remove (included)
  94123. * @returns an array populated with the removed particles
  94124. */
  94125. removeParticles(start: number, end: number): SolidParticle[];
  94126. /**
  94127. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  94128. * @param solidParticleArray an array populated with Solid Particles objects
  94129. * @returns the SPS
  94130. */
  94131. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  94132. /**
  94133. * Creates a new particle and modifies the SPS mesh geometry :
  94134. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  94135. * - calls _addParticle() to populate the particle array
  94136. * factorized code from addShape() and insertParticlesFromArray()
  94137. * @param idx particle index in the particles array
  94138. * @param i particle index in its shape
  94139. * @param modelShape particle ModelShape object
  94140. * @param shape shape vertex array
  94141. * @param meshInd shape indices array
  94142. * @param meshUV shape uv array
  94143. * @param meshCol shape color array
  94144. * @param meshNor shape normals array
  94145. * @param bbInfo shape bounding info
  94146. * @param storage target particle storage
  94147. * @options addShape() passed options
  94148. * @hidden
  94149. */
  94150. private _insertNewParticle;
  94151. /**
  94152. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  94153. * This method calls `updateParticle()` for each particle of the SPS.
  94154. * For an animated SPS, it is usually called within the render loop.
  94155. * This methods does nothing if called on a non updatable or not yet built SPS. Example : buildMesh() not called after having added or removed particles from an expandable SPS.
  94156. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  94157. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  94158. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  94159. * @returns the SPS.
  94160. */
  94161. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  94162. /**
  94163. * Disposes the SPS.
  94164. */
  94165. dispose(): void;
  94166. /**
  94167. * Returns a SolidParticle object from its identifier : particle.id
  94168. * @param id (integer) the particle Id
  94169. * @returns the searched particle or null if not found in the SPS.
  94170. */
  94171. getParticleById(id: number): Nullable<SolidParticle>;
  94172. /**
  94173. * Returns a new array populated with the particles having the passed shapeId.
  94174. * @param shapeId (integer) the shape identifier
  94175. * @returns a new solid particle array
  94176. */
  94177. getParticlesByShapeId(shapeId: number): SolidParticle[];
  94178. /**
  94179. * Populates the passed array "ref" with the particles having the passed shapeId.
  94180. * @param shapeId the shape identifier
  94181. * @returns the SPS
  94182. * @param ref
  94183. */
  94184. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  94185. /**
  94186. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  94187. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94188. * @returns the SPS.
  94189. */
  94190. refreshVisibleSize(): SolidParticleSystem;
  94191. /**
  94192. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  94193. * @param size the size (float) of the visibility box
  94194. * note : this doesn't lock the SPS mesh bounding box.
  94195. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94196. */
  94197. setVisibilityBox(size: number): void;
  94198. /**
  94199. * Gets whether the SPS as always visible or not
  94200. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94201. */
  94202. /**
  94203. * Sets the SPS as always visible or not
  94204. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94205. */
  94206. isAlwaysVisible: boolean;
  94207. /**
  94208. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  94209. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94210. */
  94211. /**
  94212. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  94213. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94214. */
  94215. isVisibilityBoxLocked: boolean;
  94216. /**
  94217. * Tells to `setParticles()` to compute the particle rotations or not.
  94218. * Default value : true. The SPS is faster when it's set to false.
  94219. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  94220. */
  94221. /**
  94222. * Gets if `setParticles()` computes the particle rotations or not.
  94223. * Default value : true. The SPS is faster when it's set to false.
  94224. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  94225. */
  94226. computeParticleRotation: boolean;
  94227. /**
  94228. * Tells to `setParticles()` to compute the particle colors or not.
  94229. * Default value : true. The SPS is faster when it's set to false.
  94230. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  94231. */
  94232. /**
  94233. * Gets if `setParticles()` computes the particle colors or not.
  94234. * Default value : true. The SPS is faster when it's set to false.
  94235. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  94236. */
  94237. computeParticleColor: boolean;
  94238. /**
  94239. * Gets if `setParticles()` computes the particle textures or not.
  94240. * Default value : true. The SPS is faster when it's set to false.
  94241. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  94242. */
  94243. computeParticleTexture: boolean;
  94244. /**
  94245. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  94246. * Default value : false. The SPS is faster when it's set to false.
  94247. * Note : the particle custom vertex positions aren't stored values.
  94248. */
  94249. /**
  94250. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  94251. * Default value : false. The SPS is faster when it's set to false.
  94252. * Note : the particle custom vertex positions aren't stored values.
  94253. */
  94254. computeParticleVertex: boolean;
  94255. /**
  94256. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  94257. */
  94258. /**
  94259. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  94260. */
  94261. computeBoundingBox: boolean;
  94262. /**
  94263. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  94264. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  94265. * Default : `true`
  94266. */
  94267. /**
  94268. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  94269. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  94270. * Default : `true`
  94271. */
  94272. depthSortParticles: boolean;
  94273. /**
  94274. * Gets if the SPS is created as expandable at construction time.
  94275. * Default : `false`
  94276. */
  94277. readonly expandable: boolean;
  94278. /**
  94279. * This function does nothing. It may be overwritten to set all the particle first values.
  94280. * The SPS doesn't call this function, you may have to call it by your own.
  94281. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  94282. */
  94283. initParticles(): void;
  94284. /**
  94285. * This function does nothing. It may be overwritten to recycle a particle.
  94286. * The SPS doesn't call this function, you may have to call it by your own.
  94287. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  94288. * @param particle The particle to recycle
  94289. * @returns the recycled particle
  94290. */
  94291. recycleParticle(particle: SolidParticle): SolidParticle;
  94292. /**
  94293. * Updates a particle : this function should be overwritten by the user.
  94294. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  94295. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  94296. * @example : just set a particle position or velocity and recycle conditions
  94297. * @param particle The particle to update
  94298. * @returns the updated particle
  94299. */
  94300. updateParticle(particle: SolidParticle): SolidParticle;
  94301. /**
  94302. * Updates a vertex of a particle : it can be overwritten by the user.
  94303. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  94304. * @param particle the current particle
  94305. * @param vertex the current index of the current particle
  94306. * @param pt the index of the current vertex in the particle shape
  94307. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  94308. * @example : just set a vertex particle position
  94309. * @returns the updated vertex
  94310. */
  94311. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  94312. /**
  94313. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  94314. * This does nothing and may be overwritten by the user.
  94315. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94316. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94317. * @param update the boolean update value actually passed to setParticles()
  94318. */
  94319. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  94320. /**
  94321. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  94322. * This will be passed three parameters.
  94323. * This does nothing and may be overwritten by the user.
  94324. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94325. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94326. * @param update the boolean update value actually passed to setParticles()
  94327. */
  94328. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  94329. }
  94330. }
  94331. declare module BABYLON {
  94332. /**
  94333. * Represents one particle of a solid particle system.
  94334. */
  94335. export class SolidParticle {
  94336. /**
  94337. * particle global index
  94338. */
  94339. idx: number;
  94340. /**
  94341. * particle identifier
  94342. */
  94343. id: number;
  94344. /**
  94345. * The color of the particle
  94346. */
  94347. color: Nullable<Color4>;
  94348. /**
  94349. * The world space position of the particle.
  94350. */
  94351. position: Vector3;
  94352. /**
  94353. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  94354. */
  94355. rotation: Vector3;
  94356. /**
  94357. * The world space rotation quaternion of the particle.
  94358. */
  94359. rotationQuaternion: Nullable<Quaternion>;
  94360. /**
  94361. * The scaling of the particle.
  94362. */
  94363. scaling: Vector3;
  94364. /**
  94365. * The uvs of the particle.
  94366. */
  94367. uvs: Vector4;
  94368. /**
  94369. * The current speed of the particle.
  94370. */
  94371. velocity: Vector3;
  94372. /**
  94373. * The pivot point in the particle local space.
  94374. */
  94375. pivot: Vector3;
  94376. /**
  94377. * Must the particle be translated from its pivot point in its local space ?
  94378. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  94379. * Default : false
  94380. */
  94381. translateFromPivot: boolean;
  94382. /**
  94383. * Is the particle active or not ?
  94384. */
  94385. alive: boolean;
  94386. /**
  94387. * Is the particle visible or not ?
  94388. */
  94389. isVisible: boolean;
  94390. /**
  94391. * Index of this particle in the global "positions" array (Internal use)
  94392. * @hidden
  94393. */
  94394. _pos: number;
  94395. /**
  94396. * @hidden Index of this particle in the global "indices" array (Internal use)
  94397. */
  94398. _ind: number;
  94399. /**
  94400. * @hidden ModelShape of this particle (Internal use)
  94401. */
  94402. _model: ModelShape;
  94403. /**
  94404. * ModelShape id of this particle
  94405. */
  94406. shapeId: number;
  94407. /**
  94408. * Index of the particle in its shape id
  94409. */
  94410. idxInShape: number;
  94411. /**
  94412. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  94413. */
  94414. _modelBoundingInfo: BoundingInfo;
  94415. /**
  94416. * @hidden Particle BoundingInfo object (Internal use)
  94417. */
  94418. _boundingInfo: BoundingInfo;
  94419. /**
  94420. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  94421. */
  94422. _sps: SolidParticleSystem;
  94423. /**
  94424. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  94425. */
  94426. _stillInvisible: boolean;
  94427. /**
  94428. * @hidden Last computed particle rotation matrix
  94429. */
  94430. _rotationMatrix: number[];
  94431. /**
  94432. * Parent particle Id, if any.
  94433. * Default null.
  94434. */
  94435. parentId: Nullable<number>;
  94436. /**
  94437. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  94438. * The possible values are :
  94439. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  94440. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94441. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  94442. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  94443. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94444. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  94445. * */
  94446. cullingStrategy: number;
  94447. /**
  94448. * @hidden Internal global position in the SPS.
  94449. */
  94450. _globalPosition: Vector3;
  94451. /**
  94452. * Creates a Solid Particle object.
  94453. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  94454. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  94455. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  94456. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  94457. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  94458. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  94459. * @param shapeId (integer) is the model shape identifier in the SPS.
  94460. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  94461. * @param sps defines the sps it is associated to
  94462. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  94463. */
  94464. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  94465. /**
  94466. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  94467. * @param target the particle target
  94468. * @returns the current particle
  94469. */
  94470. copyToRef(target: SolidParticle): SolidParticle;
  94471. /**
  94472. * Legacy support, changed scale to scaling
  94473. */
  94474. /**
  94475. * Legacy support, changed scale to scaling
  94476. */
  94477. scale: Vector3;
  94478. /**
  94479. * Legacy support, changed quaternion to rotationQuaternion
  94480. */
  94481. /**
  94482. * Legacy support, changed quaternion to rotationQuaternion
  94483. */
  94484. quaternion: Nullable<Quaternion>;
  94485. /**
  94486. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  94487. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  94488. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  94489. * @returns true if it intersects
  94490. */
  94491. intersectsMesh(target: Mesh | SolidParticle): boolean;
  94492. /**
  94493. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  94494. * A particle is in the frustum if its bounding box intersects the frustum
  94495. * @param frustumPlanes defines the frustum to test
  94496. * @returns true if the particle is in the frustum planes
  94497. */
  94498. isInFrustum(frustumPlanes: Plane[]): boolean;
  94499. /**
  94500. * get the rotation matrix of the particle
  94501. * @hidden
  94502. */
  94503. getRotationMatrix(m: Matrix): void;
  94504. }
  94505. /**
  94506. * Represents the shape of the model used by one particle of a solid particle system.
  94507. * SPS internal tool, don't use it manually.
  94508. */
  94509. export class ModelShape {
  94510. /**
  94511. * The shape id
  94512. * @hidden
  94513. */
  94514. shapeID: number;
  94515. /**
  94516. * flat array of model positions (internal use)
  94517. * @hidden
  94518. */
  94519. _shape: Vector3[];
  94520. /**
  94521. * flat array of model UVs (internal use)
  94522. * @hidden
  94523. */
  94524. _shapeUV: number[];
  94525. /**
  94526. * color array of the model
  94527. * @hidden
  94528. */
  94529. _shapeColors: number[];
  94530. /**
  94531. * indices array of the model
  94532. * @hidden
  94533. */
  94534. _indices: number[];
  94535. /**
  94536. * normals array of the model
  94537. * @hidden
  94538. */
  94539. _normals: number[];
  94540. /**
  94541. * length of the shape in the model indices array (internal use)
  94542. * @hidden
  94543. */
  94544. _indicesLength: number;
  94545. /**
  94546. * Custom position function (internal use)
  94547. * @hidden
  94548. */
  94549. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  94550. /**
  94551. * Custom vertex function (internal use)
  94552. * @hidden
  94553. */
  94554. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  94555. /**
  94556. * 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.
  94557. * SPS internal tool, don't use it manually.
  94558. * @hidden
  94559. */
  94560. constructor(id: number, shape: Vector3[], indices: number[], normals: number[], colors: number[], shapeUV: number[], posFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>, vtxFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>);
  94561. }
  94562. /**
  94563. * Represents a Depth Sorted Particle in the solid particle system.
  94564. */
  94565. export class DepthSortedParticle {
  94566. /**
  94567. * Index of the particle in the "indices" array
  94568. */
  94569. ind: number;
  94570. /**
  94571. * Length of the particle shape in the "indices" array
  94572. */
  94573. indicesLength: number;
  94574. /**
  94575. * Squared distance from the particle to the camera
  94576. */
  94577. sqDistance: number;
  94578. }
  94579. }
  94580. declare module BABYLON {
  94581. /**
  94582. * @hidden
  94583. */
  94584. export class _MeshCollisionData {
  94585. _checkCollisions: boolean;
  94586. _collisionMask: number;
  94587. _collisionGroup: number;
  94588. _collider: Nullable<Collider>;
  94589. _oldPositionForCollisions: Vector3;
  94590. _diffPositionForCollisions: Vector3;
  94591. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  94592. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  94593. }
  94594. }
  94595. declare module BABYLON {
  94596. /** @hidden */
  94597. class _FacetDataStorage {
  94598. facetPositions: Vector3[];
  94599. facetNormals: Vector3[];
  94600. facetPartitioning: number[][];
  94601. facetNb: number;
  94602. partitioningSubdivisions: number;
  94603. partitioningBBoxRatio: number;
  94604. facetDataEnabled: boolean;
  94605. facetParameters: any;
  94606. bbSize: Vector3;
  94607. subDiv: {
  94608. max: number;
  94609. X: number;
  94610. Y: number;
  94611. Z: number;
  94612. };
  94613. facetDepthSort: boolean;
  94614. facetDepthSortEnabled: boolean;
  94615. depthSortedIndices: IndicesArray;
  94616. depthSortedFacets: {
  94617. ind: number;
  94618. sqDistance: number;
  94619. }[];
  94620. facetDepthSortFunction: (f1: {
  94621. ind: number;
  94622. sqDistance: number;
  94623. }, f2: {
  94624. ind: number;
  94625. sqDistance: number;
  94626. }) => number;
  94627. facetDepthSortFrom: Vector3;
  94628. facetDepthSortOrigin: Vector3;
  94629. invertedMatrix: Matrix;
  94630. }
  94631. /**
  94632. * @hidden
  94633. **/
  94634. class _InternalAbstractMeshDataInfo {
  94635. _hasVertexAlpha: boolean;
  94636. _useVertexColors: boolean;
  94637. _numBoneInfluencers: number;
  94638. _applyFog: boolean;
  94639. _receiveShadows: boolean;
  94640. _facetData: _FacetDataStorage;
  94641. _visibility: number;
  94642. _skeleton: Nullable<Skeleton>;
  94643. _layerMask: number;
  94644. _computeBonesUsingShaders: boolean;
  94645. _isActive: boolean;
  94646. _onlyForInstances: boolean;
  94647. _isActiveIntermediate: boolean;
  94648. _onlyForInstancesIntermediate: boolean;
  94649. _actAsRegularMesh: boolean;
  94650. }
  94651. /**
  94652. * Class used to store all common mesh properties
  94653. */
  94654. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  94655. /** No occlusion */
  94656. static OCCLUSION_TYPE_NONE: number;
  94657. /** Occlusion set to optimisitic */
  94658. static OCCLUSION_TYPE_OPTIMISTIC: number;
  94659. /** Occlusion set to strict */
  94660. static OCCLUSION_TYPE_STRICT: number;
  94661. /** Use an accurante occlusion algorithm */
  94662. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  94663. /** Use a conservative occlusion algorithm */
  94664. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  94665. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  94666. * Test order :
  94667. * Is the bounding sphere outside the frustum ?
  94668. * If not, are the bounding box vertices outside the frustum ?
  94669. * It not, then the cullable object is in the frustum.
  94670. */
  94671. static readonly CULLINGSTRATEGY_STANDARD: number;
  94672. /** Culling strategy : Bounding Sphere Only.
  94673. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  94674. * It's also less accurate than the standard because some not visible objects can still be selected.
  94675. * Test : is the bounding sphere outside the frustum ?
  94676. * If not, then the cullable object is in the frustum.
  94677. */
  94678. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  94679. /** Culling strategy : Optimistic Inclusion.
  94680. * This in an inclusion test first, then the standard exclusion test.
  94681. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  94682. * 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.
  94683. * Anyway, it's as accurate as the standard strategy.
  94684. * Test :
  94685. * Is the cullable object bounding sphere center in the frustum ?
  94686. * If not, apply the default culling strategy.
  94687. */
  94688. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  94689. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  94690. * This in an inclusion test first, then the bounding sphere only exclusion test.
  94691. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  94692. * 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.
  94693. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  94694. * Test :
  94695. * Is the cullable object bounding sphere center in the frustum ?
  94696. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  94697. */
  94698. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  94699. /**
  94700. * No billboard
  94701. */
  94702. static readonly BILLBOARDMODE_NONE: number;
  94703. /** Billboard on X axis */
  94704. static readonly BILLBOARDMODE_X: number;
  94705. /** Billboard on Y axis */
  94706. static readonly BILLBOARDMODE_Y: number;
  94707. /** Billboard on Z axis */
  94708. static readonly BILLBOARDMODE_Z: number;
  94709. /** Billboard on all axes */
  94710. static readonly BILLBOARDMODE_ALL: number;
  94711. /** Billboard on using position instead of orientation */
  94712. static readonly BILLBOARDMODE_USE_POSITION: number;
  94713. /** @hidden */
  94714. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  94715. /**
  94716. * The culling strategy to use to check whether the mesh must be rendered or not.
  94717. * This value can be changed at any time and will be used on the next render mesh selection.
  94718. * The possible values are :
  94719. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  94720. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94721. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  94722. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  94723. * Please read each static variable documentation to get details about the culling process.
  94724. * */
  94725. cullingStrategy: number;
  94726. /**
  94727. * Gets the number of facets in the mesh
  94728. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  94729. */
  94730. readonly facetNb: number;
  94731. /**
  94732. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  94733. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  94734. */
  94735. partitioningSubdivisions: number;
  94736. /**
  94737. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  94738. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  94739. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  94740. */
  94741. partitioningBBoxRatio: number;
  94742. /**
  94743. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  94744. * Works only for updatable meshes.
  94745. * Doesn't work with multi-materials
  94746. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  94747. */
  94748. mustDepthSortFacets: boolean;
  94749. /**
  94750. * The location (Vector3) where the facet depth sort must be computed from.
  94751. * By default, the active camera position.
  94752. * Used only when facet depth sort is enabled
  94753. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  94754. */
  94755. facetDepthSortFrom: Vector3;
  94756. /**
  94757. * gets a boolean indicating if facetData is enabled
  94758. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  94759. */
  94760. readonly isFacetDataEnabled: boolean;
  94761. /** @hidden */
  94762. _updateNonUniformScalingState(value: boolean): boolean;
  94763. /**
  94764. * An event triggered when this mesh collides with another one
  94765. */
  94766. onCollideObservable: Observable<AbstractMesh>;
  94767. /** Set a function to call when this mesh collides with another one */
  94768. onCollide: () => void;
  94769. /**
  94770. * An event triggered when the collision's position changes
  94771. */
  94772. onCollisionPositionChangeObservable: Observable<Vector3>;
  94773. /** Set a function to call when the collision's position changes */
  94774. onCollisionPositionChange: () => void;
  94775. /**
  94776. * An event triggered when material is changed
  94777. */
  94778. onMaterialChangedObservable: Observable<AbstractMesh>;
  94779. /**
  94780. * Gets or sets the orientation for POV movement & rotation
  94781. */
  94782. definedFacingForward: boolean;
  94783. /** @hidden */
  94784. _occlusionQuery: Nullable<WebGLQuery>;
  94785. /** @hidden */
  94786. _renderingGroup: Nullable<RenderingGroup>;
  94787. /**
  94788. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  94789. */
  94790. /**
  94791. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  94792. */
  94793. visibility: number;
  94794. /** Gets or sets the alpha index used to sort transparent meshes
  94795. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  94796. */
  94797. alphaIndex: number;
  94798. /**
  94799. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  94800. */
  94801. isVisible: boolean;
  94802. /**
  94803. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  94804. */
  94805. isPickable: boolean;
  94806. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  94807. showSubMeshesBoundingBox: boolean;
  94808. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  94809. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  94810. */
  94811. isBlocker: boolean;
  94812. /**
  94813. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  94814. */
  94815. enablePointerMoveEvents: boolean;
  94816. /**
  94817. * Specifies the rendering group id for this mesh (0 by default)
  94818. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  94819. */
  94820. renderingGroupId: number;
  94821. private _material;
  94822. /** Gets or sets current material */
  94823. material: Nullable<Material>;
  94824. /**
  94825. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  94826. * @see http://doc.babylonjs.com/babylon101/shadows
  94827. */
  94828. receiveShadows: boolean;
  94829. /** Defines color to use when rendering outline */
  94830. outlineColor: Color3;
  94831. /** Define width to use when rendering outline */
  94832. outlineWidth: number;
  94833. /** Defines color to use when rendering overlay */
  94834. overlayColor: Color3;
  94835. /** Defines alpha to use when rendering overlay */
  94836. overlayAlpha: number;
  94837. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  94838. hasVertexAlpha: boolean;
  94839. /** 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) */
  94840. useVertexColors: boolean;
  94841. /**
  94842. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  94843. */
  94844. computeBonesUsingShaders: boolean;
  94845. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  94846. numBoneInfluencers: number;
  94847. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  94848. applyFog: boolean;
  94849. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  94850. useOctreeForRenderingSelection: boolean;
  94851. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  94852. useOctreeForPicking: boolean;
  94853. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  94854. useOctreeForCollisions: boolean;
  94855. /**
  94856. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  94857. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  94858. */
  94859. layerMask: number;
  94860. /**
  94861. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  94862. */
  94863. alwaysSelectAsActiveMesh: boolean;
  94864. /**
  94865. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  94866. */
  94867. doNotSyncBoundingInfo: boolean;
  94868. /**
  94869. * Gets or sets the current action manager
  94870. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  94871. */
  94872. actionManager: Nullable<AbstractActionManager>;
  94873. private _meshCollisionData;
  94874. /**
  94875. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  94876. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94877. */
  94878. ellipsoid: Vector3;
  94879. /**
  94880. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  94881. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94882. */
  94883. ellipsoidOffset: Vector3;
  94884. /**
  94885. * Gets or sets a collision mask used to mask collisions (default is -1).
  94886. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  94887. */
  94888. collisionMask: number;
  94889. /**
  94890. * Gets or sets the current collision group mask (-1 by default).
  94891. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  94892. */
  94893. collisionGroup: number;
  94894. /**
  94895. * Defines edge width used when edgesRenderer is enabled
  94896. * @see https://www.babylonjs-playground.com/#10OJSG#13
  94897. */
  94898. edgesWidth: number;
  94899. /**
  94900. * Defines edge color used when edgesRenderer is enabled
  94901. * @see https://www.babylonjs-playground.com/#10OJSG#13
  94902. */
  94903. edgesColor: Color4;
  94904. /** @hidden */
  94905. _edgesRenderer: Nullable<IEdgesRenderer>;
  94906. /** @hidden */
  94907. _masterMesh: Nullable<AbstractMesh>;
  94908. /** @hidden */
  94909. _boundingInfo: Nullable<BoundingInfo>;
  94910. /** @hidden */
  94911. _renderId: number;
  94912. /**
  94913. * Gets or sets the list of subMeshes
  94914. * @see http://doc.babylonjs.com/how_to/multi_materials
  94915. */
  94916. subMeshes: SubMesh[];
  94917. /** @hidden */
  94918. _intersectionsInProgress: AbstractMesh[];
  94919. /** @hidden */
  94920. _unIndexed: boolean;
  94921. /** @hidden */
  94922. _lightSources: Light[];
  94923. /** Gets the list of lights affecting that mesh */
  94924. readonly lightSources: Light[];
  94925. /** @hidden */
  94926. readonly _positions: Nullable<Vector3[]>;
  94927. /** @hidden */
  94928. _waitingData: {
  94929. lods: Nullable<any>;
  94930. actions: Nullable<any>;
  94931. freezeWorldMatrix: Nullable<boolean>;
  94932. };
  94933. /** @hidden */
  94934. _bonesTransformMatrices: Nullable<Float32Array>;
  94935. /** @hidden */
  94936. _transformMatrixTexture: Nullable<RawTexture>;
  94937. /**
  94938. * Gets or sets a skeleton to apply skining transformations
  94939. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94940. */
  94941. skeleton: Nullable<Skeleton>;
  94942. /**
  94943. * An event triggered when the mesh is rebuilt.
  94944. */
  94945. onRebuildObservable: Observable<AbstractMesh>;
  94946. /**
  94947. * Creates a new AbstractMesh
  94948. * @param name defines the name of the mesh
  94949. * @param scene defines the hosting scene
  94950. */
  94951. constructor(name: string, scene?: Nullable<Scene>);
  94952. /**
  94953. * Returns the string "AbstractMesh"
  94954. * @returns "AbstractMesh"
  94955. */
  94956. getClassName(): string;
  94957. /**
  94958. * Gets a string representation of the current mesh
  94959. * @param fullDetails defines a boolean indicating if full details must be included
  94960. * @returns a string representation of the current mesh
  94961. */
  94962. toString(fullDetails?: boolean): string;
  94963. /**
  94964. * @hidden
  94965. */
  94966. protected _getEffectiveParent(): Nullable<Node>;
  94967. /** @hidden */
  94968. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  94969. /** @hidden */
  94970. _rebuild(): void;
  94971. /** @hidden */
  94972. _resyncLightSources(): void;
  94973. /** @hidden */
  94974. _resyncLighSource(light: Light): void;
  94975. /** @hidden */
  94976. _unBindEffect(): void;
  94977. /** @hidden */
  94978. _removeLightSource(light: Light, dispose: boolean): void;
  94979. private _markSubMeshesAsDirty;
  94980. /** @hidden */
  94981. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  94982. /** @hidden */
  94983. _markSubMeshesAsAttributesDirty(): void;
  94984. /** @hidden */
  94985. _markSubMeshesAsMiscDirty(): void;
  94986. /**
  94987. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  94988. */
  94989. scaling: Vector3;
  94990. /**
  94991. * Returns true if the mesh is blocked. Implemented by child classes
  94992. */
  94993. readonly isBlocked: boolean;
  94994. /**
  94995. * Returns the mesh itself by default. Implemented by child classes
  94996. * @param camera defines the camera to use to pick the right LOD level
  94997. * @returns the currentAbstractMesh
  94998. */
  94999. getLOD(camera: Camera): Nullable<AbstractMesh>;
  95000. /**
  95001. * Returns 0 by default. Implemented by child classes
  95002. * @returns an integer
  95003. */
  95004. getTotalVertices(): number;
  95005. /**
  95006. * Returns a positive integer : the total number of indices in this mesh geometry.
  95007. * @returns the numner of indices or zero if the mesh has no geometry.
  95008. */
  95009. getTotalIndices(): number;
  95010. /**
  95011. * Returns null by default. Implemented by child classes
  95012. * @returns null
  95013. */
  95014. getIndices(): Nullable<IndicesArray>;
  95015. /**
  95016. * Returns the array of the requested vertex data kind. Implemented by child classes
  95017. * @param kind defines the vertex data kind to use
  95018. * @returns null
  95019. */
  95020. getVerticesData(kind: string): Nullable<FloatArray>;
  95021. /**
  95022. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95023. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95024. * Note that a new underlying VertexBuffer object is created each call.
  95025. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95026. * @param kind defines vertex data kind:
  95027. * * VertexBuffer.PositionKind
  95028. * * VertexBuffer.UVKind
  95029. * * VertexBuffer.UV2Kind
  95030. * * VertexBuffer.UV3Kind
  95031. * * VertexBuffer.UV4Kind
  95032. * * VertexBuffer.UV5Kind
  95033. * * VertexBuffer.UV6Kind
  95034. * * VertexBuffer.ColorKind
  95035. * * VertexBuffer.MatricesIndicesKind
  95036. * * VertexBuffer.MatricesIndicesExtraKind
  95037. * * VertexBuffer.MatricesWeightsKind
  95038. * * VertexBuffer.MatricesWeightsExtraKind
  95039. * @param data defines the data source
  95040. * @param updatable defines if the data must be flagged as updatable (or static)
  95041. * @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
  95042. * @returns the current mesh
  95043. */
  95044. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95045. /**
  95046. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95047. * If the mesh has no geometry, it is simply returned as it is.
  95048. * @param kind defines vertex data kind:
  95049. * * VertexBuffer.PositionKind
  95050. * * VertexBuffer.UVKind
  95051. * * VertexBuffer.UV2Kind
  95052. * * VertexBuffer.UV3Kind
  95053. * * VertexBuffer.UV4Kind
  95054. * * VertexBuffer.UV5Kind
  95055. * * VertexBuffer.UV6Kind
  95056. * * VertexBuffer.ColorKind
  95057. * * VertexBuffer.MatricesIndicesKind
  95058. * * VertexBuffer.MatricesIndicesExtraKind
  95059. * * VertexBuffer.MatricesWeightsKind
  95060. * * VertexBuffer.MatricesWeightsExtraKind
  95061. * @param data defines the data source
  95062. * @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
  95063. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  95064. * @returns the current mesh
  95065. */
  95066. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  95067. /**
  95068. * Sets the mesh indices,
  95069. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  95070. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  95071. * @param totalVertices Defines the total number of vertices
  95072. * @returns the current mesh
  95073. */
  95074. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  95075. /**
  95076. * Gets a boolean indicating if specific vertex data is present
  95077. * @param kind defines the vertex data kind to use
  95078. * @returns true is data kind is present
  95079. */
  95080. isVerticesDataPresent(kind: string): boolean;
  95081. /**
  95082. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  95083. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  95084. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  95085. * @returns a BoundingInfo
  95086. */
  95087. getBoundingInfo(): BoundingInfo;
  95088. /**
  95089. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  95090. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  95091. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  95092. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  95093. * @returns the current mesh
  95094. */
  95095. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  95096. /**
  95097. * Overwrite the current bounding info
  95098. * @param boundingInfo defines the new bounding info
  95099. * @returns the current mesh
  95100. */
  95101. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  95102. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  95103. readonly useBones: boolean;
  95104. /** @hidden */
  95105. _preActivate(): void;
  95106. /** @hidden */
  95107. _preActivateForIntermediateRendering(renderId: number): void;
  95108. /** @hidden */
  95109. _activate(renderId: number, intermediateRendering: boolean): boolean;
  95110. /** @hidden */
  95111. _postActivate(): void;
  95112. /** @hidden */
  95113. _freeze(): void;
  95114. /** @hidden */
  95115. _unFreeze(): void;
  95116. /**
  95117. * Gets the current world matrix
  95118. * @returns a Matrix
  95119. */
  95120. getWorldMatrix(): Matrix;
  95121. /** @hidden */
  95122. _getWorldMatrixDeterminant(): number;
  95123. /**
  95124. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  95125. */
  95126. readonly isAnInstance: boolean;
  95127. /**
  95128. * Gets a boolean indicating if this mesh has instances
  95129. */
  95130. readonly hasInstances: boolean;
  95131. /**
  95132. * Perform relative position change from the point of view of behind the front of the mesh.
  95133. * This is performed taking into account the meshes current rotation, so you do not have to care.
  95134. * Supports definition of mesh facing forward or backward
  95135. * @param amountRight defines the distance on the right axis
  95136. * @param amountUp defines the distance on the up axis
  95137. * @param amountForward defines the distance on the forward axis
  95138. * @returns the current mesh
  95139. */
  95140. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  95141. /**
  95142. * Calculate relative position change from the point of view of behind the front of the mesh.
  95143. * This is performed taking into account the meshes current rotation, so you do not have to care.
  95144. * Supports definition of mesh facing forward or backward
  95145. * @param amountRight defines the distance on the right axis
  95146. * @param amountUp defines the distance on the up axis
  95147. * @param amountForward defines the distance on the forward axis
  95148. * @returns the new displacement vector
  95149. */
  95150. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  95151. /**
  95152. * Perform relative rotation change from the point of view of behind the front of the mesh.
  95153. * Supports definition of mesh facing forward or backward
  95154. * @param flipBack defines the flip
  95155. * @param twirlClockwise defines the twirl
  95156. * @param tiltRight defines the tilt
  95157. * @returns the current mesh
  95158. */
  95159. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  95160. /**
  95161. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  95162. * Supports definition of mesh facing forward or backward.
  95163. * @param flipBack defines the flip
  95164. * @param twirlClockwise defines the twirl
  95165. * @param tiltRight defines the tilt
  95166. * @returns the new rotation vector
  95167. */
  95168. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  95169. /**
  95170. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  95171. * This means the mesh underlying bounding box and sphere are recomputed.
  95172. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  95173. * @returns the current mesh
  95174. */
  95175. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  95176. /** @hidden */
  95177. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  95178. /** @hidden */
  95179. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  95180. /** @hidden */
  95181. _updateBoundingInfo(): AbstractMesh;
  95182. /** @hidden */
  95183. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  95184. /** @hidden */
  95185. protected _afterComputeWorldMatrix(): void;
  95186. /** @hidden */
  95187. readonly _effectiveMesh: AbstractMesh;
  95188. /**
  95189. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  95190. * A mesh is in the frustum if its bounding box intersects the frustum
  95191. * @param frustumPlanes defines the frustum to test
  95192. * @returns true if the mesh is in the frustum planes
  95193. */
  95194. isInFrustum(frustumPlanes: Plane[]): boolean;
  95195. /**
  95196. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  95197. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  95198. * @param frustumPlanes defines the frustum to test
  95199. * @returns true if the mesh is completely in the frustum planes
  95200. */
  95201. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  95202. /**
  95203. * True if the mesh intersects another mesh or a SolidParticle object
  95204. * @param mesh defines a target mesh or SolidParticle to test
  95205. * @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)
  95206. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  95207. * @returns true if there is an intersection
  95208. */
  95209. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  95210. /**
  95211. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  95212. * @param point defines the point to test
  95213. * @returns true if there is an intersection
  95214. */
  95215. intersectsPoint(point: Vector3): boolean;
  95216. /**
  95217. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  95218. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  95219. */
  95220. checkCollisions: boolean;
  95221. /**
  95222. * Gets Collider object used to compute collisions (not physics)
  95223. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  95224. */
  95225. readonly collider: Nullable<Collider>;
  95226. /**
  95227. * Move the mesh using collision engine
  95228. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  95229. * @param displacement defines the requested displacement vector
  95230. * @returns the current mesh
  95231. */
  95232. moveWithCollisions(displacement: Vector3): AbstractMesh;
  95233. private _onCollisionPositionChange;
  95234. /** @hidden */
  95235. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  95236. /** @hidden */
  95237. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  95238. /** @hidden */
  95239. _checkCollision(collider: Collider): AbstractMesh;
  95240. /** @hidden */
  95241. _generatePointsArray(): boolean;
  95242. /**
  95243. * Checks if the passed Ray intersects with the mesh
  95244. * @param ray defines the ray to use
  95245. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  95246. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  95247. * @returns the picking info
  95248. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  95249. */
  95250. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  95251. /**
  95252. * Clones the current mesh
  95253. * @param name defines the mesh name
  95254. * @param newParent defines the new mesh parent
  95255. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  95256. * @returns the new mesh
  95257. */
  95258. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  95259. /**
  95260. * Disposes all the submeshes of the current meshnp
  95261. * @returns the current mesh
  95262. */
  95263. releaseSubMeshes(): AbstractMesh;
  95264. /**
  95265. * Releases resources associated with this abstract mesh.
  95266. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95267. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95268. */
  95269. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95270. /**
  95271. * Adds the passed mesh as a child to the current mesh
  95272. * @param mesh defines the child mesh
  95273. * @returns the current mesh
  95274. */
  95275. addChild(mesh: AbstractMesh): AbstractMesh;
  95276. /**
  95277. * Removes the passed mesh from the current mesh children list
  95278. * @param mesh defines the child mesh
  95279. * @returns the current mesh
  95280. */
  95281. removeChild(mesh: AbstractMesh): AbstractMesh;
  95282. /** @hidden */
  95283. private _initFacetData;
  95284. /**
  95285. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  95286. * This method can be called within the render loop.
  95287. * 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
  95288. * @returns the current mesh
  95289. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95290. */
  95291. updateFacetData(): AbstractMesh;
  95292. /**
  95293. * Returns the facetLocalNormals array.
  95294. * The normals are expressed in the mesh local spac
  95295. * @returns an array of Vector3
  95296. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95297. */
  95298. getFacetLocalNormals(): Vector3[];
  95299. /**
  95300. * Returns the facetLocalPositions array.
  95301. * The facet positions are expressed in the mesh local space
  95302. * @returns an array of Vector3
  95303. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95304. */
  95305. getFacetLocalPositions(): Vector3[];
  95306. /**
  95307. * Returns the facetLocalPartioning array
  95308. * @returns an array of array of numbers
  95309. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95310. */
  95311. getFacetLocalPartitioning(): number[][];
  95312. /**
  95313. * Returns the i-th facet position in the world system.
  95314. * This method allocates a new Vector3 per call
  95315. * @param i defines the facet index
  95316. * @returns a new Vector3
  95317. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95318. */
  95319. getFacetPosition(i: number): Vector3;
  95320. /**
  95321. * Sets the reference Vector3 with the i-th facet position in the world system
  95322. * @param i defines the facet index
  95323. * @param ref defines the target vector
  95324. * @returns the current mesh
  95325. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95326. */
  95327. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  95328. /**
  95329. * Returns the i-th facet normal in the world system.
  95330. * This method allocates a new Vector3 per call
  95331. * @param i defines the facet index
  95332. * @returns a new Vector3
  95333. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95334. */
  95335. getFacetNormal(i: number): Vector3;
  95336. /**
  95337. * Sets the reference Vector3 with the i-th facet normal in the world system
  95338. * @param i defines the facet index
  95339. * @param ref defines the target vector
  95340. * @returns the current mesh
  95341. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95342. */
  95343. getFacetNormalToRef(i: number, ref: Vector3): this;
  95344. /**
  95345. * 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)
  95346. * @param x defines x coordinate
  95347. * @param y defines y coordinate
  95348. * @param z defines z coordinate
  95349. * @returns the array of facet indexes
  95350. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95351. */
  95352. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  95353. /**
  95354. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  95355. * @param projected sets as the (x,y,z) world projection on the facet
  95356. * @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
  95357. * @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
  95358. * @param x defines x coordinate
  95359. * @param y defines y coordinate
  95360. * @param z defines z coordinate
  95361. * @returns the face index if found (or null instead)
  95362. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95363. */
  95364. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  95365. /**
  95366. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  95367. * @param projected sets as the (x,y,z) local projection on the facet
  95368. * @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
  95369. * @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
  95370. * @param x defines x coordinate
  95371. * @param y defines y coordinate
  95372. * @param z defines z coordinate
  95373. * @returns the face index if found (or null instead)
  95374. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95375. */
  95376. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  95377. /**
  95378. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  95379. * @returns the parameters
  95380. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95381. */
  95382. getFacetDataParameters(): any;
  95383. /**
  95384. * Disables the feature FacetData and frees the related memory
  95385. * @returns the current mesh
  95386. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95387. */
  95388. disableFacetData(): AbstractMesh;
  95389. /**
  95390. * Updates the AbstractMesh indices array
  95391. * @param indices defines the data source
  95392. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  95393. * @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)
  95394. * @returns the current mesh
  95395. */
  95396. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  95397. /**
  95398. * Creates new normals data for the mesh
  95399. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  95400. * @returns the current mesh
  95401. */
  95402. createNormals(updatable: boolean): AbstractMesh;
  95403. /**
  95404. * Align the mesh with a normal
  95405. * @param normal defines the normal to use
  95406. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  95407. * @returns the current mesh
  95408. */
  95409. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  95410. /** @hidden */
  95411. _checkOcclusionQuery(): boolean;
  95412. /**
  95413. * Disables the mesh edge rendering mode
  95414. * @returns the currentAbstractMesh
  95415. */
  95416. disableEdgesRendering(): AbstractMesh;
  95417. /**
  95418. * Enables the edge rendering mode on the mesh.
  95419. * This mode makes the mesh edges visible
  95420. * @param epsilon defines the maximal distance between two angles to detect a face
  95421. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  95422. * @returns the currentAbstractMesh
  95423. * @see https://www.babylonjs-playground.com/#19O9TU#0
  95424. */
  95425. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  95426. }
  95427. }
  95428. declare module BABYLON {
  95429. /**
  95430. * Interface used to define ActionEvent
  95431. */
  95432. export interface IActionEvent {
  95433. /** The mesh or sprite that triggered the action */
  95434. source: any;
  95435. /** The X mouse cursor position at the time of the event */
  95436. pointerX: number;
  95437. /** The Y mouse cursor position at the time of the event */
  95438. pointerY: number;
  95439. /** The mesh that is currently pointed at (can be null) */
  95440. meshUnderPointer: Nullable<AbstractMesh>;
  95441. /** the original (browser) event that triggered the ActionEvent */
  95442. sourceEvent?: any;
  95443. /** additional data for the event */
  95444. additionalData?: any;
  95445. }
  95446. /**
  95447. * ActionEvent is the event being sent when an action is triggered.
  95448. */
  95449. export class ActionEvent implements IActionEvent {
  95450. /** The mesh or sprite that triggered the action */
  95451. source: any;
  95452. /** The X mouse cursor position at the time of the event */
  95453. pointerX: number;
  95454. /** The Y mouse cursor position at the time of the event */
  95455. pointerY: number;
  95456. /** The mesh that is currently pointed at (can be null) */
  95457. meshUnderPointer: Nullable<AbstractMesh>;
  95458. /** the original (browser) event that triggered the ActionEvent */
  95459. sourceEvent?: any;
  95460. /** additional data for the event */
  95461. additionalData?: any;
  95462. /**
  95463. * Creates a new ActionEvent
  95464. * @param source The mesh or sprite that triggered the action
  95465. * @param pointerX The X mouse cursor position at the time of the event
  95466. * @param pointerY The Y mouse cursor position at the time of the event
  95467. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  95468. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  95469. * @param additionalData additional data for the event
  95470. */
  95471. constructor(
  95472. /** The mesh or sprite that triggered the action */
  95473. source: any,
  95474. /** The X mouse cursor position at the time of the event */
  95475. pointerX: number,
  95476. /** The Y mouse cursor position at the time of the event */
  95477. pointerY: number,
  95478. /** The mesh that is currently pointed at (can be null) */
  95479. meshUnderPointer: Nullable<AbstractMesh>,
  95480. /** the original (browser) event that triggered the ActionEvent */
  95481. sourceEvent?: any,
  95482. /** additional data for the event */
  95483. additionalData?: any);
  95484. /**
  95485. * Helper function to auto-create an ActionEvent from a source mesh.
  95486. * @param source The source mesh that triggered the event
  95487. * @param evt The original (browser) event
  95488. * @param additionalData additional data for the event
  95489. * @returns the new ActionEvent
  95490. */
  95491. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  95492. /**
  95493. * Helper function to auto-create an ActionEvent from a source sprite
  95494. * @param source The source sprite that triggered the event
  95495. * @param scene Scene associated with the sprite
  95496. * @param evt The original (browser) event
  95497. * @param additionalData additional data for the event
  95498. * @returns the new ActionEvent
  95499. */
  95500. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  95501. /**
  95502. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  95503. * @param scene the scene where the event occurred
  95504. * @param evt The original (browser) event
  95505. * @returns the new ActionEvent
  95506. */
  95507. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  95508. /**
  95509. * Helper function to auto-create an ActionEvent from a primitive
  95510. * @param prim defines the target primitive
  95511. * @param pointerPos defines the pointer position
  95512. * @param evt The original (browser) event
  95513. * @param additionalData additional data for the event
  95514. * @returns the new ActionEvent
  95515. */
  95516. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  95517. }
  95518. }
  95519. declare module BABYLON {
  95520. /**
  95521. * Abstract class used to decouple action Manager from scene and meshes.
  95522. * Do not instantiate.
  95523. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  95524. */
  95525. export abstract class AbstractActionManager implements IDisposable {
  95526. /** Gets the list of active triggers */
  95527. static Triggers: {
  95528. [key: string]: number;
  95529. };
  95530. /** Gets the cursor to use when hovering items */
  95531. hoverCursor: string;
  95532. /** Gets the list of actions */
  95533. actions: IAction[];
  95534. /**
  95535. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  95536. */
  95537. isRecursive: boolean;
  95538. /**
  95539. * Releases all associated resources
  95540. */
  95541. abstract dispose(): void;
  95542. /**
  95543. * Does this action manager has pointer triggers
  95544. */
  95545. abstract readonly hasPointerTriggers: boolean;
  95546. /**
  95547. * Does this action manager has pick triggers
  95548. */
  95549. abstract readonly hasPickTriggers: boolean;
  95550. /**
  95551. * Process a specific trigger
  95552. * @param trigger defines the trigger to process
  95553. * @param evt defines the event details to be processed
  95554. */
  95555. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  95556. /**
  95557. * Does this action manager handles actions of any of the given triggers
  95558. * @param triggers defines the triggers to be tested
  95559. * @return a boolean indicating whether one (or more) of the triggers is handled
  95560. */
  95561. abstract hasSpecificTriggers(triggers: number[]): boolean;
  95562. /**
  95563. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  95564. * speed.
  95565. * @param triggerA defines the trigger to be tested
  95566. * @param triggerB defines the trigger to be tested
  95567. * @return a boolean indicating whether one (or more) of the triggers is handled
  95568. */
  95569. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  95570. /**
  95571. * Does this action manager handles actions of a given trigger
  95572. * @param trigger defines the trigger to be tested
  95573. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  95574. * @return whether the trigger is handled
  95575. */
  95576. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  95577. /**
  95578. * Serialize this manager to a JSON object
  95579. * @param name defines the property name to store this manager
  95580. * @returns a JSON representation of this manager
  95581. */
  95582. abstract serialize(name: string): any;
  95583. /**
  95584. * Registers an action to this action manager
  95585. * @param action defines the action to be registered
  95586. * @return the action amended (prepared) after registration
  95587. */
  95588. abstract registerAction(action: IAction): Nullable<IAction>;
  95589. /**
  95590. * Unregisters an action to this action manager
  95591. * @param action defines the action to be unregistered
  95592. * @return a boolean indicating whether the action has been unregistered
  95593. */
  95594. abstract unregisterAction(action: IAction): Boolean;
  95595. /**
  95596. * Does exist one action manager with at least one trigger
  95597. **/
  95598. static readonly HasTriggers: boolean;
  95599. /**
  95600. * Does exist one action manager with at least one pick trigger
  95601. **/
  95602. static readonly HasPickTriggers: boolean;
  95603. /**
  95604. * Does exist one action manager that handles actions of a given trigger
  95605. * @param trigger defines the trigger to be tested
  95606. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  95607. **/
  95608. static HasSpecificTrigger(trigger: number): boolean;
  95609. }
  95610. }
  95611. declare module BABYLON {
  95612. /**
  95613. * Defines how a node can be built from a string name.
  95614. */
  95615. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  95616. /**
  95617. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  95618. */
  95619. export class Node implements IBehaviorAware<Node> {
  95620. /** @hidden */
  95621. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  95622. private static _NodeConstructors;
  95623. /**
  95624. * Add a new node constructor
  95625. * @param type defines the type name of the node to construct
  95626. * @param constructorFunc defines the constructor function
  95627. */
  95628. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  95629. /**
  95630. * Returns a node constructor based on type name
  95631. * @param type defines the type name
  95632. * @param name defines the new node name
  95633. * @param scene defines the hosting scene
  95634. * @param options defines optional options to transmit to constructors
  95635. * @returns the new constructor or null
  95636. */
  95637. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  95638. /**
  95639. * Gets or sets the name of the node
  95640. */
  95641. name: string;
  95642. /**
  95643. * Gets or sets the id of the node
  95644. */
  95645. id: string;
  95646. /**
  95647. * Gets or sets the unique id of the node
  95648. */
  95649. uniqueId: number;
  95650. /**
  95651. * Gets or sets a string used to store user defined state for the node
  95652. */
  95653. state: string;
  95654. /**
  95655. * Gets or sets an object used to store user defined information for the node
  95656. */
  95657. metadata: any;
  95658. /**
  95659. * For internal use only. Please do not use.
  95660. */
  95661. reservedDataStore: any;
  95662. /**
  95663. * List of inspectable custom properties (used by the Inspector)
  95664. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95665. */
  95666. inspectableCustomProperties: IInspectable[];
  95667. private _doNotSerialize;
  95668. /**
  95669. * Gets or sets a boolean used to define if the node must be serialized
  95670. */
  95671. doNotSerialize: boolean;
  95672. /** @hidden */
  95673. _isDisposed: boolean;
  95674. /**
  95675. * Gets a list of Animations associated with the node
  95676. */
  95677. animations: Animation[];
  95678. protected _ranges: {
  95679. [name: string]: Nullable<AnimationRange>;
  95680. };
  95681. /**
  95682. * Callback raised when the node is ready to be used
  95683. */
  95684. onReady: Nullable<(node: Node) => void>;
  95685. private _isEnabled;
  95686. private _isParentEnabled;
  95687. private _isReady;
  95688. /** @hidden */
  95689. _currentRenderId: number;
  95690. private _parentUpdateId;
  95691. /** @hidden */
  95692. _childUpdateId: number;
  95693. /** @hidden */
  95694. _waitingParentId: Nullable<string>;
  95695. /** @hidden */
  95696. _scene: Scene;
  95697. /** @hidden */
  95698. _cache: any;
  95699. private _parentNode;
  95700. private _children;
  95701. /** @hidden */
  95702. _worldMatrix: Matrix;
  95703. /** @hidden */
  95704. _worldMatrixDeterminant: number;
  95705. /** @hidden */
  95706. _worldMatrixDeterminantIsDirty: boolean;
  95707. /** @hidden */
  95708. private _sceneRootNodesIndex;
  95709. /**
  95710. * Gets a boolean indicating if the node has been disposed
  95711. * @returns true if the node was disposed
  95712. */
  95713. isDisposed(): boolean;
  95714. /**
  95715. * Gets or sets the parent of the node (without keeping the current position in the scene)
  95716. * @see https://doc.babylonjs.com/how_to/parenting
  95717. */
  95718. parent: Nullable<Node>;
  95719. /** @hidden */
  95720. _addToSceneRootNodes(): void;
  95721. /** @hidden */
  95722. _removeFromSceneRootNodes(): void;
  95723. private _animationPropertiesOverride;
  95724. /**
  95725. * Gets or sets the animation properties override
  95726. */
  95727. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  95728. /**
  95729. * Gets a string idenfifying the name of the class
  95730. * @returns "Node" string
  95731. */
  95732. getClassName(): string;
  95733. /** @hidden */
  95734. readonly _isNode: boolean;
  95735. /**
  95736. * An event triggered when the mesh is disposed
  95737. */
  95738. onDisposeObservable: Observable<Node>;
  95739. private _onDisposeObserver;
  95740. /**
  95741. * Sets a callback that will be raised when the node will be disposed
  95742. */
  95743. onDispose: () => void;
  95744. /**
  95745. * Creates a new Node
  95746. * @param name the name and id to be given to this node
  95747. * @param scene the scene this node will be added to
  95748. */
  95749. constructor(name: string, scene?: Nullable<Scene>);
  95750. /**
  95751. * Gets the scene of the node
  95752. * @returns a scene
  95753. */
  95754. getScene(): Scene;
  95755. /**
  95756. * Gets the engine of the node
  95757. * @returns a Engine
  95758. */
  95759. getEngine(): Engine;
  95760. private _behaviors;
  95761. /**
  95762. * Attach a behavior to the node
  95763. * @see http://doc.babylonjs.com/features/behaviour
  95764. * @param behavior defines the behavior to attach
  95765. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  95766. * @returns the current Node
  95767. */
  95768. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  95769. /**
  95770. * Remove an attached behavior
  95771. * @see http://doc.babylonjs.com/features/behaviour
  95772. * @param behavior defines the behavior to attach
  95773. * @returns the current Node
  95774. */
  95775. removeBehavior(behavior: Behavior<Node>): Node;
  95776. /**
  95777. * Gets the list of attached behaviors
  95778. * @see http://doc.babylonjs.com/features/behaviour
  95779. */
  95780. readonly behaviors: Behavior<Node>[];
  95781. /**
  95782. * Gets an attached behavior by name
  95783. * @param name defines the name of the behavior to look for
  95784. * @see http://doc.babylonjs.com/features/behaviour
  95785. * @returns null if behavior was not found else the requested behavior
  95786. */
  95787. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  95788. /**
  95789. * Returns the latest update of the World matrix
  95790. * @returns a Matrix
  95791. */
  95792. getWorldMatrix(): Matrix;
  95793. /** @hidden */
  95794. _getWorldMatrixDeterminant(): number;
  95795. /**
  95796. * Returns directly the latest state of the mesh World matrix.
  95797. * A Matrix is returned.
  95798. */
  95799. readonly worldMatrixFromCache: Matrix;
  95800. /** @hidden */
  95801. _initCache(): void;
  95802. /** @hidden */
  95803. updateCache(force?: boolean): void;
  95804. /** @hidden */
  95805. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  95806. /** @hidden */
  95807. _updateCache(ignoreParentClass?: boolean): void;
  95808. /** @hidden */
  95809. _isSynchronized(): boolean;
  95810. /** @hidden */
  95811. _markSyncedWithParent(): void;
  95812. /** @hidden */
  95813. isSynchronizedWithParent(): boolean;
  95814. /** @hidden */
  95815. isSynchronized(): boolean;
  95816. /**
  95817. * Is this node ready to be used/rendered
  95818. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95819. * @return true if the node is ready
  95820. */
  95821. isReady(completeCheck?: boolean): boolean;
  95822. /**
  95823. * Is this node enabled?
  95824. * 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
  95825. * @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
  95826. * @return whether this node (and its parent) is enabled
  95827. */
  95828. isEnabled(checkAncestors?: boolean): boolean;
  95829. /** @hidden */
  95830. protected _syncParentEnabledState(): void;
  95831. /**
  95832. * Set the enabled state of this node
  95833. * @param value defines the new enabled state
  95834. */
  95835. setEnabled(value: boolean): void;
  95836. /**
  95837. * Is this node a descendant of the given node?
  95838. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  95839. * @param ancestor defines the parent node to inspect
  95840. * @returns a boolean indicating if this node is a descendant of the given node
  95841. */
  95842. isDescendantOf(ancestor: Node): boolean;
  95843. /** @hidden */
  95844. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  95845. /**
  95846. * Will return all nodes that have this node as ascendant
  95847. * @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
  95848. * @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
  95849. * @return all children nodes of all types
  95850. */
  95851. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  95852. /**
  95853. * Get all child-meshes of this node
  95854. * @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)
  95855. * @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
  95856. * @returns an array of AbstractMesh
  95857. */
  95858. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  95859. /**
  95860. * Get all direct children of this node
  95861. * @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
  95862. * @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)
  95863. * @returns an array of Node
  95864. */
  95865. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  95866. /** @hidden */
  95867. _setReady(state: boolean): void;
  95868. /**
  95869. * Get an animation by name
  95870. * @param name defines the name of the animation to look for
  95871. * @returns null if not found else the requested animation
  95872. */
  95873. getAnimationByName(name: string): Nullable<Animation>;
  95874. /**
  95875. * Creates an animation range for this node
  95876. * @param name defines the name of the range
  95877. * @param from defines the starting key
  95878. * @param to defines the end key
  95879. */
  95880. createAnimationRange(name: string, from: number, to: number): void;
  95881. /**
  95882. * Delete a specific animation range
  95883. * @param name defines the name of the range to delete
  95884. * @param deleteFrames defines if animation frames from the range must be deleted as well
  95885. */
  95886. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95887. /**
  95888. * Get an animation range by name
  95889. * @param name defines the name of the animation range to look for
  95890. * @returns null if not found else the requested animation range
  95891. */
  95892. getAnimationRange(name: string): Nullable<AnimationRange>;
  95893. /**
  95894. * Gets the list of all animation ranges defined on this node
  95895. * @returns an array
  95896. */
  95897. getAnimationRanges(): Nullable<AnimationRange>[];
  95898. /**
  95899. * Will start the animation sequence
  95900. * @param name defines the range frames for animation sequence
  95901. * @param loop defines if the animation should loop (false by default)
  95902. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  95903. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  95904. * @returns the object created for this animation. If range does not exist, it will return null
  95905. */
  95906. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95907. /**
  95908. * Serialize animation ranges into a JSON compatible object
  95909. * @returns serialization object
  95910. */
  95911. serializeAnimationRanges(): any;
  95912. /**
  95913. * Computes the world matrix of the node
  95914. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95915. * @returns the world matrix
  95916. */
  95917. computeWorldMatrix(force?: boolean): Matrix;
  95918. /**
  95919. * Releases resources associated with this node.
  95920. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95921. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95922. */
  95923. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95924. /**
  95925. * Parse animation range data from a serialization object and store them into a given node
  95926. * @param node defines where to store the animation ranges
  95927. * @param parsedNode defines the serialization object to read data from
  95928. * @param scene defines the hosting scene
  95929. */
  95930. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  95931. /**
  95932. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  95933. * @param includeDescendants Include bounding info from descendants as well (true by default)
  95934. * @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
  95935. * @returns the new bounding vectors
  95936. */
  95937. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  95938. min: Vector3;
  95939. max: Vector3;
  95940. };
  95941. }
  95942. }
  95943. declare module BABYLON {
  95944. /**
  95945. * @hidden
  95946. */
  95947. export class _IAnimationState {
  95948. key: number;
  95949. repeatCount: number;
  95950. workValue?: any;
  95951. loopMode?: number;
  95952. offsetValue?: any;
  95953. highLimitValue?: any;
  95954. }
  95955. /**
  95956. * Class used to store any kind of animation
  95957. */
  95958. export class Animation {
  95959. /**Name of the animation */
  95960. name: string;
  95961. /**Property to animate */
  95962. targetProperty: string;
  95963. /**The frames per second of the animation */
  95964. framePerSecond: number;
  95965. /**The data type of the animation */
  95966. dataType: number;
  95967. /**The loop mode of the animation */
  95968. loopMode?: number | undefined;
  95969. /**Specifies if blending should be enabled */
  95970. enableBlending?: boolean | undefined;
  95971. /**
  95972. * Use matrix interpolation instead of using direct key value when animating matrices
  95973. */
  95974. static AllowMatricesInterpolation: boolean;
  95975. /**
  95976. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  95977. */
  95978. static AllowMatrixDecomposeForInterpolation: boolean;
  95979. /**
  95980. * Stores the key frames of the animation
  95981. */
  95982. private _keys;
  95983. /**
  95984. * Stores the easing function of the animation
  95985. */
  95986. private _easingFunction;
  95987. /**
  95988. * @hidden Internal use only
  95989. */
  95990. _runtimeAnimations: RuntimeAnimation[];
  95991. /**
  95992. * The set of event that will be linked to this animation
  95993. */
  95994. private _events;
  95995. /**
  95996. * Stores an array of target property paths
  95997. */
  95998. targetPropertyPath: string[];
  95999. /**
  96000. * Stores the blending speed of the animation
  96001. */
  96002. blendingSpeed: number;
  96003. /**
  96004. * Stores the animation ranges for the animation
  96005. */
  96006. private _ranges;
  96007. /**
  96008. * @hidden Internal use
  96009. */
  96010. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  96011. /**
  96012. * Sets up an animation
  96013. * @param property The property to animate
  96014. * @param animationType The animation type to apply
  96015. * @param framePerSecond The frames per second of the animation
  96016. * @param easingFunction The easing function used in the animation
  96017. * @returns The created animation
  96018. */
  96019. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  96020. /**
  96021. * Create and start an animation on a node
  96022. * @param name defines the name of the global animation that will be run on all nodes
  96023. * @param node defines the root node where the animation will take place
  96024. * @param targetProperty defines property to animate
  96025. * @param framePerSecond defines the number of frame per second yo use
  96026. * @param totalFrame defines the number of frames in total
  96027. * @param from defines the initial value
  96028. * @param to defines the final value
  96029. * @param loopMode defines which loop mode you want to use (off by default)
  96030. * @param easingFunction defines the easing function to use (linear by default)
  96031. * @param onAnimationEnd defines the callback to call when animation end
  96032. * @returns the animatable created for this animation
  96033. */
  96034. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  96035. /**
  96036. * Create and start an animation on a node and its descendants
  96037. * @param name defines the name of the global animation that will be run on all nodes
  96038. * @param node defines the root node where the animation will take place
  96039. * @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
  96040. * @param targetProperty defines property to animate
  96041. * @param framePerSecond defines the number of frame per second to use
  96042. * @param totalFrame defines the number of frames in total
  96043. * @param from defines the initial value
  96044. * @param to defines the final value
  96045. * @param loopMode defines which loop mode you want to use (off by default)
  96046. * @param easingFunction defines the easing function to use (linear by default)
  96047. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  96048. * @returns the list of animatables created for all nodes
  96049. * @example https://www.babylonjs-playground.com/#MH0VLI
  96050. */
  96051. 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[]>;
  96052. /**
  96053. * Creates a new animation, merges it with the existing animations and starts it
  96054. * @param name Name of the animation
  96055. * @param node Node which contains the scene that begins the animations
  96056. * @param targetProperty Specifies which property to animate
  96057. * @param framePerSecond The frames per second of the animation
  96058. * @param totalFrame The total number of frames
  96059. * @param from The frame at the beginning of the animation
  96060. * @param to The frame at the end of the animation
  96061. * @param loopMode Specifies the loop mode of the animation
  96062. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  96063. * @param onAnimationEnd Callback to run once the animation is complete
  96064. * @returns Nullable animation
  96065. */
  96066. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  96067. /**
  96068. * Transition property of an host to the target Value
  96069. * @param property The property to transition
  96070. * @param targetValue The target Value of the property
  96071. * @param host The object where the property to animate belongs
  96072. * @param scene Scene used to run the animation
  96073. * @param frameRate Framerate (in frame/s) to use
  96074. * @param transition The transition type we want to use
  96075. * @param duration The duration of the animation, in milliseconds
  96076. * @param onAnimationEnd Callback trigger at the end of the animation
  96077. * @returns Nullable animation
  96078. */
  96079. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  96080. /**
  96081. * Return the array of runtime animations currently using this animation
  96082. */
  96083. readonly runtimeAnimations: RuntimeAnimation[];
  96084. /**
  96085. * Specifies if any of the runtime animations are currently running
  96086. */
  96087. readonly hasRunningRuntimeAnimations: boolean;
  96088. /**
  96089. * Initializes the animation
  96090. * @param name Name of the animation
  96091. * @param targetProperty Property to animate
  96092. * @param framePerSecond The frames per second of the animation
  96093. * @param dataType The data type of the animation
  96094. * @param loopMode The loop mode of the animation
  96095. * @param enableBlending Specifies if blending should be enabled
  96096. */
  96097. constructor(
  96098. /**Name of the animation */
  96099. name: string,
  96100. /**Property to animate */
  96101. targetProperty: string,
  96102. /**The frames per second of the animation */
  96103. framePerSecond: number,
  96104. /**The data type of the animation */
  96105. dataType: number,
  96106. /**The loop mode of the animation */
  96107. loopMode?: number | undefined,
  96108. /**Specifies if blending should be enabled */
  96109. enableBlending?: boolean | undefined);
  96110. /**
  96111. * Converts the animation to a string
  96112. * @param fullDetails support for multiple levels of logging within scene loading
  96113. * @returns String form of the animation
  96114. */
  96115. toString(fullDetails?: boolean): string;
  96116. /**
  96117. * Add an event to this animation
  96118. * @param event Event to add
  96119. */
  96120. addEvent(event: AnimationEvent): void;
  96121. /**
  96122. * Remove all events found at the given frame
  96123. * @param frame The frame to remove events from
  96124. */
  96125. removeEvents(frame: number): void;
  96126. /**
  96127. * Retrieves all the events from the animation
  96128. * @returns Events from the animation
  96129. */
  96130. getEvents(): AnimationEvent[];
  96131. /**
  96132. * Creates an animation range
  96133. * @param name Name of the animation range
  96134. * @param from Starting frame of the animation range
  96135. * @param to Ending frame of the animation
  96136. */
  96137. createRange(name: string, from: number, to: number): void;
  96138. /**
  96139. * Deletes an animation range by name
  96140. * @param name Name of the animation range to delete
  96141. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  96142. */
  96143. deleteRange(name: string, deleteFrames?: boolean): void;
  96144. /**
  96145. * Gets the animation range by name, or null if not defined
  96146. * @param name Name of the animation range
  96147. * @returns Nullable animation range
  96148. */
  96149. getRange(name: string): Nullable<AnimationRange>;
  96150. /**
  96151. * Gets the key frames from the animation
  96152. * @returns The key frames of the animation
  96153. */
  96154. getKeys(): Array<IAnimationKey>;
  96155. /**
  96156. * Gets the highest frame rate of the animation
  96157. * @returns Highest frame rate of the animation
  96158. */
  96159. getHighestFrame(): number;
  96160. /**
  96161. * Gets the easing function of the animation
  96162. * @returns Easing function of the animation
  96163. */
  96164. getEasingFunction(): IEasingFunction;
  96165. /**
  96166. * Sets the easing function of the animation
  96167. * @param easingFunction A custom mathematical formula for animation
  96168. */
  96169. setEasingFunction(easingFunction: EasingFunction): void;
  96170. /**
  96171. * Interpolates a scalar linearly
  96172. * @param startValue Start value of the animation curve
  96173. * @param endValue End value of the animation curve
  96174. * @param gradient Scalar amount to interpolate
  96175. * @returns Interpolated scalar value
  96176. */
  96177. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  96178. /**
  96179. * Interpolates a scalar cubically
  96180. * @param startValue Start value of the animation curve
  96181. * @param outTangent End tangent of the animation
  96182. * @param endValue End value of the animation curve
  96183. * @param inTangent Start tangent of the animation curve
  96184. * @param gradient Scalar amount to interpolate
  96185. * @returns Interpolated scalar value
  96186. */
  96187. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  96188. /**
  96189. * Interpolates a quaternion using a spherical linear interpolation
  96190. * @param startValue Start value of the animation curve
  96191. * @param endValue End value of the animation curve
  96192. * @param gradient Scalar amount to interpolate
  96193. * @returns Interpolated quaternion value
  96194. */
  96195. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  96196. /**
  96197. * Interpolates a quaternion cubically
  96198. * @param startValue Start value of the animation curve
  96199. * @param outTangent End tangent of the animation curve
  96200. * @param endValue End value of the animation curve
  96201. * @param inTangent Start tangent of the animation curve
  96202. * @param gradient Scalar amount to interpolate
  96203. * @returns Interpolated quaternion value
  96204. */
  96205. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  96206. /**
  96207. * Interpolates a Vector3 linearl
  96208. * @param startValue Start value of the animation curve
  96209. * @param endValue End value of the animation curve
  96210. * @param gradient Scalar amount to interpolate
  96211. * @returns Interpolated scalar value
  96212. */
  96213. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  96214. /**
  96215. * Interpolates a Vector3 cubically
  96216. * @param startValue Start value of the animation curve
  96217. * @param outTangent End tangent of the animation
  96218. * @param endValue End value of the animation curve
  96219. * @param inTangent Start tangent of the animation curve
  96220. * @param gradient Scalar amount to interpolate
  96221. * @returns InterpolatedVector3 value
  96222. */
  96223. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  96224. /**
  96225. * Interpolates a Vector2 linearly
  96226. * @param startValue Start value of the animation curve
  96227. * @param endValue End value of the animation curve
  96228. * @param gradient Scalar amount to interpolate
  96229. * @returns Interpolated Vector2 value
  96230. */
  96231. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  96232. /**
  96233. * Interpolates a Vector2 cubically
  96234. * @param startValue Start value of the animation curve
  96235. * @param outTangent End tangent of the animation
  96236. * @param endValue End value of the animation curve
  96237. * @param inTangent Start tangent of the animation curve
  96238. * @param gradient Scalar amount to interpolate
  96239. * @returns Interpolated Vector2 value
  96240. */
  96241. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  96242. /**
  96243. * Interpolates a size linearly
  96244. * @param startValue Start value of the animation curve
  96245. * @param endValue End value of the animation curve
  96246. * @param gradient Scalar amount to interpolate
  96247. * @returns Interpolated Size value
  96248. */
  96249. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  96250. /**
  96251. * Interpolates a Color3 linearly
  96252. * @param startValue Start value of the animation curve
  96253. * @param endValue End value of the animation curve
  96254. * @param gradient Scalar amount to interpolate
  96255. * @returns Interpolated Color3 value
  96256. */
  96257. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  96258. /**
  96259. * Interpolates a Color4 linearly
  96260. * @param startValue Start value of the animation curve
  96261. * @param endValue End value of the animation curve
  96262. * @param gradient Scalar amount to interpolate
  96263. * @returns Interpolated Color3 value
  96264. */
  96265. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  96266. /**
  96267. * @hidden Internal use only
  96268. */
  96269. _getKeyValue(value: any): any;
  96270. /**
  96271. * @hidden Internal use only
  96272. */
  96273. _interpolate(currentFrame: number, state: _IAnimationState): any;
  96274. /**
  96275. * Defines the function to use to interpolate matrices
  96276. * @param startValue defines the start matrix
  96277. * @param endValue defines the end matrix
  96278. * @param gradient defines the gradient between both matrices
  96279. * @param result defines an optional target matrix where to store the interpolation
  96280. * @returns the interpolated matrix
  96281. */
  96282. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  96283. /**
  96284. * Makes a copy of the animation
  96285. * @returns Cloned animation
  96286. */
  96287. clone(): Animation;
  96288. /**
  96289. * Sets the key frames of the animation
  96290. * @param values The animation key frames to set
  96291. */
  96292. setKeys(values: Array<IAnimationKey>): void;
  96293. /**
  96294. * Serializes the animation to an object
  96295. * @returns Serialized object
  96296. */
  96297. serialize(): any;
  96298. /**
  96299. * Float animation type
  96300. */
  96301. static readonly ANIMATIONTYPE_FLOAT: number;
  96302. /**
  96303. * Vector3 animation type
  96304. */
  96305. static readonly ANIMATIONTYPE_VECTOR3: number;
  96306. /**
  96307. * Quaternion animation type
  96308. */
  96309. static readonly ANIMATIONTYPE_QUATERNION: number;
  96310. /**
  96311. * Matrix animation type
  96312. */
  96313. static readonly ANIMATIONTYPE_MATRIX: number;
  96314. /**
  96315. * Color3 animation type
  96316. */
  96317. static readonly ANIMATIONTYPE_COLOR3: number;
  96318. /**
  96319. * Color3 animation type
  96320. */
  96321. static readonly ANIMATIONTYPE_COLOR4: number;
  96322. /**
  96323. * Vector2 animation type
  96324. */
  96325. static readonly ANIMATIONTYPE_VECTOR2: number;
  96326. /**
  96327. * Size animation type
  96328. */
  96329. static readonly ANIMATIONTYPE_SIZE: number;
  96330. /**
  96331. * Relative Loop Mode
  96332. */
  96333. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  96334. /**
  96335. * Cycle Loop Mode
  96336. */
  96337. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  96338. /**
  96339. * Constant Loop Mode
  96340. */
  96341. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  96342. /** @hidden */
  96343. static _UniversalLerp(left: any, right: any, amount: number): any;
  96344. /**
  96345. * Parses an animation object and creates an animation
  96346. * @param parsedAnimation Parsed animation object
  96347. * @returns Animation object
  96348. */
  96349. static Parse(parsedAnimation: any): Animation;
  96350. /**
  96351. * Appends the serialized animations from the source animations
  96352. * @param source Source containing the animations
  96353. * @param destination Target to store the animations
  96354. */
  96355. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  96356. }
  96357. }
  96358. declare module BABYLON {
  96359. /**
  96360. * Interface containing an array of animations
  96361. */
  96362. export interface IAnimatable {
  96363. /**
  96364. * Array of animations
  96365. */
  96366. animations: Nullable<Array<Animation>>;
  96367. }
  96368. }
  96369. declare module BABYLON {
  96370. /**
  96371. * This represents all the required information to add a fresnel effect on a material:
  96372. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  96373. */
  96374. export class FresnelParameters {
  96375. private _isEnabled;
  96376. /**
  96377. * Define if the fresnel effect is enable or not.
  96378. */
  96379. isEnabled: boolean;
  96380. /**
  96381. * Define the color used on edges (grazing angle)
  96382. */
  96383. leftColor: Color3;
  96384. /**
  96385. * Define the color used on center
  96386. */
  96387. rightColor: Color3;
  96388. /**
  96389. * Define bias applied to computed fresnel term
  96390. */
  96391. bias: number;
  96392. /**
  96393. * Defined the power exponent applied to fresnel term
  96394. */
  96395. power: number;
  96396. /**
  96397. * Clones the current fresnel and its valuues
  96398. * @returns a clone fresnel configuration
  96399. */
  96400. clone(): FresnelParameters;
  96401. /**
  96402. * Serializes the current fresnel parameters to a JSON representation.
  96403. * @return the JSON serialization
  96404. */
  96405. serialize(): any;
  96406. /**
  96407. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  96408. * @param parsedFresnelParameters Define the JSON representation
  96409. * @returns the parsed parameters
  96410. */
  96411. static Parse(parsedFresnelParameters: any): FresnelParameters;
  96412. }
  96413. }
  96414. declare module BABYLON {
  96415. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  96416. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96417. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96418. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96419. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96420. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96421. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96422. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96423. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96424. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96425. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96426. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96427. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96428. /**
  96429. * Decorator used to define property that can be serialized as reference to a camera
  96430. * @param sourceName defines the name of the property to decorate
  96431. */
  96432. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96433. /**
  96434. * Class used to help serialization objects
  96435. */
  96436. export class SerializationHelper {
  96437. /** @hidden */
  96438. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  96439. /** @hidden */
  96440. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  96441. /** @hidden */
  96442. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  96443. /** @hidden */
  96444. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  96445. /**
  96446. * Appends the serialized animations from the source animations
  96447. * @param source Source containing the animations
  96448. * @param destination Target to store the animations
  96449. */
  96450. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  96451. /**
  96452. * Static function used to serialized a specific entity
  96453. * @param entity defines the entity to serialize
  96454. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  96455. * @returns a JSON compatible object representing the serialization of the entity
  96456. */
  96457. static Serialize<T>(entity: T, serializationObject?: any): any;
  96458. /**
  96459. * Creates a new entity from a serialization data object
  96460. * @param creationFunction defines a function used to instanciated the new entity
  96461. * @param source defines the source serialization data
  96462. * @param scene defines the hosting scene
  96463. * @param rootUrl defines the root url for resources
  96464. * @returns a new entity
  96465. */
  96466. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  96467. /**
  96468. * Clones an object
  96469. * @param creationFunction defines the function used to instanciate the new object
  96470. * @param source defines the source object
  96471. * @returns the cloned object
  96472. */
  96473. static Clone<T>(creationFunction: () => T, source: T): T;
  96474. /**
  96475. * Instanciates a new object based on a source one (some data will be shared between both object)
  96476. * @param creationFunction defines the function used to instanciate the new object
  96477. * @param source defines the source object
  96478. * @returns the new object
  96479. */
  96480. static Instanciate<T>(creationFunction: () => T, source: T): T;
  96481. }
  96482. }
  96483. declare module BABYLON {
  96484. /**
  96485. * Class used to manipulate GUIDs
  96486. */
  96487. export class GUID {
  96488. /**
  96489. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  96490. * Be aware Math.random() could cause collisions, but:
  96491. * "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"
  96492. * @returns a pseudo random id
  96493. */
  96494. static RandomId(): string;
  96495. }
  96496. }
  96497. declare module BABYLON {
  96498. /**
  96499. * Base class of all the textures in babylon.
  96500. * It groups all the common properties the materials, post process, lights... might need
  96501. * in order to make a correct use of the texture.
  96502. */
  96503. export class BaseTexture implements IAnimatable {
  96504. /**
  96505. * Default anisotropic filtering level for the application.
  96506. * It is set to 4 as a good tradeoff between perf and quality.
  96507. */
  96508. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  96509. /**
  96510. * Gets or sets the unique id of the texture
  96511. */
  96512. uniqueId: number;
  96513. /**
  96514. * Define the name of the texture.
  96515. */
  96516. name: string;
  96517. /**
  96518. * Gets or sets an object used to store user defined information.
  96519. */
  96520. metadata: any;
  96521. /**
  96522. * For internal use only. Please do not use.
  96523. */
  96524. reservedDataStore: any;
  96525. private _hasAlpha;
  96526. /**
  96527. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  96528. */
  96529. hasAlpha: boolean;
  96530. /**
  96531. * Defines if the alpha value should be determined via the rgb values.
  96532. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  96533. */
  96534. getAlphaFromRGB: boolean;
  96535. /**
  96536. * Intensity or strength of the texture.
  96537. * It is commonly used by materials to fine tune the intensity of the texture
  96538. */
  96539. level: number;
  96540. /**
  96541. * Define the UV chanel to use starting from 0 and defaulting to 0.
  96542. * This is part of the texture as textures usually maps to one uv set.
  96543. */
  96544. coordinatesIndex: number;
  96545. private _coordinatesMode;
  96546. /**
  96547. * How a texture is mapped.
  96548. *
  96549. * | Value | Type | Description |
  96550. * | ----- | ----------------------------------- | ----------- |
  96551. * | 0 | EXPLICIT_MODE | |
  96552. * | 1 | SPHERICAL_MODE | |
  96553. * | 2 | PLANAR_MODE | |
  96554. * | 3 | CUBIC_MODE | |
  96555. * | 4 | PROJECTION_MODE | |
  96556. * | 5 | SKYBOX_MODE | |
  96557. * | 6 | INVCUBIC_MODE | |
  96558. * | 7 | EQUIRECTANGULAR_MODE | |
  96559. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  96560. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  96561. */
  96562. coordinatesMode: number;
  96563. /**
  96564. * | Value | Type | Description |
  96565. * | ----- | ------------------ | ----------- |
  96566. * | 0 | CLAMP_ADDRESSMODE | |
  96567. * | 1 | WRAP_ADDRESSMODE | |
  96568. * | 2 | MIRROR_ADDRESSMODE | |
  96569. */
  96570. wrapU: number;
  96571. /**
  96572. * | Value | Type | Description |
  96573. * | ----- | ------------------ | ----------- |
  96574. * | 0 | CLAMP_ADDRESSMODE | |
  96575. * | 1 | WRAP_ADDRESSMODE | |
  96576. * | 2 | MIRROR_ADDRESSMODE | |
  96577. */
  96578. wrapV: number;
  96579. /**
  96580. * | Value | Type | Description |
  96581. * | ----- | ------------------ | ----------- |
  96582. * | 0 | CLAMP_ADDRESSMODE | |
  96583. * | 1 | WRAP_ADDRESSMODE | |
  96584. * | 2 | MIRROR_ADDRESSMODE | |
  96585. */
  96586. wrapR: number;
  96587. /**
  96588. * With compliant hardware and browser (supporting anisotropic filtering)
  96589. * this defines the level of anisotropic filtering in the texture.
  96590. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  96591. */
  96592. anisotropicFilteringLevel: number;
  96593. /**
  96594. * Define if the texture is a cube texture or if false a 2d texture.
  96595. */
  96596. isCube: boolean;
  96597. /**
  96598. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  96599. */
  96600. is3D: boolean;
  96601. /**
  96602. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  96603. */
  96604. is2DArray: boolean;
  96605. /**
  96606. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  96607. * HDR texture are usually stored in linear space.
  96608. * This only impacts the PBR and Background materials
  96609. */
  96610. gammaSpace: boolean;
  96611. /**
  96612. * Gets or sets whether or not the texture contains RGBD data.
  96613. */
  96614. isRGBD: boolean;
  96615. /**
  96616. * Is Z inverted in the texture (useful in a cube texture).
  96617. */
  96618. invertZ: boolean;
  96619. /**
  96620. * Are mip maps generated for this texture or not.
  96621. */
  96622. readonly noMipmap: boolean;
  96623. /**
  96624. * @hidden
  96625. */
  96626. lodLevelInAlpha: boolean;
  96627. /**
  96628. * With prefiltered texture, defined the offset used during the prefiltering steps.
  96629. */
  96630. lodGenerationOffset: number;
  96631. /**
  96632. * With prefiltered texture, defined the scale used during the prefiltering steps.
  96633. */
  96634. lodGenerationScale: number;
  96635. /**
  96636. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  96637. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  96638. * average roughness values.
  96639. */
  96640. linearSpecularLOD: boolean;
  96641. /**
  96642. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  96643. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  96644. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  96645. */
  96646. irradianceTexture: Nullable<BaseTexture>;
  96647. /**
  96648. * Define if the texture is a render target.
  96649. */
  96650. isRenderTarget: boolean;
  96651. /**
  96652. * Define the unique id of the texture in the scene.
  96653. */
  96654. readonly uid: string;
  96655. /**
  96656. * Return a string representation of the texture.
  96657. * @returns the texture as a string
  96658. */
  96659. toString(): string;
  96660. /**
  96661. * Get the class name of the texture.
  96662. * @returns "BaseTexture"
  96663. */
  96664. getClassName(): string;
  96665. /**
  96666. * Define the list of animation attached to the texture.
  96667. */
  96668. animations: Animation[];
  96669. /**
  96670. * An event triggered when the texture is disposed.
  96671. */
  96672. onDisposeObservable: Observable<BaseTexture>;
  96673. private _onDisposeObserver;
  96674. /**
  96675. * Callback triggered when the texture has been disposed.
  96676. * Kept for back compatibility, you can use the onDisposeObservable instead.
  96677. */
  96678. onDispose: () => void;
  96679. /**
  96680. * Define the current state of the loading sequence when in delayed load mode.
  96681. */
  96682. delayLoadState: number;
  96683. private _scene;
  96684. /** @hidden */
  96685. _texture: Nullable<InternalTexture>;
  96686. private _uid;
  96687. /**
  96688. * Define if the texture is preventinga material to render or not.
  96689. * If not and the texture is not ready, the engine will use a default black texture instead.
  96690. */
  96691. readonly isBlocking: boolean;
  96692. /**
  96693. * Instantiates a new BaseTexture.
  96694. * Base class of all the textures in babylon.
  96695. * It groups all the common properties the materials, post process, lights... might need
  96696. * in order to make a correct use of the texture.
  96697. * @param scene Define the scene the texture blongs to
  96698. */
  96699. constructor(scene: Nullable<Scene>);
  96700. /**
  96701. * Get the scene the texture belongs to.
  96702. * @returns the scene or null if undefined
  96703. */
  96704. getScene(): Nullable<Scene>;
  96705. /**
  96706. * Get the texture transform matrix used to offset tile the texture for istance.
  96707. * @returns the transformation matrix
  96708. */
  96709. getTextureMatrix(): Matrix;
  96710. /**
  96711. * Get the texture reflection matrix used to rotate/transform the reflection.
  96712. * @returns the reflection matrix
  96713. */
  96714. getReflectionTextureMatrix(): Matrix;
  96715. /**
  96716. * Get the underlying lower level texture from Babylon.
  96717. * @returns the insternal texture
  96718. */
  96719. getInternalTexture(): Nullable<InternalTexture>;
  96720. /**
  96721. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  96722. * @returns true if ready or not blocking
  96723. */
  96724. isReadyOrNotBlocking(): boolean;
  96725. /**
  96726. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  96727. * @returns true if fully ready
  96728. */
  96729. isReady(): boolean;
  96730. private _cachedSize;
  96731. /**
  96732. * Get the size of the texture.
  96733. * @returns the texture size.
  96734. */
  96735. getSize(): ISize;
  96736. /**
  96737. * Get the base size of the texture.
  96738. * It can be different from the size if the texture has been resized for POT for instance
  96739. * @returns the base size
  96740. */
  96741. getBaseSize(): ISize;
  96742. /**
  96743. * Update the sampling mode of the texture.
  96744. * Default is Trilinear mode.
  96745. *
  96746. * | Value | Type | Description |
  96747. * | ----- | ------------------ | ----------- |
  96748. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  96749. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  96750. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  96751. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  96752. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  96753. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  96754. * | 7 | NEAREST_LINEAR | |
  96755. * | 8 | NEAREST_NEAREST | |
  96756. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  96757. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  96758. * | 11 | LINEAR_LINEAR | |
  96759. * | 12 | LINEAR_NEAREST | |
  96760. *
  96761. * > _mag_: magnification filter (close to the viewer)
  96762. * > _min_: minification filter (far from the viewer)
  96763. * > _mip_: filter used between mip map levels
  96764. *@param samplingMode Define the new sampling mode of the texture
  96765. */
  96766. updateSamplingMode(samplingMode: number): void;
  96767. /**
  96768. * Scales the texture if is `canRescale()`
  96769. * @param ratio the resize factor we want to use to rescale
  96770. */
  96771. scale(ratio: number): void;
  96772. /**
  96773. * Get if the texture can rescale.
  96774. */
  96775. readonly canRescale: boolean;
  96776. /** @hidden */
  96777. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  96778. /** @hidden */
  96779. _rebuild(): void;
  96780. /**
  96781. * Triggers the load sequence in delayed load mode.
  96782. */
  96783. delayLoad(): void;
  96784. /**
  96785. * Clones the texture.
  96786. * @returns the cloned texture
  96787. */
  96788. clone(): Nullable<BaseTexture>;
  96789. /**
  96790. * Get the texture underlying type (INT, FLOAT...)
  96791. */
  96792. readonly textureType: number;
  96793. /**
  96794. * Get the texture underlying format (RGB, RGBA...)
  96795. */
  96796. readonly textureFormat: number;
  96797. /**
  96798. * Indicates that textures need to be re-calculated for all materials
  96799. */
  96800. protected _markAllSubMeshesAsTexturesDirty(): void;
  96801. /**
  96802. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  96803. * This will returns an RGBA array buffer containing either in values (0-255) or
  96804. * float values (0-1) depending of the underlying buffer type.
  96805. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  96806. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  96807. * @param buffer defines a user defined buffer to fill with data (can be null)
  96808. * @returns The Array buffer containing the pixels data.
  96809. */
  96810. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  96811. /**
  96812. * Release and destroy the underlying lower level texture aka internalTexture.
  96813. */
  96814. releaseInternalTexture(): void;
  96815. /** @hidden */
  96816. readonly _lodTextureHigh: Nullable<BaseTexture>;
  96817. /** @hidden */
  96818. readonly _lodTextureMid: Nullable<BaseTexture>;
  96819. /** @hidden */
  96820. readonly _lodTextureLow: Nullable<BaseTexture>;
  96821. /**
  96822. * Dispose the texture and release its associated resources.
  96823. */
  96824. dispose(): void;
  96825. /**
  96826. * Serialize the texture into a JSON representation that can be parsed later on.
  96827. * @returns the JSON representation of the texture
  96828. */
  96829. serialize(): any;
  96830. /**
  96831. * Helper function to be called back once a list of texture contains only ready textures.
  96832. * @param textures Define the list of textures to wait for
  96833. * @param callback Define the callback triggered once the entire list will be ready
  96834. */
  96835. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  96836. }
  96837. }
  96838. declare module BABYLON {
  96839. /**
  96840. * Options to be used when creating an effect.
  96841. */
  96842. export interface IEffectCreationOptions {
  96843. /**
  96844. * Atrributes that will be used in the shader.
  96845. */
  96846. attributes: string[];
  96847. /**
  96848. * Uniform varible names that will be set in the shader.
  96849. */
  96850. uniformsNames: string[];
  96851. /**
  96852. * Uniform buffer variable names that will be set in the shader.
  96853. */
  96854. uniformBuffersNames: string[];
  96855. /**
  96856. * Sampler texture variable names that will be set in the shader.
  96857. */
  96858. samplers: string[];
  96859. /**
  96860. * Define statements that will be set in the shader.
  96861. */
  96862. defines: any;
  96863. /**
  96864. * Possible fallbacks for this effect to improve performance when needed.
  96865. */
  96866. fallbacks: Nullable<IEffectFallbacks>;
  96867. /**
  96868. * Callback that will be called when the shader is compiled.
  96869. */
  96870. onCompiled: Nullable<(effect: Effect) => void>;
  96871. /**
  96872. * Callback that will be called if an error occurs during shader compilation.
  96873. */
  96874. onError: Nullable<(effect: Effect, errors: string) => void>;
  96875. /**
  96876. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96877. */
  96878. indexParameters?: any;
  96879. /**
  96880. * Max number of lights that can be used in the shader.
  96881. */
  96882. maxSimultaneousLights?: number;
  96883. /**
  96884. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  96885. */
  96886. transformFeedbackVaryings?: Nullable<string[]>;
  96887. }
  96888. /**
  96889. * Effect containing vertex and fragment shader that can be executed on an object.
  96890. */
  96891. export class Effect implements IDisposable {
  96892. /**
  96893. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  96894. */
  96895. static ShadersRepository: string;
  96896. /**
  96897. * Name of the effect.
  96898. */
  96899. name: any;
  96900. /**
  96901. * String container all the define statements that should be set on the shader.
  96902. */
  96903. defines: string;
  96904. /**
  96905. * Callback that will be called when the shader is compiled.
  96906. */
  96907. onCompiled: Nullable<(effect: Effect) => void>;
  96908. /**
  96909. * Callback that will be called if an error occurs during shader compilation.
  96910. */
  96911. onError: Nullable<(effect: Effect, errors: string) => void>;
  96912. /**
  96913. * Callback that will be called when effect is bound.
  96914. */
  96915. onBind: Nullable<(effect: Effect) => void>;
  96916. /**
  96917. * Unique ID of the effect.
  96918. */
  96919. uniqueId: number;
  96920. /**
  96921. * Observable that will be called when the shader is compiled.
  96922. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  96923. */
  96924. onCompileObservable: Observable<Effect>;
  96925. /**
  96926. * Observable that will be called if an error occurs during shader compilation.
  96927. */
  96928. onErrorObservable: Observable<Effect>;
  96929. /** @hidden */
  96930. _onBindObservable: Nullable<Observable<Effect>>;
  96931. /**
  96932. * Observable that will be called when effect is bound.
  96933. */
  96934. readonly onBindObservable: Observable<Effect>;
  96935. /** @hidden */
  96936. _bonesComputationForcedToCPU: boolean;
  96937. private static _uniqueIdSeed;
  96938. private _engine;
  96939. private _uniformBuffersNames;
  96940. private _uniformsNames;
  96941. private _samplerList;
  96942. private _samplers;
  96943. private _isReady;
  96944. private _compilationError;
  96945. private _allFallbacksProcessed;
  96946. private _attributesNames;
  96947. private _attributes;
  96948. private _uniforms;
  96949. /**
  96950. * Key for the effect.
  96951. * @hidden
  96952. */
  96953. _key: string;
  96954. private _indexParameters;
  96955. private _fallbacks;
  96956. private _vertexSourceCode;
  96957. private _fragmentSourceCode;
  96958. private _vertexSourceCodeOverride;
  96959. private _fragmentSourceCodeOverride;
  96960. private _transformFeedbackVaryings;
  96961. /**
  96962. * Compiled shader to webGL program.
  96963. * @hidden
  96964. */
  96965. _pipelineContext: Nullable<IPipelineContext>;
  96966. private _valueCache;
  96967. private static _baseCache;
  96968. /**
  96969. * Instantiates an effect.
  96970. * An effect can be used to create/manage/execute vertex and fragment shaders.
  96971. * @param baseName Name of the effect.
  96972. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  96973. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  96974. * @param samplers List of sampler variables that will be passed to the shader.
  96975. * @param engine Engine to be used to render the effect
  96976. * @param defines Define statements to be added to the shader.
  96977. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  96978. * @param onCompiled Callback that will be called when the shader is compiled.
  96979. * @param onError Callback that will be called if an error occurs during shader compilation.
  96980. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96981. */
  96982. constructor(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: Nullable<string[]>, engine?: ThinEngine, defines?: Nullable<string>, fallbacks?: Nullable<IEffectFallbacks>, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any);
  96983. private _useFinalCode;
  96984. /**
  96985. * Unique key for this effect
  96986. */
  96987. readonly key: string;
  96988. /**
  96989. * If the effect has been compiled and prepared.
  96990. * @returns if the effect is compiled and prepared.
  96991. */
  96992. isReady(): boolean;
  96993. private _isReadyInternal;
  96994. /**
  96995. * The engine the effect was initialized with.
  96996. * @returns the engine.
  96997. */
  96998. getEngine(): Engine;
  96999. /**
  97000. * The pipeline context for this effect
  97001. * @returns the associated pipeline context
  97002. */
  97003. getPipelineContext(): Nullable<IPipelineContext>;
  97004. /**
  97005. * The set of names of attribute variables for the shader.
  97006. * @returns An array of attribute names.
  97007. */
  97008. getAttributesNames(): string[];
  97009. /**
  97010. * Returns the attribute at the given index.
  97011. * @param index The index of the attribute.
  97012. * @returns The location of the attribute.
  97013. */
  97014. getAttributeLocation(index: number): number;
  97015. /**
  97016. * Returns the attribute based on the name of the variable.
  97017. * @param name of the attribute to look up.
  97018. * @returns the attribute location.
  97019. */
  97020. getAttributeLocationByName(name: string): number;
  97021. /**
  97022. * The number of attributes.
  97023. * @returns the numnber of attributes.
  97024. */
  97025. getAttributesCount(): number;
  97026. /**
  97027. * Gets the index of a uniform variable.
  97028. * @param uniformName of the uniform to look up.
  97029. * @returns the index.
  97030. */
  97031. getUniformIndex(uniformName: string): number;
  97032. /**
  97033. * Returns the attribute based on the name of the variable.
  97034. * @param uniformName of the uniform to look up.
  97035. * @returns the location of the uniform.
  97036. */
  97037. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  97038. /**
  97039. * Returns an array of sampler variable names
  97040. * @returns The array of sampler variable neames.
  97041. */
  97042. getSamplers(): string[];
  97043. /**
  97044. * The error from the last compilation.
  97045. * @returns the error string.
  97046. */
  97047. getCompilationError(): string;
  97048. /**
  97049. * Gets a boolean indicating that all fallbacks were used during compilation
  97050. * @returns true if all fallbacks were used
  97051. */
  97052. allFallbacksProcessed(): boolean;
  97053. /**
  97054. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  97055. * @param func The callback to be used.
  97056. */
  97057. executeWhenCompiled(func: (effect: Effect) => void): void;
  97058. private _checkIsReady;
  97059. private _loadShader;
  97060. /**
  97061. * Recompiles the webGL program
  97062. * @param vertexSourceCode The source code for the vertex shader.
  97063. * @param fragmentSourceCode The source code for the fragment shader.
  97064. * @param onCompiled Callback called when completed.
  97065. * @param onError Callback called on error.
  97066. * @hidden
  97067. */
  97068. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  97069. /**
  97070. * Prepares the effect
  97071. * @hidden
  97072. */
  97073. _prepareEffect(): void;
  97074. private _processCompilationErrors;
  97075. /**
  97076. * Checks if the effect is supported. (Must be called after compilation)
  97077. */
  97078. readonly isSupported: boolean;
  97079. /**
  97080. * Binds a texture to the engine to be used as output of the shader.
  97081. * @param channel Name of the output variable.
  97082. * @param texture Texture to bind.
  97083. * @hidden
  97084. */
  97085. _bindTexture(channel: string, texture: InternalTexture): void;
  97086. /**
  97087. * Sets a texture on the engine to be used in the shader.
  97088. * @param channel Name of the sampler variable.
  97089. * @param texture Texture to set.
  97090. */
  97091. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  97092. /**
  97093. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  97094. * @param channel Name of the sampler variable.
  97095. * @param texture Texture to set.
  97096. */
  97097. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  97098. /**
  97099. * Sets an array of textures on the engine to be used in the shader.
  97100. * @param channel Name of the variable.
  97101. * @param textures Textures to set.
  97102. */
  97103. setTextureArray(channel: string, textures: BaseTexture[]): void;
  97104. /**
  97105. * 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)
  97106. * @param channel Name of the sampler variable.
  97107. * @param postProcess Post process to get the input texture from.
  97108. */
  97109. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  97110. /**
  97111. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  97112. * 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)
  97113. * @param channel Name of the sampler variable.
  97114. * @param postProcess Post process to get the output texture from.
  97115. */
  97116. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  97117. /** @hidden */
  97118. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  97119. /** @hidden */
  97120. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  97121. /** @hidden */
  97122. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  97123. /** @hidden */
  97124. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  97125. /**
  97126. * Binds a buffer to a uniform.
  97127. * @param buffer Buffer to bind.
  97128. * @param name Name of the uniform variable to bind to.
  97129. */
  97130. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  97131. /**
  97132. * Binds block to a uniform.
  97133. * @param blockName Name of the block to bind.
  97134. * @param index Index to bind.
  97135. */
  97136. bindUniformBlock(blockName: string, index: number): void;
  97137. /**
  97138. * Sets an interger value on a uniform variable.
  97139. * @param uniformName Name of the variable.
  97140. * @param value Value to be set.
  97141. * @returns this effect.
  97142. */
  97143. setInt(uniformName: string, value: number): Effect;
  97144. /**
  97145. * Sets an int array on a uniform variable.
  97146. * @param uniformName Name of the variable.
  97147. * @param array array to be set.
  97148. * @returns this effect.
  97149. */
  97150. setIntArray(uniformName: string, array: Int32Array): Effect;
  97151. /**
  97152. * 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)
  97153. * @param uniformName Name of the variable.
  97154. * @param array array to be set.
  97155. * @returns this effect.
  97156. */
  97157. setIntArray2(uniformName: string, array: Int32Array): Effect;
  97158. /**
  97159. * 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)
  97160. * @param uniformName Name of the variable.
  97161. * @param array array to be set.
  97162. * @returns this effect.
  97163. */
  97164. setIntArray3(uniformName: string, array: Int32Array): Effect;
  97165. /**
  97166. * 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)
  97167. * @param uniformName Name of the variable.
  97168. * @param array array to be set.
  97169. * @returns this effect.
  97170. */
  97171. setIntArray4(uniformName: string, array: Int32Array): Effect;
  97172. /**
  97173. * Sets an float array on a uniform variable.
  97174. * @param uniformName Name of the variable.
  97175. * @param array array to be set.
  97176. * @returns this effect.
  97177. */
  97178. setFloatArray(uniformName: string, array: Float32Array): Effect;
  97179. /**
  97180. * 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)
  97181. * @param uniformName Name of the variable.
  97182. * @param array array to be set.
  97183. * @returns this effect.
  97184. */
  97185. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  97186. /**
  97187. * 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)
  97188. * @param uniformName Name of the variable.
  97189. * @param array array to be set.
  97190. * @returns this effect.
  97191. */
  97192. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  97193. /**
  97194. * 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)
  97195. * @param uniformName Name of the variable.
  97196. * @param array array to be set.
  97197. * @returns this effect.
  97198. */
  97199. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  97200. /**
  97201. * Sets an array on a uniform variable.
  97202. * @param uniformName Name of the variable.
  97203. * @param array array to be set.
  97204. * @returns this effect.
  97205. */
  97206. setArray(uniformName: string, array: number[]): Effect;
  97207. /**
  97208. * 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)
  97209. * @param uniformName Name of the variable.
  97210. * @param array array to be set.
  97211. * @returns this effect.
  97212. */
  97213. setArray2(uniformName: string, array: number[]): Effect;
  97214. /**
  97215. * 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)
  97216. * @param uniformName Name of the variable.
  97217. * @param array array to be set.
  97218. * @returns this effect.
  97219. */
  97220. setArray3(uniformName: string, array: number[]): Effect;
  97221. /**
  97222. * 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)
  97223. * @param uniformName Name of the variable.
  97224. * @param array array to be set.
  97225. * @returns this effect.
  97226. */
  97227. setArray4(uniformName: string, array: number[]): Effect;
  97228. /**
  97229. * Sets matrices on a uniform variable.
  97230. * @param uniformName Name of the variable.
  97231. * @param matrices matrices to be set.
  97232. * @returns this effect.
  97233. */
  97234. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  97235. /**
  97236. * Sets matrix on a uniform variable.
  97237. * @param uniformName Name of the variable.
  97238. * @param matrix matrix to be set.
  97239. * @returns this effect.
  97240. */
  97241. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  97242. /**
  97243. * 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)
  97244. * @param uniformName Name of the variable.
  97245. * @param matrix matrix to be set.
  97246. * @returns this effect.
  97247. */
  97248. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  97249. /**
  97250. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  97251. * @param uniformName Name of the variable.
  97252. * @param matrix matrix to be set.
  97253. * @returns this effect.
  97254. */
  97255. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  97256. /**
  97257. * Sets a float on a uniform variable.
  97258. * @param uniformName Name of the variable.
  97259. * @param value value to be set.
  97260. * @returns this effect.
  97261. */
  97262. setFloat(uniformName: string, value: number): Effect;
  97263. /**
  97264. * Sets a boolean on a uniform variable.
  97265. * @param uniformName Name of the variable.
  97266. * @param bool value to be set.
  97267. * @returns this effect.
  97268. */
  97269. setBool(uniformName: string, bool: boolean): Effect;
  97270. /**
  97271. * Sets a Vector2 on a uniform variable.
  97272. * @param uniformName Name of the variable.
  97273. * @param vector2 vector2 to be set.
  97274. * @returns this effect.
  97275. */
  97276. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  97277. /**
  97278. * Sets a float2 on a uniform variable.
  97279. * @param uniformName Name of the variable.
  97280. * @param x First float in float2.
  97281. * @param y Second float in float2.
  97282. * @returns this effect.
  97283. */
  97284. setFloat2(uniformName: string, x: number, y: number): Effect;
  97285. /**
  97286. * Sets a Vector3 on a uniform variable.
  97287. * @param uniformName Name of the variable.
  97288. * @param vector3 Value to be set.
  97289. * @returns this effect.
  97290. */
  97291. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  97292. /**
  97293. * Sets a float3 on a uniform variable.
  97294. * @param uniformName Name of the variable.
  97295. * @param x First float in float3.
  97296. * @param y Second float in float3.
  97297. * @param z Third float in float3.
  97298. * @returns this effect.
  97299. */
  97300. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  97301. /**
  97302. * Sets a Vector4 on a uniform variable.
  97303. * @param uniformName Name of the variable.
  97304. * @param vector4 Value to be set.
  97305. * @returns this effect.
  97306. */
  97307. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  97308. /**
  97309. * Sets a float4 on a uniform variable.
  97310. * @param uniformName Name of the variable.
  97311. * @param x First float in float4.
  97312. * @param y Second float in float4.
  97313. * @param z Third float in float4.
  97314. * @param w Fourth float in float4.
  97315. * @returns this effect.
  97316. */
  97317. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  97318. /**
  97319. * Sets a Color3 on a uniform variable.
  97320. * @param uniformName Name of the variable.
  97321. * @param color3 Value to be set.
  97322. * @returns this effect.
  97323. */
  97324. setColor3(uniformName: string, color3: IColor3Like): Effect;
  97325. /**
  97326. * Sets a Color4 on a uniform variable.
  97327. * @param uniformName Name of the variable.
  97328. * @param color3 Value to be set.
  97329. * @param alpha Alpha value to be set.
  97330. * @returns this effect.
  97331. */
  97332. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  97333. /**
  97334. * Sets a Color4 on a uniform variable
  97335. * @param uniformName defines the name of the variable
  97336. * @param color4 defines the value to be set
  97337. * @returns this effect.
  97338. */
  97339. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  97340. /** Release all associated resources */
  97341. dispose(): void;
  97342. /**
  97343. * This function will add a new shader to the shader store
  97344. * @param name the name of the shader
  97345. * @param pixelShader optional pixel shader content
  97346. * @param vertexShader optional vertex shader content
  97347. */
  97348. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  97349. /**
  97350. * Store of each shader (The can be looked up using effect.key)
  97351. */
  97352. static ShadersStore: {
  97353. [key: string]: string;
  97354. };
  97355. /**
  97356. * Store of each included file for a shader (The can be looked up using effect.key)
  97357. */
  97358. static IncludesShadersStore: {
  97359. [key: string]: string;
  97360. };
  97361. /**
  97362. * Resets the cache of effects.
  97363. */
  97364. static ResetCache(): void;
  97365. }
  97366. }
  97367. declare module BABYLON {
  97368. /**
  97369. * Interface used to describe the capabilities of the engine relatively to the current browser
  97370. */
  97371. export interface EngineCapabilities {
  97372. /** Maximum textures units per fragment shader */
  97373. maxTexturesImageUnits: number;
  97374. /** Maximum texture units per vertex shader */
  97375. maxVertexTextureImageUnits: number;
  97376. /** Maximum textures units in the entire pipeline */
  97377. maxCombinedTexturesImageUnits: number;
  97378. /** Maximum texture size */
  97379. maxTextureSize: number;
  97380. /** Maximum texture samples */
  97381. maxSamples?: number;
  97382. /** Maximum cube texture size */
  97383. maxCubemapTextureSize: number;
  97384. /** Maximum render texture size */
  97385. maxRenderTextureSize: number;
  97386. /** Maximum number of vertex attributes */
  97387. maxVertexAttribs: number;
  97388. /** Maximum number of varyings */
  97389. maxVaryingVectors: number;
  97390. /** Maximum number of uniforms per vertex shader */
  97391. maxVertexUniformVectors: number;
  97392. /** Maximum number of uniforms per fragment shader */
  97393. maxFragmentUniformVectors: number;
  97394. /** Defines if standard derivates (dx/dy) are supported */
  97395. standardDerivatives: boolean;
  97396. /** Defines if s3tc texture compression is supported */
  97397. s3tc?: WEBGL_compressed_texture_s3tc;
  97398. /** Defines if pvrtc texture compression is supported */
  97399. pvrtc: any;
  97400. /** Defines if etc1 texture compression is supported */
  97401. etc1: any;
  97402. /** Defines if etc2 texture compression is supported */
  97403. etc2: any;
  97404. /** Defines if astc texture compression is supported */
  97405. astc: any;
  97406. /** Defines if float textures are supported */
  97407. textureFloat: boolean;
  97408. /** Defines if vertex array objects are supported */
  97409. vertexArrayObject: boolean;
  97410. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  97411. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  97412. /** Gets the maximum level of anisotropy supported */
  97413. maxAnisotropy: number;
  97414. /** Defines if instancing is supported */
  97415. instancedArrays: boolean;
  97416. /** Defines if 32 bits indices are supported */
  97417. uintIndices: boolean;
  97418. /** Defines if high precision shaders are supported */
  97419. highPrecisionShaderSupported: boolean;
  97420. /** Defines if depth reading in the fragment shader is supported */
  97421. fragmentDepthSupported: boolean;
  97422. /** Defines if float texture linear filtering is supported*/
  97423. textureFloatLinearFiltering: boolean;
  97424. /** Defines if rendering to float textures is supported */
  97425. textureFloatRender: boolean;
  97426. /** Defines if half float textures are supported*/
  97427. textureHalfFloat: boolean;
  97428. /** Defines if half float texture linear filtering is supported*/
  97429. textureHalfFloatLinearFiltering: boolean;
  97430. /** Defines if rendering to half float textures is supported */
  97431. textureHalfFloatRender: boolean;
  97432. /** Defines if textureLOD shader command is supported */
  97433. textureLOD: boolean;
  97434. /** Defines if draw buffers extension is supported */
  97435. drawBuffersExtension: boolean;
  97436. /** Defines if depth textures are supported */
  97437. depthTextureExtension: boolean;
  97438. /** Defines if float color buffer are supported */
  97439. colorBufferFloat: boolean;
  97440. /** Gets disjoint timer query extension (null if not supported) */
  97441. timerQuery?: EXT_disjoint_timer_query;
  97442. /** Defines if timestamp can be used with timer query */
  97443. canUseTimestampForTimerQuery: boolean;
  97444. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  97445. multiview?: any;
  97446. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  97447. oculusMultiview?: any;
  97448. /** Function used to let the system compiles shaders in background */
  97449. parallelShaderCompile?: {
  97450. COMPLETION_STATUS_KHR: number;
  97451. };
  97452. /** Max number of texture samples for MSAA */
  97453. maxMSAASamples: number;
  97454. /** Defines if the blend min max extension is supported */
  97455. blendMinMax: boolean;
  97456. }
  97457. }
  97458. declare module BABYLON {
  97459. /**
  97460. * @hidden
  97461. **/
  97462. export class DepthCullingState {
  97463. private _isDepthTestDirty;
  97464. private _isDepthMaskDirty;
  97465. private _isDepthFuncDirty;
  97466. private _isCullFaceDirty;
  97467. private _isCullDirty;
  97468. private _isZOffsetDirty;
  97469. private _isFrontFaceDirty;
  97470. private _depthTest;
  97471. private _depthMask;
  97472. private _depthFunc;
  97473. private _cull;
  97474. private _cullFace;
  97475. private _zOffset;
  97476. private _frontFace;
  97477. /**
  97478. * Initializes the state.
  97479. */
  97480. constructor();
  97481. readonly isDirty: boolean;
  97482. zOffset: number;
  97483. cullFace: Nullable<number>;
  97484. cull: Nullable<boolean>;
  97485. depthFunc: Nullable<number>;
  97486. depthMask: boolean;
  97487. depthTest: boolean;
  97488. frontFace: Nullable<number>;
  97489. reset(): void;
  97490. apply(gl: WebGLRenderingContext): void;
  97491. }
  97492. }
  97493. declare module BABYLON {
  97494. /**
  97495. * @hidden
  97496. **/
  97497. export class StencilState {
  97498. /** 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 */
  97499. static readonly ALWAYS: number;
  97500. /** Passed to stencilOperation to specify that stencil value must be kept */
  97501. static readonly KEEP: number;
  97502. /** Passed to stencilOperation to specify that stencil value must be replaced */
  97503. static readonly REPLACE: number;
  97504. private _isStencilTestDirty;
  97505. private _isStencilMaskDirty;
  97506. private _isStencilFuncDirty;
  97507. private _isStencilOpDirty;
  97508. private _stencilTest;
  97509. private _stencilMask;
  97510. private _stencilFunc;
  97511. private _stencilFuncRef;
  97512. private _stencilFuncMask;
  97513. private _stencilOpStencilFail;
  97514. private _stencilOpDepthFail;
  97515. private _stencilOpStencilDepthPass;
  97516. readonly isDirty: boolean;
  97517. stencilFunc: number;
  97518. stencilFuncRef: number;
  97519. stencilFuncMask: number;
  97520. stencilOpStencilFail: number;
  97521. stencilOpDepthFail: number;
  97522. stencilOpStencilDepthPass: number;
  97523. stencilMask: number;
  97524. stencilTest: boolean;
  97525. constructor();
  97526. reset(): void;
  97527. apply(gl: WebGLRenderingContext): void;
  97528. }
  97529. }
  97530. declare module BABYLON {
  97531. /**
  97532. * @hidden
  97533. **/
  97534. export class AlphaState {
  97535. private _isAlphaBlendDirty;
  97536. private _isBlendFunctionParametersDirty;
  97537. private _isBlendEquationParametersDirty;
  97538. private _isBlendConstantsDirty;
  97539. private _alphaBlend;
  97540. private _blendFunctionParameters;
  97541. private _blendEquationParameters;
  97542. private _blendConstants;
  97543. /**
  97544. * Initializes the state.
  97545. */
  97546. constructor();
  97547. readonly isDirty: boolean;
  97548. alphaBlend: boolean;
  97549. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  97550. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  97551. setAlphaEquationParameters(rgb: number, alpha: number): void;
  97552. reset(): void;
  97553. apply(gl: WebGLRenderingContext): void;
  97554. }
  97555. }
  97556. declare module BABYLON {
  97557. /** @hidden */
  97558. export class WebGL2ShaderProcessor implements IShaderProcessor {
  97559. attributeProcessor(attribute: string): string;
  97560. varyingProcessor(varying: string, isFragment: boolean): string;
  97561. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  97562. }
  97563. }
  97564. declare module BABYLON {
  97565. /**
  97566. * Interface for attribute information associated with buffer instanciation
  97567. */
  97568. export interface InstancingAttributeInfo {
  97569. /**
  97570. * Index/offset of the attribute in the vertex shader
  97571. */
  97572. index: number;
  97573. /**
  97574. * size of the attribute, 1, 2, 3 or 4
  97575. */
  97576. attributeSize: number;
  97577. /**
  97578. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  97579. * default is FLOAT
  97580. */
  97581. attributeType: number;
  97582. /**
  97583. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  97584. */
  97585. normalized: boolean;
  97586. /**
  97587. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  97588. */
  97589. offset: number;
  97590. /**
  97591. * Name of the GLSL attribute, for debugging purpose only
  97592. */
  97593. attributeName: string;
  97594. }
  97595. }
  97596. declare module BABYLON {
  97597. interface ThinEngine {
  97598. /**
  97599. * Update a video texture
  97600. * @param texture defines the texture to update
  97601. * @param video defines the video element to use
  97602. * @param invertY defines if data must be stored with Y axis inverted
  97603. */
  97604. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  97605. }
  97606. }
  97607. declare module BABYLON {
  97608. /**
  97609. * Settings for finer control over video usage
  97610. */
  97611. export interface VideoTextureSettings {
  97612. /**
  97613. * Applies `autoplay` to video, if specified
  97614. */
  97615. autoPlay?: boolean;
  97616. /**
  97617. * Applies `loop` to video, if specified
  97618. */
  97619. loop?: boolean;
  97620. /**
  97621. * Automatically updates internal texture from video at every frame in the render loop
  97622. */
  97623. autoUpdateTexture: boolean;
  97624. /**
  97625. * Image src displayed during the video loading or until the user interacts with the video.
  97626. */
  97627. poster?: string;
  97628. }
  97629. /**
  97630. * If you want to display a video in your scene, this is the special texture for that.
  97631. * This special texture works similar to other textures, with the exception of a few parameters.
  97632. * @see https://doc.babylonjs.com/how_to/video_texture
  97633. */
  97634. export class VideoTexture extends Texture {
  97635. /**
  97636. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  97637. */
  97638. readonly autoUpdateTexture: boolean;
  97639. /**
  97640. * The video instance used by the texture internally
  97641. */
  97642. readonly video: HTMLVideoElement;
  97643. private _onUserActionRequestedObservable;
  97644. /**
  97645. * Event triggerd when a dom action is required by the user to play the video.
  97646. * This happens due to recent changes in browser policies preventing video to auto start.
  97647. */
  97648. readonly onUserActionRequestedObservable: Observable<Texture>;
  97649. private _generateMipMaps;
  97650. private _engine;
  97651. private _stillImageCaptured;
  97652. private _displayingPosterTexture;
  97653. private _settings;
  97654. private _createInternalTextureOnEvent;
  97655. private _frameId;
  97656. /**
  97657. * Creates a video texture.
  97658. * If you want to display a video in your scene, this is the special texture for that.
  97659. * This special texture works similar to other textures, with the exception of a few parameters.
  97660. * @see https://doc.babylonjs.com/how_to/video_texture
  97661. * @param name optional name, will detect from video source, if not defined
  97662. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  97663. * @param scene is obviously the current scene.
  97664. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  97665. * @param invertY is false by default but can be used to invert video on Y axis
  97666. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  97667. * @param settings allows finer control over video usage
  97668. */
  97669. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  97670. private _getName;
  97671. private _getVideo;
  97672. private _createInternalTexture;
  97673. private reset;
  97674. /**
  97675. * @hidden Internal method to initiate `update`.
  97676. */
  97677. _rebuild(): void;
  97678. /**
  97679. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  97680. */
  97681. update(): void;
  97682. /**
  97683. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  97684. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  97685. */
  97686. updateTexture(isVisible: boolean): void;
  97687. protected _updateInternalTexture: () => void;
  97688. /**
  97689. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  97690. * @param url New url.
  97691. */
  97692. updateURL(url: string): void;
  97693. /**
  97694. * Dispose the texture and release its associated resources.
  97695. */
  97696. dispose(): void;
  97697. /**
  97698. * Creates a video texture straight from a stream.
  97699. * @param scene Define the scene the texture should be created in
  97700. * @param stream Define the stream the texture should be created from
  97701. * @returns The created video texture as a promise
  97702. */
  97703. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  97704. /**
  97705. * Creates a video texture straight from your WebCam video feed.
  97706. * @param scene Define the scene the texture should be created in
  97707. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  97708. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  97709. * @returns The created video texture as a promise
  97710. */
  97711. static CreateFromWebCamAsync(scene: Scene, constraints: {
  97712. minWidth: number;
  97713. maxWidth: number;
  97714. minHeight: number;
  97715. maxHeight: number;
  97716. deviceId: string;
  97717. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  97718. /**
  97719. * Creates a video texture straight from your WebCam video feed.
  97720. * @param scene Define the scene the texture should be created in
  97721. * @param onReady Define a callback to triggered once the texture will be ready
  97722. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  97723. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  97724. */
  97725. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  97726. minWidth: number;
  97727. maxWidth: number;
  97728. minHeight: number;
  97729. maxHeight: number;
  97730. deviceId: string;
  97731. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  97732. }
  97733. }
  97734. declare module BABYLON {
  97735. /**
  97736. * Defines the interface used by objects working like Scene
  97737. * @hidden
  97738. */
  97739. interface ISceneLike {
  97740. _addPendingData(data: any): void;
  97741. _removePendingData(data: any): void;
  97742. offlineProvider: IOfflineProvider;
  97743. }
  97744. /** Interface defining initialization parameters for Engine class */
  97745. export interface EngineOptions extends WebGLContextAttributes {
  97746. /**
  97747. * Defines if the engine should no exceed a specified device ratio
  97748. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  97749. */
  97750. limitDeviceRatio?: number;
  97751. /**
  97752. * Defines if webvr should be enabled automatically
  97753. * @see http://doc.babylonjs.com/how_to/webvr_camera
  97754. */
  97755. autoEnableWebVR?: boolean;
  97756. /**
  97757. * Defines if webgl2 should be turned off even if supported
  97758. * @see http://doc.babylonjs.com/features/webgl2
  97759. */
  97760. disableWebGL2Support?: boolean;
  97761. /**
  97762. * Defines if webaudio should be initialized as well
  97763. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  97764. */
  97765. audioEngine?: boolean;
  97766. /**
  97767. * Defines if animations should run using a deterministic lock step
  97768. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  97769. */
  97770. deterministicLockstep?: boolean;
  97771. /** Defines the maximum steps to use with deterministic lock step mode */
  97772. lockstepMaxSteps?: number;
  97773. /**
  97774. * Defines that engine should ignore context lost events
  97775. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  97776. */
  97777. doNotHandleContextLost?: boolean;
  97778. /**
  97779. * Defines that engine should ignore modifying touch action attribute and style
  97780. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  97781. */
  97782. doNotHandleTouchAction?: boolean;
  97783. /**
  97784. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  97785. */
  97786. useHighPrecisionFloats?: boolean;
  97787. }
  97788. /**
  97789. * The base engine class (root of all engines)
  97790. */
  97791. export class ThinEngine {
  97792. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  97793. static ExceptionList: ({
  97794. key: string;
  97795. capture: string;
  97796. captureConstraint: number;
  97797. targets: string[];
  97798. } | {
  97799. key: string;
  97800. capture: null;
  97801. captureConstraint: null;
  97802. targets: string[];
  97803. })[];
  97804. /** @hidden */
  97805. static _TextureLoaders: IInternalTextureLoader[];
  97806. /**
  97807. * Returns the current npm package of the sdk
  97808. */
  97809. static readonly NpmPackage: string;
  97810. /**
  97811. * Returns the current version of the framework
  97812. */
  97813. static readonly Version: string;
  97814. /**
  97815. * Returns a string describing the current engine
  97816. */
  97817. readonly description: string;
  97818. /**
  97819. * Gets or sets the epsilon value used by collision engine
  97820. */
  97821. static CollisionsEpsilon: number;
  97822. /**
  97823. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  97824. */
  97825. static ShadersRepository: string;
  97826. /** @hidden */
  97827. _shaderProcessor: IShaderProcessor;
  97828. /**
  97829. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  97830. */
  97831. forcePOTTextures: boolean;
  97832. /**
  97833. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  97834. */
  97835. isFullscreen: boolean;
  97836. /**
  97837. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  97838. */
  97839. cullBackFaces: boolean;
  97840. /**
  97841. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  97842. */
  97843. renderEvenInBackground: boolean;
  97844. /**
  97845. * Gets or sets a boolean indicating that cache can be kept between frames
  97846. */
  97847. preventCacheWipeBetweenFrames: boolean;
  97848. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  97849. validateShaderPrograms: boolean;
  97850. /**
  97851. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  97852. * This can provide greater z depth for distant objects.
  97853. */
  97854. useReverseDepthBuffer: boolean;
  97855. /**
  97856. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  97857. */
  97858. disableUniformBuffers: boolean;
  97859. /** @hidden */
  97860. _uniformBuffers: UniformBuffer[];
  97861. /**
  97862. * Gets a boolean indicating that the engine supports uniform buffers
  97863. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  97864. */
  97865. readonly supportsUniformBuffers: boolean;
  97866. /** @hidden */
  97867. _gl: WebGLRenderingContext;
  97868. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  97869. protected _windowIsBackground: boolean;
  97870. protected _webGLVersion: number;
  97871. protected _creationOptions: EngineOptions;
  97872. protected _highPrecisionShadersAllowed: boolean;
  97873. /** @hidden */
  97874. readonly _shouldUseHighPrecisionShader: boolean;
  97875. /**
  97876. * Gets a boolean indicating that only power of 2 textures are supported
  97877. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  97878. */
  97879. readonly needPOTTextures: boolean;
  97880. /** @hidden */
  97881. _badOS: boolean;
  97882. /** @hidden */
  97883. _badDesktopOS: boolean;
  97884. private _hardwareScalingLevel;
  97885. /** @hidden */
  97886. _caps: EngineCapabilities;
  97887. private _isStencilEnable;
  97888. protected _colorWrite: boolean;
  97889. private _glVersion;
  97890. private _glRenderer;
  97891. private _glVendor;
  97892. /** @hidden */
  97893. _videoTextureSupported: boolean;
  97894. protected _renderingQueueLaunched: boolean;
  97895. protected _activeRenderLoops: (() => void)[];
  97896. /**
  97897. * Observable signaled when a context lost event is raised
  97898. */
  97899. onContextLostObservable: Observable<ThinEngine>;
  97900. /**
  97901. * Observable signaled when a context restored event is raised
  97902. */
  97903. onContextRestoredObservable: Observable<ThinEngine>;
  97904. private _onContextLost;
  97905. private _onContextRestored;
  97906. protected _contextWasLost: boolean;
  97907. /** @hidden */
  97908. _doNotHandleContextLost: boolean;
  97909. /**
  97910. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  97911. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  97912. */
  97913. doNotHandleContextLost: boolean;
  97914. /**
  97915. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  97916. */
  97917. disableVertexArrayObjects: boolean;
  97918. /** @hidden */
  97919. protected _depthCullingState: DepthCullingState;
  97920. /** @hidden */
  97921. protected _stencilState: StencilState;
  97922. /** @hidden */
  97923. protected _alphaState: AlphaState;
  97924. /** @hidden */
  97925. _internalTexturesCache: InternalTexture[];
  97926. /** @hidden */
  97927. protected _activeChannel: number;
  97928. private _currentTextureChannel;
  97929. /** @hidden */
  97930. protected _boundTexturesCache: {
  97931. [key: string]: Nullable<InternalTexture>;
  97932. };
  97933. /** @hidden */
  97934. protected _currentEffect: Nullable<Effect>;
  97935. /** @hidden */
  97936. protected _currentProgram: Nullable<WebGLProgram>;
  97937. private _compiledEffects;
  97938. private _vertexAttribArraysEnabled;
  97939. /** @hidden */
  97940. protected _cachedViewport: Nullable<IViewportLike>;
  97941. private _cachedVertexArrayObject;
  97942. /** @hidden */
  97943. protected _cachedVertexBuffers: any;
  97944. /** @hidden */
  97945. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  97946. /** @hidden */
  97947. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  97948. /** @hidden */
  97949. _currentRenderTarget: Nullable<InternalTexture>;
  97950. private _uintIndicesCurrentlySet;
  97951. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  97952. /** @hidden */
  97953. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  97954. private _currentBufferPointers;
  97955. private _currentInstanceLocations;
  97956. private _currentInstanceBuffers;
  97957. private _textureUnits;
  97958. /** @hidden */
  97959. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  97960. /** @hidden */
  97961. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  97962. /** @hidden */
  97963. _boundRenderFunction: any;
  97964. private _vaoRecordInProgress;
  97965. private _mustWipeVertexAttributes;
  97966. private _emptyTexture;
  97967. private _emptyCubeTexture;
  97968. private _emptyTexture3D;
  97969. private _emptyTexture2DArray;
  97970. /** @hidden */
  97971. _frameHandler: number;
  97972. private _nextFreeTextureSlots;
  97973. private _maxSimultaneousTextures;
  97974. private _activeRequests;
  97975. protected _texturesSupported: string[];
  97976. /** @hidden */
  97977. _textureFormatInUse: Nullable<string>;
  97978. protected readonly _supportsHardwareTextureRescaling: boolean;
  97979. /**
  97980. * Gets the list of texture formats supported
  97981. */
  97982. readonly texturesSupported: Array<string>;
  97983. /**
  97984. * Gets the list of texture formats in use
  97985. */
  97986. readonly textureFormatInUse: Nullable<string>;
  97987. /**
  97988. * Gets the current viewport
  97989. */
  97990. readonly currentViewport: Nullable<IViewportLike>;
  97991. /**
  97992. * Gets the default empty texture
  97993. */
  97994. readonly emptyTexture: InternalTexture;
  97995. /**
  97996. * Gets the default empty 3D texture
  97997. */
  97998. readonly emptyTexture3D: InternalTexture;
  97999. /**
  98000. * Gets the default empty 2D array texture
  98001. */
  98002. readonly emptyTexture2DArray: InternalTexture;
  98003. /**
  98004. * Gets the default empty cube texture
  98005. */
  98006. readonly emptyCubeTexture: InternalTexture;
  98007. /**
  98008. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  98009. */
  98010. readonly premultipliedAlpha: boolean;
  98011. /**
  98012. * Observable event triggered before each texture is initialized
  98013. */
  98014. onBeforeTextureInitObservable: Observable<Texture>;
  98015. /**
  98016. * Creates a new engine
  98017. * @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
  98018. * @param antialias defines enable antialiasing (default: false)
  98019. * @param options defines further options to be sent to the getContext() function
  98020. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  98021. */
  98022. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  98023. private _rebuildInternalTextures;
  98024. private _rebuildEffects;
  98025. /**
  98026. * Gets a boolean indicating if all created effects are ready
  98027. * @returns true if all effects are ready
  98028. */
  98029. areAllEffectsReady(): boolean;
  98030. protected _rebuildBuffers(): void;
  98031. private _initGLContext;
  98032. /**
  98033. * Gets version of the current webGL context
  98034. */
  98035. readonly webGLVersion: number;
  98036. /**
  98037. * Gets a string idenfifying the name of the class
  98038. * @returns "Engine" string
  98039. */
  98040. getClassName(): string;
  98041. /**
  98042. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  98043. */
  98044. readonly isStencilEnable: boolean;
  98045. /** @hidden */
  98046. _prepareWorkingCanvas(): void;
  98047. /**
  98048. * Reset the texture cache to empty state
  98049. */
  98050. resetTextureCache(): void;
  98051. /**
  98052. * Gets an object containing information about the current webGL context
  98053. * @returns an object containing the vender, the renderer and the version of the current webGL context
  98054. */
  98055. getGlInfo(): {
  98056. vendor: string;
  98057. renderer: string;
  98058. version: string;
  98059. };
  98060. /**
  98061. * Defines the hardware scaling level.
  98062. * By default the hardware scaling level is computed from the window device ratio.
  98063. * 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.
  98064. * @param level defines the level to use
  98065. */
  98066. setHardwareScalingLevel(level: number): void;
  98067. /**
  98068. * Gets the current hardware scaling level.
  98069. * By default the hardware scaling level is computed from the window device ratio.
  98070. * 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.
  98071. * @returns a number indicating the current hardware scaling level
  98072. */
  98073. getHardwareScalingLevel(): number;
  98074. /**
  98075. * Gets the list of loaded textures
  98076. * @returns an array containing all loaded textures
  98077. */
  98078. getLoadedTexturesCache(): InternalTexture[];
  98079. /**
  98080. * Gets the object containing all engine capabilities
  98081. * @returns the EngineCapabilities object
  98082. */
  98083. getCaps(): EngineCapabilities;
  98084. /**
  98085. * stop executing a render loop function and remove it from the execution array
  98086. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  98087. */
  98088. stopRenderLoop(renderFunction?: () => void): void;
  98089. /** @hidden */
  98090. _renderLoop(): void;
  98091. /**
  98092. * Gets the HTML canvas attached with the current webGL context
  98093. * @returns a HTML canvas
  98094. */
  98095. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  98096. /**
  98097. * Gets host window
  98098. * @returns the host window object
  98099. */
  98100. getHostWindow(): Nullable<Window>;
  98101. /**
  98102. * Gets the current render width
  98103. * @param useScreen defines if screen size must be used (or the current render target if any)
  98104. * @returns a number defining the current render width
  98105. */
  98106. getRenderWidth(useScreen?: boolean): number;
  98107. /**
  98108. * Gets the current render height
  98109. * @param useScreen defines if screen size must be used (or the current render target if any)
  98110. * @returns a number defining the current render height
  98111. */
  98112. getRenderHeight(useScreen?: boolean): number;
  98113. /**
  98114. * Can be used to override the current requestAnimationFrame requester.
  98115. * @hidden
  98116. */
  98117. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  98118. /**
  98119. * Register and execute a render loop. The engine can have more than one render function
  98120. * @param renderFunction defines the function to continuously execute
  98121. */
  98122. runRenderLoop(renderFunction: () => void): void;
  98123. /**
  98124. * Clear the current render buffer or the current render target (if any is set up)
  98125. * @param color defines the color to use
  98126. * @param backBuffer defines if the back buffer must be cleared
  98127. * @param depth defines if the depth buffer must be cleared
  98128. * @param stencil defines if the stencil buffer must be cleared
  98129. */
  98130. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  98131. private _viewportCached;
  98132. /** @hidden */
  98133. _viewport(x: number, y: number, width: number, height: number): void;
  98134. /**
  98135. * Set the WebGL's viewport
  98136. * @param viewport defines the viewport element to be used
  98137. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  98138. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  98139. */
  98140. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  98141. /**
  98142. * Begin a new frame
  98143. */
  98144. beginFrame(): void;
  98145. /**
  98146. * Enf the current frame
  98147. */
  98148. endFrame(): void;
  98149. /**
  98150. * Resize the view according to the canvas' size
  98151. */
  98152. resize(): void;
  98153. /**
  98154. * Force a specific size of the canvas
  98155. * @param width defines the new canvas' width
  98156. * @param height defines the new canvas' height
  98157. */
  98158. setSize(width: number, height: number): void;
  98159. /**
  98160. * Binds the frame buffer to the specified texture.
  98161. * @param texture The texture to render to or null for the default canvas
  98162. * @param faceIndex The face of the texture to render to in case of cube texture
  98163. * @param requiredWidth The width of the target to render to
  98164. * @param requiredHeight The height of the target to render to
  98165. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  98166. * @param depthStencilTexture The depth stencil texture to use to render
  98167. * @param lodLevel defines le lod level to bind to the frame buffer
  98168. */
  98169. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  98170. /** @hidden */
  98171. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  98172. /**
  98173. * Unbind the current render target texture from the webGL context
  98174. * @param texture defines the render target texture to unbind
  98175. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  98176. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  98177. */
  98178. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  98179. /**
  98180. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  98181. */
  98182. flushFramebuffer(): void;
  98183. /**
  98184. * Unbind the current render target and bind the default framebuffer
  98185. */
  98186. restoreDefaultFramebuffer(): void;
  98187. /** @hidden */
  98188. protected _resetVertexBufferBinding(): void;
  98189. /**
  98190. * Creates a vertex buffer
  98191. * @param data the data for the vertex buffer
  98192. * @returns the new WebGL static buffer
  98193. */
  98194. createVertexBuffer(data: DataArray): DataBuffer;
  98195. private _createVertexBuffer;
  98196. /**
  98197. * Creates a dynamic vertex buffer
  98198. * @param data the data for the dynamic vertex buffer
  98199. * @returns the new WebGL dynamic buffer
  98200. */
  98201. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  98202. protected _resetIndexBufferBinding(): void;
  98203. /**
  98204. * Creates a new index buffer
  98205. * @param indices defines the content of the index buffer
  98206. * @param updatable defines if the index buffer must be updatable
  98207. * @returns a new webGL buffer
  98208. */
  98209. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  98210. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  98211. /**
  98212. * Bind a webGL buffer to the webGL context
  98213. * @param buffer defines the buffer to bind
  98214. */
  98215. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  98216. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  98217. private bindBuffer;
  98218. /**
  98219. * update the bound buffer with the given data
  98220. * @param data defines the data to update
  98221. */
  98222. updateArrayBuffer(data: Float32Array): void;
  98223. private _vertexAttribPointer;
  98224. private _bindIndexBufferWithCache;
  98225. private _bindVertexBuffersAttributes;
  98226. /**
  98227. * Records a vertex array object
  98228. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  98229. * @param vertexBuffers defines the list of vertex buffers to store
  98230. * @param indexBuffer defines the index buffer to store
  98231. * @param effect defines the effect to store
  98232. * @returns the new vertex array object
  98233. */
  98234. recordVertexArrayObject(vertexBuffers: {
  98235. [key: string]: VertexBuffer;
  98236. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  98237. /**
  98238. * Bind a specific vertex array object
  98239. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  98240. * @param vertexArrayObject defines the vertex array object to bind
  98241. * @param indexBuffer defines the index buffer to bind
  98242. */
  98243. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  98244. /**
  98245. * Bind webGl buffers directly to the webGL context
  98246. * @param vertexBuffer defines the vertex buffer to bind
  98247. * @param indexBuffer defines the index buffer to bind
  98248. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  98249. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  98250. * @param effect defines the effect associated with the vertex buffer
  98251. */
  98252. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  98253. private _unbindVertexArrayObject;
  98254. /**
  98255. * Bind a list of vertex buffers to the webGL context
  98256. * @param vertexBuffers defines the list of vertex buffers to bind
  98257. * @param indexBuffer defines the index buffer to bind
  98258. * @param effect defines the effect associated with the vertex buffers
  98259. */
  98260. bindBuffers(vertexBuffers: {
  98261. [key: string]: Nullable<VertexBuffer>;
  98262. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  98263. /**
  98264. * Unbind all instance attributes
  98265. */
  98266. unbindInstanceAttributes(): void;
  98267. /**
  98268. * Release and free the memory of a vertex array object
  98269. * @param vao defines the vertex array object to delete
  98270. */
  98271. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  98272. /** @hidden */
  98273. _releaseBuffer(buffer: DataBuffer): boolean;
  98274. protected _deleteBuffer(buffer: DataBuffer): void;
  98275. /**
  98276. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  98277. * @param instancesBuffer defines the webGL buffer to update and bind
  98278. * @param data defines the data to store in the buffer
  98279. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  98280. */
  98281. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  98282. /**
  98283. * Apply all cached states (depth, culling, stencil and alpha)
  98284. */
  98285. applyStates(): void;
  98286. /**
  98287. * Send a draw order
  98288. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  98289. * @param indexStart defines the starting index
  98290. * @param indexCount defines the number of index to draw
  98291. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98292. */
  98293. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  98294. /**
  98295. * Draw a list of points
  98296. * @param verticesStart defines the index of first vertex to draw
  98297. * @param verticesCount defines the count of vertices to draw
  98298. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98299. */
  98300. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  98301. /**
  98302. * Draw a list of unindexed primitives
  98303. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  98304. * @param verticesStart defines the index of first vertex to draw
  98305. * @param verticesCount defines the count of vertices to draw
  98306. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98307. */
  98308. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  98309. /**
  98310. * Draw a list of indexed primitives
  98311. * @param fillMode defines the primitive to use
  98312. * @param indexStart defines the starting index
  98313. * @param indexCount defines the number of index to draw
  98314. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98315. */
  98316. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  98317. /**
  98318. * Draw a list of unindexed primitives
  98319. * @param fillMode defines the primitive to use
  98320. * @param verticesStart defines the index of first vertex to draw
  98321. * @param verticesCount defines the count of vertices to draw
  98322. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98323. */
  98324. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  98325. private _drawMode;
  98326. /** @hidden */
  98327. protected _reportDrawCall(): void;
  98328. /** @hidden */
  98329. _releaseEffect(effect: Effect): void;
  98330. /** @hidden */
  98331. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  98332. /**
  98333. * Create a new effect (used to store vertex/fragment shaders)
  98334. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  98335. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  98336. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  98337. * @param samplers defines an array of string used to represent textures
  98338. * @param defines defines the string containing the defines to use to compile the shaders
  98339. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  98340. * @param onCompiled defines a function to call when the effect creation is successful
  98341. * @param onError defines a function to call when the effect creation has failed
  98342. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  98343. * @returns the new Effect
  98344. */
  98345. createEffect(baseName: any, attributesNamesOrOptions: string[] | IEffectCreationOptions, uniformsNamesOrEngine: string[] | ThinEngine, samplers?: string[], defines?: string, fallbacks?: IEffectFallbacks, onCompiled?: Nullable<(effect: Effect) => void>, onError?: Nullable<(effect: Effect, errors: string) => void>, indexParameters?: any): Effect;
  98346. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  98347. private _compileShader;
  98348. private _compileRawShader;
  98349. /**
  98350. * Directly creates a webGL program
  98351. * @param pipelineContext defines the pipeline context to attach to
  98352. * @param vertexCode defines the vertex shader code to use
  98353. * @param fragmentCode defines the fragment shader code to use
  98354. * @param context defines the webGL context to use (if not set, the current one will be used)
  98355. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  98356. * @returns the new webGL program
  98357. */
  98358. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  98359. /**
  98360. * Creates a webGL program
  98361. * @param pipelineContext defines the pipeline context to attach to
  98362. * @param vertexCode defines the vertex shader code to use
  98363. * @param fragmentCode defines the fragment shader code to use
  98364. * @param defines defines the string containing the defines to use to compile the shaders
  98365. * @param context defines the webGL context to use (if not set, the current one will be used)
  98366. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  98367. * @returns the new webGL program
  98368. */
  98369. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  98370. /**
  98371. * Creates a new pipeline context
  98372. * @returns the new pipeline
  98373. */
  98374. createPipelineContext(): IPipelineContext;
  98375. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  98376. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  98377. /** @hidden */
  98378. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  98379. /** @hidden */
  98380. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  98381. /** @hidden */
  98382. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  98383. /**
  98384. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  98385. * @param pipelineContext defines the pipeline context to use
  98386. * @param uniformsNames defines the list of uniform names
  98387. * @returns an array of webGL uniform locations
  98388. */
  98389. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  98390. /**
  98391. * Gets the lsit of active attributes for a given webGL program
  98392. * @param pipelineContext defines the pipeline context to use
  98393. * @param attributesNames defines the list of attribute names to get
  98394. * @returns an array of indices indicating the offset of each attribute
  98395. */
  98396. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  98397. /**
  98398. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  98399. * @param effect defines the effect to activate
  98400. */
  98401. enableEffect(effect: Nullable<Effect>): void;
  98402. /**
  98403. * Set the value of an uniform to a number (int)
  98404. * @param uniform defines the webGL uniform location where to store the value
  98405. * @param value defines the int number to store
  98406. */
  98407. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  98408. /**
  98409. * Set the value of an uniform to an array of int32
  98410. * @param uniform defines the webGL uniform location where to store the value
  98411. * @param array defines the array of int32 to store
  98412. */
  98413. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98414. /**
  98415. * Set the value of an uniform to an array of int32 (stored as vec2)
  98416. * @param uniform defines the webGL uniform location where to store the value
  98417. * @param array defines the array of int32 to store
  98418. */
  98419. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98420. /**
  98421. * Set the value of an uniform to an array of int32 (stored as vec3)
  98422. * @param uniform defines the webGL uniform location where to store the value
  98423. * @param array defines the array of int32 to store
  98424. */
  98425. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98426. /**
  98427. * Set the value of an uniform to an array of int32 (stored as vec4)
  98428. * @param uniform defines the webGL uniform location where to store the value
  98429. * @param array defines the array of int32 to store
  98430. */
  98431. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98432. /**
  98433. * Set the value of an uniform to an array of number
  98434. * @param uniform defines the webGL uniform location where to store the value
  98435. * @param array defines the array of number to store
  98436. */
  98437. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98438. /**
  98439. * Set the value of an uniform to an array of number (stored as vec2)
  98440. * @param uniform defines the webGL uniform location where to store the value
  98441. * @param array defines the array of number to store
  98442. */
  98443. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98444. /**
  98445. * Set the value of an uniform to an array of number (stored as vec3)
  98446. * @param uniform defines the webGL uniform location where to store the value
  98447. * @param array defines the array of number to store
  98448. */
  98449. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98450. /**
  98451. * Set the value of an uniform to an array of number (stored as vec4)
  98452. * @param uniform defines the webGL uniform location where to store the value
  98453. * @param array defines the array of number to store
  98454. */
  98455. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98456. /**
  98457. * Set the value of an uniform to an array of float32 (stored as matrices)
  98458. * @param uniform defines the webGL uniform location where to store the value
  98459. * @param matrices defines the array of float32 to store
  98460. */
  98461. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  98462. /**
  98463. * Set the value of an uniform to a matrix (3x3)
  98464. * @param uniform defines the webGL uniform location where to store the value
  98465. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  98466. */
  98467. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  98468. /**
  98469. * Set the value of an uniform to a matrix (2x2)
  98470. * @param uniform defines the webGL uniform location where to store the value
  98471. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  98472. */
  98473. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  98474. /**
  98475. * Set the value of an uniform to a number (float)
  98476. * @param uniform defines the webGL uniform location where to store the value
  98477. * @param value defines the float number to store
  98478. */
  98479. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  98480. /**
  98481. * Set the value of an uniform to a vec2
  98482. * @param uniform defines the webGL uniform location where to store the value
  98483. * @param x defines the 1st component of the value
  98484. * @param y defines the 2nd component of the value
  98485. */
  98486. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  98487. /**
  98488. * Set the value of an uniform to a vec3
  98489. * @param uniform defines the webGL uniform location where to store the value
  98490. * @param x defines the 1st component of the value
  98491. * @param y defines the 2nd component of the value
  98492. * @param z defines the 3rd component of the value
  98493. */
  98494. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  98495. /**
  98496. * Set the value of an uniform to a vec4
  98497. * @param uniform defines the webGL uniform location where to store the value
  98498. * @param x defines the 1st component of the value
  98499. * @param y defines the 2nd component of the value
  98500. * @param z defines the 3rd component of the value
  98501. * @param w defines the 4th component of the value
  98502. */
  98503. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  98504. /**
  98505. * Gets the depth culling state manager
  98506. */
  98507. readonly depthCullingState: DepthCullingState;
  98508. /**
  98509. * Gets the alpha state manager
  98510. */
  98511. readonly alphaState: AlphaState;
  98512. /**
  98513. * Gets the stencil state manager
  98514. */
  98515. readonly stencilState: StencilState;
  98516. /**
  98517. * Clears the list of texture accessible through engine.
  98518. * This can help preventing texture load conflict due to name collision.
  98519. */
  98520. clearInternalTexturesCache(): void;
  98521. /**
  98522. * Force the entire cache to be cleared
  98523. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  98524. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  98525. */
  98526. wipeCaches(bruteForce?: boolean): void;
  98527. /** @hidden */
  98528. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  98529. min: number;
  98530. mag: number;
  98531. };
  98532. /** @hidden */
  98533. _createTexture(): WebGLTexture;
  98534. /**
  98535. * Usually called from Texture.ts.
  98536. * Passed information to create a WebGLTexture
  98537. * @param urlArg defines a value which contains one of the following:
  98538. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  98539. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  98540. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  98541. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  98542. * @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)
  98543. * @param scene needed for loading to the correct scene
  98544. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  98545. * @param onLoad optional callback to be called upon successful completion
  98546. * @param onError optional callback to be called upon failure
  98547. * @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
  98548. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  98549. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  98550. * @param forcedExtension defines the extension to use to pick the right loader
  98551. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  98552. * @param mimeType defines an optional mime type
  98553. * @returns a InternalTexture for assignment back into BABYLON.Texture
  98554. */
  98555. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<ISceneLike>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>, excludeLoaders?: Array<IInternalTextureLoader>, mimeType?: string): InternalTexture;
  98556. /**
  98557. * @hidden
  98558. */
  98559. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  98560. /**
  98561. * Creates a raw texture
  98562. * @param data defines the data to store in the texture
  98563. * @param width defines the width of the texture
  98564. * @param height defines the height of the texture
  98565. * @param format defines the format of the data
  98566. * @param generateMipMaps defines if the engine should generate the mip levels
  98567. * @param invertY defines if data must be stored with Y axis inverted
  98568. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  98569. * @param compression defines the compression used (null by default)
  98570. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  98571. * @returns the raw texture inside an InternalTexture
  98572. */
  98573. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  98574. /**
  98575. * Creates a new raw cube texture
  98576. * @param data defines the array of data to use to create each face
  98577. * @param size defines the size of the textures
  98578. * @param format defines the format of the data
  98579. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  98580. * @param generateMipMaps defines if the engine should generate the mip levels
  98581. * @param invertY defines if data must be stored with Y axis inverted
  98582. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98583. * @param compression defines the compression used (null by default)
  98584. * @returns the cube texture as an InternalTexture
  98585. */
  98586. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  98587. /**
  98588. * Creates a new raw 3D texture
  98589. * @param data defines the data used to create the texture
  98590. * @param width defines the width of the texture
  98591. * @param height defines the height of the texture
  98592. * @param depth defines the depth of the texture
  98593. * @param format defines the format of the texture
  98594. * @param generateMipMaps defines if the engine must generate mip levels
  98595. * @param invertY defines if data must be stored with Y axis inverted
  98596. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98597. * @param compression defines the compressed used (can be null)
  98598. * @param textureType defines the compressed used (can be null)
  98599. * @returns a new raw 3D texture (stored in an InternalTexture)
  98600. */
  98601. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  98602. /**
  98603. * Creates a new raw 2D array texture
  98604. * @param data defines the data used to create the texture
  98605. * @param width defines the width of the texture
  98606. * @param height defines the height of the texture
  98607. * @param depth defines the number of layers of the texture
  98608. * @param format defines the format of the texture
  98609. * @param generateMipMaps defines if the engine must generate mip levels
  98610. * @param invertY defines if data must be stored with Y axis inverted
  98611. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98612. * @param compression defines the compressed used (can be null)
  98613. * @param textureType defines the compressed used (can be null)
  98614. * @returns a new raw 2D array texture (stored in an InternalTexture)
  98615. */
  98616. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  98617. private _unpackFlipYCached;
  98618. /**
  98619. * In case you are sharing the context with other applications, it might
  98620. * be interested to not cache the unpack flip y state to ensure a consistent
  98621. * value would be set.
  98622. */
  98623. enableUnpackFlipYCached: boolean;
  98624. /** @hidden */
  98625. _unpackFlipY(value: boolean): void;
  98626. /** @hidden */
  98627. _getUnpackAlignement(): number;
  98628. /**
  98629. * Update the sampling mode of a given texture
  98630. * @param samplingMode defines the required sampling mode
  98631. * @param texture defines the texture to update
  98632. */
  98633. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  98634. /** @hidden */
  98635. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  98636. width: number;
  98637. height: number;
  98638. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  98639. /** @hidden */
  98640. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  98641. /** @hidden */
  98642. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  98643. /** @hidden */
  98644. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  98645. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  98646. private _prepareWebGLTexture;
  98647. /** @hidden */
  98648. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  98649. /** @hidden */
  98650. _releaseFramebufferObjects(texture: InternalTexture): void;
  98651. /** @hidden */
  98652. _releaseTexture(texture: InternalTexture): void;
  98653. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  98654. protected _setProgram(program: WebGLProgram): void;
  98655. protected _boundUniforms: {
  98656. [key: number]: WebGLUniformLocation;
  98657. };
  98658. /**
  98659. * Binds an effect to the webGL context
  98660. * @param effect defines the effect to bind
  98661. */
  98662. bindSamplers(effect: Effect): void;
  98663. private _activateCurrentTexture;
  98664. /** @hidden */
  98665. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  98666. /** @hidden */
  98667. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  98668. /**
  98669. * Unbind all textures from the webGL context
  98670. */
  98671. unbindAllTextures(): void;
  98672. /**
  98673. * Sets a texture to the according uniform.
  98674. * @param channel The texture channel
  98675. * @param uniform The uniform to set
  98676. * @param texture The texture to apply
  98677. */
  98678. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  98679. private _bindSamplerUniformToChannel;
  98680. private _getTextureWrapMode;
  98681. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  98682. /**
  98683. * Sets an array of texture to the webGL context
  98684. * @param channel defines the channel where the texture array must be set
  98685. * @param uniform defines the associated uniform location
  98686. * @param textures defines the array of textures to bind
  98687. */
  98688. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  98689. /** @hidden */
  98690. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  98691. private _setTextureParameterFloat;
  98692. private _setTextureParameterInteger;
  98693. /**
  98694. * Unbind all vertex attributes from the webGL context
  98695. */
  98696. unbindAllAttributes(): void;
  98697. /**
  98698. * 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
  98699. */
  98700. releaseEffects(): void;
  98701. /**
  98702. * Dispose and release all associated resources
  98703. */
  98704. dispose(): void;
  98705. /**
  98706. * Attach a new callback raised when context lost event is fired
  98707. * @param callback defines the callback to call
  98708. */
  98709. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  98710. /**
  98711. * Attach a new callback raised when context restored event is fired
  98712. * @param callback defines the callback to call
  98713. */
  98714. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  98715. /**
  98716. * Get the current error code of the webGL context
  98717. * @returns the error code
  98718. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  98719. */
  98720. getError(): number;
  98721. private _canRenderToFloatFramebuffer;
  98722. private _canRenderToHalfFloatFramebuffer;
  98723. private _canRenderToFramebuffer;
  98724. /** @hidden */
  98725. _getWebGLTextureType(type: number): number;
  98726. /** @hidden */
  98727. _getInternalFormat(format: number): number;
  98728. /** @hidden */
  98729. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  98730. /** @hidden */
  98731. _getRGBAMultiSampleBufferFormat(type: number): number;
  98732. /** @hidden */
  98733. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (data: any) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: IWebRequest, exception?: any) => void): IFileRequest;
  98734. /**
  98735. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  98736. * @returns true if the engine can be created
  98737. * @ignorenaming
  98738. */
  98739. static isSupported(): boolean;
  98740. /**
  98741. * Find the next highest power of two.
  98742. * @param x Number to start search from.
  98743. * @return Next highest power of two.
  98744. */
  98745. static CeilingPOT(x: number): number;
  98746. /**
  98747. * Find the next lowest power of two.
  98748. * @param x Number to start search from.
  98749. * @return Next lowest power of two.
  98750. */
  98751. static FloorPOT(x: number): number;
  98752. /**
  98753. * Find the nearest power of two.
  98754. * @param x Number to start search from.
  98755. * @return Next nearest power of two.
  98756. */
  98757. static NearestPOT(x: number): number;
  98758. /**
  98759. * Get the closest exponent of two
  98760. * @param value defines the value to approximate
  98761. * @param max defines the maximum value to return
  98762. * @param mode defines how to define the closest value
  98763. * @returns closest exponent of two of the given value
  98764. */
  98765. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  98766. /**
  98767. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  98768. * @param func - the function to be called
  98769. * @param requester - the object that will request the next frame. Falls back to window.
  98770. * @returns frame number
  98771. */
  98772. static QueueNewFrame(func: () => void, requester?: any): number;
  98773. }
  98774. }
  98775. declare module BABYLON {
  98776. /**
  98777. * Class representing spherical harmonics coefficients to the 3rd degree
  98778. */
  98779. export class SphericalHarmonics {
  98780. /**
  98781. * Defines whether or not the harmonics have been prescaled for rendering.
  98782. */
  98783. preScaled: boolean;
  98784. /**
  98785. * The l0,0 coefficients of the spherical harmonics
  98786. */
  98787. l00: Vector3;
  98788. /**
  98789. * The l1,-1 coefficients of the spherical harmonics
  98790. */
  98791. l1_1: Vector3;
  98792. /**
  98793. * The l1,0 coefficients of the spherical harmonics
  98794. */
  98795. l10: Vector3;
  98796. /**
  98797. * The l1,1 coefficients of the spherical harmonics
  98798. */
  98799. l11: Vector3;
  98800. /**
  98801. * The l2,-2 coefficients of the spherical harmonics
  98802. */
  98803. l2_2: Vector3;
  98804. /**
  98805. * The l2,-1 coefficients of the spherical harmonics
  98806. */
  98807. l2_1: Vector3;
  98808. /**
  98809. * The l2,0 coefficients of the spherical harmonics
  98810. */
  98811. l20: Vector3;
  98812. /**
  98813. * The l2,1 coefficients of the spherical harmonics
  98814. */
  98815. l21: Vector3;
  98816. /**
  98817. * The l2,2 coefficients of the spherical harmonics
  98818. */
  98819. l22: Vector3;
  98820. /**
  98821. * Adds a light to the spherical harmonics
  98822. * @param direction the direction of the light
  98823. * @param color the color of the light
  98824. * @param deltaSolidAngle the delta solid angle of the light
  98825. */
  98826. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  98827. /**
  98828. * Scales the spherical harmonics by the given amount
  98829. * @param scale the amount to scale
  98830. */
  98831. scaleInPlace(scale: number): void;
  98832. /**
  98833. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  98834. *
  98835. * ```
  98836. * E_lm = A_l * L_lm
  98837. * ```
  98838. *
  98839. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  98840. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  98841. * the scaling factors are given in equation 9.
  98842. */
  98843. convertIncidentRadianceToIrradiance(): void;
  98844. /**
  98845. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  98846. *
  98847. * ```
  98848. * L = (1/pi) * E * rho
  98849. * ```
  98850. *
  98851. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  98852. */
  98853. convertIrradianceToLambertianRadiance(): void;
  98854. /**
  98855. * Integrates the reconstruction coefficients directly in to the SH preventing further
  98856. * required operations at run time.
  98857. *
  98858. * This is simply done by scaling back the SH with Ylm constants parameter.
  98859. * The trigonometric part being applied by the shader at run time.
  98860. */
  98861. preScaleForRendering(): void;
  98862. /**
  98863. * Constructs a spherical harmonics from an array.
  98864. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  98865. * @returns the spherical harmonics
  98866. */
  98867. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  98868. /**
  98869. * Gets the spherical harmonics from polynomial
  98870. * @param polynomial the spherical polynomial
  98871. * @returns the spherical harmonics
  98872. */
  98873. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  98874. }
  98875. /**
  98876. * Class representing spherical polynomial coefficients to the 3rd degree
  98877. */
  98878. export class SphericalPolynomial {
  98879. private _harmonics;
  98880. /**
  98881. * The spherical harmonics used to create the polynomials.
  98882. */
  98883. readonly preScaledHarmonics: SphericalHarmonics;
  98884. /**
  98885. * The x coefficients of the spherical polynomial
  98886. */
  98887. x: Vector3;
  98888. /**
  98889. * The y coefficients of the spherical polynomial
  98890. */
  98891. y: Vector3;
  98892. /**
  98893. * The z coefficients of the spherical polynomial
  98894. */
  98895. z: Vector3;
  98896. /**
  98897. * The xx coefficients of the spherical polynomial
  98898. */
  98899. xx: Vector3;
  98900. /**
  98901. * The yy coefficients of the spherical polynomial
  98902. */
  98903. yy: Vector3;
  98904. /**
  98905. * The zz coefficients of the spherical polynomial
  98906. */
  98907. zz: Vector3;
  98908. /**
  98909. * The xy coefficients of the spherical polynomial
  98910. */
  98911. xy: Vector3;
  98912. /**
  98913. * The yz coefficients of the spherical polynomial
  98914. */
  98915. yz: Vector3;
  98916. /**
  98917. * The zx coefficients of the spherical polynomial
  98918. */
  98919. zx: Vector3;
  98920. /**
  98921. * Adds an ambient color to the spherical polynomial
  98922. * @param color the color to add
  98923. */
  98924. addAmbient(color: Color3): void;
  98925. /**
  98926. * Scales the spherical polynomial by the given amount
  98927. * @param scale the amount to scale
  98928. */
  98929. scaleInPlace(scale: number): void;
  98930. /**
  98931. * Gets the spherical polynomial from harmonics
  98932. * @param harmonics the spherical harmonics
  98933. * @returns the spherical polynomial
  98934. */
  98935. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  98936. /**
  98937. * Constructs a spherical polynomial from an array.
  98938. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  98939. * @returns the spherical polynomial
  98940. */
  98941. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  98942. }
  98943. }
  98944. declare module BABYLON {
  98945. /**
  98946. * Defines the source of the internal texture
  98947. */
  98948. export enum InternalTextureSource {
  98949. /**
  98950. * The source of the texture data is unknown
  98951. */
  98952. Unknown = 0,
  98953. /**
  98954. * Texture data comes from an URL
  98955. */
  98956. Url = 1,
  98957. /**
  98958. * Texture data is only used for temporary storage
  98959. */
  98960. Temp = 2,
  98961. /**
  98962. * Texture data comes from raw data (ArrayBuffer)
  98963. */
  98964. Raw = 3,
  98965. /**
  98966. * Texture content is dynamic (video or dynamic texture)
  98967. */
  98968. Dynamic = 4,
  98969. /**
  98970. * Texture content is generated by rendering to it
  98971. */
  98972. RenderTarget = 5,
  98973. /**
  98974. * Texture content is part of a multi render target process
  98975. */
  98976. MultiRenderTarget = 6,
  98977. /**
  98978. * Texture data comes from a cube data file
  98979. */
  98980. Cube = 7,
  98981. /**
  98982. * Texture data comes from a raw cube data
  98983. */
  98984. CubeRaw = 8,
  98985. /**
  98986. * Texture data come from a prefiltered cube data file
  98987. */
  98988. CubePrefiltered = 9,
  98989. /**
  98990. * Texture content is raw 3D data
  98991. */
  98992. Raw3D = 10,
  98993. /**
  98994. * Texture content is raw 2D array data
  98995. */
  98996. Raw2DArray = 11,
  98997. /**
  98998. * Texture content is a depth texture
  98999. */
  99000. Depth = 12,
  99001. /**
  99002. * Texture data comes from a raw cube data encoded with RGBD
  99003. */
  99004. CubeRawRGBD = 13
  99005. }
  99006. /**
  99007. * Class used to store data associated with WebGL texture data for the engine
  99008. * This class should not be used directly
  99009. */
  99010. export class InternalTexture {
  99011. /** @hidden */
  99012. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  99013. /**
  99014. * Defines if the texture is ready
  99015. */
  99016. isReady: boolean;
  99017. /**
  99018. * Defines if the texture is a cube texture
  99019. */
  99020. isCube: boolean;
  99021. /**
  99022. * Defines if the texture contains 3D data
  99023. */
  99024. is3D: boolean;
  99025. /**
  99026. * Defines if the texture contains 2D array data
  99027. */
  99028. is2DArray: boolean;
  99029. /**
  99030. * Defines if the texture contains multiview data
  99031. */
  99032. isMultiview: boolean;
  99033. /**
  99034. * Gets the URL used to load this texture
  99035. */
  99036. url: string;
  99037. /**
  99038. * Gets the sampling mode of the texture
  99039. */
  99040. samplingMode: number;
  99041. /**
  99042. * Gets a boolean indicating if the texture needs mipmaps generation
  99043. */
  99044. generateMipMaps: boolean;
  99045. /**
  99046. * Gets the number of samples used by the texture (WebGL2+ only)
  99047. */
  99048. samples: number;
  99049. /**
  99050. * Gets the type of the texture (int, float...)
  99051. */
  99052. type: number;
  99053. /**
  99054. * Gets the format of the texture (RGB, RGBA...)
  99055. */
  99056. format: number;
  99057. /**
  99058. * Observable called when the texture is loaded
  99059. */
  99060. onLoadedObservable: Observable<InternalTexture>;
  99061. /**
  99062. * Gets the width of the texture
  99063. */
  99064. width: number;
  99065. /**
  99066. * Gets the height of the texture
  99067. */
  99068. height: number;
  99069. /**
  99070. * Gets the depth of the texture
  99071. */
  99072. depth: number;
  99073. /**
  99074. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  99075. */
  99076. baseWidth: number;
  99077. /**
  99078. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  99079. */
  99080. baseHeight: number;
  99081. /**
  99082. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  99083. */
  99084. baseDepth: number;
  99085. /**
  99086. * Gets a boolean indicating if the texture is inverted on Y axis
  99087. */
  99088. invertY: boolean;
  99089. /** @hidden */
  99090. _invertVScale: boolean;
  99091. /** @hidden */
  99092. _associatedChannel: number;
  99093. /** @hidden */
  99094. _source: InternalTextureSource;
  99095. /** @hidden */
  99096. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  99097. /** @hidden */
  99098. _bufferView: Nullable<ArrayBufferView>;
  99099. /** @hidden */
  99100. _bufferViewArray: Nullable<ArrayBufferView[]>;
  99101. /** @hidden */
  99102. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  99103. /** @hidden */
  99104. _size: number;
  99105. /** @hidden */
  99106. _extension: string;
  99107. /** @hidden */
  99108. _files: Nullable<string[]>;
  99109. /** @hidden */
  99110. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  99111. /** @hidden */
  99112. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  99113. /** @hidden */
  99114. _framebuffer: Nullable<WebGLFramebuffer>;
  99115. /** @hidden */
  99116. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  99117. /** @hidden */
  99118. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  99119. /** @hidden */
  99120. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  99121. /** @hidden */
  99122. _attachments: Nullable<number[]>;
  99123. /** @hidden */
  99124. _cachedCoordinatesMode: Nullable<number>;
  99125. /** @hidden */
  99126. _cachedWrapU: Nullable<number>;
  99127. /** @hidden */
  99128. _cachedWrapV: Nullable<number>;
  99129. /** @hidden */
  99130. _cachedWrapR: Nullable<number>;
  99131. /** @hidden */
  99132. _cachedAnisotropicFilteringLevel: Nullable<number>;
  99133. /** @hidden */
  99134. _isDisabled: boolean;
  99135. /** @hidden */
  99136. _compression: Nullable<string>;
  99137. /** @hidden */
  99138. _generateStencilBuffer: boolean;
  99139. /** @hidden */
  99140. _generateDepthBuffer: boolean;
  99141. /** @hidden */
  99142. _comparisonFunction: number;
  99143. /** @hidden */
  99144. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  99145. /** @hidden */
  99146. _lodGenerationScale: number;
  99147. /** @hidden */
  99148. _lodGenerationOffset: number;
  99149. /** @hidden */
  99150. _colorTextureArray: Nullable<WebGLTexture>;
  99151. /** @hidden */
  99152. _depthStencilTextureArray: Nullable<WebGLTexture>;
  99153. /** @hidden */
  99154. _lodTextureHigh: Nullable<BaseTexture>;
  99155. /** @hidden */
  99156. _lodTextureMid: Nullable<BaseTexture>;
  99157. /** @hidden */
  99158. _lodTextureLow: Nullable<BaseTexture>;
  99159. /** @hidden */
  99160. _isRGBD: boolean;
  99161. /** @hidden */
  99162. _linearSpecularLOD: boolean;
  99163. /** @hidden */
  99164. _irradianceTexture: Nullable<BaseTexture>;
  99165. /** @hidden */
  99166. _webGLTexture: Nullable<WebGLTexture>;
  99167. /** @hidden */
  99168. _references: number;
  99169. private _engine;
  99170. /**
  99171. * Gets the Engine the texture belongs to.
  99172. * @returns The babylon engine
  99173. */
  99174. getEngine(): ThinEngine;
  99175. /**
  99176. * Gets the data source type of the texture
  99177. */
  99178. readonly source: InternalTextureSource;
  99179. /**
  99180. * Creates a new InternalTexture
  99181. * @param engine defines the engine to use
  99182. * @param source defines the type of data that will be used
  99183. * @param delayAllocation if the texture allocation should be delayed (default: false)
  99184. */
  99185. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  99186. /**
  99187. * Increments the number of references (ie. the number of Texture that point to it)
  99188. */
  99189. incrementReferences(): void;
  99190. /**
  99191. * Change the size of the texture (not the size of the content)
  99192. * @param width defines the new width
  99193. * @param height defines the new height
  99194. * @param depth defines the new depth (1 by default)
  99195. */
  99196. updateSize(width: int, height: int, depth?: int): void;
  99197. /** @hidden */
  99198. _rebuild(): void;
  99199. /** @hidden */
  99200. _swapAndDie(target: InternalTexture): void;
  99201. /**
  99202. * Dispose the current allocated resources
  99203. */
  99204. dispose(): void;
  99205. }
  99206. }
  99207. declare module BABYLON {
  99208. /**
  99209. * Class used to work with sound analyzer using fast fourier transform (FFT)
  99210. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99211. */
  99212. export class Analyser {
  99213. /**
  99214. * Gets or sets the smoothing
  99215. * @ignorenaming
  99216. */
  99217. SMOOTHING: number;
  99218. /**
  99219. * Gets or sets the FFT table size
  99220. * @ignorenaming
  99221. */
  99222. FFT_SIZE: number;
  99223. /**
  99224. * Gets or sets the bar graph amplitude
  99225. * @ignorenaming
  99226. */
  99227. BARGRAPHAMPLITUDE: number;
  99228. /**
  99229. * Gets or sets the position of the debug canvas
  99230. * @ignorenaming
  99231. */
  99232. DEBUGCANVASPOS: {
  99233. x: number;
  99234. y: number;
  99235. };
  99236. /**
  99237. * Gets or sets the debug canvas size
  99238. * @ignorenaming
  99239. */
  99240. DEBUGCANVASSIZE: {
  99241. width: number;
  99242. height: number;
  99243. };
  99244. private _byteFreqs;
  99245. private _byteTime;
  99246. private _floatFreqs;
  99247. private _webAudioAnalyser;
  99248. private _debugCanvas;
  99249. private _debugCanvasContext;
  99250. private _scene;
  99251. private _registerFunc;
  99252. private _audioEngine;
  99253. /**
  99254. * Creates a new analyser
  99255. * @param scene defines hosting scene
  99256. */
  99257. constructor(scene: Scene);
  99258. /**
  99259. * Get the number of data values you will have to play with for the visualization
  99260. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  99261. * @returns a number
  99262. */
  99263. getFrequencyBinCount(): number;
  99264. /**
  99265. * Gets the current frequency data as a byte array
  99266. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  99267. * @returns a Uint8Array
  99268. */
  99269. getByteFrequencyData(): Uint8Array;
  99270. /**
  99271. * Gets the current waveform as a byte array
  99272. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  99273. * @returns a Uint8Array
  99274. */
  99275. getByteTimeDomainData(): Uint8Array;
  99276. /**
  99277. * Gets the current frequency data as a float array
  99278. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  99279. * @returns a Float32Array
  99280. */
  99281. getFloatFrequencyData(): Float32Array;
  99282. /**
  99283. * Renders the debug canvas
  99284. */
  99285. drawDebugCanvas(): void;
  99286. /**
  99287. * Stops rendering the debug canvas and removes it
  99288. */
  99289. stopDebugCanvas(): void;
  99290. /**
  99291. * Connects two audio nodes
  99292. * @param inputAudioNode defines first node to connect
  99293. * @param outputAudioNode defines second node to connect
  99294. */
  99295. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  99296. /**
  99297. * Releases all associated resources
  99298. */
  99299. dispose(): void;
  99300. }
  99301. }
  99302. declare module BABYLON {
  99303. /**
  99304. * This represents an audio engine and it is responsible
  99305. * to play, synchronize and analyse sounds throughout the application.
  99306. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99307. */
  99308. export interface IAudioEngine extends IDisposable {
  99309. /**
  99310. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  99311. */
  99312. readonly canUseWebAudio: boolean;
  99313. /**
  99314. * Gets the current AudioContext if available.
  99315. */
  99316. readonly audioContext: Nullable<AudioContext>;
  99317. /**
  99318. * The master gain node defines the global audio volume of your audio engine.
  99319. */
  99320. readonly masterGain: GainNode;
  99321. /**
  99322. * Gets whether or not mp3 are supported by your browser.
  99323. */
  99324. readonly isMP3supported: boolean;
  99325. /**
  99326. * Gets whether or not ogg are supported by your browser.
  99327. */
  99328. readonly isOGGsupported: boolean;
  99329. /**
  99330. * Defines if Babylon should emit a warning if WebAudio is not supported.
  99331. * @ignoreNaming
  99332. */
  99333. WarnedWebAudioUnsupported: boolean;
  99334. /**
  99335. * Defines if the audio engine relies on a custom unlocked button.
  99336. * In this case, the embedded button will not be displayed.
  99337. */
  99338. useCustomUnlockedButton: boolean;
  99339. /**
  99340. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  99341. */
  99342. readonly unlocked: boolean;
  99343. /**
  99344. * Event raised when audio has been unlocked on the browser.
  99345. */
  99346. onAudioUnlockedObservable: Observable<AudioEngine>;
  99347. /**
  99348. * Event raised when audio has been locked on the browser.
  99349. */
  99350. onAudioLockedObservable: Observable<AudioEngine>;
  99351. /**
  99352. * Flags the audio engine in Locked state.
  99353. * This happens due to new browser policies preventing audio to autoplay.
  99354. */
  99355. lock(): void;
  99356. /**
  99357. * Unlocks the audio engine once a user action has been done on the dom.
  99358. * This is helpful to resume play once browser policies have been satisfied.
  99359. */
  99360. unlock(): void;
  99361. }
  99362. /**
  99363. * This represents the default audio engine used in babylon.
  99364. * It is responsible to play, synchronize and analyse sounds throughout the application.
  99365. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99366. */
  99367. export class AudioEngine implements IAudioEngine {
  99368. private _audioContext;
  99369. private _audioContextInitialized;
  99370. private _muteButton;
  99371. private _hostElement;
  99372. /**
  99373. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  99374. */
  99375. canUseWebAudio: boolean;
  99376. /**
  99377. * The master gain node defines the global audio volume of your audio engine.
  99378. */
  99379. masterGain: GainNode;
  99380. /**
  99381. * Defines if Babylon should emit a warning if WebAudio is not supported.
  99382. * @ignoreNaming
  99383. */
  99384. WarnedWebAudioUnsupported: boolean;
  99385. /**
  99386. * Gets whether or not mp3 are supported by your browser.
  99387. */
  99388. isMP3supported: boolean;
  99389. /**
  99390. * Gets whether or not ogg are supported by your browser.
  99391. */
  99392. isOGGsupported: boolean;
  99393. /**
  99394. * Gets whether audio has been unlocked on the device.
  99395. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  99396. * a user interaction has happened.
  99397. */
  99398. unlocked: boolean;
  99399. /**
  99400. * Defines if the audio engine relies on a custom unlocked button.
  99401. * In this case, the embedded button will not be displayed.
  99402. */
  99403. useCustomUnlockedButton: boolean;
  99404. /**
  99405. * Event raised when audio has been unlocked on the browser.
  99406. */
  99407. onAudioUnlockedObservable: Observable<AudioEngine>;
  99408. /**
  99409. * Event raised when audio has been locked on the browser.
  99410. */
  99411. onAudioLockedObservable: Observable<AudioEngine>;
  99412. /**
  99413. * Gets the current AudioContext if available.
  99414. */
  99415. readonly audioContext: Nullable<AudioContext>;
  99416. private _connectedAnalyser;
  99417. /**
  99418. * Instantiates a new audio engine.
  99419. *
  99420. * There should be only one per page as some browsers restrict the number
  99421. * of audio contexts you can create.
  99422. * @param hostElement defines the host element where to display the mute icon if necessary
  99423. */
  99424. constructor(hostElement?: Nullable<HTMLElement>);
  99425. /**
  99426. * Flags the audio engine in Locked state.
  99427. * This happens due to new browser policies preventing audio to autoplay.
  99428. */
  99429. lock(): void;
  99430. /**
  99431. * Unlocks the audio engine once a user action has been done on the dom.
  99432. * This is helpful to resume play once browser policies have been satisfied.
  99433. */
  99434. unlock(): void;
  99435. private _resumeAudioContext;
  99436. private _initializeAudioContext;
  99437. private _tryToRun;
  99438. private _triggerRunningState;
  99439. private _triggerSuspendedState;
  99440. private _displayMuteButton;
  99441. private _moveButtonToTopLeft;
  99442. private _onResize;
  99443. private _hideMuteButton;
  99444. /**
  99445. * Destroy and release the resources associated with the audio ccontext.
  99446. */
  99447. dispose(): void;
  99448. /**
  99449. * Gets the global volume sets on the master gain.
  99450. * @returns the global volume if set or -1 otherwise
  99451. */
  99452. getGlobalVolume(): number;
  99453. /**
  99454. * Sets the global volume of your experience (sets on the master gain).
  99455. * @param newVolume Defines the new global volume of the application
  99456. */
  99457. setGlobalVolume(newVolume: number): void;
  99458. /**
  99459. * Connect the audio engine to an audio analyser allowing some amazing
  99460. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  99461. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  99462. * @param analyser The analyser to connect to the engine
  99463. */
  99464. connectToAnalyser(analyser: Analyser): void;
  99465. }
  99466. }
  99467. declare module BABYLON {
  99468. /**
  99469. * Interface used to present a loading screen while loading a scene
  99470. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99471. */
  99472. export interface ILoadingScreen {
  99473. /**
  99474. * Function called to display the loading screen
  99475. */
  99476. displayLoadingUI: () => void;
  99477. /**
  99478. * Function called to hide the loading screen
  99479. */
  99480. hideLoadingUI: () => void;
  99481. /**
  99482. * Gets or sets the color to use for the background
  99483. */
  99484. loadingUIBackgroundColor: string;
  99485. /**
  99486. * Gets or sets the text to display while loading
  99487. */
  99488. loadingUIText: string;
  99489. }
  99490. /**
  99491. * Class used for the default loading screen
  99492. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99493. */
  99494. export class DefaultLoadingScreen implements ILoadingScreen {
  99495. private _renderingCanvas;
  99496. private _loadingText;
  99497. private _loadingDivBackgroundColor;
  99498. private _loadingDiv;
  99499. private _loadingTextDiv;
  99500. /** Gets or sets the logo url to use for the default loading screen */
  99501. static DefaultLogoUrl: string;
  99502. /** Gets or sets the spinner url to use for the default loading screen */
  99503. static DefaultSpinnerUrl: string;
  99504. /**
  99505. * Creates a new default loading screen
  99506. * @param _renderingCanvas defines the canvas used to render the scene
  99507. * @param _loadingText defines the default text to display
  99508. * @param _loadingDivBackgroundColor defines the default background color
  99509. */
  99510. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  99511. /**
  99512. * Function called to display the loading screen
  99513. */
  99514. displayLoadingUI(): void;
  99515. /**
  99516. * Function called to hide the loading screen
  99517. */
  99518. hideLoadingUI(): void;
  99519. /**
  99520. * Gets or sets the text to display while loading
  99521. */
  99522. loadingUIText: string;
  99523. /**
  99524. * Gets or sets the color to use for the background
  99525. */
  99526. loadingUIBackgroundColor: string;
  99527. private _resizeLoadingUI;
  99528. }
  99529. }
  99530. declare module BABYLON {
  99531. /**
  99532. * Interface for any object that can request an animation frame
  99533. */
  99534. export interface ICustomAnimationFrameRequester {
  99535. /**
  99536. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  99537. */
  99538. renderFunction?: Function;
  99539. /**
  99540. * Called to request the next frame to render to
  99541. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  99542. */
  99543. requestAnimationFrame: Function;
  99544. /**
  99545. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  99546. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  99547. */
  99548. requestID?: number;
  99549. }
  99550. }
  99551. declare module BABYLON {
  99552. /**
  99553. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  99554. */
  99555. export class PerformanceMonitor {
  99556. private _enabled;
  99557. private _rollingFrameTime;
  99558. private _lastFrameTimeMs;
  99559. /**
  99560. * constructor
  99561. * @param frameSampleSize The number of samples required to saturate the sliding window
  99562. */
  99563. constructor(frameSampleSize?: number);
  99564. /**
  99565. * Samples current frame
  99566. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  99567. */
  99568. sampleFrame(timeMs?: number): void;
  99569. /**
  99570. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  99571. */
  99572. readonly averageFrameTime: number;
  99573. /**
  99574. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  99575. */
  99576. readonly averageFrameTimeVariance: number;
  99577. /**
  99578. * Returns the frame time of the most recent frame
  99579. */
  99580. readonly instantaneousFrameTime: number;
  99581. /**
  99582. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  99583. */
  99584. readonly averageFPS: number;
  99585. /**
  99586. * Returns the average framerate in frames per second using the most recent frame time
  99587. */
  99588. readonly instantaneousFPS: number;
  99589. /**
  99590. * Returns true if enough samples have been taken to completely fill the sliding window
  99591. */
  99592. readonly isSaturated: boolean;
  99593. /**
  99594. * Enables contributions to the sliding window sample set
  99595. */
  99596. enable(): void;
  99597. /**
  99598. * Disables contributions to the sliding window sample set
  99599. * Samples will not be interpolated over the disabled period
  99600. */
  99601. disable(): void;
  99602. /**
  99603. * Returns true if sampling is enabled
  99604. */
  99605. readonly isEnabled: boolean;
  99606. /**
  99607. * Resets performance monitor
  99608. */
  99609. reset(): void;
  99610. }
  99611. /**
  99612. * RollingAverage
  99613. *
  99614. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  99615. */
  99616. export class RollingAverage {
  99617. /**
  99618. * Current average
  99619. */
  99620. average: number;
  99621. /**
  99622. * Current variance
  99623. */
  99624. variance: number;
  99625. protected _samples: Array<number>;
  99626. protected _sampleCount: number;
  99627. protected _pos: number;
  99628. protected _m2: number;
  99629. /**
  99630. * constructor
  99631. * @param length The number of samples required to saturate the sliding window
  99632. */
  99633. constructor(length: number);
  99634. /**
  99635. * Adds a sample to the sample set
  99636. * @param v The sample value
  99637. */
  99638. add(v: number): void;
  99639. /**
  99640. * Returns previously added values or null if outside of history or outside the sliding window domain
  99641. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  99642. * @return Value previously recorded with add() or null if outside of range
  99643. */
  99644. history(i: number): number;
  99645. /**
  99646. * Returns true if enough samples have been taken to completely fill the sliding window
  99647. * @return true if sample-set saturated
  99648. */
  99649. isSaturated(): boolean;
  99650. /**
  99651. * Resets the rolling average (equivalent to 0 samples taken so far)
  99652. */
  99653. reset(): void;
  99654. /**
  99655. * Wraps a value around the sample range boundaries
  99656. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  99657. * @return Wrapped position in sample range
  99658. */
  99659. protected _wrapPosition(i: number): number;
  99660. }
  99661. }
  99662. declare module BABYLON {
  99663. /**
  99664. * This class is used to track a performance counter which is number based.
  99665. * The user has access to many properties which give statistics of different nature.
  99666. *
  99667. * The implementer can track two kinds of Performance Counter: time and count.
  99668. * 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.
  99669. * 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.
  99670. */
  99671. export class PerfCounter {
  99672. /**
  99673. * Gets or sets a global boolean to turn on and off all the counters
  99674. */
  99675. static Enabled: boolean;
  99676. /**
  99677. * Returns the smallest value ever
  99678. */
  99679. readonly min: number;
  99680. /**
  99681. * Returns the biggest value ever
  99682. */
  99683. readonly max: number;
  99684. /**
  99685. * Returns the average value since the performance counter is running
  99686. */
  99687. readonly average: number;
  99688. /**
  99689. * Returns the average value of the last second the counter was monitored
  99690. */
  99691. readonly lastSecAverage: number;
  99692. /**
  99693. * Returns the current value
  99694. */
  99695. readonly current: number;
  99696. /**
  99697. * Gets the accumulated total
  99698. */
  99699. readonly total: number;
  99700. /**
  99701. * Gets the total value count
  99702. */
  99703. readonly count: number;
  99704. /**
  99705. * Creates a new counter
  99706. */
  99707. constructor();
  99708. /**
  99709. * Call this method to start monitoring a new frame.
  99710. * 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.
  99711. */
  99712. fetchNewFrame(): void;
  99713. /**
  99714. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  99715. * @param newCount the count value to add to the monitored count
  99716. * @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.
  99717. */
  99718. addCount(newCount: number, fetchResult: boolean): void;
  99719. /**
  99720. * Start monitoring this performance counter
  99721. */
  99722. beginMonitoring(): void;
  99723. /**
  99724. * Compute the time lapsed since the previous beginMonitoring() call.
  99725. * @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
  99726. */
  99727. endMonitoring(newFrame?: boolean): void;
  99728. private _fetchResult;
  99729. private _startMonitoringTime;
  99730. private _min;
  99731. private _max;
  99732. private _average;
  99733. private _current;
  99734. private _totalValueCount;
  99735. private _totalAccumulated;
  99736. private _lastSecAverage;
  99737. private _lastSecAccumulated;
  99738. private _lastSecTime;
  99739. private _lastSecValueCount;
  99740. }
  99741. }
  99742. declare module BABYLON {
  99743. /**
  99744. * Defines the interface used by display changed events
  99745. */
  99746. export interface IDisplayChangedEventArgs {
  99747. /** Gets the vrDisplay object (if any) */
  99748. vrDisplay: Nullable<any>;
  99749. /** Gets a boolean indicating if webVR is supported */
  99750. vrSupported: boolean;
  99751. }
  99752. /**
  99753. * Defines the interface used by objects containing a viewport (like a camera)
  99754. */
  99755. interface IViewportOwnerLike {
  99756. /**
  99757. * Gets or sets the viewport
  99758. */
  99759. viewport: IViewportLike;
  99760. }
  99761. /**
  99762. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  99763. */
  99764. export class Engine extends ThinEngine {
  99765. /** Defines that alpha blending is disabled */
  99766. static readonly ALPHA_DISABLE: number;
  99767. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  99768. static readonly ALPHA_ADD: number;
  99769. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  99770. static readonly ALPHA_COMBINE: number;
  99771. /** Defines that alpha blending to DEST - SRC * DEST */
  99772. static readonly ALPHA_SUBTRACT: number;
  99773. /** Defines that alpha blending to SRC * DEST */
  99774. static readonly ALPHA_MULTIPLY: number;
  99775. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  99776. static readonly ALPHA_MAXIMIZED: number;
  99777. /** Defines that alpha blending to SRC + DEST */
  99778. static readonly ALPHA_ONEONE: number;
  99779. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  99780. static readonly ALPHA_PREMULTIPLIED: number;
  99781. /**
  99782. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  99783. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  99784. */
  99785. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  99786. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  99787. static readonly ALPHA_INTERPOLATE: number;
  99788. /**
  99789. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  99790. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  99791. */
  99792. static readonly ALPHA_SCREENMODE: number;
  99793. /** Defines that the ressource is not delayed*/
  99794. static readonly DELAYLOADSTATE_NONE: number;
  99795. /** Defines that the ressource was successfully delay loaded */
  99796. static readonly DELAYLOADSTATE_LOADED: number;
  99797. /** Defines that the ressource is currently delay loading */
  99798. static readonly DELAYLOADSTATE_LOADING: number;
  99799. /** Defines that the ressource is delayed and has not started loading */
  99800. static readonly DELAYLOADSTATE_NOTLOADED: number;
  99801. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  99802. static readonly NEVER: number;
  99803. /** 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 */
  99804. static readonly ALWAYS: number;
  99805. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  99806. static readonly LESS: number;
  99807. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  99808. static readonly EQUAL: number;
  99809. /** 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 */
  99810. static readonly LEQUAL: number;
  99811. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  99812. static readonly GREATER: number;
  99813. /** 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 */
  99814. static readonly GEQUAL: number;
  99815. /** 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 */
  99816. static readonly NOTEQUAL: number;
  99817. /** Passed to stencilOperation to specify that stencil value must be kept */
  99818. static readonly KEEP: number;
  99819. /** Passed to stencilOperation to specify that stencil value must be replaced */
  99820. static readonly REPLACE: number;
  99821. /** Passed to stencilOperation to specify that stencil value must be incremented */
  99822. static readonly INCR: number;
  99823. /** Passed to stencilOperation to specify that stencil value must be decremented */
  99824. static readonly DECR: number;
  99825. /** Passed to stencilOperation to specify that stencil value must be inverted */
  99826. static readonly INVERT: number;
  99827. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  99828. static readonly INCR_WRAP: number;
  99829. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  99830. static readonly DECR_WRAP: number;
  99831. /** Texture is not repeating outside of 0..1 UVs */
  99832. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  99833. /** Texture is repeating outside of 0..1 UVs */
  99834. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  99835. /** Texture is repeating and mirrored */
  99836. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  99837. /** ALPHA */
  99838. static readonly TEXTUREFORMAT_ALPHA: number;
  99839. /** LUMINANCE */
  99840. static readonly TEXTUREFORMAT_LUMINANCE: number;
  99841. /** LUMINANCE_ALPHA */
  99842. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  99843. /** RGB */
  99844. static readonly TEXTUREFORMAT_RGB: number;
  99845. /** RGBA */
  99846. static readonly TEXTUREFORMAT_RGBA: number;
  99847. /** RED */
  99848. static readonly TEXTUREFORMAT_RED: number;
  99849. /** RED (2nd reference) */
  99850. static readonly TEXTUREFORMAT_R: number;
  99851. /** RG */
  99852. static readonly TEXTUREFORMAT_RG: number;
  99853. /** RED_INTEGER */
  99854. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  99855. /** RED_INTEGER (2nd reference) */
  99856. static readonly TEXTUREFORMAT_R_INTEGER: number;
  99857. /** RG_INTEGER */
  99858. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  99859. /** RGB_INTEGER */
  99860. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  99861. /** RGBA_INTEGER */
  99862. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  99863. /** UNSIGNED_BYTE */
  99864. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  99865. /** UNSIGNED_BYTE (2nd reference) */
  99866. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  99867. /** FLOAT */
  99868. static readonly TEXTURETYPE_FLOAT: number;
  99869. /** HALF_FLOAT */
  99870. static readonly TEXTURETYPE_HALF_FLOAT: number;
  99871. /** BYTE */
  99872. static readonly TEXTURETYPE_BYTE: number;
  99873. /** SHORT */
  99874. static readonly TEXTURETYPE_SHORT: number;
  99875. /** UNSIGNED_SHORT */
  99876. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  99877. /** INT */
  99878. static readonly TEXTURETYPE_INT: number;
  99879. /** UNSIGNED_INT */
  99880. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  99881. /** UNSIGNED_SHORT_4_4_4_4 */
  99882. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  99883. /** UNSIGNED_SHORT_5_5_5_1 */
  99884. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  99885. /** UNSIGNED_SHORT_5_6_5 */
  99886. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  99887. /** UNSIGNED_INT_2_10_10_10_REV */
  99888. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  99889. /** UNSIGNED_INT_24_8 */
  99890. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  99891. /** UNSIGNED_INT_10F_11F_11F_REV */
  99892. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  99893. /** UNSIGNED_INT_5_9_9_9_REV */
  99894. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  99895. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  99896. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  99897. /** nearest is mag = nearest and min = nearest and mip = linear */
  99898. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  99899. /** Bilinear is mag = linear and min = linear and mip = nearest */
  99900. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  99901. /** Trilinear is mag = linear and min = linear and mip = linear */
  99902. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  99903. /** nearest is mag = nearest and min = nearest and mip = linear */
  99904. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  99905. /** Bilinear is mag = linear and min = linear and mip = nearest */
  99906. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  99907. /** Trilinear is mag = linear and min = linear and mip = linear */
  99908. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  99909. /** mag = nearest and min = nearest and mip = nearest */
  99910. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  99911. /** mag = nearest and min = linear and mip = nearest */
  99912. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  99913. /** mag = nearest and min = linear and mip = linear */
  99914. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  99915. /** mag = nearest and min = linear and mip = none */
  99916. static readonly TEXTURE_NEAREST_LINEAR: number;
  99917. /** mag = nearest and min = nearest and mip = none */
  99918. static readonly TEXTURE_NEAREST_NEAREST: number;
  99919. /** mag = linear and min = nearest and mip = nearest */
  99920. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  99921. /** mag = linear and min = nearest and mip = linear */
  99922. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  99923. /** mag = linear and min = linear and mip = none */
  99924. static readonly TEXTURE_LINEAR_LINEAR: number;
  99925. /** mag = linear and min = nearest and mip = none */
  99926. static readonly TEXTURE_LINEAR_NEAREST: number;
  99927. /** Explicit coordinates mode */
  99928. static readonly TEXTURE_EXPLICIT_MODE: number;
  99929. /** Spherical coordinates mode */
  99930. static readonly TEXTURE_SPHERICAL_MODE: number;
  99931. /** Planar coordinates mode */
  99932. static readonly TEXTURE_PLANAR_MODE: number;
  99933. /** Cubic coordinates mode */
  99934. static readonly TEXTURE_CUBIC_MODE: number;
  99935. /** Projection coordinates mode */
  99936. static readonly TEXTURE_PROJECTION_MODE: number;
  99937. /** Skybox coordinates mode */
  99938. static readonly TEXTURE_SKYBOX_MODE: number;
  99939. /** Inverse Cubic coordinates mode */
  99940. static readonly TEXTURE_INVCUBIC_MODE: number;
  99941. /** Equirectangular coordinates mode */
  99942. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  99943. /** Equirectangular Fixed coordinates mode */
  99944. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  99945. /** Equirectangular Fixed Mirrored coordinates mode */
  99946. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  99947. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  99948. static readonly SCALEMODE_FLOOR: number;
  99949. /** Defines that texture rescaling will look for the nearest power of 2 size */
  99950. static readonly SCALEMODE_NEAREST: number;
  99951. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  99952. static readonly SCALEMODE_CEILING: number;
  99953. /**
  99954. * Returns the current npm package of the sdk
  99955. */
  99956. static readonly NpmPackage: string;
  99957. /**
  99958. * Returns the current version of the framework
  99959. */
  99960. static readonly Version: string;
  99961. /** Gets the list of created engines */
  99962. static readonly Instances: Engine[];
  99963. /**
  99964. * Gets the latest created engine
  99965. */
  99966. static readonly LastCreatedEngine: Nullable<Engine>;
  99967. /**
  99968. * Gets the latest created scene
  99969. */
  99970. static readonly LastCreatedScene: Nullable<Scene>;
  99971. /**
  99972. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  99973. * @param flag defines which part of the materials must be marked as dirty
  99974. * @param predicate defines a predicate used to filter which materials should be affected
  99975. */
  99976. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  99977. /**
  99978. * Method called to create the default loading screen.
  99979. * This can be overriden in your own app.
  99980. * @param canvas The rendering canvas element
  99981. * @returns The loading screen
  99982. */
  99983. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  99984. /**
  99985. * Method called to create the default rescale post process on each engine.
  99986. */
  99987. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  99988. /**
  99989. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  99990. **/
  99991. enableOfflineSupport: boolean;
  99992. /**
  99993. * 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)
  99994. **/
  99995. disableManifestCheck: boolean;
  99996. /**
  99997. * Gets the list of created scenes
  99998. */
  99999. scenes: Scene[];
  100000. /**
  100001. * Event raised when a new scene is created
  100002. */
  100003. onNewSceneAddedObservable: Observable<Scene>;
  100004. /**
  100005. * Gets the list of created postprocesses
  100006. */
  100007. postProcesses: PostProcess[];
  100008. /**
  100009. * Gets a boolean indicating if the pointer is currently locked
  100010. */
  100011. isPointerLock: boolean;
  100012. /**
  100013. * Observable event triggered each time the rendering canvas is resized
  100014. */
  100015. onResizeObservable: Observable<Engine>;
  100016. /**
  100017. * Observable event triggered each time the canvas loses focus
  100018. */
  100019. onCanvasBlurObservable: Observable<Engine>;
  100020. /**
  100021. * Observable event triggered each time the canvas gains focus
  100022. */
  100023. onCanvasFocusObservable: Observable<Engine>;
  100024. /**
  100025. * Observable event triggered each time the canvas receives pointerout event
  100026. */
  100027. onCanvasPointerOutObservable: Observable<PointerEvent>;
  100028. /**
  100029. * Observable raised when the engine begins a new frame
  100030. */
  100031. onBeginFrameObservable: Observable<Engine>;
  100032. /**
  100033. * If set, will be used to request the next animation frame for the render loop
  100034. */
  100035. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  100036. /**
  100037. * Observable raised when the engine ends the current frame
  100038. */
  100039. onEndFrameObservable: Observable<Engine>;
  100040. /**
  100041. * Observable raised when the engine is about to compile a shader
  100042. */
  100043. onBeforeShaderCompilationObservable: Observable<Engine>;
  100044. /**
  100045. * Observable raised when the engine has jsut compiled a shader
  100046. */
  100047. onAfterShaderCompilationObservable: Observable<Engine>;
  100048. /**
  100049. * Gets the audio engine
  100050. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  100051. * @ignorenaming
  100052. */
  100053. static audioEngine: IAudioEngine;
  100054. /**
  100055. * Default AudioEngine factory responsible of creating the Audio Engine.
  100056. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  100057. */
  100058. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  100059. /**
  100060. * Default offline support factory responsible of creating a tool used to store data locally.
  100061. * By default, this will create a Database object if the workload has been embedded.
  100062. */
  100063. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  100064. private _loadingScreen;
  100065. private _pointerLockRequested;
  100066. private _dummyFramebuffer;
  100067. private _rescalePostProcess;
  100068. /** @hidden */
  100069. protected _alphaMode: number;
  100070. /** @hidden */
  100071. protected _alphaEquation: number;
  100072. private _deterministicLockstep;
  100073. private _lockstepMaxSteps;
  100074. protected readonly _supportsHardwareTextureRescaling: boolean;
  100075. private _fps;
  100076. private _deltaTime;
  100077. /** @hidden */
  100078. _drawCalls: PerfCounter;
  100079. /**
  100080. * Turn this value on if you want to pause FPS computation when in background
  100081. */
  100082. disablePerformanceMonitorInBackground: boolean;
  100083. private _performanceMonitor;
  100084. /**
  100085. * Gets the performance monitor attached to this engine
  100086. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  100087. */
  100088. readonly performanceMonitor: PerformanceMonitor;
  100089. private _onFocus;
  100090. private _onBlur;
  100091. private _onCanvasPointerOut;
  100092. private _onCanvasBlur;
  100093. private _onCanvasFocus;
  100094. private _onFullscreenChange;
  100095. private _onPointerLockChange;
  100096. /**
  100097. * Gets the HTML element used to attach event listeners
  100098. * @returns a HTML element
  100099. */
  100100. getInputElement(): Nullable<HTMLElement>;
  100101. /**
  100102. * Creates a new engine
  100103. * @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
  100104. * @param antialias defines enable antialiasing (default: false)
  100105. * @param options defines further options to be sent to the getContext() function
  100106. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  100107. */
  100108. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  100109. /**
  100110. * Gets current aspect ratio
  100111. * @param viewportOwner defines the camera to use to get the aspect ratio
  100112. * @param useScreen defines if screen size must be used (or the current render target if any)
  100113. * @returns a number defining the aspect ratio
  100114. */
  100115. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  100116. /**
  100117. * Gets current screen aspect ratio
  100118. * @returns a number defining the aspect ratio
  100119. */
  100120. getScreenAspectRatio(): number;
  100121. /**
  100122. * Gets host document
  100123. * @returns the host document object
  100124. */
  100125. getHostDocument(): Document;
  100126. /**
  100127. * Gets the client rect of the HTML canvas attached with the current webGL context
  100128. * @returns a client rectanglee
  100129. */
  100130. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  100131. /**
  100132. * Gets the client rect of the HTML element used for events
  100133. * @returns a client rectanglee
  100134. */
  100135. getInputElementClientRect(): Nullable<ClientRect>;
  100136. /**
  100137. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  100138. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100139. * @returns true if engine is in deterministic lock step mode
  100140. */
  100141. isDeterministicLockStep(): boolean;
  100142. /**
  100143. * Gets the max steps when engine is running in deterministic lock step
  100144. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100145. * @returns the max steps
  100146. */
  100147. getLockstepMaxSteps(): number;
  100148. /**
  100149. * Force the mipmap generation for the given render target texture
  100150. * @param texture defines the render target texture to use
  100151. */
  100152. generateMipMapsForCubemap(texture: InternalTexture): void;
  100153. /** States */
  100154. /**
  100155. * Set various states to the webGL context
  100156. * @param culling defines backface culling state
  100157. * @param zOffset defines the value to apply to zOffset (0 by default)
  100158. * @param force defines if states must be applied even if cache is up to date
  100159. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  100160. */
  100161. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  100162. /**
  100163. * Set the z offset to apply to current rendering
  100164. * @param value defines the offset to apply
  100165. */
  100166. setZOffset(value: number): void;
  100167. /**
  100168. * Gets the current value of the zOffset
  100169. * @returns the current zOffset state
  100170. */
  100171. getZOffset(): number;
  100172. /**
  100173. * Enable or disable depth buffering
  100174. * @param enable defines the state to set
  100175. */
  100176. setDepthBuffer(enable: boolean): void;
  100177. /**
  100178. * Gets a boolean indicating if depth writing is enabled
  100179. * @returns the current depth writing state
  100180. */
  100181. getDepthWrite(): boolean;
  100182. /**
  100183. * Enable or disable depth writing
  100184. * @param enable defines the state to set
  100185. */
  100186. setDepthWrite(enable: boolean): void;
  100187. /**
  100188. * Enable or disable color writing
  100189. * @param enable defines the state to set
  100190. */
  100191. setColorWrite(enable: boolean): void;
  100192. /**
  100193. * Gets a boolean indicating if color writing is enabled
  100194. * @returns the current color writing state
  100195. */
  100196. getColorWrite(): boolean;
  100197. /**
  100198. * Sets alpha constants used by some alpha blending modes
  100199. * @param r defines the red component
  100200. * @param g defines the green component
  100201. * @param b defines the blue component
  100202. * @param a defines the alpha component
  100203. */
  100204. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  100205. /**
  100206. * Sets the current alpha mode
  100207. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  100208. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  100209. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  100210. */
  100211. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  100212. /**
  100213. * Gets the current alpha mode
  100214. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  100215. * @returns the current alpha mode
  100216. */
  100217. getAlphaMode(): number;
  100218. /**
  100219. * Sets the current alpha equation
  100220. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  100221. */
  100222. setAlphaEquation(equation: number): void;
  100223. /**
  100224. * Gets the current alpha equation.
  100225. * @returns the current alpha equation
  100226. */
  100227. getAlphaEquation(): number;
  100228. /**
  100229. * Gets a boolean indicating if stencil buffer is enabled
  100230. * @returns the current stencil buffer state
  100231. */
  100232. getStencilBuffer(): boolean;
  100233. /**
  100234. * Enable or disable the stencil buffer
  100235. * @param enable defines if the stencil buffer must be enabled or disabled
  100236. */
  100237. setStencilBuffer(enable: boolean): void;
  100238. /**
  100239. * Gets the current stencil mask
  100240. * @returns a number defining the new stencil mask to use
  100241. */
  100242. getStencilMask(): number;
  100243. /**
  100244. * Sets the current stencil mask
  100245. * @param mask defines the new stencil mask to use
  100246. */
  100247. setStencilMask(mask: number): void;
  100248. /**
  100249. * Gets the current stencil function
  100250. * @returns a number defining the stencil function to use
  100251. */
  100252. getStencilFunction(): number;
  100253. /**
  100254. * Gets the current stencil reference value
  100255. * @returns a number defining the stencil reference value to use
  100256. */
  100257. getStencilFunctionReference(): number;
  100258. /**
  100259. * Gets the current stencil mask
  100260. * @returns a number defining the stencil mask to use
  100261. */
  100262. getStencilFunctionMask(): number;
  100263. /**
  100264. * Sets the current stencil function
  100265. * @param stencilFunc defines the new stencil function to use
  100266. */
  100267. setStencilFunction(stencilFunc: number): void;
  100268. /**
  100269. * Sets the current stencil reference
  100270. * @param reference defines the new stencil reference to use
  100271. */
  100272. setStencilFunctionReference(reference: number): void;
  100273. /**
  100274. * Sets the current stencil mask
  100275. * @param mask defines the new stencil mask to use
  100276. */
  100277. setStencilFunctionMask(mask: number): void;
  100278. /**
  100279. * Gets the current stencil operation when stencil fails
  100280. * @returns a number defining stencil operation to use when stencil fails
  100281. */
  100282. getStencilOperationFail(): number;
  100283. /**
  100284. * Gets the current stencil operation when depth fails
  100285. * @returns a number defining stencil operation to use when depth fails
  100286. */
  100287. getStencilOperationDepthFail(): number;
  100288. /**
  100289. * Gets the current stencil operation when stencil passes
  100290. * @returns a number defining stencil operation to use when stencil passes
  100291. */
  100292. getStencilOperationPass(): number;
  100293. /**
  100294. * Sets the stencil operation to use when stencil fails
  100295. * @param operation defines the stencil operation to use when stencil fails
  100296. */
  100297. setStencilOperationFail(operation: number): void;
  100298. /**
  100299. * Sets the stencil operation to use when depth fails
  100300. * @param operation defines the stencil operation to use when depth fails
  100301. */
  100302. setStencilOperationDepthFail(operation: number): void;
  100303. /**
  100304. * Sets the stencil operation to use when stencil passes
  100305. * @param operation defines the stencil operation to use when stencil passes
  100306. */
  100307. setStencilOperationPass(operation: number): void;
  100308. /**
  100309. * Sets a boolean indicating if the dithering state is enabled or disabled
  100310. * @param value defines the dithering state
  100311. */
  100312. setDitheringState(value: boolean): void;
  100313. /**
  100314. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  100315. * @param value defines the rasterizer state
  100316. */
  100317. setRasterizerState(value: boolean): void;
  100318. /**
  100319. * Gets the current depth function
  100320. * @returns a number defining the depth function
  100321. */
  100322. getDepthFunction(): Nullable<number>;
  100323. /**
  100324. * Sets the current depth function
  100325. * @param depthFunc defines the function to use
  100326. */
  100327. setDepthFunction(depthFunc: number): void;
  100328. /**
  100329. * Sets the current depth function to GREATER
  100330. */
  100331. setDepthFunctionToGreater(): void;
  100332. /**
  100333. * Sets the current depth function to GEQUAL
  100334. */
  100335. setDepthFunctionToGreaterOrEqual(): void;
  100336. /**
  100337. * Sets the current depth function to LESS
  100338. */
  100339. setDepthFunctionToLess(): void;
  100340. /**
  100341. * Sets the current depth function to LEQUAL
  100342. */
  100343. setDepthFunctionToLessOrEqual(): void;
  100344. private _cachedStencilBuffer;
  100345. private _cachedStencilFunction;
  100346. private _cachedStencilMask;
  100347. private _cachedStencilOperationPass;
  100348. private _cachedStencilOperationFail;
  100349. private _cachedStencilOperationDepthFail;
  100350. private _cachedStencilReference;
  100351. /**
  100352. * Caches the the state of the stencil buffer
  100353. */
  100354. cacheStencilState(): void;
  100355. /**
  100356. * Restores the state of the stencil buffer
  100357. */
  100358. restoreStencilState(): void;
  100359. /**
  100360. * Directly set the WebGL Viewport
  100361. * @param x defines the x coordinate of the viewport (in screen space)
  100362. * @param y defines the y coordinate of the viewport (in screen space)
  100363. * @param width defines the width of the viewport (in screen space)
  100364. * @param height defines the height of the viewport (in screen space)
  100365. * @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
  100366. */
  100367. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  100368. /**
  100369. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  100370. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  100371. * @param y defines the y-coordinate of the corner of the clear rectangle
  100372. * @param width defines the width of the clear rectangle
  100373. * @param height defines the height of the clear rectangle
  100374. * @param clearColor defines the clear color
  100375. */
  100376. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  100377. /**
  100378. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  100379. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  100380. * @param y defines the y-coordinate of the corner of the clear rectangle
  100381. * @param width defines the width of the clear rectangle
  100382. * @param height defines the height of the clear rectangle
  100383. */
  100384. enableScissor(x: number, y: number, width: number, height: number): void;
  100385. /**
  100386. * Disable previously set scissor test rectangle
  100387. */
  100388. disableScissor(): void;
  100389. protected _reportDrawCall(): void;
  100390. /**
  100391. * Initializes a webVR display and starts listening to display change events
  100392. * The onVRDisplayChangedObservable will be notified upon these changes
  100393. * @returns The onVRDisplayChangedObservable
  100394. */
  100395. initWebVR(): Observable<IDisplayChangedEventArgs>;
  100396. /** @hidden */
  100397. _prepareVRComponent(): void;
  100398. /** @hidden */
  100399. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  100400. /** @hidden */
  100401. _submitVRFrame(): void;
  100402. /**
  100403. * Call this function to leave webVR mode
  100404. * Will do nothing if webVR is not supported or if there is no webVR device
  100405. * @see http://doc.babylonjs.com/how_to/webvr_camera
  100406. */
  100407. disableVR(): void;
  100408. /**
  100409. * Gets a boolean indicating that the system is in VR mode and is presenting
  100410. * @returns true if VR mode is engaged
  100411. */
  100412. isVRPresenting(): boolean;
  100413. /** @hidden */
  100414. _requestVRFrame(): void;
  100415. /** @hidden */
  100416. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  100417. /**
  100418. * Gets the source code of the vertex shader associated with a specific webGL program
  100419. * @param program defines the program to use
  100420. * @returns a string containing the source code of the vertex shader associated with the program
  100421. */
  100422. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  100423. /**
  100424. * Gets the source code of the fragment shader associated with a specific webGL program
  100425. * @param program defines the program to use
  100426. * @returns a string containing the source code of the fragment shader associated with the program
  100427. */
  100428. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  100429. /**
  100430. * Reads pixels from the current frame buffer. Please note that this function can be slow
  100431. * @param x defines the x coordinate of the rectangle where pixels must be read
  100432. * @param y defines the y coordinate of the rectangle where pixels must be read
  100433. * @param width defines the width of the rectangle where pixels must be read
  100434. * @param height defines the height of the rectangle where pixels must be read
  100435. * @returns a Uint8Array containing RGBA colors
  100436. */
  100437. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  100438. /**
  100439. * Sets a depth stencil texture from a render target to the according uniform.
  100440. * @param channel The texture channel
  100441. * @param uniform The uniform to set
  100442. * @param texture The render target texture containing the depth stencil texture to apply
  100443. */
  100444. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  100445. /**
  100446. * Sets a texture to the webGL context from a postprocess
  100447. * @param channel defines the channel to use
  100448. * @param postProcess defines the source postprocess
  100449. */
  100450. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  100451. /**
  100452. * Binds the output of the passed in post process to the texture channel specified
  100453. * @param channel The channel the texture should be bound to
  100454. * @param postProcess The post process which's output should be bound
  100455. */
  100456. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  100457. /** @hidden */
  100458. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  100459. protected _rebuildBuffers(): void;
  100460. /** @hidden */
  100461. _renderFrame(): void;
  100462. _renderLoop(): void;
  100463. /** @hidden */
  100464. _renderViews(): boolean;
  100465. /**
  100466. * Toggle full screen mode
  100467. * @param requestPointerLock defines if a pointer lock should be requested from the user
  100468. */
  100469. switchFullscreen(requestPointerLock: boolean): void;
  100470. /**
  100471. * Enters full screen mode
  100472. * @param requestPointerLock defines if a pointer lock should be requested from the user
  100473. */
  100474. enterFullscreen(requestPointerLock: boolean): void;
  100475. /**
  100476. * Exits full screen mode
  100477. */
  100478. exitFullscreen(): void;
  100479. /**
  100480. * Enters Pointerlock mode
  100481. */
  100482. enterPointerlock(): void;
  100483. /**
  100484. * Exits Pointerlock mode
  100485. */
  100486. exitPointerlock(): void;
  100487. /**
  100488. * Begin a new frame
  100489. */
  100490. beginFrame(): void;
  100491. /**
  100492. * Enf the current frame
  100493. */
  100494. endFrame(): void;
  100495. resize(): void;
  100496. /**
  100497. * Set the compressed texture format to use, based on the formats you have, and the formats
  100498. * supported by the hardware / browser.
  100499. *
  100500. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  100501. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  100502. * to API arguments needed to compressed textures. This puts the burden on the container
  100503. * generator to house the arcane code for determining these for current & future formats.
  100504. *
  100505. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  100506. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  100507. *
  100508. * Note: The result of this call is not taken into account when a texture is base64.
  100509. *
  100510. * @param formatsAvailable defines the list of those format families you have created
  100511. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  100512. *
  100513. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  100514. * @returns The extension selected.
  100515. */
  100516. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  100517. /**
  100518. * Force a specific size of the canvas
  100519. * @param width defines the new canvas' width
  100520. * @param height defines the new canvas' height
  100521. */
  100522. setSize(width: number, height: number): void;
  100523. /**
  100524. * Updates a dynamic vertex buffer.
  100525. * @param vertexBuffer the vertex buffer to update
  100526. * @param data the data used to update the vertex buffer
  100527. * @param byteOffset the byte offset of the data
  100528. * @param byteLength the byte length of the data
  100529. */
  100530. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  100531. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  100532. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  100533. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  100534. _releaseTexture(texture: InternalTexture): void;
  100535. /**
  100536. * @hidden
  100537. * Rescales a texture
  100538. * @param source input texutre
  100539. * @param destination destination texture
  100540. * @param scene scene to use to render the resize
  100541. * @param internalFormat format to use when resizing
  100542. * @param onComplete callback to be called when resize has completed
  100543. */
  100544. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  100545. /**
  100546. * Gets the current framerate
  100547. * @returns a number representing the framerate
  100548. */
  100549. getFps(): number;
  100550. /**
  100551. * Gets the time spent between current and previous frame
  100552. * @returns a number representing the delta time in ms
  100553. */
  100554. getDeltaTime(): number;
  100555. private _measureFps;
  100556. /** @hidden */
  100557. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  100558. /**
  100559. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  100560. * @param renderTarget The render target to set the frame buffer for
  100561. */
  100562. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  100563. /**
  100564. * Update a dynamic index buffer
  100565. * @param indexBuffer defines the target index buffer
  100566. * @param indices defines the data to update
  100567. * @param offset defines the offset in the target index buffer where update should start
  100568. */
  100569. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  100570. /**
  100571. * Updates the sample count of a render target texture
  100572. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  100573. * @param texture defines the texture to update
  100574. * @param samples defines the sample count to set
  100575. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  100576. */
  100577. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  100578. /**
  100579. * Updates a depth texture Comparison Mode and Function.
  100580. * If the comparison Function is equal to 0, the mode will be set to none.
  100581. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  100582. * @param texture The texture to set the comparison function for
  100583. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  100584. */
  100585. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  100586. /**
  100587. * Creates a webGL buffer to use with instanciation
  100588. * @param capacity defines the size of the buffer
  100589. * @returns the webGL buffer
  100590. */
  100591. createInstancesBuffer(capacity: number): DataBuffer;
  100592. /**
  100593. * Delete a webGL buffer used with instanciation
  100594. * @param buffer defines the webGL buffer to delete
  100595. */
  100596. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  100597. /** @hidden */
  100598. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  100599. dispose(): void;
  100600. private _disableTouchAction;
  100601. /**
  100602. * Display the loading screen
  100603. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100604. */
  100605. displayLoadingUI(): void;
  100606. /**
  100607. * Hide the loading screen
  100608. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100609. */
  100610. hideLoadingUI(): void;
  100611. /**
  100612. * Gets the current loading screen object
  100613. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100614. */
  100615. /**
  100616. * Sets the current loading screen object
  100617. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100618. */
  100619. loadingScreen: ILoadingScreen;
  100620. /**
  100621. * Sets the current loading screen text
  100622. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100623. */
  100624. loadingUIText: string;
  100625. /**
  100626. * Sets the current loading screen background color
  100627. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100628. */
  100629. loadingUIBackgroundColor: string;
  100630. /** Pointerlock and fullscreen */
  100631. /**
  100632. * Ask the browser to promote the current element to pointerlock mode
  100633. * @param element defines the DOM element to promote
  100634. */
  100635. static _RequestPointerlock(element: HTMLElement): void;
  100636. /**
  100637. * Asks the browser to exit pointerlock mode
  100638. */
  100639. static _ExitPointerlock(): void;
  100640. /**
  100641. * Ask the browser to promote the current element to fullscreen rendering mode
  100642. * @param element defines the DOM element to promote
  100643. */
  100644. static _RequestFullscreen(element: HTMLElement): void;
  100645. /**
  100646. * Asks the browser to exit fullscreen mode
  100647. */
  100648. static _ExitFullscreen(): void;
  100649. }
  100650. }
  100651. declare module BABYLON {
  100652. /**
  100653. * The engine store class is responsible to hold all the instances of Engine and Scene created
  100654. * during the life time of the application.
  100655. */
  100656. export class EngineStore {
  100657. /** Gets the list of created engines */
  100658. static Instances: Engine[];
  100659. /** @hidden */
  100660. static _LastCreatedScene: Nullable<Scene>;
  100661. /**
  100662. * Gets the latest created engine
  100663. */
  100664. static readonly LastCreatedEngine: Nullable<Engine>;
  100665. /**
  100666. * Gets the latest created scene
  100667. */
  100668. static readonly LastCreatedScene: Nullable<Scene>;
  100669. /**
  100670. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  100671. * @ignorenaming
  100672. */
  100673. static UseFallbackTexture: boolean;
  100674. /**
  100675. * Texture content used if a texture cannot loaded
  100676. * @ignorenaming
  100677. */
  100678. static FallbackTexture: string;
  100679. }
  100680. }
  100681. declare module BABYLON {
  100682. /**
  100683. * Helper class that provides a small promise polyfill
  100684. */
  100685. export class PromisePolyfill {
  100686. /**
  100687. * Static function used to check if the polyfill is required
  100688. * If this is the case then the function will inject the polyfill to window.Promise
  100689. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  100690. */
  100691. static Apply(force?: boolean): void;
  100692. }
  100693. }
  100694. declare module BABYLON {
  100695. /**
  100696. * Interface for screenshot methods with describe argument called `size` as object with options
  100697. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  100698. */
  100699. export interface IScreenshotSize {
  100700. /**
  100701. * number in pixels for canvas height
  100702. */
  100703. height?: number;
  100704. /**
  100705. * multiplier allowing render at a higher or lower resolution
  100706. * If value is defined then height and width will be ignored and taken from camera
  100707. */
  100708. precision?: number;
  100709. /**
  100710. * number in pixels for canvas width
  100711. */
  100712. width?: number;
  100713. }
  100714. }
  100715. declare module BABYLON {
  100716. interface IColor4Like {
  100717. r: float;
  100718. g: float;
  100719. b: float;
  100720. a: float;
  100721. }
  100722. /**
  100723. * Class containing a set of static utilities functions
  100724. */
  100725. export class Tools {
  100726. /**
  100727. * Gets or sets the base URL to use to load assets
  100728. */
  100729. static BaseUrl: string;
  100730. /**
  100731. * Enable/Disable Custom HTTP Request Headers globally.
  100732. * default = false
  100733. * @see CustomRequestHeaders
  100734. */
  100735. static UseCustomRequestHeaders: boolean;
  100736. /**
  100737. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  100738. * i.e. when loading files, where the server/service expects an Authorization header
  100739. */
  100740. static CustomRequestHeaders: {
  100741. [key: string]: string;
  100742. };
  100743. /**
  100744. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  100745. */
  100746. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  100747. /**
  100748. * Default behaviour for cors in the application.
  100749. * It can be a string if the expected behavior is identical in the entire app.
  100750. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  100751. */
  100752. static CorsBehavior: string | ((url: string | string[]) => string);
  100753. /**
  100754. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  100755. * @ignorenaming
  100756. */
  100757. static UseFallbackTexture: boolean;
  100758. /**
  100759. * Use this object to register external classes like custom textures or material
  100760. * to allow the laoders to instantiate them
  100761. */
  100762. static RegisteredExternalClasses: {
  100763. [key: string]: Object;
  100764. };
  100765. /**
  100766. * Texture content used if a texture cannot loaded
  100767. * @ignorenaming
  100768. */
  100769. static fallbackTexture: string;
  100770. /**
  100771. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  100772. * @param u defines the coordinate on X axis
  100773. * @param v defines the coordinate on Y axis
  100774. * @param width defines the width of the source data
  100775. * @param height defines the height of the source data
  100776. * @param pixels defines the source byte array
  100777. * @param color defines the output color
  100778. */
  100779. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  100780. /**
  100781. * Interpolates between a and b via alpha
  100782. * @param a The lower value (returned when alpha = 0)
  100783. * @param b The upper value (returned when alpha = 1)
  100784. * @param alpha The interpolation-factor
  100785. * @return The mixed value
  100786. */
  100787. static Mix(a: number, b: number, alpha: number): number;
  100788. /**
  100789. * Tries to instantiate a new object from a given class name
  100790. * @param className defines the class name to instantiate
  100791. * @returns the new object or null if the system was not able to do the instantiation
  100792. */
  100793. static Instantiate(className: string): any;
  100794. /**
  100795. * Provides a slice function that will work even on IE
  100796. * @param data defines the array to slice
  100797. * @param start defines the start of the data (optional)
  100798. * @param end defines the end of the data (optional)
  100799. * @returns the new sliced array
  100800. */
  100801. static Slice<T>(data: T, start?: number, end?: number): T;
  100802. /**
  100803. * Polyfill for setImmediate
  100804. * @param action defines the action to execute after the current execution block
  100805. */
  100806. static SetImmediate(action: () => void): void;
  100807. /**
  100808. * Function indicating if a number is an exponent of 2
  100809. * @param value defines the value to test
  100810. * @returns true if the value is an exponent of 2
  100811. */
  100812. static IsExponentOfTwo(value: number): boolean;
  100813. private static _tmpFloatArray;
  100814. /**
  100815. * Returns the nearest 32-bit single precision float representation of a Number
  100816. * @param value A Number. If the parameter is of a different type, it will get converted
  100817. * to a number or to NaN if it cannot be converted
  100818. * @returns number
  100819. */
  100820. static FloatRound(value: number): number;
  100821. /**
  100822. * Extracts the filename from a path
  100823. * @param path defines the path to use
  100824. * @returns the filename
  100825. */
  100826. static GetFilename(path: string): string;
  100827. /**
  100828. * Extracts the "folder" part of a path (everything before the filename).
  100829. * @param uri The URI to extract the info from
  100830. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  100831. * @returns The "folder" part of the path
  100832. */
  100833. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  100834. /**
  100835. * Extracts text content from a DOM element hierarchy
  100836. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  100837. */
  100838. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  100839. /**
  100840. * Convert an angle in radians to degrees
  100841. * @param angle defines the angle to convert
  100842. * @returns the angle in degrees
  100843. */
  100844. static ToDegrees(angle: number): number;
  100845. /**
  100846. * Convert an angle in degrees to radians
  100847. * @param angle defines the angle to convert
  100848. * @returns the angle in radians
  100849. */
  100850. static ToRadians(angle: number): number;
  100851. /**
  100852. * Returns an array if obj is not an array
  100853. * @param obj defines the object to evaluate as an array
  100854. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  100855. * @returns either obj directly if obj is an array or a new array containing obj
  100856. */
  100857. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  100858. /**
  100859. * Gets the pointer prefix to use
  100860. * @returns "pointer" if touch is enabled. Else returns "mouse"
  100861. */
  100862. static GetPointerPrefix(): string;
  100863. /**
  100864. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  100865. * @param url define the url we are trying
  100866. * @param element define the dom element where to configure the cors policy
  100867. */
  100868. static SetCorsBehavior(url: string | string[], element: {
  100869. crossOrigin: string | null;
  100870. }): void;
  100871. /**
  100872. * Removes unwanted characters from an url
  100873. * @param url defines the url to clean
  100874. * @returns the cleaned url
  100875. */
  100876. static CleanUrl(url: string): string;
  100877. /**
  100878. * Gets or sets a function used to pre-process url before using them to load assets
  100879. */
  100880. static PreprocessUrl: (url: string) => string;
  100881. /**
  100882. * Loads an image as an HTMLImageElement.
  100883. * @param input url string, ArrayBuffer, or Blob to load
  100884. * @param onLoad callback called when the image successfully loads
  100885. * @param onError callback called when the image fails to load
  100886. * @param offlineProvider offline provider for caching
  100887. * @param mimeType optional mime type
  100888. * @returns the HTMLImageElement of the loaded image
  100889. */
  100890. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  100891. /**
  100892. * Loads a file from a url
  100893. * @param url url string, ArrayBuffer, or Blob to load
  100894. * @param onSuccess callback called when the file successfully loads
  100895. * @param onProgress callback called while file is loading (if the server supports this mode)
  100896. * @param offlineProvider defines the offline provider for caching
  100897. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  100898. * @param onError callback called when the file fails to load
  100899. * @returns a file request object
  100900. */
  100901. 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;
  100902. /**
  100903. * Loads a file from a url
  100904. * @param url the file url to load
  100905. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  100906. */
  100907. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  100908. /**
  100909. * Load a script (identified by an url). When the url returns, the
  100910. * content of this file is added into a new script element, attached to the DOM (body element)
  100911. * @param scriptUrl defines the url of the script to laod
  100912. * @param onSuccess defines the callback called when the script is loaded
  100913. * @param onError defines the callback to call if an error occurs
  100914. * @param scriptId defines the id of the script element
  100915. */
  100916. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  100917. /**
  100918. * Load an asynchronous script (identified by an url). When the url returns, the
  100919. * content of this file is added into a new script element, attached to the DOM (body element)
  100920. * @param scriptUrl defines the url of the script to laod
  100921. * @param scriptId defines the id of the script element
  100922. * @returns a promise request object
  100923. */
  100924. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  100925. /**
  100926. * Loads a file from a blob
  100927. * @param fileToLoad defines the blob to use
  100928. * @param callback defines the callback to call when data is loaded
  100929. * @param progressCallback defines the callback to call during loading process
  100930. * @returns a file request object
  100931. */
  100932. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  100933. /**
  100934. * Reads a file from a File object
  100935. * @param file defines the file to load
  100936. * @param onSuccess defines the callback to call when data is loaded
  100937. * @param onProgress defines the callback to call during loading process
  100938. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  100939. * @param onError defines the callback to call when an error occurs
  100940. * @returns a file request object
  100941. */
  100942. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  100943. /**
  100944. * Creates a data url from a given string content
  100945. * @param content defines the content to convert
  100946. * @returns the new data url link
  100947. */
  100948. static FileAsURL(content: string): string;
  100949. /**
  100950. * Format the given number to a specific decimal format
  100951. * @param value defines the number to format
  100952. * @param decimals defines the number of decimals to use
  100953. * @returns the formatted string
  100954. */
  100955. static Format(value: number, decimals?: number): string;
  100956. /**
  100957. * Tries to copy an object by duplicating every property
  100958. * @param source defines the source object
  100959. * @param destination defines the target object
  100960. * @param doNotCopyList defines a list of properties to avoid
  100961. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  100962. */
  100963. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  100964. /**
  100965. * Gets a boolean indicating if the given object has no own property
  100966. * @param obj defines the object to test
  100967. * @returns true if object has no own property
  100968. */
  100969. static IsEmpty(obj: any): boolean;
  100970. /**
  100971. * Function used to register events at window level
  100972. * @param windowElement defines the Window object to use
  100973. * @param events defines the events to register
  100974. */
  100975. static RegisterTopRootEvents(windowElement: Window, events: {
  100976. name: string;
  100977. handler: Nullable<(e: FocusEvent) => any>;
  100978. }[]): void;
  100979. /**
  100980. * Function used to unregister events from window level
  100981. * @param windowElement defines the Window object to use
  100982. * @param events defines the events to unregister
  100983. */
  100984. static UnregisterTopRootEvents(windowElement: Window, events: {
  100985. name: string;
  100986. handler: Nullable<(e: FocusEvent) => any>;
  100987. }[]): void;
  100988. /**
  100989. * @ignore
  100990. */
  100991. static _ScreenshotCanvas: HTMLCanvasElement;
  100992. /**
  100993. * Dumps the current bound framebuffer
  100994. * @param width defines the rendering width
  100995. * @param height defines the rendering height
  100996. * @param engine defines the hosting engine
  100997. * @param successCallback defines the callback triggered once the data are available
  100998. * @param mimeType defines the mime type of the result
  100999. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  101000. */
  101001. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  101002. /**
  101003. * Converts the canvas data to blob.
  101004. * This acts as a polyfill for browsers not supporting the to blob function.
  101005. * @param canvas Defines the canvas to extract the data from
  101006. * @param successCallback Defines the callback triggered once the data are available
  101007. * @param mimeType Defines the mime type of the result
  101008. */
  101009. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  101010. /**
  101011. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  101012. * @param successCallback defines the callback triggered once the data are available
  101013. * @param mimeType defines the mime type of the result
  101014. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  101015. */
  101016. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  101017. /**
  101018. * Downloads a blob in the browser
  101019. * @param blob defines the blob to download
  101020. * @param fileName defines the name of the downloaded file
  101021. */
  101022. static Download(blob: Blob, fileName: string): void;
  101023. /**
  101024. * Captures a screenshot of the current rendering
  101025. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  101026. * @param engine defines the rendering engine
  101027. * @param camera defines the source camera
  101028. * @param size This parameter can be set to a single number or to an object with the
  101029. * following (optional) properties: precision, width, height. If a single number is passed,
  101030. * it will be used for both width and height. If an object is passed, the screenshot size
  101031. * will be derived from the parameters. The precision property is a multiplier allowing
  101032. * rendering at a higher or lower resolution
  101033. * @param successCallback defines the callback receives a single parameter which contains the
  101034. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  101035. * src parameter of an <img> to display it
  101036. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  101037. * Check your browser for supported MIME types
  101038. */
  101039. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  101040. /**
  101041. * Captures a screenshot of the current rendering
  101042. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  101043. * @param engine defines the rendering engine
  101044. * @param camera defines the source camera
  101045. * @param size This parameter can be set to a single number or to an object with the
  101046. * following (optional) properties: precision, width, height. If a single number is passed,
  101047. * it will be used for both width and height. If an object is passed, the screenshot size
  101048. * will be derived from the parameters. The precision property is a multiplier allowing
  101049. * rendering at a higher or lower resolution
  101050. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  101051. * Check your browser for supported MIME types
  101052. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  101053. * to the src parameter of an <img> to display it
  101054. */
  101055. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  101056. /**
  101057. * Generates an image screenshot from the specified camera.
  101058. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  101059. * @param engine The engine to use for rendering
  101060. * @param camera The camera to use for rendering
  101061. * @param size This parameter can be set to a single number or to an object with the
  101062. * following (optional) properties: precision, width, height. If a single number is passed,
  101063. * it will be used for both width and height. If an object is passed, the screenshot size
  101064. * will be derived from the parameters. The precision property is a multiplier allowing
  101065. * rendering at a higher or lower resolution
  101066. * @param successCallback The callback receives a single parameter which contains the
  101067. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  101068. * src parameter of an <img> to display it
  101069. * @param mimeType The MIME type of the screenshot image (default: image/png).
  101070. * Check your browser for supported MIME types
  101071. * @param samples Texture samples (default: 1)
  101072. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  101073. * @param fileName A name for for the downloaded file.
  101074. */
  101075. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  101076. /**
  101077. * Generates an image screenshot from the specified camera.
  101078. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  101079. * @param engine The engine to use for rendering
  101080. * @param camera The camera to use for rendering
  101081. * @param size This parameter can be set to a single number or to an object with the
  101082. * following (optional) properties: precision, width, height. If a single number is passed,
  101083. * it will be used for both width and height. If an object is passed, the screenshot size
  101084. * will be derived from the parameters. The precision property is a multiplier allowing
  101085. * rendering at a higher or lower resolution
  101086. * @param mimeType The MIME type of the screenshot image (default: image/png).
  101087. * Check your browser for supported MIME types
  101088. * @param samples Texture samples (default: 1)
  101089. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  101090. * @param fileName A name for for the downloaded file.
  101091. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  101092. * to the src parameter of an <img> to display it
  101093. */
  101094. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  101095. /**
  101096. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  101097. * Be aware Math.random() could cause collisions, but:
  101098. * "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"
  101099. * @returns a pseudo random id
  101100. */
  101101. static RandomId(): string;
  101102. /**
  101103. * Test if the given uri is a base64 string
  101104. * @param uri The uri to test
  101105. * @return True if the uri is a base64 string or false otherwise
  101106. */
  101107. static IsBase64(uri: string): boolean;
  101108. /**
  101109. * Decode the given base64 uri.
  101110. * @param uri The uri to decode
  101111. * @return The decoded base64 data.
  101112. */
  101113. static DecodeBase64(uri: string): ArrayBuffer;
  101114. /**
  101115. * Gets the absolute url.
  101116. * @param url the input url
  101117. * @return the absolute url
  101118. */
  101119. static GetAbsoluteUrl(url: string): string;
  101120. /**
  101121. * No log
  101122. */
  101123. static readonly NoneLogLevel: number;
  101124. /**
  101125. * Only message logs
  101126. */
  101127. static readonly MessageLogLevel: number;
  101128. /**
  101129. * Only warning logs
  101130. */
  101131. static readonly WarningLogLevel: number;
  101132. /**
  101133. * Only error logs
  101134. */
  101135. static readonly ErrorLogLevel: number;
  101136. /**
  101137. * All logs
  101138. */
  101139. static readonly AllLogLevel: number;
  101140. /**
  101141. * Gets a value indicating the number of loading errors
  101142. * @ignorenaming
  101143. */
  101144. static readonly errorsCount: number;
  101145. /**
  101146. * Callback called when a new log is added
  101147. */
  101148. static OnNewCacheEntry: (entry: string) => void;
  101149. /**
  101150. * Log a message to the console
  101151. * @param message defines the message to log
  101152. */
  101153. static Log(message: string): void;
  101154. /**
  101155. * Write a warning message to the console
  101156. * @param message defines the message to log
  101157. */
  101158. static Warn(message: string): void;
  101159. /**
  101160. * Write an error message to the console
  101161. * @param message defines the message to log
  101162. */
  101163. static Error(message: string): void;
  101164. /**
  101165. * Gets current log cache (list of logs)
  101166. */
  101167. static readonly LogCache: string;
  101168. /**
  101169. * Clears the log cache
  101170. */
  101171. static ClearLogCache(): void;
  101172. /**
  101173. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  101174. */
  101175. static LogLevels: number;
  101176. /**
  101177. * Checks if the window object exists
  101178. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  101179. */
  101180. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  101181. /**
  101182. * No performance log
  101183. */
  101184. static readonly PerformanceNoneLogLevel: number;
  101185. /**
  101186. * Use user marks to log performance
  101187. */
  101188. static readonly PerformanceUserMarkLogLevel: number;
  101189. /**
  101190. * Log performance to the console
  101191. */
  101192. static readonly PerformanceConsoleLogLevel: number;
  101193. private static _performance;
  101194. /**
  101195. * Sets the current performance log level
  101196. */
  101197. static PerformanceLogLevel: number;
  101198. private static _StartPerformanceCounterDisabled;
  101199. private static _EndPerformanceCounterDisabled;
  101200. private static _StartUserMark;
  101201. private static _EndUserMark;
  101202. private static _StartPerformanceConsole;
  101203. private static _EndPerformanceConsole;
  101204. /**
  101205. * Starts a performance counter
  101206. */
  101207. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  101208. /**
  101209. * Ends a specific performance coutner
  101210. */
  101211. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  101212. /**
  101213. * Gets either window.performance.now() if supported or Date.now() else
  101214. */
  101215. static readonly Now: number;
  101216. /**
  101217. * This method will return the name of the class used to create the instance of the given object.
  101218. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  101219. * @param object the object to get the class name from
  101220. * @param isType defines if the object is actually a type
  101221. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  101222. */
  101223. static GetClassName(object: any, isType?: boolean): string;
  101224. /**
  101225. * Gets the first element of an array satisfying a given predicate
  101226. * @param array defines the array to browse
  101227. * @param predicate defines the predicate to use
  101228. * @returns null if not found or the element
  101229. */
  101230. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  101231. /**
  101232. * This method will return the name of the full name of the class, including its owning module (if any).
  101233. * 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).
  101234. * @param object the object to get the class name from
  101235. * @param isType defines if the object is actually a type
  101236. * @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.
  101237. * @ignorenaming
  101238. */
  101239. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  101240. /**
  101241. * Returns a promise that resolves after the given amount of time.
  101242. * @param delay Number of milliseconds to delay
  101243. * @returns Promise that resolves after the given amount of time
  101244. */
  101245. static DelayAsync(delay: number): Promise<void>;
  101246. }
  101247. /**
  101248. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  101249. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  101250. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  101251. * @param name The name of the class, case should be preserved
  101252. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  101253. */
  101254. export function className(name: string, module?: string): (target: Object) => void;
  101255. /**
  101256. * An implementation of a loop for asynchronous functions.
  101257. */
  101258. export class AsyncLoop {
  101259. /**
  101260. * Defines the number of iterations for the loop
  101261. */
  101262. iterations: number;
  101263. /**
  101264. * Defines the current index of the loop.
  101265. */
  101266. index: number;
  101267. private _done;
  101268. private _fn;
  101269. private _successCallback;
  101270. /**
  101271. * Constructor.
  101272. * @param iterations the number of iterations.
  101273. * @param func the function to run each iteration
  101274. * @param successCallback the callback that will be called upon succesful execution
  101275. * @param offset starting offset.
  101276. */
  101277. constructor(
  101278. /**
  101279. * Defines the number of iterations for the loop
  101280. */
  101281. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  101282. /**
  101283. * Execute the next iteration. Must be called after the last iteration was finished.
  101284. */
  101285. executeNext(): void;
  101286. /**
  101287. * Break the loop and run the success callback.
  101288. */
  101289. breakLoop(): void;
  101290. /**
  101291. * Create and run an async loop.
  101292. * @param iterations the number of iterations.
  101293. * @param fn the function to run each iteration
  101294. * @param successCallback the callback that will be called upon succesful execution
  101295. * @param offset starting offset.
  101296. * @returns the created async loop object
  101297. */
  101298. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  101299. /**
  101300. * A for-loop that will run a given number of iterations synchronous and the rest async.
  101301. * @param iterations total number of iterations
  101302. * @param syncedIterations number of synchronous iterations in each async iteration.
  101303. * @param fn the function to call each iteration.
  101304. * @param callback a success call back that will be called when iterating stops.
  101305. * @param breakFunction a break condition (optional)
  101306. * @param timeout timeout settings for the setTimeout function. default - 0.
  101307. * @returns the created async loop object
  101308. */
  101309. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  101310. }
  101311. }
  101312. declare module BABYLON {
  101313. /**
  101314. * This class implement a typical dictionary using a string as key and the generic type T as value.
  101315. * The underlying implementation relies on an associative array to ensure the best performances.
  101316. * The value can be anything including 'null' but except 'undefined'
  101317. */
  101318. export class StringDictionary<T> {
  101319. /**
  101320. * This will clear this dictionary and copy the content from the 'source' one.
  101321. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  101322. * @param source the dictionary to take the content from and copy to this dictionary
  101323. */
  101324. copyFrom(source: StringDictionary<T>): void;
  101325. /**
  101326. * Get a value based from its key
  101327. * @param key the given key to get the matching value from
  101328. * @return the value if found, otherwise undefined is returned
  101329. */
  101330. get(key: string): T | undefined;
  101331. /**
  101332. * Get a value from its key or add it if it doesn't exist.
  101333. * This method will ensure you that a given key/data will be present in the dictionary.
  101334. * @param key the given key to get the matching value from
  101335. * @param factory the factory that will create the value if the key is not present in the dictionary.
  101336. * The factory will only be invoked if there's no data for the given key.
  101337. * @return the value corresponding to the key.
  101338. */
  101339. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  101340. /**
  101341. * Get a value from its key if present in the dictionary otherwise add it
  101342. * @param key the key to get the value from
  101343. * @param val if there's no such key/value pair in the dictionary add it with this value
  101344. * @return the value corresponding to the key
  101345. */
  101346. getOrAdd(key: string, val: T): T;
  101347. /**
  101348. * Check if there's a given key in the dictionary
  101349. * @param key the key to check for
  101350. * @return true if the key is present, false otherwise
  101351. */
  101352. contains(key: string): boolean;
  101353. /**
  101354. * Add a new key and its corresponding value
  101355. * @param key the key to add
  101356. * @param value the value corresponding to the key
  101357. * @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
  101358. */
  101359. add(key: string, value: T): boolean;
  101360. /**
  101361. * Update a specific value associated to a key
  101362. * @param key defines the key to use
  101363. * @param value defines the value to store
  101364. * @returns true if the value was updated (or false if the key was not found)
  101365. */
  101366. set(key: string, value: T): boolean;
  101367. /**
  101368. * Get the element of the given key and remove it from the dictionary
  101369. * @param key defines the key to search
  101370. * @returns the value associated with the key or null if not found
  101371. */
  101372. getAndRemove(key: string): Nullable<T>;
  101373. /**
  101374. * Remove a key/value from the dictionary.
  101375. * @param key the key to remove
  101376. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  101377. */
  101378. remove(key: string): boolean;
  101379. /**
  101380. * Clear the whole content of the dictionary
  101381. */
  101382. clear(): void;
  101383. /**
  101384. * Gets the current count
  101385. */
  101386. readonly count: number;
  101387. /**
  101388. * Execute a callback on each key/val of the dictionary.
  101389. * Note that you can remove any element in this dictionary in the callback implementation
  101390. * @param callback the callback to execute on a given key/value pair
  101391. */
  101392. forEach(callback: (key: string, val: T) => void): void;
  101393. /**
  101394. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  101395. * If the callback returns null or undefined the method will iterate to the next key/value pair
  101396. * Note that you can remove any element in this dictionary in the callback implementation
  101397. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  101398. * @returns the first item
  101399. */
  101400. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  101401. private _count;
  101402. private _data;
  101403. }
  101404. }
  101405. declare module BABYLON {
  101406. /** @hidden */
  101407. export interface ICollisionCoordinator {
  101408. createCollider(): Collider;
  101409. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  101410. init(scene: Scene): void;
  101411. }
  101412. /** @hidden */
  101413. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  101414. private _scene;
  101415. private _scaledPosition;
  101416. private _scaledVelocity;
  101417. private _finalPosition;
  101418. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  101419. createCollider(): Collider;
  101420. init(scene: Scene): void;
  101421. private _collideWithWorld;
  101422. }
  101423. }
  101424. declare module BABYLON {
  101425. /**
  101426. * Class used to manage all inputs for the scene.
  101427. */
  101428. export class InputManager {
  101429. /** The distance in pixel that you have to move to prevent some events */
  101430. static DragMovementThreshold: number;
  101431. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  101432. static LongPressDelay: number;
  101433. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  101434. static DoubleClickDelay: number;
  101435. /** If you need to check double click without raising a single click at first click, enable this flag */
  101436. static ExclusiveDoubleClickMode: boolean;
  101437. private _wheelEventName;
  101438. private _onPointerMove;
  101439. private _onPointerDown;
  101440. private _onPointerUp;
  101441. private _initClickEvent;
  101442. private _initActionManager;
  101443. private _delayedSimpleClick;
  101444. private _delayedSimpleClickTimeout;
  101445. private _previousDelayedSimpleClickTimeout;
  101446. private _meshPickProceed;
  101447. private _previousButtonPressed;
  101448. private _currentPickResult;
  101449. private _previousPickResult;
  101450. private _totalPointersPressed;
  101451. private _doubleClickOccured;
  101452. private _pointerOverMesh;
  101453. private _pickedDownMesh;
  101454. private _pickedUpMesh;
  101455. private _pointerX;
  101456. private _pointerY;
  101457. private _unTranslatedPointerX;
  101458. private _unTranslatedPointerY;
  101459. private _startingPointerPosition;
  101460. private _previousStartingPointerPosition;
  101461. private _startingPointerTime;
  101462. private _previousStartingPointerTime;
  101463. private _pointerCaptures;
  101464. private _onKeyDown;
  101465. private _onKeyUp;
  101466. private _onCanvasFocusObserver;
  101467. private _onCanvasBlurObserver;
  101468. private _scene;
  101469. /**
  101470. * Creates a new InputManager
  101471. * @param scene defines the hosting scene
  101472. */
  101473. constructor(scene: Scene);
  101474. /**
  101475. * Gets the mesh that is currently under the pointer
  101476. */
  101477. readonly meshUnderPointer: Nullable<AbstractMesh>;
  101478. /**
  101479. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  101480. */
  101481. readonly unTranslatedPointer: Vector2;
  101482. /**
  101483. * Gets or sets the current on-screen X position of the pointer
  101484. */
  101485. pointerX: number;
  101486. /**
  101487. * Gets or sets the current on-screen Y position of the pointer
  101488. */
  101489. pointerY: number;
  101490. private _updatePointerPosition;
  101491. private _processPointerMove;
  101492. private _setRayOnPointerInfo;
  101493. private _checkPrePointerObservable;
  101494. /**
  101495. * Use this method to simulate a pointer move on a mesh
  101496. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101497. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101498. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101499. */
  101500. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  101501. /**
  101502. * Use this method to simulate a pointer down on a mesh
  101503. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101504. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101505. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101506. */
  101507. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  101508. private _processPointerDown;
  101509. /** @hidden */
  101510. _isPointerSwiping(): boolean;
  101511. /**
  101512. * Use this method to simulate a pointer up on a mesh
  101513. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101514. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101515. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101516. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  101517. */
  101518. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  101519. private _processPointerUp;
  101520. /**
  101521. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  101522. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  101523. * @returns true if the pointer was captured
  101524. */
  101525. isPointerCaptured(pointerId?: number): boolean;
  101526. /**
  101527. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  101528. * @param attachUp defines if you want to attach events to pointerup
  101529. * @param attachDown defines if you want to attach events to pointerdown
  101530. * @param attachMove defines if you want to attach events to pointermove
  101531. */
  101532. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  101533. /**
  101534. * Detaches all event handlers
  101535. */
  101536. detachControl(): void;
  101537. /**
  101538. * Force the value of meshUnderPointer
  101539. * @param mesh defines the mesh to use
  101540. */
  101541. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  101542. /**
  101543. * Gets the mesh under the pointer
  101544. * @returns a Mesh or null if no mesh is under the pointer
  101545. */
  101546. getPointerOverMesh(): Nullable<AbstractMesh>;
  101547. }
  101548. }
  101549. declare module BABYLON {
  101550. /**
  101551. * Helper class used to generate session unique ID
  101552. */
  101553. export class UniqueIdGenerator {
  101554. private static _UniqueIdCounter;
  101555. /**
  101556. * Gets an unique (relatively to the current scene) Id
  101557. */
  101558. static readonly UniqueId: number;
  101559. }
  101560. }
  101561. declare module BABYLON {
  101562. /**
  101563. * This class defines the direct association between an animation and a target
  101564. */
  101565. export class TargetedAnimation {
  101566. /**
  101567. * Animation to perform
  101568. */
  101569. animation: Animation;
  101570. /**
  101571. * Target to animate
  101572. */
  101573. target: any;
  101574. /**
  101575. * Serialize the object
  101576. * @returns the JSON object representing the current entity
  101577. */
  101578. serialize(): any;
  101579. }
  101580. /**
  101581. * Use this class to create coordinated animations on multiple targets
  101582. */
  101583. export class AnimationGroup implements IDisposable {
  101584. /** The name of the animation group */
  101585. name: string;
  101586. private _scene;
  101587. private _targetedAnimations;
  101588. private _animatables;
  101589. private _from;
  101590. private _to;
  101591. private _isStarted;
  101592. private _isPaused;
  101593. private _speedRatio;
  101594. private _loopAnimation;
  101595. /**
  101596. * Gets or sets the unique id of the node
  101597. */
  101598. uniqueId: number;
  101599. /**
  101600. * This observable will notify when one animation have ended
  101601. */
  101602. onAnimationEndObservable: Observable<TargetedAnimation>;
  101603. /**
  101604. * Observer raised when one animation loops
  101605. */
  101606. onAnimationLoopObservable: Observable<TargetedAnimation>;
  101607. /**
  101608. * Observer raised when all animations have looped
  101609. */
  101610. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  101611. /**
  101612. * This observable will notify when all animations have ended.
  101613. */
  101614. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  101615. /**
  101616. * This observable will notify when all animations have paused.
  101617. */
  101618. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  101619. /**
  101620. * This observable will notify when all animations are playing.
  101621. */
  101622. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  101623. /**
  101624. * Gets the first frame
  101625. */
  101626. readonly from: number;
  101627. /**
  101628. * Gets the last frame
  101629. */
  101630. readonly to: number;
  101631. /**
  101632. * Define if the animations are started
  101633. */
  101634. readonly isStarted: boolean;
  101635. /**
  101636. * Gets a value indicating that the current group is playing
  101637. */
  101638. readonly isPlaying: boolean;
  101639. /**
  101640. * Gets or sets the speed ratio to use for all animations
  101641. */
  101642. /**
  101643. * Gets or sets the speed ratio to use for all animations
  101644. */
  101645. speedRatio: number;
  101646. /**
  101647. * Gets or sets if all animations should loop or not
  101648. */
  101649. loopAnimation: boolean;
  101650. /**
  101651. * Gets the targeted animations for this animation group
  101652. */
  101653. readonly targetedAnimations: Array<TargetedAnimation>;
  101654. /**
  101655. * returning the list of animatables controlled by this animation group.
  101656. */
  101657. readonly animatables: Array<Animatable>;
  101658. /**
  101659. * Instantiates a new Animation Group.
  101660. * This helps managing several animations at once.
  101661. * @see http://doc.babylonjs.com/how_to/group
  101662. * @param name Defines the name of the group
  101663. * @param scene Defines the scene the group belongs to
  101664. */
  101665. constructor(
  101666. /** The name of the animation group */
  101667. name: string, scene?: Nullable<Scene>);
  101668. /**
  101669. * Add an animation (with its target) in the group
  101670. * @param animation defines the animation we want to add
  101671. * @param target defines the target of the animation
  101672. * @returns the TargetedAnimation object
  101673. */
  101674. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  101675. /**
  101676. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  101677. * It can add constant keys at begin or end
  101678. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  101679. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  101680. * @returns the animation group
  101681. */
  101682. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  101683. private _animationLoopCount;
  101684. private _animationLoopFlags;
  101685. private _processLoop;
  101686. /**
  101687. * Start all animations on given targets
  101688. * @param loop defines if animations must loop
  101689. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  101690. * @param from defines the from key (optional)
  101691. * @param to defines the to key (optional)
  101692. * @returns the current animation group
  101693. */
  101694. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  101695. /**
  101696. * Pause all animations
  101697. * @returns the animation group
  101698. */
  101699. pause(): AnimationGroup;
  101700. /**
  101701. * Play all animations to initial state
  101702. * This function will start() the animations if they were not started or will restart() them if they were paused
  101703. * @param loop defines if animations must loop
  101704. * @returns the animation group
  101705. */
  101706. play(loop?: boolean): AnimationGroup;
  101707. /**
  101708. * Reset all animations to initial state
  101709. * @returns the animation group
  101710. */
  101711. reset(): AnimationGroup;
  101712. /**
  101713. * Restart animations from key 0
  101714. * @returns the animation group
  101715. */
  101716. restart(): AnimationGroup;
  101717. /**
  101718. * Stop all animations
  101719. * @returns the animation group
  101720. */
  101721. stop(): AnimationGroup;
  101722. /**
  101723. * Set animation weight for all animatables
  101724. * @param weight defines the weight to use
  101725. * @return the animationGroup
  101726. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  101727. */
  101728. setWeightForAllAnimatables(weight: number): AnimationGroup;
  101729. /**
  101730. * Synchronize and normalize all animatables with a source animatable
  101731. * @param root defines the root animatable to synchronize with
  101732. * @return the animationGroup
  101733. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  101734. */
  101735. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  101736. /**
  101737. * Goes to a specific frame in this animation group
  101738. * @param frame the frame number to go to
  101739. * @return the animationGroup
  101740. */
  101741. goToFrame(frame: number): AnimationGroup;
  101742. /**
  101743. * Dispose all associated resources
  101744. */
  101745. dispose(): void;
  101746. private _checkAnimationGroupEnded;
  101747. /**
  101748. * Clone the current animation group and returns a copy
  101749. * @param newName defines the name of the new group
  101750. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  101751. * @returns the new aniamtion group
  101752. */
  101753. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  101754. /**
  101755. * Serializes the animationGroup to an object
  101756. * @returns Serialized object
  101757. */
  101758. serialize(): any;
  101759. /**
  101760. * Returns a new AnimationGroup object parsed from the source provided.
  101761. * @param parsedAnimationGroup defines the source
  101762. * @param scene defines the scene that will receive the animationGroup
  101763. * @returns a new AnimationGroup
  101764. */
  101765. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  101766. /**
  101767. * Returns the string "AnimationGroup"
  101768. * @returns "AnimationGroup"
  101769. */
  101770. getClassName(): string;
  101771. /**
  101772. * Creates a detailled string about the object
  101773. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  101774. * @returns a string representing the object
  101775. */
  101776. toString(fullDetails?: boolean): string;
  101777. }
  101778. }
  101779. declare module BABYLON {
  101780. /**
  101781. * Define an interface for all classes that will hold resources
  101782. */
  101783. export interface IDisposable {
  101784. /**
  101785. * Releases all held resources
  101786. */
  101787. dispose(): void;
  101788. }
  101789. /** Interface defining initialization parameters for Scene class */
  101790. export interface SceneOptions {
  101791. /**
  101792. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  101793. * It will improve performance when the number of geometries becomes important.
  101794. */
  101795. useGeometryUniqueIdsMap?: boolean;
  101796. /**
  101797. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  101798. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  101799. */
  101800. useMaterialMeshMap?: boolean;
  101801. /**
  101802. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  101803. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  101804. */
  101805. useClonedMeshhMap?: boolean;
  101806. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  101807. virtual?: boolean;
  101808. }
  101809. /**
  101810. * Represents a scene to be rendered by the engine.
  101811. * @see http://doc.babylonjs.com/features/scene
  101812. */
  101813. export class Scene extends AbstractScene implements IAnimatable {
  101814. /** The fog is deactivated */
  101815. static readonly FOGMODE_NONE: number;
  101816. /** The fog density is following an exponential function */
  101817. static readonly FOGMODE_EXP: number;
  101818. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  101819. static readonly FOGMODE_EXP2: number;
  101820. /** The fog density is following a linear function. */
  101821. static readonly FOGMODE_LINEAR: number;
  101822. /**
  101823. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  101824. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101825. */
  101826. static MinDeltaTime: number;
  101827. /**
  101828. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  101829. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101830. */
  101831. static MaxDeltaTime: number;
  101832. /**
  101833. * Factory used to create the default material.
  101834. * @param name The name of the material to create
  101835. * @param scene The scene to create the material for
  101836. * @returns The default material
  101837. */
  101838. static DefaultMaterialFactory(scene: Scene): Material;
  101839. /**
  101840. * Factory used to create the a collision coordinator.
  101841. * @returns The collision coordinator
  101842. */
  101843. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  101844. /** @hidden */
  101845. _inputManager: InputManager;
  101846. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  101847. cameraToUseForPointers: Nullable<Camera>;
  101848. /** @hidden */
  101849. readonly _isScene: boolean;
  101850. /**
  101851. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  101852. */
  101853. autoClear: boolean;
  101854. /**
  101855. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  101856. */
  101857. autoClearDepthAndStencil: boolean;
  101858. /**
  101859. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  101860. */
  101861. clearColor: Color4;
  101862. /**
  101863. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  101864. */
  101865. ambientColor: Color3;
  101866. /**
  101867. * This is use to store the default BRDF lookup for PBR materials in your scene.
  101868. * It should only be one of the following (if not the default embedded one):
  101869. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  101870. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  101871. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  101872. * The material properties need to be setup according to the type of texture in use.
  101873. */
  101874. environmentBRDFTexture: BaseTexture;
  101875. /** @hidden */
  101876. protected _environmentTexture: Nullable<BaseTexture>;
  101877. /**
  101878. * Texture used in all pbr material as the reflection texture.
  101879. * As in the majority of the scene they are the same (exception for multi room and so on),
  101880. * this is easier to reference from here than from all the materials.
  101881. */
  101882. /**
  101883. * Texture used in all pbr material as the reflection texture.
  101884. * As in the majority of the scene they are the same (exception for multi room and so on),
  101885. * this is easier to set here than in all the materials.
  101886. */
  101887. environmentTexture: Nullable<BaseTexture>;
  101888. /** @hidden */
  101889. protected _environmentIntensity: number;
  101890. /**
  101891. * Intensity of the environment in all pbr material.
  101892. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  101893. * As in the majority of the scene they are the same (exception for multi room and so on),
  101894. * this is easier to reference from here than from all the materials.
  101895. */
  101896. /**
  101897. * Intensity of the environment in all pbr material.
  101898. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  101899. * As in the majority of the scene they are the same (exception for multi room and so on),
  101900. * this is easier to set here than in all the materials.
  101901. */
  101902. environmentIntensity: number;
  101903. /** @hidden */
  101904. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101905. /**
  101906. * Default image processing configuration used either in the rendering
  101907. * Forward main pass or through the imageProcessingPostProcess if present.
  101908. * As in the majority of the scene they are the same (exception for multi camera),
  101909. * this is easier to reference from here than from all the materials and post process.
  101910. *
  101911. * No setter as we it is a shared configuration, you can set the values instead.
  101912. */
  101913. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  101914. private _forceWireframe;
  101915. /**
  101916. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  101917. */
  101918. forceWireframe: boolean;
  101919. private _forcePointsCloud;
  101920. /**
  101921. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  101922. */
  101923. forcePointsCloud: boolean;
  101924. /**
  101925. * Gets or sets the active clipplane 1
  101926. */
  101927. clipPlane: Nullable<Plane>;
  101928. /**
  101929. * Gets or sets the active clipplane 2
  101930. */
  101931. clipPlane2: Nullable<Plane>;
  101932. /**
  101933. * Gets or sets the active clipplane 3
  101934. */
  101935. clipPlane3: Nullable<Plane>;
  101936. /**
  101937. * Gets or sets the active clipplane 4
  101938. */
  101939. clipPlane4: Nullable<Plane>;
  101940. /**
  101941. * Gets or sets a boolean indicating if animations are enabled
  101942. */
  101943. animationsEnabled: boolean;
  101944. private _animationPropertiesOverride;
  101945. /**
  101946. * Gets or sets the animation properties override
  101947. */
  101948. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  101949. /**
  101950. * Gets or sets a boolean indicating if a constant deltatime has to be used
  101951. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  101952. */
  101953. useConstantAnimationDeltaTime: boolean;
  101954. /**
  101955. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  101956. * Please note that it requires to run a ray cast through the scene on every frame
  101957. */
  101958. constantlyUpdateMeshUnderPointer: boolean;
  101959. /**
  101960. * Defines the HTML cursor to use when hovering over interactive elements
  101961. */
  101962. hoverCursor: string;
  101963. /**
  101964. * Defines the HTML default cursor to use (empty by default)
  101965. */
  101966. defaultCursor: string;
  101967. /**
  101968. * Defines wether cursors are handled by the scene.
  101969. */
  101970. doNotHandleCursors: boolean;
  101971. /**
  101972. * This is used to call preventDefault() on pointer down
  101973. * in order to block unwanted artifacts like system double clicks
  101974. */
  101975. preventDefaultOnPointerDown: boolean;
  101976. /**
  101977. * This is used to call preventDefault() on pointer up
  101978. * in order to block unwanted artifacts like system double clicks
  101979. */
  101980. preventDefaultOnPointerUp: boolean;
  101981. /**
  101982. * Gets or sets user defined metadata
  101983. */
  101984. metadata: any;
  101985. /**
  101986. * For internal use only. Please do not use.
  101987. */
  101988. reservedDataStore: any;
  101989. /**
  101990. * Gets the name of the plugin used to load this scene (null by default)
  101991. */
  101992. loadingPluginName: string;
  101993. /**
  101994. * Use this array to add regular expressions used to disable offline support for specific urls
  101995. */
  101996. disableOfflineSupportExceptionRules: RegExp[];
  101997. /**
  101998. * An event triggered when the scene is disposed.
  101999. */
  102000. onDisposeObservable: Observable<Scene>;
  102001. private _onDisposeObserver;
  102002. /** Sets a function to be executed when this scene is disposed. */
  102003. onDispose: () => void;
  102004. /**
  102005. * An event triggered before rendering the scene (right after animations and physics)
  102006. */
  102007. onBeforeRenderObservable: Observable<Scene>;
  102008. private _onBeforeRenderObserver;
  102009. /** Sets a function to be executed before rendering this scene */
  102010. beforeRender: Nullable<() => void>;
  102011. /**
  102012. * An event triggered after rendering the scene
  102013. */
  102014. onAfterRenderObservable: Observable<Scene>;
  102015. /**
  102016. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  102017. */
  102018. onAfterRenderCameraObservable: Observable<Camera>;
  102019. private _onAfterRenderObserver;
  102020. /** Sets a function to be executed after rendering this scene */
  102021. afterRender: Nullable<() => void>;
  102022. /**
  102023. * An event triggered before animating the scene
  102024. */
  102025. onBeforeAnimationsObservable: Observable<Scene>;
  102026. /**
  102027. * An event triggered after animations processing
  102028. */
  102029. onAfterAnimationsObservable: Observable<Scene>;
  102030. /**
  102031. * An event triggered before draw calls are ready to be sent
  102032. */
  102033. onBeforeDrawPhaseObservable: Observable<Scene>;
  102034. /**
  102035. * An event triggered after draw calls have been sent
  102036. */
  102037. onAfterDrawPhaseObservable: Observable<Scene>;
  102038. /**
  102039. * An event triggered when the scene is ready
  102040. */
  102041. onReadyObservable: Observable<Scene>;
  102042. /**
  102043. * An event triggered before rendering a camera
  102044. */
  102045. onBeforeCameraRenderObservable: Observable<Camera>;
  102046. private _onBeforeCameraRenderObserver;
  102047. /** Sets a function to be executed before rendering a camera*/
  102048. beforeCameraRender: () => void;
  102049. /**
  102050. * An event triggered after rendering a camera
  102051. */
  102052. onAfterCameraRenderObservable: Observable<Camera>;
  102053. private _onAfterCameraRenderObserver;
  102054. /** Sets a function to be executed after rendering a camera*/
  102055. afterCameraRender: () => void;
  102056. /**
  102057. * An event triggered when active meshes evaluation is about to start
  102058. */
  102059. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  102060. /**
  102061. * An event triggered when active meshes evaluation is done
  102062. */
  102063. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  102064. /**
  102065. * An event triggered when particles rendering is about to start
  102066. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  102067. */
  102068. onBeforeParticlesRenderingObservable: Observable<Scene>;
  102069. /**
  102070. * An event triggered when particles rendering is done
  102071. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  102072. */
  102073. onAfterParticlesRenderingObservable: Observable<Scene>;
  102074. /**
  102075. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  102076. */
  102077. onDataLoadedObservable: Observable<Scene>;
  102078. /**
  102079. * An event triggered when a camera is created
  102080. */
  102081. onNewCameraAddedObservable: Observable<Camera>;
  102082. /**
  102083. * An event triggered when a camera is removed
  102084. */
  102085. onCameraRemovedObservable: Observable<Camera>;
  102086. /**
  102087. * An event triggered when a light is created
  102088. */
  102089. onNewLightAddedObservable: Observable<Light>;
  102090. /**
  102091. * An event triggered when a light is removed
  102092. */
  102093. onLightRemovedObservable: Observable<Light>;
  102094. /**
  102095. * An event triggered when a geometry is created
  102096. */
  102097. onNewGeometryAddedObservable: Observable<Geometry>;
  102098. /**
  102099. * An event triggered when a geometry is removed
  102100. */
  102101. onGeometryRemovedObservable: Observable<Geometry>;
  102102. /**
  102103. * An event triggered when a transform node is created
  102104. */
  102105. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  102106. /**
  102107. * An event triggered when a transform node is removed
  102108. */
  102109. onTransformNodeRemovedObservable: Observable<TransformNode>;
  102110. /**
  102111. * An event triggered when a mesh is created
  102112. */
  102113. onNewMeshAddedObservable: Observable<AbstractMesh>;
  102114. /**
  102115. * An event triggered when a mesh is removed
  102116. */
  102117. onMeshRemovedObservable: Observable<AbstractMesh>;
  102118. /**
  102119. * An event triggered when a skeleton is created
  102120. */
  102121. onNewSkeletonAddedObservable: Observable<Skeleton>;
  102122. /**
  102123. * An event triggered when a skeleton is removed
  102124. */
  102125. onSkeletonRemovedObservable: Observable<Skeleton>;
  102126. /**
  102127. * An event triggered when a material is created
  102128. */
  102129. onNewMaterialAddedObservable: Observable<Material>;
  102130. /**
  102131. * An event triggered when a material is removed
  102132. */
  102133. onMaterialRemovedObservable: Observable<Material>;
  102134. /**
  102135. * An event triggered when a texture is created
  102136. */
  102137. onNewTextureAddedObservable: Observable<BaseTexture>;
  102138. /**
  102139. * An event triggered when a texture is removed
  102140. */
  102141. onTextureRemovedObservable: Observable<BaseTexture>;
  102142. /**
  102143. * An event triggered when render targets are about to be rendered
  102144. * Can happen multiple times per frame.
  102145. */
  102146. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  102147. /**
  102148. * An event triggered when render targets were rendered.
  102149. * Can happen multiple times per frame.
  102150. */
  102151. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  102152. /**
  102153. * An event triggered before calculating deterministic simulation step
  102154. */
  102155. onBeforeStepObservable: Observable<Scene>;
  102156. /**
  102157. * An event triggered after calculating deterministic simulation step
  102158. */
  102159. onAfterStepObservable: Observable<Scene>;
  102160. /**
  102161. * An event triggered when the activeCamera property is updated
  102162. */
  102163. onActiveCameraChanged: Observable<Scene>;
  102164. /**
  102165. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  102166. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  102167. * 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)
  102168. */
  102169. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  102170. /**
  102171. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  102172. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  102173. * 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)
  102174. */
  102175. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  102176. /**
  102177. * This Observable will when a mesh has been imported into the scene.
  102178. */
  102179. onMeshImportedObservable: Observable<AbstractMesh>;
  102180. /**
  102181. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  102182. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  102183. */
  102184. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  102185. /** @hidden */
  102186. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  102187. /**
  102188. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  102189. */
  102190. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  102191. /**
  102192. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  102193. */
  102194. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  102195. /**
  102196. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  102197. */
  102198. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  102199. /** Callback called when a pointer move is detected */
  102200. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  102201. /** Callback called when a pointer down is detected */
  102202. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  102203. /** Callback called when a pointer up is detected */
  102204. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  102205. /** Callback called when a pointer pick is detected */
  102206. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  102207. /**
  102208. * 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).
  102209. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  102210. */
  102211. onPrePointerObservable: Observable<PointerInfoPre>;
  102212. /**
  102213. * Observable event triggered each time an input event is received from the rendering canvas
  102214. */
  102215. onPointerObservable: Observable<PointerInfo>;
  102216. /**
  102217. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  102218. */
  102219. readonly unTranslatedPointer: Vector2;
  102220. /**
  102221. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  102222. */
  102223. static DragMovementThreshold: number;
  102224. /**
  102225. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  102226. */
  102227. static LongPressDelay: number;
  102228. /**
  102229. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  102230. */
  102231. static DoubleClickDelay: number;
  102232. /** If you need to check double click without raising a single click at first click, enable this flag */
  102233. static ExclusiveDoubleClickMode: boolean;
  102234. /** @hidden */
  102235. _mirroredCameraPosition: Nullable<Vector3>;
  102236. /**
  102237. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  102238. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  102239. */
  102240. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  102241. /**
  102242. * Observable event triggered each time an keyboard event is received from the hosting window
  102243. */
  102244. onKeyboardObservable: Observable<KeyboardInfo>;
  102245. private _useRightHandedSystem;
  102246. /**
  102247. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  102248. */
  102249. useRightHandedSystem: boolean;
  102250. private _timeAccumulator;
  102251. private _currentStepId;
  102252. private _currentInternalStep;
  102253. /**
  102254. * Sets the step Id used by deterministic lock step
  102255. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  102256. * @param newStepId defines the step Id
  102257. */
  102258. setStepId(newStepId: number): void;
  102259. /**
  102260. * Gets the step Id used by deterministic lock step
  102261. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  102262. * @returns the step Id
  102263. */
  102264. getStepId(): number;
  102265. /**
  102266. * Gets the internal step used by deterministic lock step
  102267. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  102268. * @returns the internal step
  102269. */
  102270. getInternalStep(): number;
  102271. private _fogEnabled;
  102272. /**
  102273. * Gets or sets a boolean indicating if fog is enabled on this scene
  102274. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102275. * (Default is true)
  102276. */
  102277. fogEnabled: boolean;
  102278. private _fogMode;
  102279. /**
  102280. * Gets or sets the fog mode to use
  102281. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102282. * | mode | value |
  102283. * | --- | --- |
  102284. * | FOGMODE_NONE | 0 |
  102285. * | FOGMODE_EXP | 1 |
  102286. * | FOGMODE_EXP2 | 2 |
  102287. * | FOGMODE_LINEAR | 3 |
  102288. */
  102289. fogMode: number;
  102290. /**
  102291. * Gets or sets the fog color to use
  102292. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102293. * (Default is Color3(0.2, 0.2, 0.3))
  102294. */
  102295. fogColor: Color3;
  102296. /**
  102297. * Gets or sets the fog density to use
  102298. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102299. * (Default is 0.1)
  102300. */
  102301. fogDensity: number;
  102302. /**
  102303. * Gets or sets the fog start distance to use
  102304. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102305. * (Default is 0)
  102306. */
  102307. fogStart: number;
  102308. /**
  102309. * Gets or sets the fog end distance to use
  102310. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102311. * (Default is 1000)
  102312. */
  102313. fogEnd: number;
  102314. private _shadowsEnabled;
  102315. /**
  102316. * Gets or sets a boolean indicating if shadows are enabled on this scene
  102317. */
  102318. shadowsEnabled: boolean;
  102319. private _lightsEnabled;
  102320. /**
  102321. * Gets or sets a boolean indicating if lights are enabled on this scene
  102322. */
  102323. lightsEnabled: boolean;
  102324. /** All of the active cameras added to this scene. */
  102325. activeCameras: Camera[];
  102326. /** @hidden */
  102327. _activeCamera: Nullable<Camera>;
  102328. /** Gets or sets the current active camera */
  102329. activeCamera: Nullable<Camera>;
  102330. private _defaultMaterial;
  102331. /** The default material used on meshes when no material is affected */
  102332. /** The default material used on meshes when no material is affected */
  102333. defaultMaterial: Material;
  102334. private _texturesEnabled;
  102335. /**
  102336. * Gets or sets a boolean indicating if textures are enabled on this scene
  102337. */
  102338. texturesEnabled: boolean;
  102339. /**
  102340. * Gets or sets a boolean indicating if particles are enabled on this scene
  102341. */
  102342. particlesEnabled: boolean;
  102343. /**
  102344. * Gets or sets a boolean indicating if sprites are enabled on this scene
  102345. */
  102346. spritesEnabled: boolean;
  102347. private _skeletonsEnabled;
  102348. /**
  102349. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  102350. */
  102351. skeletonsEnabled: boolean;
  102352. /**
  102353. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  102354. */
  102355. lensFlaresEnabled: boolean;
  102356. /**
  102357. * Gets or sets a boolean indicating if collisions are enabled on this scene
  102358. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  102359. */
  102360. collisionsEnabled: boolean;
  102361. private _collisionCoordinator;
  102362. /** @hidden */
  102363. readonly collisionCoordinator: ICollisionCoordinator;
  102364. /**
  102365. * Defines the gravity applied to this scene (used only for collisions)
  102366. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  102367. */
  102368. gravity: Vector3;
  102369. /**
  102370. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  102371. */
  102372. postProcessesEnabled: boolean;
  102373. /**
  102374. * The list of postprocesses added to the scene
  102375. */
  102376. postProcesses: PostProcess[];
  102377. /**
  102378. * Gets the current postprocess manager
  102379. */
  102380. postProcessManager: PostProcessManager;
  102381. /**
  102382. * Gets or sets a boolean indicating if render targets are enabled on this scene
  102383. */
  102384. renderTargetsEnabled: boolean;
  102385. /**
  102386. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  102387. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  102388. */
  102389. dumpNextRenderTargets: boolean;
  102390. /**
  102391. * The list of user defined render targets added to the scene
  102392. */
  102393. customRenderTargets: RenderTargetTexture[];
  102394. /**
  102395. * Defines if texture loading must be delayed
  102396. * If true, textures will only be loaded when they need to be rendered
  102397. */
  102398. useDelayedTextureLoading: boolean;
  102399. /**
  102400. * Gets the list of meshes imported to the scene through SceneLoader
  102401. */
  102402. importedMeshesFiles: String[];
  102403. /**
  102404. * Gets or sets a boolean indicating if probes are enabled on this scene
  102405. */
  102406. probesEnabled: boolean;
  102407. /**
  102408. * Gets or sets the current offline provider to use to store scene data
  102409. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  102410. */
  102411. offlineProvider: IOfflineProvider;
  102412. /**
  102413. * Gets or sets the action manager associated with the scene
  102414. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  102415. */
  102416. actionManager: AbstractActionManager;
  102417. private _meshesForIntersections;
  102418. /**
  102419. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  102420. */
  102421. proceduralTexturesEnabled: boolean;
  102422. private _engine;
  102423. private _totalVertices;
  102424. /** @hidden */
  102425. _activeIndices: PerfCounter;
  102426. /** @hidden */
  102427. _activeParticles: PerfCounter;
  102428. /** @hidden */
  102429. _activeBones: PerfCounter;
  102430. private _animationRatio;
  102431. /** @hidden */
  102432. _animationTimeLast: number;
  102433. /** @hidden */
  102434. _animationTime: number;
  102435. /**
  102436. * Gets or sets a general scale for animation speed
  102437. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  102438. */
  102439. animationTimeScale: number;
  102440. /** @hidden */
  102441. _cachedMaterial: Nullable<Material>;
  102442. /** @hidden */
  102443. _cachedEffect: Nullable<Effect>;
  102444. /** @hidden */
  102445. _cachedVisibility: Nullable<number>;
  102446. private _renderId;
  102447. private _frameId;
  102448. private _executeWhenReadyTimeoutId;
  102449. private _intermediateRendering;
  102450. private _viewUpdateFlag;
  102451. private _projectionUpdateFlag;
  102452. /** @hidden */
  102453. _toBeDisposed: Nullable<IDisposable>[];
  102454. private _activeRequests;
  102455. /** @hidden */
  102456. _pendingData: any[];
  102457. private _isDisposed;
  102458. /**
  102459. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  102460. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  102461. */
  102462. dispatchAllSubMeshesOfActiveMeshes: boolean;
  102463. private _activeMeshes;
  102464. private _processedMaterials;
  102465. private _renderTargets;
  102466. /** @hidden */
  102467. _activeParticleSystems: SmartArray<IParticleSystem>;
  102468. private _activeSkeletons;
  102469. private _softwareSkinnedMeshes;
  102470. private _renderingManager;
  102471. /** @hidden */
  102472. _activeAnimatables: Animatable[];
  102473. private _transformMatrix;
  102474. private _sceneUbo;
  102475. /** @hidden */
  102476. _viewMatrix: Matrix;
  102477. private _projectionMatrix;
  102478. /** @hidden */
  102479. _forcedViewPosition: Nullable<Vector3>;
  102480. /** @hidden */
  102481. _frustumPlanes: Plane[];
  102482. /**
  102483. * Gets the list of frustum planes (built from the active camera)
  102484. */
  102485. readonly frustumPlanes: Plane[];
  102486. /**
  102487. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  102488. * This is useful if there are more lights that the maximum simulteanous authorized
  102489. */
  102490. requireLightSorting: boolean;
  102491. /** @hidden */
  102492. readonly useMaterialMeshMap: boolean;
  102493. /** @hidden */
  102494. readonly useClonedMeshhMap: boolean;
  102495. private _externalData;
  102496. private _uid;
  102497. /**
  102498. * @hidden
  102499. * Backing store of defined scene components.
  102500. */
  102501. _components: ISceneComponent[];
  102502. /**
  102503. * @hidden
  102504. * Backing store of defined scene components.
  102505. */
  102506. _serializableComponents: ISceneSerializableComponent[];
  102507. /**
  102508. * List of components to register on the next registration step.
  102509. */
  102510. private _transientComponents;
  102511. /**
  102512. * Registers the transient components if needed.
  102513. */
  102514. private _registerTransientComponents;
  102515. /**
  102516. * @hidden
  102517. * Add a component to the scene.
  102518. * Note that the ccomponent could be registered on th next frame if this is called after
  102519. * the register component stage.
  102520. * @param component Defines the component to add to the scene
  102521. */
  102522. _addComponent(component: ISceneComponent): void;
  102523. /**
  102524. * @hidden
  102525. * Gets a component from the scene.
  102526. * @param name defines the name of the component to retrieve
  102527. * @returns the component or null if not present
  102528. */
  102529. _getComponent(name: string): Nullable<ISceneComponent>;
  102530. /**
  102531. * @hidden
  102532. * Defines the actions happening before camera updates.
  102533. */
  102534. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  102535. /**
  102536. * @hidden
  102537. * Defines the actions happening before clear the canvas.
  102538. */
  102539. _beforeClearStage: Stage<SimpleStageAction>;
  102540. /**
  102541. * @hidden
  102542. * Defines the actions when collecting render targets for the frame.
  102543. */
  102544. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  102545. /**
  102546. * @hidden
  102547. * Defines the actions happening for one camera in the frame.
  102548. */
  102549. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  102550. /**
  102551. * @hidden
  102552. * Defines the actions happening during the per mesh ready checks.
  102553. */
  102554. _isReadyForMeshStage: Stage<MeshStageAction>;
  102555. /**
  102556. * @hidden
  102557. * Defines the actions happening before evaluate active mesh checks.
  102558. */
  102559. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  102560. /**
  102561. * @hidden
  102562. * Defines the actions happening during the evaluate sub mesh checks.
  102563. */
  102564. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  102565. /**
  102566. * @hidden
  102567. * Defines the actions happening during the active mesh stage.
  102568. */
  102569. _activeMeshStage: Stage<ActiveMeshStageAction>;
  102570. /**
  102571. * @hidden
  102572. * Defines the actions happening during the per camera render target step.
  102573. */
  102574. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  102575. /**
  102576. * @hidden
  102577. * Defines the actions happening just before the active camera is drawing.
  102578. */
  102579. _beforeCameraDrawStage: Stage<CameraStageAction>;
  102580. /**
  102581. * @hidden
  102582. * Defines the actions happening just before a render target is drawing.
  102583. */
  102584. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  102585. /**
  102586. * @hidden
  102587. * Defines the actions happening just before a rendering group is drawing.
  102588. */
  102589. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  102590. /**
  102591. * @hidden
  102592. * Defines the actions happening just before a mesh is drawing.
  102593. */
  102594. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  102595. /**
  102596. * @hidden
  102597. * Defines the actions happening just after a mesh has been drawn.
  102598. */
  102599. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  102600. /**
  102601. * @hidden
  102602. * Defines the actions happening just after a rendering group has been drawn.
  102603. */
  102604. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  102605. /**
  102606. * @hidden
  102607. * Defines the actions happening just after the active camera has been drawn.
  102608. */
  102609. _afterCameraDrawStage: Stage<CameraStageAction>;
  102610. /**
  102611. * @hidden
  102612. * Defines the actions happening just after a render target has been drawn.
  102613. */
  102614. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  102615. /**
  102616. * @hidden
  102617. * Defines the actions happening just after rendering all cameras and computing intersections.
  102618. */
  102619. _afterRenderStage: Stage<SimpleStageAction>;
  102620. /**
  102621. * @hidden
  102622. * Defines the actions happening when a pointer move event happens.
  102623. */
  102624. _pointerMoveStage: Stage<PointerMoveStageAction>;
  102625. /**
  102626. * @hidden
  102627. * Defines the actions happening when a pointer down event happens.
  102628. */
  102629. _pointerDownStage: Stage<PointerUpDownStageAction>;
  102630. /**
  102631. * @hidden
  102632. * Defines the actions happening when a pointer up event happens.
  102633. */
  102634. _pointerUpStage: Stage<PointerUpDownStageAction>;
  102635. /**
  102636. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  102637. */
  102638. private geometriesByUniqueId;
  102639. /**
  102640. * Creates a new Scene
  102641. * @param engine defines the engine to use to render this scene
  102642. * @param options defines the scene options
  102643. */
  102644. constructor(engine: Engine, options?: SceneOptions);
  102645. /**
  102646. * Gets a string idenfifying the name of the class
  102647. * @returns "Scene" string
  102648. */
  102649. getClassName(): string;
  102650. private _defaultMeshCandidates;
  102651. /**
  102652. * @hidden
  102653. */
  102654. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  102655. private _defaultSubMeshCandidates;
  102656. /**
  102657. * @hidden
  102658. */
  102659. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  102660. /**
  102661. * Sets the default candidate providers for the scene.
  102662. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  102663. * and getCollidingSubMeshCandidates to their default function
  102664. */
  102665. setDefaultCandidateProviders(): void;
  102666. /**
  102667. * Gets the mesh that is currently under the pointer
  102668. */
  102669. readonly meshUnderPointer: Nullable<AbstractMesh>;
  102670. /**
  102671. * Gets or sets the current on-screen X position of the pointer
  102672. */
  102673. pointerX: number;
  102674. /**
  102675. * Gets or sets the current on-screen Y position of the pointer
  102676. */
  102677. pointerY: number;
  102678. /**
  102679. * Gets the cached material (ie. the latest rendered one)
  102680. * @returns the cached material
  102681. */
  102682. getCachedMaterial(): Nullable<Material>;
  102683. /**
  102684. * Gets the cached effect (ie. the latest rendered one)
  102685. * @returns the cached effect
  102686. */
  102687. getCachedEffect(): Nullable<Effect>;
  102688. /**
  102689. * Gets the cached visibility state (ie. the latest rendered one)
  102690. * @returns the cached visibility state
  102691. */
  102692. getCachedVisibility(): Nullable<number>;
  102693. /**
  102694. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  102695. * @param material defines the current material
  102696. * @param effect defines the current effect
  102697. * @param visibility defines the current visibility state
  102698. * @returns true if one parameter is not cached
  102699. */
  102700. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  102701. /**
  102702. * Gets the engine associated with the scene
  102703. * @returns an Engine
  102704. */
  102705. getEngine(): Engine;
  102706. /**
  102707. * Gets the total number of vertices rendered per frame
  102708. * @returns the total number of vertices rendered per frame
  102709. */
  102710. getTotalVertices(): number;
  102711. /**
  102712. * Gets the performance counter for total vertices
  102713. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102714. */
  102715. readonly totalVerticesPerfCounter: PerfCounter;
  102716. /**
  102717. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  102718. * @returns the total number of active indices rendered per frame
  102719. */
  102720. getActiveIndices(): number;
  102721. /**
  102722. * Gets the performance counter for active indices
  102723. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102724. */
  102725. readonly totalActiveIndicesPerfCounter: PerfCounter;
  102726. /**
  102727. * Gets the total number of active particles rendered per frame
  102728. * @returns the total number of active particles rendered per frame
  102729. */
  102730. getActiveParticles(): number;
  102731. /**
  102732. * Gets the performance counter for active particles
  102733. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102734. */
  102735. readonly activeParticlesPerfCounter: PerfCounter;
  102736. /**
  102737. * Gets the total number of active bones rendered per frame
  102738. * @returns the total number of active bones rendered per frame
  102739. */
  102740. getActiveBones(): number;
  102741. /**
  102742. * Gets the performance counter for active bones
  102743. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102744. */
  102745. readonly activeBonesPerfCounter: PerfCounter;
  102746. /**
  102747. * Gets the array of active meshes
  102748. * @returns an array of AbstractMesh
  102749. */
  102750. getActiveMeshes(): SmartArray<AbstractMesh>;
  102751. /**
  102752. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  102753. * @returns a number
  102754. */
  102755. getAnimationRatio(): number;
  102756. /**
  102757. * Gets an unique Id for the current render phase
  102758. * @returns a number
  102759. */
  102760. getRenderId(): number;
  102761. /**
  102762. * Gets an unique Id for the current frame
  102763. * @returns a number
  102764. */
  102765. getFrameId(): number;
  102766. /** Call this function if you want to manually increment the render Id*/
  102767. incrementRenderId(): void;
  102768. private _createUbo;
  102769. /**
  102770. * Use this method to simulate a pointer move on a mesh
  102771. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102772. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102773. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102774. * @returns the current scene
  102775. */
  102776. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  102777. /**
  102778. * Use this method to simulate a pointer down on a mesh
  102779. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102780. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102781. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102782. * @returns the current scene
  102783. */
  102784. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  102785. /**
  102786. * Use this method to simulate a pointer up on a mesh
  102787. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102788. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102789. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102790. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  102791. * @returns the current scene
  102792. */
  102793. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  102794. /**
  102795. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  102796. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  102797. * @returns true if the pointer was captured
  102798. */
  102799. isPointerCaptured(pointerId?: number): boolean;
  102800. /**
  102801. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  102802. * @param attachUp defines if you want to attach events to pointerup
  102803. * @param attachDown defines if you want to attach events to pointerdown
  102804. * @param attachMove defines if you want to attach events to pointermove
  102805. */
  102806. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  102807. /** Detaches all event handlers*/
  102808. detachControl(): void;
  102809. /**
  102810. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  102811. * Delay loaded resources are not taking in account
  102812. * @return true if all required resources are ready
  102813. */
  102814. isReady(): boolean;
  102815. /** Resets all cached information relative to material (including effect and visibility) */
  102816. resetCachedMaterial(): void;
  102817. /**
  102818. * Registers a function to be called before every frame render
  102819. * @param func defines the function to register
  102820. */
  102821. registerBeforeRender(func: () => void): void;
  102822. /**
  102823. * Unregisters a function called before every frame render
  102824. * @param func defines the function to unregister
  102825. */
  102826. unregisterBeforeRender(func: () => void): void;
  102827. /**
  102828. * Registers a function to be called after every frame render
  102829. * @param func defines the function to register
  102830. */
  102831. registerAfterRender(func: () => void): void;
  102832. /**
  102833. * Unregisters a function called after every frame render
  102834. * @param func defines the function to unregister
  102835. */
  102836. unregisterAfterRender(func: () => void): void;
  102837. private _executeOnceBeforeRender;
  102838. /**
  102839. * The provided function will run before render once and will be disposed afterwards.
  102840. * A timeout delay can be provided so that the function will be executed in N ms.
  102841. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  102842. * @param func The function to be executed.
  102843. * @param timeout optional delay in ms
  102844. */
  102845. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  102846. /** @hidden */
  102847. _addPendingData(data: any): void;
  102848. /** @hidden */
  102849. _removePendingData(data: any): void;
  102850. /**
  102851. * Returns the number of items waiting to be loaded
  102852. * @returns the number of items waiting to be loaded
  102853. */
  102854. getWaitingItemsCount(): number;
  102855. /**
  102856. * Returns a boolean indicating if the scene is still loading data
  102857. */
  102858. readonly isLoading: boolean;
  102859. /**
  102860. * Registers a function to be executed when the scene is ready
  102861. * @param {Function} func - the function to be executed
  102862. */
  102863. executeWhenReady(func: () => void): void;
  102864. /**
  102865. * Returns a promise that resolves when the scene is ready
  102866. * @returns A promise that resolves when the scene is ready
  102867. */
  102868. whenReadyAsync(): Promise<void>;
  102869. /** @hidden */
  102870. _checkIsReady(): void;
  102871. /**
  102872. * Gets all animatable attached to the scene
  102873. */
  102874. readonly animatables: Animatable[];
  102875. /**
  102876. * Resets the last animation time frame.
  102877. * Useful to override when animations start running when loading a scene for the first time.
  102878. */
  102879. resetLastAnimationTimeFrame(): void;
  102880. /**
  102881. * Gets the current view matrix
  102882. * @returns a Matrix
  102883. */
  102884. getViewMatrix(): Matrix;
  102885. /**
  102886. * Gets the current projection matrix
  102887. * @returns a Matrix
  102888. */
  102889. getProjectionMatrix(): Matrix;
  102890. /**
  102891. * Gets the current transform matrix
  102892. * @returns a Matrix made of View * Projection
  102893. */
  102894. getTransformMatrix(): Matrix;
  102895. /**
  102896. * Sets the current transform matrix
  102897. * @param viewL defines the View matrix to use
  102898. * @param projectionL defines the Projection matrix to use
  102899. * @param viewR defines the right View matrix to use (if provided)
  102900. * @param projectionR defines the right Projection matrix to use (if provided)
  102901. */
  102902. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  102903. /**
  102904. * Gets the uniform buffer used to store scene data
  102905. * @returns a UniformBuffer
  102906. */
  102907. getSceneUniformBuffer(): UniformBuffer;
  102908. /**
  102909. * Gets an unique (relatively to the current scene) Id
  102910. * @returns an unique number for the scene
  102911. */
  102912. getUniqueId(): number;
  102913. /**
  102914. * Add a mesh to the list of scene's meshes
  102915. * @param newMesh defines the mesh to add
  102916. * @param recursive if all child meshes should also be added to the scene
  102917. */
  102918. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  102919. /**
  102920. * Remove a mesh for the list of scene's meshes
  102921. * @param toRemove defines the mesh to remove
  102922. * @param recursive if all child meshes should also be removed from the scene
  102923. * @returns the index where the mesh was in the mesh list
  102924. */
  102925. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  102926. /**
  102927. * Add a transform node to the list of scene's transform nodes
  102928. * @param newTransformNode defines the transform node to add
  102929. */
  102930. addTransformNode(newTransformNode: TransformNode): void;
  102931. /**
  102932. * Remove a transform node for the list of scene's transform nodes
  102933. * @param toRemove defines the transform node to remove
  102934. * @returns the index where the transform node was in the transform node list
  102935. */
  102936. removeTransformNode(toRemove: TransformNode): number;
  102937. /**
  102938. * Remove a skeleton for the list of scene's skeletons
  102939. * @param toRemove defines the skeleton to remove
  102940. * @returns the index where the skeleton was in the skeleton list
  102941. */
  102942. removeSkeleton(toRemove: Skeleton): number;
  102943. /**
  102944. * Remove a morph target for the list of scene's morph targets
  102945. * @param toRemove defines the morph target to remove
  102946. * @returns the index where the morph target was in the morph target list
  102947. */
  102948. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  102949. /**
  102950. * Remove a light for the list of scene's lights
  102951. * @param toRemove defines the light to remove
  102952. * @returns the index where the light was in the light list
  102953. */
  102954. removeLight(toRemove: Light): number;
  102955. /**
  102956. * Remove a camera for the list of scene's cameras
  102957. * @param toRemove defines the camera to remove
  102958. * @returns the index where the camera was in the camera list
  102959. */
  102960. removeCamera(toRemove: Camera): number;
  102961. /**
  102962. * Remove a particle system for the list of scene's particle systems
  102963. * @param toRemove defines the particle system to remove
  102964. * @returns the index where the particle system was in the particle system list
  102965. */
  102966. removeParticleSystem(toRemove: IParticleSystem): number;
  102967. /**
  102968. * Remove a animation for the list of scene's animations
  102969. * @param toRemove defines the animation to remove
  102970. * @returns the index where the animation was in the animation list
  102971. */
  102972. removeAnimation(toRemove: Animation): number;
  102973. /**
  102974. * Will stop the animation of the given target
  102975. * @param target - the target
  102976. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  102977. * @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)
  102978. */
  102979. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  102980. /**
  102981. * Removes the given animation group from this scene.
  102982. * @param toRemove The animation group to remove
  102983. * @returns The index of the removed animation group
  102984. */
  102985. removeAnimationGroup(toRemove: AnimationGroup): number;
  102986. /**
  102987. * Removes the given multi-material from this scene.
  102988. * @param toRemove The multi-material to remove
  102989. * @returns The index of the removed multi-material
  102990. */
  102991. removeMultiMaterial(toRemove: MultiMaterial): number;
  102992. /**
  102993. * Removes the given material from this scene.
  102994. * @param toRemove The material to remove
  102995. * @returns The index of the removed material
  102996. */
  102997. removeMaterial(toRemove: Material): number;
  102998. /**
  102999. * Removes the given action manager from this scene.
  103000. * @param toRemove The action manager to remove
  103001. * @returns The index of the removed action manager
  103002. */
  103003. removeActionManager(toRemove: AbstractActionManager): number;
  103004. /**
  103005. * Removes the given texture from this scene.
  103006. * @param toRemove The texture to remove
  103007. * @returns The index of the removed texture
  103008. */
  103009. removeTexture(toRemove: BaseTexture): number;
  103010. /**
  103011. * Adds the given light to this scene
  103012. * @param newLight The light to add
  103013. */
  103014. addLight(newLight: Light): void;
  103015. /**
  103016. * Sorts the list list based on light priorities
  103017. */
  103018. sortLightsByPriority(): void;
  103019. /**
  103020. * Adds the given camera to this scene
  103021. * @param newCamera The camera to add
  103022. */
  103023. addCamera(newCamera: Camera): void;
  103024. /**
  103025. * Adds the given skeleton to this scene
  103026. * @param newSkeleton The skeleton to add
  103027. */
  103028. addSkeleton(newSkeleton: Skeleton): void;
  103029. /**
  103030. * Adds the given particle system to this scene
  103031. * @param newParticleSystem The particle system to add
  103032. */
  103033. addParticleSystem(newParticleSystem: IParticleSystem): void;
  103034. /**
  103035. * Adds the given animation to this scene
  103036. * @param newAnimation The animation to add
  103037. */
  103038. addAnimation(newAnimation: Animation): void;
  103039. /**
  103040. * Adds the given animation group to this scene.
  103041. * @param newAnimationGroup The animation group to add
  103042. */
  103043. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  103044. /**
  103045. * Adds the given multi-material to this scene
  103046. * @param newMultiMaterial The multi-material to add
  103047. */
  103048. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  103049. /**
  103050. * Adds the given material to this scene
  103051. * @param newMaterial The material to add
  103052. */
  103053. addMaterial(newMaterial: Material): void;
  103054. /**
  103055. * Adds the given morph target to this scene
  103056. * @param newMorphTargetManager The morph target to add
  103057. */
  103058. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  103059. /**
  103060. * Adds the given geometry to this scene
  103061. * @param newGeometry The geometry to add
  103062. */
  103063. addGeometry(newGeometry: Geometry): void;
  103064. /**
  103065. * Adds the given action manager to this scene
  103066. * @param newActionManager The action manager to add
  103067. */
  103068. addActionManager(newActionManager: AbstractActionManager): void;
  103069. /**
  103070. * Adds the given texture to this scene.
  103071. * @param newTexture The texture to add
  103072. */
  103073. addTexture(newTexture: BaseTexture): void;
  103074. /**
  103075. * Switch active camera
  103076. * @param newCamera defines the new active camera
  103077. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  103078. */
  103079. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  103080. /**
  103081. * sets the active camera of the scene using its ID
  103082. * @param id defines the camera's ID
  103083. * @return the new active camera or null if none found.
  103084. */
  103085. setActiveCameraByID(id: string): Nullable<Camera>;
  103086. /**
  103087. * sets the active camera of the scene using its name
  103088. * @param name defines the camera's name
  103089. * @returns the new active camera or null if none found.
  103090. */
  103091. setActiveCameraByName(name: string): Nullable<Camera>;
  103092. /**
  103093. * get an animation group using its name
  103094. * @param name defines the material's name
  103095. * @return the animation group or null if none found.
  103096. */
  103097. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  103098. /**
  103099. * Get a material using its unique id
  103100. * @param uniqueId defines the material's unique id
  103101. * @return the material or null if none found.
  103102. */
  103103. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  103104. /**
  103105. * get a material using its id
  103106. * @param id defines the material's ID
  103107. * @return the material or null if none found.
  103108. */
  103109. getMaterialByID(id: string): Nullable<Material>;
  103110. /**
  103111. * Gets a the last added material using a given id
  103112. * @param id defines the material's ID
  103113. * @return the last material with the given id or null if none found.
  103114. */
  103115. getLastMaterialByID(id: string): Nullable<Material>;
  103116. /**
  103117. * Gets a material using its name
  103118. * @param name defines the material's name
  103119. * @return the material or null if none found.
  103120. */
  103121. getMaterialByName(name: string): Nullable<Material>;
  103122. /**
  103123. * Get a texture using its unique id
  103124. * @param uniqueId defines the texture's unique id
  103125. * @return the texture or null if none found.
  103126. */
  103127. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  103128. /**
  103129. * Gets a camera using its id
  103130. * @param id defines the id to look for
  103131. * @returns the camera or null if not found
  103132. */
  103133. getCameraByID(id: string): Nullable<Camera>;
  103134. /**
  103135. * Gets a camera using its unique id
  103136. * @param uniqueId defines the unique id to look for
  103137. * @returns the camera or null if not found
  103138. */
  103139. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  103140. /**
  103141. * Gets a camera using its name
  103142. * @param name defines the camera's name
  103143. * @return the camera or null if none found.
  103144. */
  103145. getCameraByName(name: string): Nullable<Camera>;
  103146. /**
  103147. * Gets a bone using its id
  103148. * @param id defines the bone's id
  103149. * @return the bone or null if not found
  103150. */
  103151. getBoneByID(id: string): Nullable<Bone>;
  103152. /**
  103153. * Gets a bone using its id
  103154. * @param name defines the bone's name
  103155. * @return the bone or null if not found
  103156. */
  103157. getBoneByName(name: string): Nullable<Bone>;
  103158. /**
  103159. * Gets a light node using its name
  103160. * @param name defines the the light's name
  103161. * @return the light or null if none found.
  103162. */
  103163. getLightByName(name: string): Nullable<Light>;
  103164. /**
  103165. * Gets a light node using its id
  103166. * @param id defines the light's id
  103167. * @return the light or null if none found.
  103168. */
  103169. getLightByID(id: string): Nullable<Light>;
  103170. /**
  103171. * Gets a light node using its scene-generated unique ID
  103172. * @param uniqueId defines the light's unique id
  103173. * @return the light or null if none found.
  103174. */
  103175. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  103176. /**
  103177. * Gets a particle system by id
  103178. * @param id defines the particle system id
  103179. * @return the corresponding system or null if none found
  103180. */
  103181. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  103182. /**
  103183. * Gets a geometry using its ID
  103184. * @param id defines the geometry's id
  103185. * @return the geometry or null if none found.
  103186. */
  103187. getGeometryByID(id: string): Nullable<Geometry>;
  103188. private _getGeometryByUniqueID;
  103189. /**
  103190. * Add a new geometry to this scene
  103191. * @param geometry defines the geometry to be added to the scene.
  103192. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  103193. * @return a boolean defining if the geometry was added or not
  103194. */
  103195. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  103196. /**
  103197. * Removes an existing geometry
  103198. * @param geometry defines the geometry to be removed from the scene
  103199. * @return a boolean defining if the geometry was removed or not
  103200. */
  103201. removeGeometry(geometry: Geometry): boolean;
  103202. /**
  103203. * Gets the list of geometries attached to the scene
  103204. * @returns an array of Geometry
  103205. */
  103206. getGeometries(): Geometry[];
  103207. /**
  103208. * Gets the first added mesh found of a given ID
  103209. * @param id defines the id to search for
  103210. * @return the mesh found or null if not found at all
  103211. */
  103212. getMeshByID(id: string): Nullable<AbstractMesh>;
  103213. /**
  103214. * Gets a list of meshes using their id
  103215. * @param id defines the id to search for
  103216. * @returns a list of meshes
  103217. */
  103218. getMeshesByID(id: string): Array<AbstractMesh>;
  103219. /**
  103220. * Gets the first added transform node found of a given ID
  103221. * @param id defines the id to search for
  103222. * @return the found transform node or null if not found at all.
  103223. */
  103224. getTransformNodeByID(id: string): Nullable<TransformNode>;
  103225. /**
  103226. * Gets a transform node with its auto-generated unique id
  103227. * @param uniqueId efines the unique id to search for
  103228. * @return the found transform node or null if not found at all.
  103229. */
  103230. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  103231. /**
  103232. * Gets a list of transform nodes using their id
  103233. * @param id defines the id to search for
  103234. * @returns a list of transform nodes
  103235. */
  103236. getTransformNodesByID(id: string): Array<TransformNode>;
  103237. /**
  103238. * Gets a mesh with its auto-generated unique id
  103239. * @param uniqueId defines the unique id to search for
  103240. * @return the found mesh or null if not found at all.
  103241. */
  103242. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  103243. /**
  103244. * Gets a the last added mesh using a given id
  103245. * @param id defines the id to search for
  103246. * @return the found mesh or null if not found at all.
  103247. */
  103248. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  103249. /**
  103250. * Gets a the last added node (Mesh, Camera, Light) using a given id
  103251. * @param id defines the id to search for
  103252. * @return the found node or null if not found at all
  103253. */
  103254. getLastEntryByID(id: string): Nullable<Node>;
  103255. /**
  103256. * Gets a node (Mesh, Camera, Light) using a given id
  103257. * @param id defines the id to search for
  103258. * @return the found node or null if not found at all
  103259. */
  103260. getNodeByID(id: string): Nullable<Node>;
  103261. /**
  103262. * Gets a node (Mesh, Camera, Light) using a given name
  103263. * @param name defines the name to search for
  103264. * @return the found node or null if not found at all.
  103265. */
  103266. getNodeByName(name: string): Nullable<Node>;
  103267. /**
  103268. * Gets a mesh using a given name
  103269. * @param name defines the name to search for
  103270. * @return the found mesh or null if not found at all.
  103271. */
  103272. getMeshByName(name: string): Nullable<AbstractMesh>;
  103273. /**
  103274. * Gets a transform node using a given name
  103275. * @param name defines the name to search for
  103276. * @return the found transform node or null if not found at all.
  103277. */
  103278. getTransformNodeByName(name: string): Nullable<TransformNode>;
  103279. /**
  103280. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  103281. * @param id defines the id to search for
  103282. * @return the found skeleton or null if not found at all.
  103283. */
  103284. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  103285. /**
  103286. * Gets a skeleton using a given auto generated unique id
  103287. * @param uniqueId defines the unique id to search for
  103288. * @return the found skeleton or null if not found at all.
  103289. */
  103290. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  103291. /**
  103292. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  103293. * @param id defines the id to search for
  103294. * @return the found skeleton or null if not found at all.
  103295. */
  103296. getSkeletonById(id: string): Nullable<Skeleton>;
  103297. /**
  103298. * Gets a skeleton using a given name
  103299. * @param name defines the name to search for
  103300. * @return the found skeleton or null if not found at all.
  103301. */
  103302. getSkeletonByName(name: string): Nullable<Skeleton>;
  103303. /**
  103304. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  103305. * @param id defines the id to search for
  103306. * @return the found morph target manager or null if not found at all.
  103307. */
  103308. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  103309. /**
  103310. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  103311. * @param id defines the id to search for
  103312. * @return the found morph target or null if not found at all.
  103313. */
  103314. getMorphTargetById(id: string): Nullable<MorphTarget>;
  103315. /**
  103316. * Gets a boolean indicating if the given mesh is active
  103317. * @param mesh defines the mesh to look for
  103318. * @returns true if the mesh is in the active list
  103319. */
  103320. isActiveMesh(mesh: AbstractMesh): boolean;
  103321. /**
  103322. * Return a unique id as a string which can serve as an identifier for the scene
  103323. */
  103324. readonly uid: string;
  103325. /**
  103326. * Add an externaly attached data from its key.
  103327. * This method call will fail and return false, if such key already exists.
  103328. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  103329. * @param key the unique key that identifies the data
  103330. * @param data the data object to associate to the key for this Engine instance
  103331. * @return true if no such key were already present and the data was added successfully, false otherwise
  103332. */
  103333. addExternalData<T>(key: string, data: T): boolean;
  103334. /**
  103335. * Get an externaly attached data from its key
  103336. * @param key the unique key that identifies the data
  103337. * @return the associated data, if present (can be null), or undefined if not present
  103338. */
  103339. getExternalData<T>(key: string): Nullable<T>;
  103340. /**
  103341. * Get an externaly attached data from its key, create it using a factory if it's not already present
  103342. * @param key the unique key that identifies the data
  103343. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  103344. * @return the associated data, can be null if the factory returned null.
  103345. */
  103346. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  103347. /**
  103348. * Remove an externaly attached data from the Engine instance
  103349. * @param key the unique key that identifies the data
  103350. * @return true if the data was successfully removed, false if it doesn't exist
  103351. */
  103352. removeExternalData(key: string): boolean;
  103353. private _evaluateSubMesh;
  103354. /**
  103355. * Clear the processed materials smart array preventing retention point in material dispose.
  103356. */
  103357. freeProcessedMaterials(): void;
  103358. private _preventFreeActiveMeshesAndRenderingGroups;
  103359. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  103360. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  103361. * when disposing several meshes in a row or a hierarchy of meshes.
  103362. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  103363. */
  103364. blockfreeActiveMeshesAndRenderingGroups: boolean;
  103365. /**
  103366. * Clear the active meshes smart array preventing retention point in mesh dispose.
  103367. */
  103368. freeActiveMeshes(): void;
  103369. /**
  103370. * Clear the info related to rendering groups preventing retention points during dispose.
  103371. */
  103372. freeRenderingGroups(): void;
  103373. /** @hidden */
  103374. _isInIntermediateRendering(): boolean;
  103375. /**
  103376. * Lambda returning the list of potentially active meshes.
  103377. */
  103378. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  103379. /**
  103380. * Lambda returning the list of potentially active sub meshes.
  103381. */
  103382. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  103383. /**
  103384. * Lambda returning the list of potentially intersecting sub meshes.
  103385. */
  103386. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  103387. /**
  103388. * Lambda returning the list of potentially colliding sub meshes.
  103389. */
  103390. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  103391. private _activeMeshesFrozen;
  103392. private _skipEvaluateActiveMeshesCompletely;
  103393. /**
  103394. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  103395. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  103396. * @returns the current scene
  103397. */
  103398. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  103399. /**
  103400. * Use this function to restart evaluating active meshes on every frame
  103401. * @returns the current scene
  103402. */
  103403. unfreezeActiveMeshes(): Scene;
  103404. private _evaluateActiveMeshes;
  103405. private _activeMesh;
  103406. /**
  103407. * Update the transform matrix to update from the current active camera
  103408. * @param force defines a boolean used to force the update even if cache is up to date
  103409. */
  103410. updateTransformMatrix(force?: boolean): void;
  103411. private _bindFrameBuffer;
  103412. /** @hidden */
  103413. _allowPostProcessClearColor: boolean;
  103414. /** @hidden */
  103415. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  103416. private _processSubCameras;
  103417. private _checkIntersections;
  103418. /** @hidden */
  103419. _advancePhysicsEngineStep(step: number): void;
  103420. /**
  103421. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  103422. */
  103423. getDeterministicFrameTime: () => number;
  103424. /** @hidden */
  103425. _animate(): void;
  103426. /** Execute all animations (for a frame) */
  103427. animate(): void;
  103428. /**
  103429. * Render the scene
  103430. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  103431. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  103432. */
  103433. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  103434. /**
  103435. * Freeze all materials
  103436. * A frozen material will not be updatable but should be faster to render
  103437. */
  103438. freezeMaterials(): void;
  103439. /**
  103440. * Unfreeze all materials
  103441. * A frozen material will not be updatable but should be faster to render
  103442. */
  103443. unfreezeMaterials(): void;
  103444. /**
  103445. * Releases all held ressources
  103446. */
  103447. dispose(): void;
  103448. /**
  103449. * Gets if the scene is already disposed
  103450. */
  103451. readonly isDisposed: boolean;
  103452. /**
  103453. * Call this function to reduce memory footprint of the scene.
  103454. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  103455. */
  103456. clearCachedVertexData(): void;
  103457. /**
  103458. * This function will remove the local cached buffer data from texture.
  103459. * It will save memory but will prevent the texture from being rebuilt
  103460. */
  103461. cleanCachedTextureBuffer(): void;
  103462. /**
  103463. * Get the world extend vectors with an optional filter
  103464. *
  103465. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  103466. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  103467. */
  103468. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  103469. min: Vector3;
  103470. max: Vector3;
  103471. };
  103472. /**
  103473. * Creates a ray that can be used to pick in the scene
  103474. * @param x defines the x coordinate of the origin (on-screen)
  103475. * @param y defines the y coordinate of the origin (on-screen)
  103476. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  103477. * @param camera defines the camera to use for the picking
  103478. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  103479. * @returns a Ray
  103480. */
  103481. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  103482. /**
  103483. * Creates a ray that can be used to pick in the scene
  103484. * @param x defines the x coordinate of the origin (on-screen)
  103485. * @param y defines the y coordinate of the origin (on-screen)
  103486. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  103487. * @param result defines the ray where to store the picking ray
  103488. * @param camera defines the camera to use for the picking
  103489. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  103490. * @returns the current scene
  103491. */
  103492. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  103493. /**
  103494. * Creates a ray that can be used to pick in the scene
  103495. * @param x defines the x coordinate of the origin (on-screen)
  103496. * @param y defines the y coordinate of the origin (on-screen)
  103497. * @param camera defines the camera to use for the picking
  103498. * @returns a Ray
  103499. */
  103500. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  103501. /**
  103502. * Creates a ray that can be used to pick in the scene
  103503. * @param x defines the x coordinate of the origin (on-screen)
  103504. * @param y defines the y coordinate of the origin (on-screen)
  103505. * @param result defines the ray where to store the picking ray
  103506. * @param camera defines the camera to use for the picking
  103507. * @returns the current scene
  103508. */
  103509. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  103510. /** Launch a ray to try to pick a mesh in the scene
  103511. * @param x position on screen
  103512. * @param y position on screen
  103513. * @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
  103514. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  103515. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  103516. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103517. * @returns a PickingInfo
  103518. */
  103519. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  103520. /** Use the given ray to pick a mesh in the scene
  103521. * @param ray The ray to use to pick meshes
  103522. * @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
  103523. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  103524. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103525. * @returns a PickingInfo
  103526. */
  103527. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  103528. /**
  103529. * Launch a ray to try to pick a mesh in the scene
  103530. * @param x X position on screen
  103531. * @param y Y position on screen
  103532. * @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
  103533. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  103534. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103535. * @returns an array of PickingInfo
  103536. */
  103537. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  103538. /**
  103539. * Launch a ray to try to pick a mesh in the scene
  103540. * @param ray Ray to use
  103541. * @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
  103542. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103543. * @returns an array of PickingInfo
  103544. */
  103545. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  103546. /**
  103547. * Force the value of meshUnderPointer
  103548. * @param mesh defines the mesh to use
  103549. */
  103550. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  103551. /**
  103552. * Gets the mesh under the pointer
  103553. * @returns a Mesh or null if no mesh is under the pointer
  103554. */
  103555. getPointerOverMesh(): Nullable<AbstractMesh>;
  103556. /** @hidden */
  103557. _rebuildGeometries(): void;
  103558. /** @hidden */
  103559. _rebuildTextures(): void;
  103560. private _getByTags;
  103561. /**
  103562. * Get a list of meshes by tags
  103563. * @param tagsQuery defines the tags query to use
  103564. * @param forEach defines a predicate used to filter results
  103565. * @returns an array of Mesh
  103566. */
  103567. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  103568. /**
  103569. * Get a list of cameras by tags
  103570. * @param tagsQuery defines the tags query to use
  103571. * @param forEach defines a predicate used to filter results
  103572. * @returns an array of Camera
  103573. */
  103574. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  103575. /**
  103576. * Get a list of lights by tags
  103577. * @param tagsQuery defines the tags query to use
  103578. * @param forEach defines a predicate used to filter results
  103579. * @returns an array of Light
  103580. */
  103581. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  103582. /**
  103583. * Get a list of materials by tags
  103584. * @param tagsQuery defines the tags query to use
  103585. * @param forEach defines a predicate used to filter results
  103586. * @returns an array of Material
  103587. */
  103588. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  103589. /**
  103590. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103591. * This allowed control for front to back rendering or reversly depending of the special needs.
  103592. *
  103593. * @param renderingGroupId The rendering group id corresponding to its index
  103594. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103595. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103596. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103597. */
  103598. 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;
  103599. /**
  103600. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103601. *
  103602. * @param renderingGroupId The rendering group id corresponding to its index
  103603. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103604. * @param depth Automatically clears depth between groups if true and autoClear is true.
  103605. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  103606. */
  103607. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  103608. /**
  103609. * Gets the current auto clear configuration for one rendering group of the rendering
  103610. * manager.
  103611. * @param index the rendering group index to get the information for
  103612. * @returns The auto clear setup for the requested rendering group
  103613. */
  103614. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  103615. private _blockMaterialDirtyMechanism;
  103616. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  103617. blockMaterialDirtyMechanism: boolean;
  103618. /**
  103619. * Will flag all materials as dirty to trigger new shader compilation
  103620. * @param flag defines the flag used to specify which material part must be marked as dirty
  103621. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  103622. */
  103623. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  103624. /** @hidden */
  103625. _loadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  103626. /** @hidden */
  103627. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  103628. /** @hidden */
  103629. _requestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  103630. /** @hidden */
  103631. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  103632. /** @hidden */
  103633. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  103634. /** @hidden */
  103635. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  103636. }
  103637. }
  103638. declare module BABYLON {
  103639. /**
  103640. * Set of assets to keep when moving a scene into an asset container.
  103641. */
  103642. export class KeepAssets extends AbstractScene {
  103643. }
  103644. /**
  103645. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  103646. */
  103647. export class InstantiatedEntries {
  103648. /**
  103649. * List of new root nodes (eg. nodes with no parent)
  103650. */
  103651. rootNodes: TransformNode[];
  103652. /**
  103653. * List of new skeletons
  103654. */
  103655. skeletons: Skeleton[];
  103656. /**
  103657. * List of new animation groups
  103658. */
  103659. animationGroups: AnimationGroup[];
  103660. }
  103661. /**
  103662. * Container with a set of assets that can be added or removed from a scene.
  103663. */
  103664. export class AssetContainer extends AbstractScene {
  103665. /**
  103666. * The scene the AssetContainer belongs to.
  103667. */
  103668. scene: Scene;
  103669. /**
  103670. * Instantiates an AssetContainer.
  103671. * @param scene The scene the AssetContainer belongs to.
  103672. */
  103673. constructor(scene: Scene);
  103674. /**
  103675. * Instantiate or clone all meshes and add the new ones to the scene.
  103676. * Skeletons and animation groups will all be cloned
  103677. * @param nameFunction defines an optional function used to get new names for clones
  103678. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  103679. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  103680. */
  103681. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  103682. /**
  103683. * Adds all the assets from the container to the scene.
  103684. */
  103685. addAllToScene(): void;
  103686. /**
  103687. * Removes all the assets in the container from the scene
  103688. */
  103689. removeAllFromScene(): void;
  103690. /**
  103691. * Disposes all the assets in the container
  103692. */
  103693. dispose(): void;
  103694. private _moveAssets;
  103695. /**
  103696. * Removes all the assets contained in the scene and adds them to the container.
  103697. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  103698. */
  103699. moveAllFromScene(keepAssets?: KeepAssets): void;
  103700. /**
  103701. * 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.
  103702. * @returns the root mesh
  103703. */
  103704. createRootMesh(): Mesh;
  103705. }
  103706. }
  103707. declare module BABYLON {
  103708. /**
  103709. * Defines how the parser contract is defined.
  103710. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  103711. */
  103712. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  103713. /**
  103714. * Defines how the individual parser contract is defined.
  103715. * These parser can parse an individual asset
  103716. */
  103717. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  103718. /**
  103719. * Base class of the scene acting as a container for the different elements composing a scene.
  103720. * This class is dynamically extended by the different components of the scene increasing
  103721. * flexibility and reducing coupling
  103722. */
  103723. export abstract class AbstractScene {
  103724. /**
  103725. * Stores the list of available parsers in the application.
  103726. */
  103727. private static _BabylonFileParsers;
  103728. /**
  103729. * Stores the list of available individual parsers in the application.
  103730. */
  103731. private static _IndividualBabylonFileParsers;
  103732. /**
  103733. * Adds a parser in the list of available ones
  103734. * @param name Defines the name of the parser
  103735. * @param parser Defines the parser to add
  103736. */
  103737. static AddParser(name: string, parser: BabylonFileParser): void;
  103738. /**
  103739. * Gets a general parser from the list of avaialble ones
  103740. * @param name Defines the name of the parser
  103741. * @returns the requested parser or null
  103742. */
  103743. static GetParser(name: string): Nullable<BabylonFileParser>;
  103744. /**
  103745. * Adds n individual parser in the list of available ones
  103746. * @param name Defines the name of the parser
  103747. * @param parser Defines the parser to add
  103748. */
  103749. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  103750. /**
  103751. * Gets an individual parser from the list of avaialble ones
  103752. * @param name Defines the name of the parser
  103753. * @returns the requested parser or null
  103754. */
  103755. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  103756. /**
  103757. * Parser json data and populate both a scene and its associated container object
  103758. * @param jsonData Defines the data to parse
  103759. * @param scene Defines the scene to parse the data for
  103760. * @param container Defines the container attached to the parsing sequence
  103761. * @param rootUrl Defines the root url of the data
  103762. */
  103763. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  103764. /**
  103765. * Gets the list of root nodes (ie. nodes with no parent)
  103766. */
  103767. rootNodes: Node[];
  103768. /** All of the cameras added to this scene
  103769. * @see http://doc.babylonjs.com/babylon101/cameras
  103770. */
  103771. cameras: Camera[];
  103772. /**
  103773. * All of the lights added to this scene
  103774. * @see http://doc.babylonjs.com/babylon101/lights
  103775. */
  103776. lights: Light[];
  103777. /**
  103778. * All of the (abstract) meshes added to this scene
  103779. */
  103780. meshes: AbstractMesh[];
  103781. /**
  103782. * The list of skeletons added to the scene
  103783. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  103784. */
  103785. skeletons: Skeleton[];
  103786. /**
  103787. * All of the particle systems added to this scene
  103788. * @see http://doc.babylonjs.com/babylon101/particles
  103789. */
  103790. particleSystems: IParticleSystem[];
  103791. /**
  103792. * Gets a list of Animations associated with the scene
  103793. */
  103794. animations: Animation[];
  103795. /**
  103796. * All of the animation groups added to this scene
  103797. * @see http://doc.babylonjs.com/how_to/group
  103798. */
  103799. animationGroups: AnimationGroup[];
  103800. /**
  103801. * All of the multi-materials added to this scene
  103802. * @see http://doc.babylonjs.com/how_to/multi_materials
  103803. */
  103804. multiMaterials: MultiMaterial[];
  103805. /**
  103806. * All of the materials added to this scene
  103807. * In the context of a Scene, it is not supposed to be modified manually.
  103808. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  103809. * Note also that the order of the Material within the array is not significant and might change.
  103810. * @see http://doc.babylonjs.com/babylon101/materials
  103811. */
  103812. materials: Material[];
  103813. /**
  103814. * The list of morph target managers added to the scene
  103815. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  103816. */
  103817. morphTargetManagers: MorphTargetManager[];
  103818. /**
  103819. * The list of geometries used in the scene.
  103820. */
  103821. geometries: Geometry[];
  103822. /**
  103823. * All of the tranform nodes added to this scene
  103824. * In the context of a Scene, it is not supposed to be modified manually.
  103825. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  103826. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  103827. * @see http://doc.babylonjs.com/how_to/transformnode
  103828. */
  103829. transformNodes: TransformNode[];
  103830. /**
  103831. * ActionManagers available on the scene.
  103832. */
  103833. actionManagers: AbstractActionManager[];
  103834. /**
  103835. * Textures to keep.
  103836. */
  103837. textures: BaseTexture[];
  103838. /**
  103839. * Environment texture for the scene
  103840. */
  103841. environmentTexture: Nullable<BaseTexture>;
  103842. }
  103843. }
  103844. declare module BABYLON {
  103845. /**
  103846. * Interface used to define options for Sound class
  103847. */
  103848. export interface ISoundOptions {
  103849. /**
  103850. * Does the sound autoplay once loaded.
  103851. */
  103852. autoplay?: boolean;
  103853. /**
  103854. * Does the sound loop after it finishes playing once.
  103855. */
  103856. loop?: boolean;
  103857. /**
  103858. * Sound's volume
  103859. */
  103860. volume?: number;
  103861. /**
  103862. * Is it a spatial sound?
  103863. */
  103864. spatialSound?: boolean;
  103865. /**
  103866. * Maximum distance to hear that sound
  103867. */
  103868. maxDistance?: number;
  103869. /**
  103870. * Uses user defined attenuation function
  103871. */
  103872. useCustomAttenuation?: boolean;
  103873. /**
  103874. * Define the roll off factor of spatial sounds.
  103875. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103876. */
  103877. rolloffFactor?: number;
  103878. /**
  103879. * Define the reference distance the sound should be heard perfectly.
  103880. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103881. */
  103882. refDistance?: number;
  103883. /**
  103884. * Define the distance attenuation model the sound will follow.
  103885. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103886. */
  103887. distanceModel?: string;
  103888. /**
  103889. * Defines the playback speed (1 by default)
  103890. */
  103891. playbackRate?: number;
  103892. /**
  103893. * Defines if the sound is from a streaming source
  103894. */
  103895. streaming?: boolean;
  103896. /**
  103897. * Defines an optional length (in seconds) inside the sound file
  103898. */
  103899. length?: number;
  103900. /**
  103901. * Defines an optional offset (in seconds) inside the sound file
  103902. */
  103903. offset?: number;
  103904. /**
  103905. * If true, URLs will not be required to state the audio file codec to use.
  103906. */
  103907. skipCodecCheck?: boolean;
  103908. }
  103909. /**
  103910. * Defines a sound that can be played in the application.
  103911. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  103912. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103913. */
  103914. export class Sound {
  103915. /**
  103916. * The name of the sound in the scene.
  103917. */
  103918. name: string;
  103919. /**
  103920. * Does the sound autoplay once loaded.
  103921. */
  103922. autoplay: boolean;
  103923. /**
  103924. * Does the sound loop after it finishes playing once.
  103925. */
  103926. loop: boolean;
  103927. /**
  103928. * Does the sound use a custom attenuation curve to simulate the falloff
  103929. * happening when the source gets further away from the camera.
  103930. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  103931. */
  103932. useCustomAttenuation: boolean;
  103933. /**
  103934. * The sound track id this sound belongs to.
  103935. */
  103936. soundTrackId: number;
  103937. /**
  103938. * Is this sound currently played.
  103939. */
  103940. isPlaying: boolean;
  103941. /**
  103942. * Is this sound currently paused.
  103943. */
  103944. isPaused: boolean;
  103945. /**
  103946. * Does this sound enables spatial sound.
  103947. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103948. */
  103949. spatialSound: boolean;
  103950. /**
  103951. * Define the reference distance the sound should be heard perfectly.
  103952. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103953. */
  103954. refDistance: number;
  103955. /**
  103956. * Define the roll off factor of spatial sounds.
  103957. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103958. */
  103959. rolloffFactor: number;
  103960. /**
  103961. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  103962. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103963. */
  103964. maxDistance: number;
  103965. /**
  103966. * Define the distance attenuation model the sound will follow.
  103967. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103968. */
  103969. distanceModel: string;
  103970. /**
  103971. * @hidden
  103972. * Back Compat
  103973. **/
  103974. onended: () => any;
  103975. /**
  103976. * Observable event when the current playing sound finishes.
  103977. */
  103978. onEndedObservable: Observable<Sound>;
  103979. private _panningModel;
  103980. private _playbackRate;
  103981. private _streaming;
  103982. private _startTime;
  103983. private _startOffset;
  103984. private _position;
  103985. /** @hidden */
  103986. _positionInEmitterSpace: boolean;
  103987. private _localDirection;
  103988. private _volume;
  103989. private _isReadyToPlay;
  103990. private _isDirectional;
  103991. private _readyToPlayCallback;
  103992. private _audioBuffer;
  103993. private _soundSource;
  103994. private _streamingSource;
  103995. private _soundPanner;
  103996. private _soundGain;
  103997. private _inputAudioNode;
  103998. private _outputAudioNode;
  103999. private _coneInnerAngle;
  104000. private _coneOuterAngle;
  104001. private _coneOuterGain;
  104002. private _scene;
  104003. private _connectedTransformNode;
  104004. private _customAttenuationFunction;
  104005. private _registerFunc;
  104006. private _isOutputConnected;
  104007. private _htmlAudioElement;
  104008. private _urlType;
  104009. private _length?;
  104010. private _offset?;
  104011. /** @hidden */
  104012. static _SceneComponentInitialization: (scene: Scene) => void;
  104013. /**
  104014. * Create a sound and attach it to a scene
  104015. * @param name Name of your sound
  104016. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  104017. * @param scene defines the scene the sound belongs to
  104018. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  104019. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  104020. */
  104021. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  104022. /**
  104023. * Release the sound and its associated resources
  104024. */
  104025. dispose(): void;
  104026. /**
  104027. * Gets if the sounds is ready to be played or not.
  104028. * @returns true if ready, otherwise false
  104029. */
  104030. isReady(): boolean;
  104031. private _soundLoaded;
  104032. /**
  104033. * Sets the data of the sound from an audiobuffer
  104034. * @param audioBuffer The audioBuffer containing the data
  104035. */
  104036. setAudioBuffer(audioBuffer: AudioBuffer): void;
  104037. /**
  104038. * Updates the current sounds options such as maxdistance, loop...
  104039. * @param options A JSON object containing values named as the object properties
  104040. */
  104041. updateOptions(options: ISoundOptions): void;
  104042. private _createSpatialParameters;
  104043. private _updateSpatialParameters;
  104044. /**
  104045. * Switch the panning model to HRTF:
  104046. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  104047. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  104048. */
  104049. switchPanningModelToHRTF(): void;
  104050. /**
  104051. * Switch the panning model to Equal Power:
  104052. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  104053. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  104054. */
  104055. switchPanningModelToEqualPower(): void;
  104056. private _switchPanningModel;
  104057. /**
  104058. * Connect this sound to a sound track audio node like gain...
  104059. * @param soundTrackAudioNode the sound track audio node to connect to
  104060. */
  104061. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  104062. /**
  104063. * Transform this sound into a directional source
  104064. * @param coneInnerAngle Size of the inner cone in degree
  104065. * @param coneOuterAngle Size of the outer cone in degree
  104066. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  104067. */
  104068. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  104069. /**
  104070. * Gets or sets the inner angle for the directional cone.
  104071. */
  104072. /**
  104073. * Gets or sets the inner angle for the directional cone.
  104074. */
  104075. directionalConeInnerAngle: number;
  104076. /**
  104077. * Gets or sets the outer angle for the directional cone.
  104078. */
  104079. /**
  104080. * Gets or sets the outer angle for the directional cone.
  104081. */
  104082. directionalConeOuterAngle: number;
  104083. /**
  104084. * Sets the position of the emitter if spatial sound is enabled
  104085. * @param newPosition Defines the new posisiton
  104086. */
  104087. setPosition(newPosition: Vector3): void;
  104088. /**
  104089. * Sets the local direction of the emitter if spatial sound is enabled
  104090. * @param newLocalDirection Defines the new local direction
  104091. */
  104092. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  104093. private _updateDirection;
  104094. /** @hidden */
  104095. updateDistanceFromListener(): void;
  104096. /**
  104097. * Sets a new custom attenuation function for the sound.
  104098. * @param callback Defines the function used for the attenuation
  104099. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  104100. */
  104101. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  104102. /**
  104103. * Play the sound
  104104. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  104105. * @param offset (optional) Start the sound at a specific time in seconds
  104106. * @param length (optional) Sound duration (in seconds)
  104107. */
  104108. play(time?: number, offset?: number, length?: number): void;
  104109. private _onended;
  104110. /**
  104111. * Stop the sound
  104112. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  104113. */
  104114. stop(time?: number): void;
  104115. /**
  104116. * Put the sound in pause
  104117. */
  104118. pause(): void;
  104119. /**
  104120. * Sets a dedicated volume for this sounds
  104121. * @param newVolume Define the new volume of the sound
  104122. * @param time Define time for gradual change to new volume
  104123. */
  104124. setVolume(newVolume: number, time?: number): void;
  104125. /**
  104126. * Set the sound play back rate
  104127. * @param newPlaybackRate Define the playback rate the sound should be played at
  104128. */
  104129. setPlaybackRate(newPlaybackRate: number): void;
  104130. /**
  104131. * Gets the volume of the sound.
  104132. * @returns the volume of the sound
  104133. */
  104134. getVolume(): number;
  104135. /**
  104136. * Attach the sound to a dedicated mesh
  104137. * @param transformNode The transform node to connect the sound with
  104138. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  104139. */
  104140. attachToMesh(transformNode: TransformNode): void;
  104141. /**
  104142. * Detach the sound from the previously attached mesh
  104143. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  104144. */
  104145. detachFromMesh(): void;
  104146. private _onRegisterAfterWorldMatrixUpdate;
  104147. /**
  104148. * Clone the current sound in the scene.
  104149. * @returns the new sound clone
  104150. */
  104151. clone(): Nullable<Sound>;
  104152. /**
  104153. * Gets the current underlying audio buffer containing the data
  104154. * @returns the audio buffer
  104155. */
  104156. getAudioBuffer(): Nullable<AudioBuffer>;
  104157. /**
  104158. * Serializes the Sound in a JSON representation
  104159. * @returns the JSON representation of the sound
  104160. */
  104161. serialize(): any;
  104162. /**
  104163. * Parse a JSON representation of a sound to innstantiate in a given scene
  104164. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  104165. * @param scene Define the scene the new parsed sound should be created in
  104166. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  104167. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  104168. * @returns the newly parsed sound
  104169. */
  104170. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  104171. }
  104172. }
  104173. declare module BABYLON {
  104174. /**
  104175. * This defines an action helpful to play a defined sound on a triggered action.
  104176. */
  104177. export class PlaySoundAction extends Action {
  104178. private _sound;
  104179. /**
  104180. * Instantiate the action
  104181. * @param triggerOptions defines the trigger options
  104182. * @param sound defines the sound to play
  104183. * @param condition defines the trigger related conditions
  104184. */
  104185. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  104186. /** @hidden */
  104187. _prepare(): void;
  104188. /**
  104189. * Execute the action and play the sound.
  104190. */
  104191. execute(): void;
  104192. /**
  104193. * Serializes the actions and its related information.
  104194. * @param parent defines the object to serialize in
  104195. * @returns the serialized object
  104196. */
  104197. serialize(parent: any): any;
  104198. }
  104199. /**
  104200. * This defines an action helpful to stop a defined sound on a triggered action.
  104201. */
  104202. export class StopSoundAction extends Action {
  104203. private _sound;
  104204. /**
  104205. * Instantiate the action
  104206. * @param triggerOptions defines the trigger options
  104207. * @param sound defines the sound to stop
  104208. * @param condition defines the trigger related conditions
  104209. */
  104210. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  104211. /** @hidden */
  104212. _prepare(): void;
  104213. /**
  104214. * Execute the action and stop the sound.
  104215. */
  104216. execute(): void;
  104217. /**
  104218. * Serializes the actions and its related information.
  104219. * @param parent defines the object to serialize in
  104220. * @returns the serialized object
  104221. */
  104222. serialize(parent: any): any;
  104223. }
  104224. }
  104225. declare module BABYLON {
  104226. /**
  104227. * This defines an action responsible to change the value of a property
  104228. * by interpolating between its current value and the newly set one once triggered.
  104229. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  104230. */
  104231. export class InterpolateValueAction extends Action {
  104232. /**
  104233. * Defines the path of the property where the value should be interpolated
  104234. */
  104235. propertyPath: string;
  104236. /**
  104237. * Defines the target value at the end of the interpolation.
  104238. */
  104239. value: any;
  104240. /**
  104241. * Defines the time it will take for the property to interpolate to the value.
  104242. */
  104243. duration: number;
  104244. /**
  104245. * Defines if the other scene animations should be stopped when the action has been triggered
  104246. */
  104247. stopOtherAnimations?: boolean;
  104248. /**
  104249. * Defines a callback raised once the interpolation animation has been done.
  104250. */
  104251. onInterpolationDone?: () => void;
  104252. /**
  104253. * Observable triggered once the interpolation animation has been done.
  104254. */
  104255. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  104256. private _target;
  104257. private _effectiveTarget;
  104258. private _property;
  104259. /**
  104260. * Instantiate the action
  104261. * @param triggerOptions defines the trigger options
  104262. * @param target defines the object containing the value to interpolate
  104263. * @param propertyPath defines the path to the property in the target object
  104264. * @param value defines the target value at the end of the interpolation
  104265. * @param duration deines the time it will take for the property to interpolate to the value.
  104266. * @param condition defines the trigger related conditions
  104267. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  104268. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  104269. */
  104270. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  104271. /** @hidden */
  104272. _prepare(): void;
  104273. /**
  104274. * Execute the action starts the value interpolation.
  104275. */
  104276. execute(): void;
  104277. /**
  104278. * Serializes the actions and its related information.
  104279. * @param parent defines the object to serialize in
  104280. * @returns the serialized object
  104281. */
  104282. serialize(parent: any): any;
  104283. }
  104284. }
  104285. declare module BABYLON {
  104286. /**
  104287. * Options allowed during the creation of a sound track.
  104288. */
  104289. export interface ISoundTrackOptions {
  104290. /**
  104291. * The volume the sound track should take during creation
  104292. */
  104293. volume?: number;
  104294. /**
  104295. * Define if the sound track is the main sound track of the scene
  104296. */
  104297. mainTrack?: boolean;
  104298. }
  104299. /**
  104300. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  104301. * It will be also used in a future release to apply effects on a specific track.
  104302. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  104303. */
  104304. export class SoundTrack {
  104305. /**
  104306. * The unique identifier of the sound track in the scene.
  104307. */
  104308. id: number;
  104309. /**
  104310. * The list of sounds included in the sound track.
  104311. */
  104312. soundCollection: Array<Sound>;
  104313. private _outputAudioNode;
  104314. private _scene;
  104315. private _connectedAnalyser;
  104316. private _options;
  104317. private _isInitialized;
  104318. /**
  104319. * Creates a new sound track.
  104320. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  104321. * @param scene Define the scene the sound track belongs to
  104322. * @param options
  104323. */
  104324. constructor(scene: Scene, options?: ISoundTrackOptions);
  104325. private _initializeSoundTrackAudioGraph;
  104326. /**
  104327. * Release the sound track and its associated resources
  104328. */
  104329. dispose(): void;
  104330. /**
  104331. * Adds a sound to this sound track
  104332. * @param sound define the cound to add
  104333. * @ignoreNaming
  104334. */
  104335. AddSound(sound: Sound): void;
  104336. /**
  104337. * Removes a sound to this sound track
  104338. * @param sound define the cound to remove
  104339. * @ignoreNaming
  104340. */
  104341. RemoveSound(sound: Sound): void;
  104342. /**
  104343. * Set a global volume for the full sound track.
  104344. * @param newVolume Define the new volume of the sound track
  104345. */
  104346. setVolume(newVolume: number): void;
  104347. /**
  104348. * Switch the panning model to HRTF:
  104349. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  104350. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  104351. */
  104352. switchPanningModelToHRTF(): void;
  104353. /**
  104354. * Switch the panning model to Equal Power:
  104355. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  104356. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  104357. */
  104358. switchPanningModelToEqualPower(): void;
  104359. /**
  104360. * Connect the sound track to an audio analyser allowing some amazing
  104361. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  104362. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  104363. * @param analyser The analyser to connect to the engine
  104364. */
  104365. connectToAnalyser(analyser: Analyser): void;
  104366. }
  104367. }
  104368. declare module BABYLON {
  104369. interface AbstractScene {
  104370. /**
  104371. * The list of sounds used in the scene.
  104372. */
  104373. sounds: Nullable<Array<Sound>>;
  104374. }
  104375. interface Scene {
  104376. /**
  104377. * @hidden
  104378. * Backing field
  104379. */
  104380. _mainSoundTrack: SoundTrack;
  104381. /**
  104382. * The main sound track played by the scene.
  104383. * It cotains your primary collection of sounds.
  104384. */
  104385. mainSoundTrack: SoundTrack;
  104386. /**
  104387. * The list of sound tracks added to the scene
  104388. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104389. */
  104390. soundTracks: Nullable<Array<SoundTrack>>;
  104391. /**
  104392. * Gets a sound using a given name
  104393. * @param name defines the name to search for
  104394. * @return the found sound or null if not found at all.
  104395. */
  104396. getSoundByName(name: string): Nullable<Sound>;
  104397. /**
  104398. * Gets or sets if audio support is enabled
  104399. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104400. */
  104401. audioEnabled: boolean;
  104402. /**
  104403. * Gets or sets if audio will be output to headphones
  104404. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104405. */
  104406. headphone: boolean;
  104407. /**
  104408. * Gets or sets custom audio listener position provider
  104409. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104410. */
  104411. audioListenerPositionProvider: Nullable<() => Vector3>;
  104412. /**
  104413. * Gets or sets a refresh rate when using 3D audio positioning
  104414. */
  104415. audioPositioningRefreshRate: number;
  104416. }
  104417. /**
  104418. * Defines the sound scene component responsible to manage any sounds
  104419. * in a given scene.
  104420. */
  104421. export class AudioSceneComponent implements ISceneSerializableComponent {
  104422. /**
  104423. * The component name helpfull to identify the component in the list of scene components.
  104424. */
  104425. readonly name: string;
  104426. /**
  104427. * The scene the component belongs to.
  104428. */
  104429. scene: Scene;
  104430. private _audioEnabled;
  104431. /**
  104432. * Gets whether audio is enabled or not.
  104433. * Please use related enable/disable method to switch state.
  104434. */
  104435. readonly audioEnabled: boolean;
  104436. private _headphone;
  104437. /**
  104438. * Gets whether audio is outputing to headphone or not.
  104439. * Please use the according Switch methods to change output.
  104440. */
  104441. readonly headphone: boolean;
  104442. /**
  104443. * Gets or sets a refresh rate when using 3D audio positioning
  104444. */
  104445. audioPositioningRefreshRate: number;
  104446. private _audioListenerPositionProvider;
  104447. /**
  104448. * Gets the current audio listener position provider
  104449. */
  104450. /**
  104451. * Sets a custom listener position for all sounds in the scene
  104452. * By default, this is the position of the first active camera
  104453. */
  104454. audioListenerPositionProvider: Nullable<() => Vector3>;
  104455. /**
  104456. * Creates a new instance of the component for the given scene
  104457. * @param scene Defines the scene to register the component in
  104458. */
  104459. constructor(scene: Scene);
  104460. /**
  104461. * Registers the component in a given scene
  104462. */
  104463. register(): void;
  104464. /**
  104465. * Rebuilds the elements related to this component in case of
  104466. * context lost for instance.
  104467. */
  104468. rebuild(): void;
  104469. /**
  104470. * Serializes the component data to the specified json object
  104471. * @param serializationObject The object to serialize to
  104472. */
  104473. serialize(serializationObject: any): void;
  104474. /**
  104475. * Adds all the elements from the container to the scene
  104476. * @param container the container holding the elements
  104477. */
  104478. addFromContainer(container: AbstractScene): void;
  104479. /**
  104480. * Removes all the elements in the container from the scene
  104481. * @param container contains the elements to remove
  104482. * @param dispose if the removed element should be disposed (default: false)
  104483. */
  104484. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  104485. /**
  104486. * Disposes the component and the associated ressources.
  104487. */
  104488. dispose(): void;
  104489. /**
  104490. * Disables audio in the associated scene.
  104491. */
  104492. disableAudio(): void;
  104493. /**
  104494. * Enables audio in the associated scene.
  104495. */
  104496. enableAudio(): void;
  104497. /**
  104498. * Switch audio to headphone output.
  104499. */
  104500. switchAudioModeForHeadphones(): void;
  104501. /**
  104502. * Switch audio to normal speakers.
  104503. */
  104504. switchAudioModeForNormalSpeakers(): void;
  104505. private _cachedCameraDirection;
  104506. private _cachedCameraPosition;
  104507. private _lastCheck;
  104508. private _afterRender;
  104509. }
  104510. }
  104511. declare module BABYLON {
  104512. /**
  104513. * Wraps one or more Sound objects and selects one with random weight for playback.
  104514. */
  104515. export class WeightedSound {
  104516. /** When true a Sound will be selected and played when the current playing Sound completes. */
  104517. loop: boolean;
  104518. private _coneInnerAngle;
  104519. private _coneOuterAngle;
  104520. private _volume;
  104521. /** A Sound is currently playing. */
  104522. isPlaying: boolean;
  104523. /** A Sound is currently paused. */
  104524. isPaused: boolean;
  104525. private _sounds;
  104526. private _weights;
  104527. private _currentIndex?;
  104528. /**
  104529. * Creates a new WeightedSound from the list of sounds given.
  104530. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  104531. * @param sounds Array of Sounds that will be selected from.
  104532. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  104533. */
  104534. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  104535. /**
  104536. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  104537. */
  104538. /**
  104539. * The size of cone in degress for a directional sound in which there will be no attenuation.
  104540. */
  104541. directionalConeInnerAngle: number;
  104542. /**
  104543. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  104544. * Listener angles between innerAngle and outerAngle will falloff linearly.
  104545. */
  104546. /**
  104547. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  104548. * Listener angles between innerAngle and outerAngle will falloff linearly.
  104549. */
  104550. directionalConeOuterAngle: number;
  104551. /**
  104552. * Playback volume.
  104553. */
  104554. /**
  104555. * Playback volume.
  104556. */
  104557. volume: number;
  104558. private _onended;
  104559. /**
  104560. * Suspend playback
  104561. */
  104562. pause(): void;
  104563. /**
  104564. * Stop playback
  104565. */
  104566. stop(): void;
  104567. /**
  104568. * Start playback.
  104569. * @param startOffset Position the clip head at a specific time in seconds.
  104570. */
  104571. play(startOffset?: number): void;
  104572. }
  104573. }
  104574. declare module BABYLON {
  104575. /**
  104576. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  104577. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104578. */
  104579. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  104580. /**
  104581. * Gets the name of the behavior.
  104582. */
  104583. readonly name: string;
  104584. /**
  104585. * The easing function used by animations
  104586. */
  104587. static EasingFunction: BackEase;
  104588. /**
  104589. * The easing mode used by animations
  104590. */
  104591. static EasingMode: number;
  104592. /**
  104593. * The duration of the animation, in milliseconds
  104594. */
  104595. transitionDuration: number;
  104596. /**
  104597. * Length of the distance animated by the transition when lower radius is reached
  104598. */
  104599. lowerRadiusTransitionRange: number;
  104600. /**
  104601. * Length of the distance animated by the transition when upper radius is reached
  104602. */
  104603. upperRadiusTransitionRange: number;
  104604. private _autoTransitionRange;
  104605. /**
  104606. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  104607. */
  104608. /**
  104609. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  104610. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  104611. */
  104612. autoTransitionRange: boolean;
  104613. private _attachedCamera;
  104614. private _onAfterCheckInputsObserver;
  104615. private _onMeshTargetChangedObserver;
  104616. /**
  104617. * Initializes the behavior.
  104618. */
  104619. init(): void;
  104620. /**
  104621. * Attaches the behavior to its arc rotate camera.
  104622. * @param camera Defines the camera to attach the behavior to
  104623. */
  104624. attach(camera: ArcRotateCamera): void;
  104625. /**
  104626. * Detaches the behavior from its current arc rotate camera.
  104627. */
  104628. detach(): void;
  104629. private _radiusIsAnimating;
  104630. private _radiusBounceTransition;
  104631. private _animatables;
  104632. private _cachedWheelPrecision;
  104633. /**
  104634. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  104635. * @param radiusLimit The limit to check against.
  104636. * @return Bool to indicate if at limit.
  104637. */
  104638. private _isRadiusAtLimit;
  104639. /**
  104640. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  104641. * @param radiusDelta The delta by which to animate to. Can be negative.
  104642. */
  104643. private _applyBoundRadiusAnimation;
  104644. /**
  104645. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  104646. */
  104647. protected _clearAnimationLocks(): void;
  104648. /**
  104649. * Stops and removes all animations that have been applied to the camera
  104650. */
  104651. stopAllAnimations(): void;
  104652. }
  104653. }
  104654. declare module BABYLON {
  104655. /**
  104656. * 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.
  104657. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104658. */
  104659. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  104660. /**
  104661. * Gets the name of the behavior.
  104662. */
  104663. readonly name: string;
  104664. private _mode;
  104665. private _radiusScale;
  104666. private _positionScale;
  104667. private _defaultElevation;
  104668. private _elevationReturnTime;
  104669. private _elevationReturnWaitTime;
  104670. private _zoomStopsAnimation;
  104671. private _framingTime;
  104672. /**
  104673. * The easing function used by animations
  104674. */
  104675. static EasingFunction: ExponentialEase;
  104676. /**
  104677. * The easing mode used by animations
  104678. */
  104679. static EasingMode: number;
  104680. /**
  104681. * Sets the current mode used by the behavior
  104682. */
  104683. /**
  104684. * Gets current mode used by the behavior.
  104685. */
  104686. mode: number;
  104687. /**
  104688. * Sets the scale applied to the radius (1 by default)
  104689. */
  104690. /**
  104691. * Gets the scale applied to the radius
  104692. */
  104693. radiusScale: number;
  104694. /**
  104695. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  104696. */
  104697. /**
  104698. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  104699. */
  104700. positionScale: number;
  104701. /**
  104702. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  104703. * behaviour is triggered, in radians.
  104704. */
  104705. /**
  104706. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  104707. * behaviour is triggered, in radians.
  104708. */
  104709. defaultElevation: number;
  104710. /**
  104711. * Sets the time (in milliseconds) taken to return to the default beta position.
  104712. * Negative value indicates camera should not return to default.
  104713. */
  104714. /**
  104715. * Gets the time (in milliseconds) taken to return to the default beta position.
  104716. * Negative value indicates camera should not return to default.
  104717. */
  104718. elevationReturnTime: number;
  104719. /**
  104720. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  104721. */
  104722. /**
  104723. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  104724. */
  104725. elevationReturnWaitTime: number;
  104726. /**
  104727. * Sets the flag that indicates if user zooming should stop animation.
  104728. */
  104729. /**
  104730. * Gets the flag that indicates if user zooming should stop animation.
  104731. */
  104732. zoomStopsAnimation: boolean;
  104733. /**
  104734. * Sets the transition time when framing the mesh, in milliseconds
  104735. */
  104736. /**
  104737. * Gets the transition time when framing the mesh, in milliseconds
  104738. */
  104739. framingTime: number;
  104740. /**
  104741. * Define if the behavior should automatically change the configured
  104742. * camera limits and sensibilities.
  104743. */
  104744. autoCorrectCameraLimitsAndSensibility: boolean;
  104745. private _onPrePointerObservableObserver;
  104746. private _onAfterCheckInputsObserver;
  104747. private _onMeshTargetChangedObserver;
  104748. private _attachedCamera;
  104749. private _isPointerDown;
  104750. private _lastInteractionTime;
  104751. /**
  104752. * Initializes the behavior.
  104753. */
  104754. init(): void;
  104755. /**
  104756. * Attaches the behavior to its arc rotate camera.
  104757. * @param camera Defines the camera to attach the behavior to
  104758. */
  104759. attach(camera: ArcRotateCamera): void;
  104760. /**
  104761. * Detaches the behavior from its current arc rotate camera.
  104762. */
  104763. detach(): void;
  104764. private _animatables;
  104765. private _betaIsAnimating;
  104766. private _betaTransition;
  104767. private _radiusTransition;
  104768. private _vectorTransition;
  104769. /**
  104770. * Targets the given mesh and updates zoom level accordingly.
  104771. * @param mesh The mesh to target.
  104772. * @param radius Optional. If a cached radius position already exists, overrides default.
  104773. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104774. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104775. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104776. */
  104777. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104778. /**
  104779. * Targets the given mesh with its children and updates zoom level accordingly.
  104780. * @param mesh The mesh to target.
  104781. * @param radius Optional. If a cached radius position already exists, overrides default.
  104782. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104783. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104784. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104785. */
  104786. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104787. /**
  104788. * Targets the given meshes with their children and updates zoom level accordingly.
  104789. * @param meshes The mesh to target.
  104790. * @param radius Optional. If a cached radius position already exists, overrides default.
  104791. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104792. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104793. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104794. */
  104795. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104796. /**
  104797. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  104798. * @param minimumWorld Determines the smaller position of the bounding box extend
  104799. * @param maximumWorld Determines the bigger position of the bounding box extend
  104800. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104801. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104802. */
  104803. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104804. /**
  104805. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  104806. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  104807. * frustum width.
  104808. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  104809. * to fully enclose the mesh in the viewing frustum.
  104810. */
  104811. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  104812. /**
  104813. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  104814. * is automatically returned to its default position (expected to be above ground plane).
  104815. */
  104816. private _maintainCameraAboveGround;
  104817. /**
  104818. * Returns the frustum slope based on the canvas ratio and camera FOV
  104819. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  104820. */
  104821. private _getFrustumSlope;
  104822. /**
  104823. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  104824. */
  104825. private _clearAnimationLocks;
  104826. /**
  104827. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  104828. */
  104829. private _applyUserInteraction;
  104830. /**
  104831. * Stops and removes all animations that have been applied to the camera
  104832. */
  104833. stopAllAnimations(): void;
  104834. /**
  104835. * Gets a value indicating if the user is moving the camera
  104836. */
  104837. readonly isUserIsMoving: boolean;
  104838. /**
  104839. * The camera can move all the way towards the mesh.
  104840. */
  104841. static IgnoreBoundsSizeMode: number;
  104842. /**
  104843. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  104844. */
  104845. static FitFrustumSidesMode: number;
  104846. }
  104847. }
  104848. declare module BABYLON {
  104849. /**
  104850. * Base class for Camera Pointer Inputs.
  104851. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  104852. * for example usage.
  104853. */
  104854. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  104855. /**
  104856. * Defines the camera the input is attached to.
  104857. */
  104858. abstract camera: Camera;
  104859. /**
  104860. * Whether keyboard modifier keys are pressed at time of last mouse event.
  104861. */
  104862. protected _altKey: boolean;
  104863. protected _ctrlKey: boolean;
  104864. protected _metaKey: boolean;
  104865. protected _shiftKey: boolean;
  104866. /**
  104867. * Which mouse buttons were pressed at time of last mouse event.
  104868. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  104869. */
  104870. protected _buttonsPressed: number;
  104871. /**
  104872. * Defines the buttons associated with the input to handle camera move.
  104873. */
  104874. buttons: number[];
  104875. /**
  104876. * Attach the input controls to a specific dom element to get the input from.
  104877. * @param element Defines the element the controls should be listened from
  104878. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104879. */
  104880. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104881. /**
  104882. * Detach the current controls from the specified dom element.
  104883. * @param element Defines the element to stop listening the inputs from
  104884. */
  104885. detachControl(element: Nullable<HTMLElement>): void;
  104886. /**
  104887. * Gets the class name of the current input.
  104888. * @returns the class name
  104889. */
  104890. getClassName(): string;
  104891. /**
  104892. * Get the friendly name associated with the input class.
  104893. * @returns the input friendly name
  104894. */
  104895. getSimpleName(): string;
  104896. /**
  104897. * Called on pointer POINTERDOUBLETAP event.
  104898. * Override this method to provide functionality on POINTERDOUBLETAP event.
  104899. */
  104900. protected onDoubleTap(type: string): void;
  104901. /**
  104902. * Called on pointer POINTERMOVE event if only a single touch is active.
  104903. * Override this method to provide functionality.
  104904. */
  104905. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  104906. /**
  104907. * Called on pointer POINTERMOVE event if multiple touches are active.
  104908. * Override this method to provide functionality.
  104909. */
  104910. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  104911. /**
  104912. * Called on JS contextmenu event.
  104913. * Override this method to provide functionality.
  104914. */
  104915. protected onContextMenu(evt: PointerEvent): void;
  104916. /**
  104917. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  104918. * press.
  104919. * Override this method to provide functionality.
  104920. */
  104921. protected onButtonDown(evt: PointerEvent): void;
  104922. /**
  104923. * Called each time a new POINTERUP event occurs. Ie, for each button
  104924. * release.
  104925. * Override this method to provide functionality.
  104926. */
  104927. protected onButtonUp(evt: PointerEvent): void;
  104928. /**
  104929. * Called when window becomes inactive.
  104930. * Override this method to provide functionality.
  104931. */
  104932. protected onLostFocus(): void;
  104933. private _pointerInput;
  104934. private _observer;
  104935. private _onLostFocus;
  104936. private pointA;
  104937. private pointB;
  104938. }
  104939. }
  104940. declare module BABYLON {
  104941. /**
  104942. * Manage the pointers inputs to control an arc rotate camera.
  104943. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104944. */
  104945. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  104946. /**
  104947. * Defines the camera the input is attached to.
  104948. */
  104949. camera: ArcRotateCamera;
  104950. /**
  104951. * Gets the class name of the current input.
  104952. * @returns the class name
  104953. */
  104954. getClassName(): string;
  104955. /**
  104956. * Defines the buttons associated with the input to handle camera move.
  104957. */
  104958. buttons: number[];
  104959. /**
  104960. * Defines the pointer angular sensibility along the X axis or how fast is
  104961. * the camera rotating.
  104962. */
  104963. angularSensibilityX: number;
  104964. /**
  104965. * Defines the pointer angular sensibility along the Y axis or how fast is
  104966. * the camera rotating.
  104967. */
  104968. angularSensibilityY: number;
  104969. /**
  104970. * Defines the pointer pinch precision or how fast is the camera zooming.
  104971. */
  104972. pinchPrecision: number;
  104973. /**
  104974. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  104975. * from 0.
  104976. * It defines the percentage of current camera.radius to use as delta when
  104977. * pinch zoom is used.
  104978. */
  104979. pinchDeltaPercentage: number;
  104980. /**
  104981. * Defines the pointer panning sensibility or how fast is the camera moving.
  104982. */
  104983. panningSensibility: number;
  104984. /**
  104985. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  104986. */
  104987. multiTouchPanning: boolean;
  104988. /**
  104989. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  104990. * zoom (pinch) through multitouch.
  104991. */
  104992. multiTouchPanAndZoom: boolean;
  104993. /**
  104994. * Revers pinch action direction.
  104995. */
  104996. pinchInwards: boolean;
  104997. private _isPanClick;
  104998. private _twoFingerActivityCount;
  104999. private _isPinching;
  105000. /**
  105001. * Called on pointer POINTERMOVE event if only a single touch is active.
  105002. */
  105003. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  105004. /**
  105005. * Called on pointer POINTERDOUBLETAP event.
  105006. */
  105007. protected onDoubleTap(type: string): void;
  105008. /**
  105009. * Called on pointer POINTERMOVE event if multiple touches are active.
  105010. */
  105011. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  105012. /**
  105013. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  105014. * press.
  105015. */
  105016. protected onButtonDown(evt: PointerEvent): void;
  105017. /**
  105018. * Called each time a new POINTERUP event occurs. Ie, for each button
  105019. * release.
  105020. */
  105021. protected onButtonUp(evt: PointerEvent): void;
  105022. /**
  105023. * Called when window becomes inactive.
  105024. */
  105025. protected onLostFocus(): void;
  105026. }
  105027. }
  105028. declare module BABYLON {
  105029. /**
  105030. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  105031. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105032. */
  105033. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  105034. /**
  105035. * Defines the camera the input is attached to.
  105036. */
  105037. camera: ArcRotateCamera;
  105038. /**
  105039. * Defines the list of key codes associated with the up action (increase alpha)
  105040. */
  105041. keysUp: number[];
  105042. /**
  105043. * Defines the list of key codes associated with the down action (decrease alpha)
  105044. */
  105045. keysDown: number[];
  105046. /**
  105047. * Defines the list of key codes associated with the left action (increase beta)
  105048. */
  105049. keysLeft: number[];
  105050. /**
  105051. * Defines the list of key codes associated with the right action (decrease beta)
  105052. */
  105053. keysRight: number[];
  105054. /**
  105055. * Defines the list of key codes associated with the reset action.
  105056. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  105057. */
  105058. keysReset: number[];
  105059. /**
  105060. * Defines the panning sensibility of the inputs.
  105061. * (How fast is the camera paning)
  105062. */
  105063. panningSensibility: number;
  105064. /**
  105065. * Defines the zooming sensibility of the inputs.
  105066. * (How fast is the camera zooming)
  105067. */
  105068. zoomingSensibility: number;
  105069. /**
  105070. * Defines wether maintaining the alt key down switch the movement mode from
  105071. * orientation to zoom.
  105072. */
  105073. useAltToZoom: boolean;
  105074. /**
  105075. * Rotation speed of the camera
  105076. */
  105077. angularSpeed: number;
  105078. private _keys;
  105079. private _ctrlPressed;
  105080. private _altPressed;
  105081. private _onCanvasBlurObserver;
  105082. private _onKeyboardObserver;
  105083. private _engine;
  105084. private _scene;
  105085. /**
  105086. * Attach the input controls to a specific dom element to get the input from.
  105087. * @param element Defines the element the controls should be listened from
  105088. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105089. */
  105090. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105091. /**
  105092. * Detach the current controls from the specified dom element.
  105093. * @param element Defines the element to stop listening the inputs from
  105094. */
  105095. detachControl(element: Nullable<HTMLElement>): void;
  105096. /**
  105097. * Update the current camera state depending on the inputs that have been used this frame.
  105098. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105099. */
  105100. checkInputs(): void;
  105101. /**
  105102. * Gets the class name of the current intput.
  105103. * @returns the class name
  105104. */
  105105. getClassName(): string;
  105106. /**
  105107. * Get the friendly name associated with the input class.
  105108. * @returns the input friendly name
  105109. */
  105110. getSimpleName(): string;
  105111. }
  105112. }
  105113. declare module BABYLON {
  105114. /**
  105115. * Manage the mouse wheel inputs to control an arc rotate camera.
  105116. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105117. */
  105118. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  105119. /**
  105120. * Defines the camera the input is attached to.
  105121. */
  105122. camera: ArcRotateCamera;
  105123. /**
  105124. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  105125. */
  105126. wheelPrecision: number;
  105127. /**
  105128. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  105129. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  105130. */
  105131. wheelDeltaPercentage: number;
  105132. private _wheel;
  105133. private _observer;
  105134. private computeDeltaFromMouseWheelLegacyEvent;
  105135. /**
  105136. * Attach the input controls to a specific dom element to get the input from.
  105137. * @param element Defines the element the controls should be listened from
  105138. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105139. */
  105140. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105141. /**
  105142. * Detach the current controls from the specified dom element.
  105143. * @param element Defines the element to stop listening the inputs from
  105144. */
  105145. detachControl(element: Nullable<HTMLElement>): void;
  105146. /**
  105147. * Gets the class name of the current intput.
  105148. * @returns the class name
  105149. */
  105150. getClassName(): string;
  105151. /**
  105152. * Get the friendly name associated with the input class.
  105153. * @returns the input friendly name
  105154. */
  105155. getSimpleName(): string;
  105156. }
  105157. }
  105158. declare module BABYLON {
  105159. /**
  105160. * Default Inputs manager for the ArcRotateCamera.
  105161. * It groups all the default supported inputs for ease of use.
  105162. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105163. */
  105164. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  105165. /**
  105166. * Instantiates a new ArcRotateCameraInputsManager.
  105167. * @param camera Defines the camera the inputs belong to
  105168. */
  105169. constructor(camera: ArcRotateCamera);
  105170. /**
  105171. * Add mouse wheel input support to the input manager.
  105172. * @returns the current input manager
  105173. */
  105174. addMouseWheel(): ArcRotateCameraInputsManager;
  105175. /**
  105176. * Add pointers input support to the input manager.
  105177. * @returns the current input manager
  105178. */
  105179. addPointers(): ArcRotateCameraInputsManager;
  105180. /**
  105181. * Add keyboard input support to the input manager.
  105182. * @returns the current input manager
  105183. */
  105184. addKeyboard(): ArcRotateCameraInputsManager;
  105185. }
  105186. }
  105187. declare module BABYLON {
  105188. /**
  105189. * This represents an orbital type of camera.
  105190. *
  105191. * 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.
  105192. * 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.
  105193. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  105194. */
  105195. export class ArcRotateCamera extends TargetCamera {
  105196. /**
  105197. * Defines the rotation angle of the camera along the longitudinal axis.
  105198. */
  105199. alpha: number;
  105200. /**
  105201. * Defines the rotation angle of the camera along the latitudinal axis.
  105202. */
  105203. beta: number;
  105204. /**
  105205. * Defines the radius of the camera from it s target point.
  105206. */
  105207. radius: number;
  105208. protected _target: Vector3;
  105209. protected _targetHost: Nullable<AbstractMesh>;
  105210. /**
  105211. * Defines the target point of the camera.
  105212. * The camera looks towards it form the radius distance.
  105213. */
  105214. target: Vector3;
  105215. /**
  105216. * Define the current local position of the camera in the scene
  105217. */
  105218. position: Vector3;
  105219. protected _upVector: Vector3;
  105220. protected _upToYMatrix: Matrix;
  105221. protected _YToUpMatrix: Matrix;
  105222. /**
  105223. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  105224. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  105225. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  105226. */
  105227. upVector: Vector3;
  105228. /**
  105229. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  105230. */
  105231. setMatUp(): void;
  105232. /**
  105233. * Current inertia value on the longitudinal axis.
  105234. * The bigger this number the longer it will take for the camera to stop.
  105235. */
  105236. inertialAlphaOffset: number;
  105237. /**
  105238. * Current inertia value on the latitudinal axis.
  105239. * The bigger this number the longer it will take for the camera to stop.
  105240. */
  105241. inertialBetaOffset: number;
  105242. /**
  105243. * Current inertia value on the radius axis.
  105244. * The bigger this number the longer it will take for the camera to stop.
  105245. */
  105246. inertialRadiusOffset: number;
  105247. /**
  105248. * Minimum allowed angle on the longitudinal axis.
  105249. * This can help limiting how the Camera is able to move in the scene.
  105250. */
  105251. lowerAlphaLimit: Nullable<number>;
  105252. /**
  105253. * Maximum allowed angle on the longitudinal axis.
  105254. * This can help limiting how the Camera is able to move in the scene.
  105255. */
  105256. upperAlphaLimit: Nullable<number>;
  105257. /**
  105258. * Minimum allowed angle on the latitudinal axis.
  105259. * This can help limiting how the Camera is able to move in the scene.
  105260. */
  105261. lowerBetaLimit: number;
  105262. /**
  105263. * Maximum allowed angle on the latitudinal axis.
  105264. * This can help limiting how the Camera is able to move in the scene.
  105265. */
  105266. upperBetaLimit: number;
  105267. /**
  105268. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  105269. * This can help limiting how the Camera is able to move in the scene.
  105270. */
  105271. lowerRadiusLimit: Nullable<number>;
  105272. /**
  105273. * Maximum allowed distance of the camera to the target (The camera can not get further).
  105274. * This can help limiting how the Camera is able to move in the scene.
  105275. */
  105276. upperRadiusLimit: Nullable<number>;
  105277. /**
  105278. * Defines the current inertia value used during panning of the camera along the X axis.
  105279. */
  105280. inertialPanningX: number;
  105281. /**
  105282. * Defines the current inertia value used during panning of the camera along the Y axis.
  105283. */
  105284. inertialPanningY: number;
  105285. /**
  105286. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  105287. * Basically if your fingers moves away from more than this distance you will be considered
  105288. * in pinch mode.
  105289. */
  105290. pinchToPanMaxDistance: number;
  105291. /**
  105292. * Defines the maximum distance the camera can pan.
  105293. * This could help keeping the cammera always in your scene.
  105294. */
  105295. panningDistanceLimit: Nullable<number>;
  105296. /**
  105297. * Defines the target of the camera before paning.
  105298. */
  105299. panningOriginTarget: Vector3;
  105300. /**
  105301. * Defines the value of the inertia used during panning.
  105302. * 0 would mean stop inertia and one would mean no decelleration at all.
  105303. */
  105304. panningInertia: number;
  105305. /**
  105306. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  105307. */
  105308. angularSensibilityX: number;
  105309. /**
  105310. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  105311. */
  105312. angularSensibilityY: number;
  105313. /**
  105314. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  105315. */
  105316. pinchPrecision: number;
  105317. /**
  105318. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  105319. * It will be used instead of pinchDeltaPrecision if different from 0.
  105320. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  105321. */
  105322. pinchDeltaPercentage: number;
  105323. /**
  105324. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  105325. */
  105326. panningSensibility: number;
  105327. /**
  105328. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  105329. */
  105330. keysUp: number[];
  105331. /**
  105332. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  105333. */
  105334. keysDown: number[];
  105335. /**
  105336. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  105337. */
  105338. keysLeft: number[];
  105339. /**
  105340. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  105341. */
  105342. keysRight: number[];
  105343. /**
  105344. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  105345. */
  105346. wheelPrecision: number;
  105347. /**
  105348. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  105349. * It will be used instead of pinchDeltaPrecision if different from 0.
  105350. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  105351. */
  105352. wheelDeltaPercentage: number;
  105353. /**
  105354. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  105355. */
  105356. zoomOnFactor: number;
  105357. /**
  105358. * Defines a screen offset for the camera position.
  105359. */
  105360. targetScreenOffset: Vector2;
  105361. /**
  105362. * Allows the camera to be completely reversed.
  105363. * If false the camera can not arrive upside down.
  105364. */
  105365. allowUpsideDown: boolean;
  105366. /**
  105367. * Define if double tap/click is used to restore the previously saved state of the camera.
  105368. */
  105369. useInputToRestoreState: boolean;
  105370. /** @hidden */
  105371. _viewMatrix: Matrix;
  105372. /** @hidden */
  105373. _useCtrlForPanning: boolean;
  105374. /** @hidden */
  105375. _panningMouseButton: number;
  105376. /**
  105377. * Defines the input associated to the camera.
  105378. */
  105379. inputs: ArcRotateCameraInputsManager;
  105380. /** @hidden */
  105381. _reset: () => void;
  105382. /**
  105383. * Defines the allowed panning axis.
  105384. */
  105385. panningAxis: Vector3;
  105386. protected _localDirection: Vector3;
  105387. protected _transformedDirection: Vector3;
  105388. private _bouncingBehavior;
  105389. /**
  105390. * Gets the bouncing behavior of the camera if it has been enabled.
  105391. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  105392. */
  105393. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  105394. /**
  105395. * Defines if the bouncing behavior of the camera is enabled on the camera.
  105396. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  105397. */
  105398. useBouncingBehavior: boolean;
  105399. private _framingBehavior;
  105400. /**
  105401. * Gets the framing behavior of the camera if it has been enabled.
  105402. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  105403. */
  105404. readonly framingBehavior: Nullable<FramingBehavior>;
  105405. /**
  105406. * Defines if the framing behavior of the camera is enabled on the camera.
  105407. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  105408. */
  105409. useFramingBehavior: boolean;
  105410. private _autoRotationBehavior;
  105411. /**
  105412. * Gets the auto rotation behavior of the camera if it has been enabled.
  105413. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105414. */
  105415. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  105416. /**
  105417. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  105418. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105419. */
  105420. useAutoRotationBehavior: boolean;
  105421. /**
  105422. * Observable triggered when the mesh target has been changed on the camera.
  105423. */
  105424. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  105425. /**
  105426. * Event raised when the camera is colliding with a mesh.
  105427. */
  105428. onCollide: (collidedMesh: AbstractMesh) => void;
  105429. /**
  105430. * Defines whether the camera should check collision with the objects oh the scene.
  105431. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  105432. */
  105433. checkCollisions: boolean;
  105434. /**
  105435. * Defines the collision radius of the camera.
  105436. * This simulates a sphere around the camera.
  105437. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  105438. */
  105439. collisionRadius: Vector3;
  105440. protected _collider: Collider;
  105441. protected _previousPosition: Vector3;
  105442. protected _collisionVelocity: Vector3;
  105443. protected _newPosition: Vector3;
  105444. protected _previousAlpha: number;
  105445. protected _previousBeta: number;
  105446. protected _previousRadius: number;
  105447. protected _collisionTriggered: boolean;
  105448. protected _targetBoundingCenter: Nullable<Vector3>;
  105449. private _computationVector;
  105450. /**
  105451. * Instantiates a new ArcRotateCamera in a given scene
  105452. * @param name Defines the name of the camera
  105453. * @param alpha Defines the camera rotation along the logitudinal axis
  105454. * @param beta Defines the camera rotation along the latitudinal axis
  105455. * @param radius Defines the camera distance from its target
  105456. * @param target Defines the camera target
  105457. * @param scene Defines the scene the camera belongs to
  105458. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  105459. */
  105460. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  105461. /** @hidden */
  105462. _initCache(): void;
  105463. /** @hidden */
  105464. _updateCache(ignoreParentClass?: boolean): void;
  105465. protected _getTargetPosition(): Vector3;
  105466. private _storedAlpha;
  105467. private _storedBeta;
  105468. private _storedRadius;
  105469. private _storedTarget;
  105470. private _storedTargetScreenOffset;
  105471. /**
  105472. * Stores the current state of the camera (alpha, beta, radius and target)
  105473. * @returns the camera itself
  105474. */
  105475. storeState(): Camera;
  105476. /**
  105477. * @hidden
  105478. * Restored camera state. You must call storeState() first
  105479. */
  105480. _restoreStateValues(): boolean;
  105481. /** @hidden */
  105482. _isSynchronizedViewMatrix(): boolean;
  105483. /**
  105484. * Attached controls to the current camera.
  105485. * @param element Defines the element the controls should be listened from
  105486. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105487. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  105488. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  105489. */
  105490. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  105491. /**
  105492. * Detach the current controls from the camera.
  105493. * The camera will stop reacting to inputs.
  105494. * @param element Defines the element to stop listening the inputs from
  105495. */
  105496. detachControl(element: HTMLElement): void;
  105497. /** @hidden */
  105498. _checkInputs(): void;
  105499. protected _checkLimits(): void;
  105500. /**
  105501. * Rebuilds angles (alpha, beta) and radius from the give position and target
  105502. */
  105503. rebuildAnglesAndRadius(): void;
  105504. /**
  105505. * Use a position to define the current camera related information like alpha, beta and radius
  105506. * @param position Defines the position to set the camera at
  105507. */
  105508. setPosition(position: Vector3): void;
  105509. /**
  105510. * Defines the target the camera should look at.
  105511. * This will automatically adapt alpha beta and radius to fit within the new target.
  105512. * @param target Defines the new target as a Vector or a mesh
  105513. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  105514. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  105515. */
  105516. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  105517. /** @hidden */
  105518. _getViewMatrix(): Matrix;
  105519. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  105520. /**
  105521. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  105522. * @param meshes Defines the mesh to zoom on
  105523. * @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)
  105524. */
  105525. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  105526. /**
  105527. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  105528. * The target will be changed but the radius
  105529. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  105530. * @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)
  105531. */
  105532. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  105533. min: Vector3;
  105534. max: Vector3;
  105535. distance: number;
  105536. }, doNotUpdateMaxZ?: boolean): void;
  105537. /**
  105538. * @override
  105539. * Override Camera.createRigCamera
  105540. */
  105541. createRigCamera(name: string, cameraIndex: number): Camera;
  105542. /**
  105543. * @hidden
  105544. * @override
  105545. * Override Camera._updateRigCameras
  105546. */
  105547. _updateRigCameras(): void;
  105548. /**
  105549. * Destroy the camera and release the current resources hold by it.
  105550. */
  105551. dispose(): void;
  105552. /**
  105553. * Gets the current object class name.
  105554. * @return the class name
  105555. */
  105556. getClassName(): string;
  105557. }
  105558. }
  105559. declare module BABYLON {
  105560. /**
  105561. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  105562. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105563. */
  105564. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  105565. /**
  105566. * Gets the name of the behavior.
  105567. */
  105568. readonly name: string;
  105569. private _zoomStopsAnimation;
  105570. private _idleRotationSpeed;
  105571. private _idleRotationWaitTime;
  105572. private _idleRotationSpinupTime;
  105573. /**
  105574. * Sets the flag that indicates if user zooming should stop animation.
  105575. */
  105576. /**
  105577. * Gets the flag that indicates if user zooming should stop animation.
  105578. */
  105579. zoomStopsAnimation: boolean;
  105580. /**
  105581. * Sets the default speed at which the camera rotates around the model.
  105582. */
  105583. /**
  105584. * Gets the default speed at which the camera rotates around the model.
  105585. */
  105586. idleRotationSpeed: number;
  105587. /**
  105588. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  105589. */
  105590. /**
  105591. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  105592. */
  105593. idleRotationWaitTime: number;
  105594. /**
  105595. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  105596. */
  105597. /**
  105598. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  105599. */
  105600. idleRotationSpinupTime: number;
  105601. /**
  105602. * Gets a value indicating if the camera is currently rotating because of this behavior
  105603. */
  105604. readonly rotationInProgress: boolean;
  105605. private _onPrePointerObservableObserver;
  105606. private _onAfterCheckInputsObserver;
  105607. private _attachedCamera;
  105608. private _isPointerDown;
  105609. private _lastFrameTime;
  105610. private _lastInteractionTime;
  105611. private _cameraRotationSpeed;
  105612. /**
  105613. * Initializes the behavior.
  105614. */
  105615. init(): void;
  105616. /**
  105617. * Attaches the behavior to its arc rotate camera.
  105618. * @param camera Defines the camera to attach the behavior to
  105619. */
  105620. attach(camera: ArcRotateCamera): void;
  105621. /**
  105622. * Detaches the behavior from its current arc rotate camera.
  105623. */
  105624. detach(): void;
  105625. /**
  105626. * Returns true if user is scrolling.
  105627. * @return true if user is scrolling.
  105628. */
  105629. private _userIsZooming;
  105630. private _lastFrameRadius;
  105631. private _shouldAnimationStopForInteraction;
  105632. /**
  105633. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  105634. */
  105635. private _applyUserInteraction;
  105636. private _userIsMoving;
  105637. }
  105638. }
  105639. declare module BABYLON {
  105640. /**
  105641. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  105642. */
  105643. export class AttachToBoxBehavior implements Behavior<Mesh> {
  105644. private ui;
  105645. /**
  105646. * The name of the behavior
  105647. */
  105648. name: string;
  105649. /**
  105650. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  105651. */
  105652. distanceAwayFromFace: number;
  105653. /**
  105654. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  105655. */
  105656. distanceAwayFromBottomOfFace: number;
  105657. private _faceVectors;
  105658. private _target;
  105659. private _scene;
  105660. private _onRenderObserver;
  105661. private _tmpMatrix;
  105662. private _tmpVector;
  105663. /**
  105664. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  105665. * @param ui The transform node that should be attched to the mesh
  105666. */
  105667. constructor(ui: TransformNode);
  105668. /**
  105669. * Initializes the behavior
  105670. */
  105671. init(): void;
  105672. private _closestFace;
  105673. private _zeroVector;
  105674. private _lookAtTmpMatrix;
  105675. private _lookAtToRef;
  105676. /**
  105677. * Attaches the AttachToBoxBehavior to the passed in mesh
  105678. * @param target The mesh that the specified node will be attached to
  105679. */
  105680. attach(target: Mesh): void;
  105681. /**
  105682. * Detaches the behavior from the mesh
  105683. */
  105684. detach(): void;
  105685. }
  105686. }
  105687. declare module BABYLON {
  105688. /**
  105689. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  105690. */
  105691. export class FadeInOutBehavior implements Behavior<Mesh> {
  105692. /**
  105693. * Time in milliseconds to delay before fading in (Default: 0)
  105694. */
  105695. delay: number;
  105696. /**
  105697. * Time in milliseconds for the mesh to fade in (Default: 300)
  105698. */
  105699. fadeInTime: number;
  105700. private _millisecondsPerFrame;
  105701. private _hovered;
  105702. private _hoverValue;
  105703. private _ownerNode;
  105704. /**
  105705. * Instatiates the FadeInOutBehavior
  105706. */
  105707. constructor();
  105708. /**
  105709. * The name of the behavior
  105710. */
  105711. readonly name: string;
  105712. /**
  105713. * Initializes the behavior
  105714. */
  105715. init(): void;
  105716. /**
  105717. * Attaches the fade behavior on the passed in mesh
  105718. * @param ownerNode The mesh that will be faded in/out once attached
  105719. */
  105720. attach(ownerNode: Mesh): void;
  105721. /**
  105722. * Detaches the behavior from the mesh
  105723. */
  105724. detach(): void;
  105725. /**
  105726. * Triggers the mesh to begin fading in or out
  105727. * @param value if the object should fade in or out (true to fade in)
  105728. */
  105729. fadeIn(value: boolean): void;
  105730. private _update;
  105731. private _setAllVisibility;
  105732. }
  105733. }
  105734. declare module BABYLON {
  105735. /**
  105736. * Class containing a set of static utilities functions for managing Pivots
  105737. * @hidden
  105738. */
  105739. export class PivotTools {
  105740. private static _PivotCached;
  105741. private static _OldPivotPoint;
  105742. private static _PivotTranslation;
  105743. private static _PivotTmpVector;
  105744. /** @hidden */
  105745. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  105746. /** @hidden */
  105747. static _RestorePivotPoint(mesh: AbstractMesh): void;
  105748. }
  105749. }
  105750. declare module BABYLON {
  105751. /**
  105752. * Class containing static functions to help procedurally build meshes
  105753. */
  105754. export class PlaneBuilder {
  105755. /**
  105756. * Creates a plane mesh
  105757. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  105758. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  105759. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  105760. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  105761. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  105762. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  105763. * @param name defines the name of the mesh
  105764. * @param options defines the options used to create the mesh
  105765. * @param scene defines the hosting scene
  105766. * @returns the plane mesh
  105767. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  105768. */
  105769. static CreatePlane(name: string, options: {
  105770. size?: number;
  105771. width?: number;
  105772. height?: number;
  105773. sideOrientation?: number;
  105774. frontUVs?: Vector4;
  105775. backUVs?: Vector4;
  105776. updatable?: boolean;
  105777. sourcePlane?: Plane;
  105778. }, scene?: Nullable<Scene>): Mesh;
  105779. }
  105780. }
  105781. declare module BABYLON {
  105782. /**
  105783. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  105784. */
  105785. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  105786. private static _AnyMouseID;
  105787. /**
  105788. * Abstract mesh the behavior is set on
  105789. */
  105790. attachedNode: AbstractMesh;
  105791. private _dragPlane;
  105792. private _scene;
  105793. private _pointerObserver;
  105794. private _beforeRenderObserver;
  105795. private static _planeScene;
  105796. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  105797. /**
  105798. * 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)
  105799. */
  105800. maxDragAngle: number;
  105801. /**
  105802. * @hidden
  105803. */
  105804. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  105805. /**
  105806. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  105807. */
  105808. currentDraggingPointerID: number;
  105809. /**
  105810. * The last position where the pointer hit the drag plane in world space
  105811. */
  105812. lastDragPosition: Vector3;
  105813. /**
  105814. * If the behavior is currently in a dragging state
  105815. */
  105816. dragging: boolean;
  105817. /**
  105818. * 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)
  105819. */
  105820. dragDeltaRatio: number;
  105821. /**
  105822. * If the drag plane orientation should be updated during the dragging (Default: true)
  105823. */
  105824. updateDragPlane: boolean;
  105825. private _debugMode;
  105826. private _moving;
  105827. /**
  105828. * Fires each time the attached mesh is dragged with the pointer
  105829. * * delta between last drag position and current drag position in world space
  105830. * * dragDistance along the drag axis
  105831. * * dragPlaneNormal normal of the current drag plane used during the drag
  105832. * * dragPlanePoint in world space where the drag intersects the drag plane
  105833. */
  105834. onDragObservable: Observable<{
  105835. delta: Vector3;
  105836. dragPlanePoint: Vector3;
  105837. dragPlaneNormal: Vector3;
  105838. dragDistance: number;
  105839. pointerId: number;
  105840. }>;
  105841. /**
  105842. * Fires each time a drag begins (eg. mouse down on mesh)
  105843. */
  105844. onDragStartObservable: Observable<{
  105845. dragPlanePoint: Vector3;
  105846. pointerId: number;
  105847. }>;
  105848. /**
  105849. * Fires each time a drag ends (eg. mouse release after drag)
  105850. */
  105851. onDragEndObservable: Observable<{
  105852. dragPlanePoint: Vector3;
  105853. pointerId: number;
  105854. }>;
  105855. /**
  105856. * If the attached mesh should be moved when dragged
  105857. */
  105858. moveAttached: boolean;
  105859. /**
  105860. * If the drag behavior will react to drag events (Default: true)
  105861. */
  105862. enabled: boolean;
  105863. /**
  105864. * If pointer events should start and release the drag (Default: true)
  105865. */
  105866. startAndReleaseDragOnPointerEvents: boolean;
  105867. /**
  105868. * If camera controls should be detached during the drag
  105869. */
  105870. detachCameraControls: boolean;
  105871. /**
  105872. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  105873. */
  105874. useObjectOrienationForDragging: boolean;
  105875. private _options;
  105876. /**
  105877. * Creates a pointer drag behavior that can be attached to a mesh
  105878. * @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)
  105879. */
  105880. constructor(options?: {
  105881. dragAxis?: Vector3;
  105882. dragPlaneNormal?: Vector3;
  105883. });
  105884. /**
  105885. * Predicate to determine if it is valid to move the object to a new position when it is moved
  105886. */
  105887. validateDrag: (targetPosition: Vector3) => boolean;
  105888. /**
  105889. * The name of the behavior
  105890. */
  105891. readonly name: string;
  105892. /**
  105893. * Initializes the behavior
  105894. */
  105895. init(): void;
  105896. private _tmpVector;
  105897. private _alternatePickedPoint;
  105898. private _worldDragAxis;
  105899. private _targetPosition;
  105900. private _attachedElement;
  105901. /**
  105902. * Attaches the drag behavior the passed in mesh
  105903. * @param ownerNode The mesh that will be dragged around once attached
  105904. * @param predicate Predicate to use for pick filtering
  105905. */
  105906. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  105907. /**
  105908. * Force relase the drag action by code.
  105909. */
  105910. releaseDrag(): void;
  105911. private _startDragRay;
  105912. private _lastPointerRay;
  105913. /**
  105914. * Simulates the start of a pointer drag event on the behavior
  105915. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  105916. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  105917. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  105918. */
  105919. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  105920. private _startDrag;
  105921. private _dragDelta;
  105922. private _moveDrag;
  105923. private _pickWithRayOnDragPlane;
  105924. private _pointA;
  105925. private _pointB;
  105926. private _pointC;
  105927. private _lineA;
  105928. private _lineB;
  105929. private _localAxis;
  105930. private _lookAt;
  105931. private _updateDragPlanePosition;
  105932. /**
  105933. * Detaches the behavior from the mesh
  105934. */
  105935. detach(): void;
  105936. }
  105937. }
  105938. declare module BABYLON {
  105939. /**
  105940. * A behavior that when attached to a mesh will allow the mesh to be scaled
  105941. */
  105942. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  105943. private _dragBehaviorA;
  105944. private _dragBehaviorB;
  105945. private _startDistance;
  105946. private _initialScale;
  105947. private _targetScale;
  105948. private _ownerNode;
  105949. private _sceneRenderObserver;
  105950. /**
  105951. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  105952. */
  105953. constructor();
  105954. /**
  105955. * The name of the behavior
  105956. */
  105957. readonly name: string;
  105958. /**
  105959. * Initializes the behavior
  105960. */
  105961. init(): void;
  105962. private _getCurrentDistance;
  105963. /**
  105964. * Attaches the scale behavior the passed in mesh
  105965. * @param ownerNode The mesh that will be scaled around once attached
  105966. */
  105967. attach(ownerNode: Mesh): void;
  105968. /**
  105969. * Detaches the behavior from the mesh
  105970. */
  105971. detach(): void;
  105972. }
  105973. }
  105974. declare module BABYLON {
  105975. /**
  105976. * 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
  105977. */
  105978. export class SixDofDragBehavior implements Behavior<Mesh> {
  105979. private static _virtualScene;
  105980. private _ownerNode;
  105981. private _sceneRenderObserver;
  105982. private _scene;
  105983. private _targetPosition;
  105984. private _virtualOriginMesh;
  105985. private _virtualDragMesh;
  105986. private _pointerObserver;
  105987. private _moving;
  105988. private _startingOrientation;
  105989. /**
  105990. * 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)
  105991. */
  105992. private zDragFactor;
  105993. /**
  105994. * If the object should rotate to face the drag origin
  105995. */
  105996. rotateDraggedObject: boolean;
  105997. /**
  105998. * If the behavior is currently in a dragging state
  105999. */
  106000. dragging: boolean;
  106001. /**
  106002. * 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)
  106003. */
  106004. dragDeltaRatio: number;
  106005. /**
  106006. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  106007. */
  106008. currentDraggingPointerID: number;
  106009. /**
  106010. * If camera controls should be detached during the drag
  106011. */
  106012. detachCameraControls: boolean;
  106013. /**
  106014. * Fires each time a drag starts
  106015. */
  106016. onDragStartObservable: Observable<{}>;
  106017. /**
  106018. * Fires each time a drag ends (eg. mouse release after drag)
  106019. */
  106020. onDragEndObservable: Observable<{}>;
  106021. /**
  106022. * 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
  106023. */
  106024. constructor();
  106025. /**
  106026. * The name of the behavior
  106027. */
  106028. readonly name: string;
  106029. /**
  106030. * Initializes the behavior
  106031. */
  106032. init(): void;
  106033. /**
  106034. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  106035. */
  106036. private readonly _pointerCamera;
  106037. /**
  106038. * Attaches the scale behavior the passed in mesh
  106039. * @param ownerNode The mesh that will be scaled around once attached
  106040. */
  106041. attach(ownerNode: Mesh): void;
  106042. /**
  106043. * Detaches the behavior from the mesh
  106044. */
  106045. detach(): void;
  106046. }
  106047. }
  106048. declare module BABYLON {
  106049. /**
  106050. * Class used to apply inverse kinematics to bones
  106051. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  106052. */
  106053. export class BoneIKController {
  106054. private static _tmpVecs;
  106055. private static _tmpQuat;
  106056. private static _tmpMats;
  106057. /**
  106058. * Gets or sets the target mesh
  106059. */
  106060. targetMesh: AbstractMesh;
  106061. /** Gets or sets the mesh used as pole */
  106062. poleTargetMesh: AbstractMesh;
  106063. /**
  106064. * Gets or sets the bone used as pole
  106065. */
  106066. poleTargetBone: Nullable<Bone>;
  106067. /**
  106068. * Gets or sets the target position
  106069. */
  106070. targetPosition: Vector3;
  106071. /**
  106072. * Gets or sets the pole target position
  106073. */
  106074. poleTargetPosition: Vector3;
  106075. /**
  106076. * Gets or sets the pole target local offset
  106077. */
  106078. poleTargetLocalOffset: Vector3;
  106079. /**
  106080. * Gets or sets the pole angle
  106081. */
  106082. poleAngle: number;
  106083. /**
  106084. * Gets or sets the mesh associated with the controller
  106085. */
  106086. mesh: AbstractMesh;
  106087. /**
  106088. * 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)
  106089. */
  106090. slerpAmount: number;
  106091. private _bone1Quat;
  106092. private _bone1Mat;
  106093. private _bone2Ang;
  106094. private _bone1;
  106095. private _bone2;
  106096. private _bone1Length;
  106097. private _bone2Length;
  106098. private _maxAngle;
  106099. private _maxReach;
  106100. private _rightHandedSystem;
  106101. private _bendAxis;
  106102. private _slerping;
  106103. private _adjustRoll;
  106104. /**
  106105. * Gets or sets maximum allowed angle
  106106. */
  106107. maxAngle: number;
  106108. /**
  106109. * Creates a new BoneIKController
  106110. * @param mesh defines the mesh to control
  106111. * @param bone defines the bone to control
  106112. * @param options defines options to set up the controller
  106113. */
  106114. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  106115. targetMesh?: AbstractMesh;
  106116. poleTargetMesh?: AbstractMesh;
  106117. poleTargetBone?: Bone;
  106118. poleTargetLocalOffset?: Vector3;
  106119. poleAngle?: number;
  106120. bendAxis?: Vector3;
  106121. maxAngle?: number;
  106122. slerpAmount?: number;
  106123. });
  106124. private _setMaxAngle;
  106125. /**
  106126. * Force the controller to update the bones
  106127. */
  106128. update(): void;
  106129. }
  106130. }
  106131. declare module BABYLON {
  106132. /**
  106133. * Class used to make a bone look toward a point in space
  106134. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  106135. */
  106136. export class BoneLookController {
  106137. private static _tmpVecs;
  106138. private static _tmpQuat;
  106139. private static _tmpMats;
  106140. /**
  106141. * The target Vector3 that the bone will look at
  106142. */
  106143. target: Vector3;
  106144. /**
  106145. * The mesh that the bone is attached to
  106146. */
  106147. mesh: AbstractMesh;
  106148. /**
  106149. * The bone that will be looking to the target
  106150. */
  106151. bone: Bone;
  106152. /**
  106153. * The up axis of the coordinate system that is used when the bone is rotated
  106154. */
  106155. upAxis: Vector3;
  106156. /**
  106157. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  106158. */
  106159. upAxisSpace: Space;
  106160. /**
  106161. * Used to make an adjustment to the yaw of the bone
  106162. */
  106163. adjustYaw: number;
  106164. /**
  106165. * Used to make an adjustment to the pitch of the bone
  106166. */
  106167. adjustPitch: number;
  106168. /**
  106169. * Used to make an adjustment to the roll of the bone
  106170. */
  106171. adjustRoll: number;
  106172. /**
  106173. * 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)
  106174. */
  106175. slerpAmount: number;
  106176. private _minYaw;
  106177. private _maxYaw;
  106178. private _minPitch;
  106179. private _maxPitch;
  106180. private _minYawSin;
  106181. private _minYawCos;
  106182. private _maxYawSin;
  106183. private _maxYawCos;
  106184. private _midYawConstraint;
  106185. private _minPitchTan;
  106186. private _maxPitchTan;
  106187. private _boneQuat;
  106188. private _slerping;
  106189. private _transformYawPitch;
  106190. private _transformYawPitchInv;
  106191. private _firstFrameSkipped;
  106192. private _yawRange;
  106193. private _fowardAxis;
  106194. /**
  106195. * Gets or sets the minimum yaw angle that the bone can look to
  106196. */
  106197. minYaw: number;
  106198. /**
  106199. * Gets or sets the maximum yaw angle that the bone can look to
  106200. */
  106201. maxYaw: number;
  106202. /**
  106203. * Gets or sets the minimum pitch angle that the bone can look to
  106204. */
  106205. minPitch: number;
  106206. /**
  106207. * Gets or sets the maximum pitch angle that the bone can look to
  106208. */
  106209. maxPitch: number;
  106210. /**
  106211. * Create a BoneLookController
  106212. * @param mesh the mesh that the bone belongs to
  106213. * @param bone the bone that will be looking to the target
  106214. * @param target the target Vector3 to look at
  106215. * @param options optional settings:
  106216. * * maxYaw: the maximum angle the bone will yaw to
  106217. * * minYaw: the minimum angle the bone will yaw to
  106218. * * maxPitch: the maximum angle the bone will pitch to
  106219. * * minPitch: the minimum angle the bone will yaw to
  106220. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  106221. * * upAxis: the up axis of the coordinate system
  106222. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  106223. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  106224. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  106225. * * adjustYaw: used to make an adjustment to the yaw of the bone
  106226. * * adjustPitch: used to make an adjustment to the pitch of the bone
  106227. * * adjustRoll: used to make an adjustment to the roll of the bone
  106228. **/
  106229. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  106230. maxYaw?: number;
  106231. minYaw?: number;
  106232. maxPitch?: number;
  106233. minPitch?: number;
  106234. slerpAmount?: number;
  106235. upAxis?: Vector3;
  106236. upAxisSpace?: Space;
  106237. yawAxis?: Vector3;
  106238. pitchAxis?: Vector3;
  106239. adjustYaw?: number;
  106240. adjustPitch?: number;
  106241. adjustRoll?: number;
  106242. });
  106243. /**
  106244. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  106245. */
  106246. update(): void;
  106247. private _getAngleDiff;
  106248. private _getAngleBetween;
  106249. private _isAngleBetween;
  106250. }
  106251. }
  106252. declare module BABYLON {
  106253. /**
  106254. * Manage the gamepad inputs to control an arc rotate camera.
  106255. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106256. */
  106257. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  106258. /**
  106259. * Defines the camera the input is attached to.
  106260. */
  106261. camera: ArcRotateCamera;
  106262. /**
  106263. * Defines the gamepad the input is gathering event from.
  106264. */
  106265. gamepad: Nullable<Gamepad>;
  106266. /**
  106267. * Defines the gamepad rotation sensiblity.
  106268. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  106269. */
  106270. gamepadRotationSensibility: number;
  106271. /**
  106272. * Defines the gamepad move sensiblity.
  106273. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  106274. */
  106275. gamepadMoveSensibility: number;
  106276. private _yAxisScale;
  106277. /**
  106278. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  106279. */
  106280. invertYAxis: boolean;
  106281. private _onGamepadConnectedObserver;
  106282. private _onGamepadDisconnectedObserver;
  106283. /**
  106284. * Attach the input controls to a specific dom element to get the input from.
  106285. * @param element Defines the element the controls should be listened from
  106286. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106287. */
  106288. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106289. /**
  106290. * Detach the current controls from the specified dom element.
  106291. * @param element Defines the element to stop listening the inputs from
  106292. */
  106293. detachControl(element: Nullable<HTMLElement>): void;
  106294. /**
  106295. * Update the current camera state depending on the inputs that have been used this frame.
  106296. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106297. */
  106298. checkInputs(): void;
  106299. /**
  106300. * Gets the class name of the current intput.
  106301. * @returns the class name
  106302. */
  106303. getClassName(): string;
  106304. /**
  106305. * Get the friendly name associated with the input class.
  106306. * @returns the input friendly name
  106307. */
  106308. getSimpleName(): string;
  106309. }
  106310. }
  106311. declare module BABYLON {
  106312. interface ArcRotateCameraInputsManager {
  106313. /**
  106314. * Add orientation input support to the input manager.
  106315. * @returns the current input manager
  106316. */
  106317. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  106318. }
  106319. /**
  106320. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  106321. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106322. */
  106323. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  106324. /**
  106325. * Defines the camera the input is attached to.
  106326. */
  106327. camera: ArcRotateCamera;
  106328. /**
  106329. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  106330. */
  106331. alphaCorrection: number;
  106332. /**
  106333. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  106334. */
  106335. gammaCorrection: number;
  106336. private _alpha;
  106337. private _gamma;
  106338. private _dirty;
  106339. private _deviceOrientationHandler;
  106340. /**
  106341. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  106342. */
  106343. constructor();
  106344. /**
  106345. * Attach the input controls to a specific dom element to get the input from.
  106346. * @param element Defines the element the controls should be listened from
  106347. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106348. */
  106349. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106350. /** @hidden */
  106351. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  106352. /**
  106353. * Update the current camera state depending on the inputs that have been used this frame.
  106354. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106355. */
  106356. checkInputs(): void;
  106357. /**
  106358. * Detach the current controls from the specified dom element.
  106359. * @param element Defines the element to stop listening the inputs from
  106360. */
  106361. detachControl(element: Nullable<HTMLElement>): void;
  106362. /**
  106363. * Gets the class name of the current intput.
  106364. * @returns the class name
  106365. */
  106366. getClassName(): string;
  106367. /**
  106368. * Get the friendly name associated with the input class.
  106369. * @returns the input friendly name
  106370. */
  106371. getSimpleName(): string;
  106372. }
  106373. }
  106374. declare module BABYLON {
  106375. /**
  106376. * Listen to mouse events to control the camera.
  106377. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106378. */
  106379. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  106380. /**
  106381. * Defines the camera the input is attached to.
  106382. */
  106383. camera: FlyCamera;
  106384. /**
  106385. * Defines if touch is enabled. (Default is true.)
  106386. */
  106387. touchEnabled: boolean;
  106388. /**
  106389. * Defines the buttons associated with the input to handle camera rotation.
  106390. */
  106391. buttons: number[];
  106392. /**
  106393. * Assign buttons for Yaw control.
  106394. */
  106395. buttonsYaw: number[];
  106396. /**
  106397. * Assign buttons for Pitch control.
  106398. */
  106399. buttonsPitch: number[];
  106400. /**
  106401. * Assign buttons for Roll control.
  106402. */
  106403. buttonsRoll: number[];
  106404. /**
  106405. * Detect if any button is being pressed while mouse is moved.
  106406. * -1 = Mouse locked.
  106407. * 0 = Left button.
  106408. * 1 = Middle Button.
  106409. * 2 = Right Button.
  106410. */
  106411. activeButton: number;
  106412. /**
  106413. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  106414. * Higher values reduce its sensitivity.
  106415. */
  106416. angularSensibility: number;
  106417. private _mousemoveCallback;
  106418. private _observer;
  106419. private _rollObserver;
  106420. private previousPosition;
  106421. private noPreventDefault;
  106422. private element;
  106423. /**
  106424. * Listen to mouse events to control the camera.
  106425. * @param touchEnabled Define if touch is enabled. (Default is true.)
  106426. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106427. */
  106428. constructor(touchEnabled?: boolean);
  106429. /**
  106430. * Attach the mouse control to the HTML DOM element.
  106431. * @param element Defines the element that listens to the input events.
  106432. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  106433. */
  106434. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106435. /**
  106436. * Detach the current controls from the specified dom element.
  106437. * @param element Defines the element to stop listening the inputs from
  106438. */
  106439. detachControl(element: Nullable<HTMLElement>): void;
  106440. /**
  106441. * Gets the class name of the current input.
  106442. * @returns the class name.
  106443. */
  106444. getClassName(): string;
  106445. /**
  106446. * Get the friendly name associated with the input class.
  106447. * @returns the input's friendly name.
  106448. */
  106449. getSimpleName(): string;
  106450. private _pointerInput;
  106451. private _onMouseMove;
  106452. /**
  106453. * Rotate camera by mouse offset.
  106454. */
  106455. private rotateCamera;
  106456. }
  106457. }
  106458. declare module BABYLON {
  106459. /**
  106460. * Default Inputs manager for the FlyCamera.
  106461. * It groups all the default supported inputs for ease of use.
  106462. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106463. */
  106464. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  106465. /**
  106466. * Instantiates a new FlyCameraInputsManager.
  106467. * @param camera Defines the camera the inputs belong to.
  106468. */
  106469. constructor(camera: FlyCamera);
  106470. /**
  106471. * Add keyboard input support to the input manager.
  106472. * @returns the new FlyCameraKeyboardMoveInput().
  106473. */
  106474. addKeyboard(): FlyCameraInputsManager;
  106475. /**
  106476. * Add mouse input support to the input manager.
  106477. * @param touchEnabled Enable touch screen support.
  106478. * @returns the new FlyCameraMouseInput().
  106479. */
  106480. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  106481. }
  106482. }
  106483. declare module BABYLON {
  106484. /**
  106485. * This is a flying camera, designed for 3D movement and rotation in all directions,
  106486. * such as in a 3D Space Shooter or a Flight Simulator.
  106487. */
  106488. export class FlyCamera extends TargetCamera {
  106489. /**
  106490. * Define the collision ellipsoid of the camera.
  106491. * This is helpful for simulating a camera body, like a player's body.
  106492. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  106493. */
  106494. ellipsoid: Vector3;
  106495. /**
  106496. * Define an offset for the position of the ellipsoid around the camera.
  106497. * This can be helpful if the camera is attached away from the player's body center,
  106498. * such as at its head.
  106499. */
  106500. ellipsoidOffset: Vector3;
  106501. /**
  106502. * Enable or disable collisions of the camera with the rest of the scene objects.
  106503. */
  106504. checkCollisions: boolean;
  106505. /**
  106506. * Enable or disable gravity on the camera.
  106507. */
  106508. applyGravity: boolean;
  106509. /**
  106510. * Define the current direction the camera is moving to.
  106511. */
  106512. cameraDirection: Vector3;
  106513. /**
  106514. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  106515. * This overrides and empties cameraRotation.
  106516. */
  106517. rotationQuaternion: Quaternion;
  106518. /**
  106519. * Track Roll to maintain the wanted Rolling when looking around.
  106520. */
  106521. _trackRoll: number;
  106522. /**
  106523. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  106524. */
  106525. rollCorrect: number;
  106526. /**
  106527. * Mimic a banked turn, Rolling the camera when Yawing.
  106528. * It's recommended to use rollCorrect = 10 for faster banking correction.
  106529. */
  106530. bankedTurn: boolean;
  106531. /**
  106532. * Limit in radians for how much Roll banking will add. (Default: 90°)
  106533. */
  106534. bankedTurnLimit: number;
  106535. /**
  106536. * Value of 0 disables the banked Roll.
  106537. * Value of 1 is equal to the Yaw angle in radians.
  106538. */
  106539. bankedTurnMultiplier: number;
  106540. /**
  106541. * The inputs manager loads all the input sources, such as keyboard and mouse.
  106542. */
  106543. inputs: FlyCameraInputsManager;
  106544. /**
  106545. * Gets the input sensibility for mouse input.
  106546. * Higher values reduce sensitivity.
  106547. */
  106548. /**
  106549. * Sets the input sensibility for a mouse input.
  106550. * Higher values reduce sensitivity.
  106551. */
  106552. angularSensibility: number;
  106553. /**
  106554. * Get the keys for camera movement forward.
  106555. */
  106556. /**
  106557. * Set the keys for camera movement forward.
  106558. */
  106559. keysForward: number[];
  106560. /**
  106561. * Get the keys for camera movement backward.
  106562. */
  106563. keysBackward: number[];
  106564. /**
  106565. * Get the keys for camera movement up.
  106566. */
  106567. /**
  106568. * Set the keys for camera movement up.
  106569. */
  106570. keysUp: number[];
  106571. /**
  106572. * Get the keys for camera movement down.
  106573. */
  106574. /**
  106575. * Set the keys for camera movement down.
  106576. */
  106577. keysDown: number[];
  106578. /**
  106579. * Get the keys for camera movement left.
  106580. */
  106581. /**
  106582. * Set the keys for camera movement left.
  106583. */
  106584. keysLeft: number[];
  106585. /**
  106586. * Set the keys for camera movement right.
  106587. */
  106588. /**
  106589. * Set the keys for camera movement right.
  106590. */
  106591. keysRight: number[];
  106592. /**
  106593. * Event raised when the camera collides with a mesh in the scene.
  106594. */
  106595. onCollide: (collidedMesh: AbstractMesh) => void;
  106596. private _collider;
  106597. private _needMoveForGravity;
  106598. private _oldPosition;
  106599. private _diffPosition;
  106600. private _newPosition;
  106601. /** @hidden */
  106602. _localDirection: Vector3;
  106603. /** @hidden */
  106604. _transformedDirection: Vector3;
  106605. /**
  106606. * Instantiates a FlyCamera.
  106607. * This is a flying camera, designed for 3D movement and rotation in all directions,
  106608. * such as in a 3D Space Shooter or a Flight Simulator.
  106609. * @param name Define the name of the camera in the scene.
  106610. * @param position Define the starting position of the camera in the scene.
  106611. * @param scene Define the scene the camera belongs to.
  106612. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  106613. */
  106614. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  106615. /**
  106616. * Attach a control to the HTML DOM element.
  106617. * @param element Defines the element that listens to the input events.
  106618. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  106619. */
  106620. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106621. /**
  106622. * Detach a control from the HTML DOM element.
  106623. * The camera will stop reacting to that input.
  106624. * @param element Defines the element that listens to the input events.
  106625. */
  106626. detachControl(element: HTMLElement): void;
  106627. private _collisionMask;
  106628. /**
  106629. * Get the mask that the camera ignores in collision events.
  106630. */
  106631. /**
  106632. * Set the mask that the camera ignores in collision events.
  106633. */
  106634. collisionMask: number;
  106635. /** @hidden */
  106636. _collideWithWorld(displacement: Vector3): void;
  106637. /** @hidden */
  106638. private _onCollisionPositionChange;
  106639. /** @hidden */
  106640. _checkInputs(): void;
  106641. /** @hidden */
  106642. _decideIfNeedsToMove(): boolean;
  106643. /** @hidden */
  106644. _updatePosition(): void;
  106645. /**
  106646. * Restore the Roll to its target value at the rate specified.
  106647. * @param rate - Higher means slower restoring.
  106648. * @hidden
  106649. */
  106650. restoreRoll(rate: number): void;
  106651. /**
  106652. * Destroy the camera and release the current resources held by it.
  106653. */
  106654. dispose(): void;
  106655. /**
  106656. * Get the current object class name.
  106657. * @returns the class name.
  106658. */
  106659. getClassName(): string;
  106660. }
  106661. }
  106662. declare module BABYLON {
  106663. /**
  106664. * Listen to keyboard events to control the camera.
  106665. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106666. */
  106667. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  106668. /**
  106669. * Defines the camera the input is attached to.
  106670. */
  106671. camera: FlyCamera;
  106672. /**
  106673. * The list of keyboard keys used to control the forward move of the camera.
  106674. */
  106675. keysForward: number[];
  106676. /**
  106677. * The list of keyboard keys used to control the backward move of the camera.
  106678. */
  106679. keysBackward: number[];
  106680. /**
  106681. * The list of keyboard keys used to control the forward move of the camera.
  106682. */
  106683. keysUp: number[];
  106684. /**
  106685. * The list of keyboard keys used to control the backward move of the camera.
  106686. */
  106687. keysDown: number[];
  106688. /**
  106689. * The list of keyboard keys used to control the right strafe move of the camera.
  106690. */
  106691. keysRight: number[];
  106692. /**
  106693. * The list of keyboard keys used to control the left strafe move of the camera.
  106694. */
  106695. keysLeft: number[];
  106696. private _keys;
  106697. private _onCanvasBlurObserver;
  106698. private _onKeyboardObserver;
  106699. private _engine;
  106700. private _scene;
  106701. /**
  106702. * Attach the input controls to a specific dom element to get the input from.
  106703. * @param element Defines the element the controls should be listened from
  106704. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106705. */
  106706. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106707. /**
  106708. * Detach the current controls from the specified dom element.
  106709. * @param element Defines the element to stop listening the inputs from
  106710. */
  106711. detachControl(element: Nullable<HTMLElement>): void;
  106712. /**
  106713. * Gets the class name of the current intput.
  106714. * @returns the class name
  106715. */
  106716. getClassName(): string;
  106717. /** @hidden */
  106718. _onLostFocus(e: FocusEvent): void;
  106719. /**
  106720. * Get the friendly name associated with the input class.
  106721. * @returns the input friendly name
  106722. */
  106723. getSimpleName(): string;
  106724. /**
  106725. * Update the current camera state depending on the inputs that have been used this frame.
  106726. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106727. */
  106728. checkInputs(): void;
  106729. }
  106730. }
  106731. declare module BABYLON {
  106732. /**
  106733. * Manage the mouse wheel inputs to control a follow camera.
  106734. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106735. */
  106736. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  106737. /**
  106738. * Defines the camera the input is attached to.
  106739. */
  106740. camera: FollowCamera;
  106741. /**
  106742. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  106743. */
  106744. axisControlRadius: boolean;
  106745. /**
  106746. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  106747. */
  106748. axisControlHeight: boolean;
  106749. /**
  106750. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  106751. */
  106752. axisControlRotation: boolean;
  106753. /**
  106754. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  106755. * relation to mouseWheel events.
  106756. */
  106757. wheelPrecision: number;
  106758. /**
  106759. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  106760. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  106761. */
  106762. wheelDeltaPercentage: number;
  106763. private _wheel;
  106764. private _observer;
  106765. /**
  106766. * Attach the input controls to a specific dom element to get the input from.
  106767. * @param element Defines the element the controls should be listened from
  106768. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106769. */
  106770. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106771. /**
  106772. * Detach the current controls from the specified dom element.
  106773. * @param element Defines the element to stop listening the inputs from
  106774. */
  106775. detachControl(element: Nullable<HTMLElement>): void;
  106776. /**
  106777. * Gets the class name of the current intput.
  106778. * @returns the class name
  106779. */
  106780. getClassName(): string;
  106781. /**
  106782. * Get the friendly name associated with the input class.
  106783. * @returns the input friendly name
  106784. */
  106785. getSimpleName(): string;
  106786. }
  106787. }
  106788. declare module BABYLON {
  106789. /**
  106790. * Manage the pointers inputs to control an follow camera.
  106791. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106792. */
  106793. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  106794. /**
  106795. * Defines the camera the input is attached to.
  106796. */
  106797. camera: FollowCamera;
  106798. /**
  106799. * Gets the class name of the current input.
  106800. * @returns the class name
  106801. */
  106802. getClassName(): string;
  106803. /**
  106804. * Defines the pointer angular sensibility along the X axis or how fast is
  106805. * the camera rotating.
  106806. * A negative number will reverse the axis direction.
  106807. */
  106808. angularSensibilityX: number;
  106809. /**
  106810. * Defines the pointer angular sensibility along the Y axis or how fast is
  106811. * the camera rotating.
  106812. * A negative number will reverse the axis direction.
  106813. */
  106814. angularSensibilityY: number;
  106815. /**
  106816. * Defines the pointer pinch precision or how fast is the camera zooming.
  106817. * A negative number will reverse the axis direction.
  106818. */
  106819. pinchPrecision: number;
  106820. /**
  106821. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  106822. * from 0.
  106823. * It defines the percentage of current camera.radius to use as delta when
  106824. * pinch zoom is used.
  106825. */
  106826. pinchDeltaPercentage: number;
  106827. /**
  106828. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  106829. */
  106830. axisXControlRadius: boolean;
  106831. /**
  106832. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  106833. */
  106834. axisXControlHeight: boolean;
  106835. /**
  106836. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  106837. */
  106838. axisXControlRotation: boolean;
  106839. /**
  106840. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  106841. */
  106842. axisYControlRadius: boolean;
  106843. /**
  106844. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  106845. */
  106846. axisYControlHeight: boolean;
  106847. /**
  106848. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  106849. */
  106850. axisYControlRotation: boolean;
  106851. /**
  106852. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  106853. */
  106854. axisPinchControlRadius: boolean;
  106855. /**
  106856. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  106857. */
  106858. axisPinchControlHeight: boolean;
  106859. /**
  106860. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  106861. */
  106862. axisPinchControlRotation: boolean;
  106863. /**
  106864. * Log error messages if basic misconfiguration has occurred.
  106865. */
  106866. warningEnable: boolean;
  106867. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  106868. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  106869. private _warningCounter;
  106870. private _warning;
  106871. }
  106872. }
  106873. declare module BABYLON {
  106874. /**
  106875. * Default Inputs manager for the FollowCamera.
  106876. * It groups all the default supported inputs for ease of use.
  106877. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106878. */
  106879. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  106880. /**
  106881. * Instantiates a new FollowCameraInputsManager.
  106882. * @param camera Defines the camera the inputs belong to
  106883. */
  106884. constructor(camera: FollowCamera);
  106885. /**
  106886. * Add keyboard input support to the input manager.
  106887. * @returns the current input manager
  106888. */
  106889. addKeyboard(): FollowCameraInputsManager;
  106890. /**
  106891. * Add mouse wheel input support to the input manager.
  106892. * @returns the current input manager
  106893. */
  106894. addMouseWheel(): FollowCameraInputsManager;
  106895. /**
  106896. * Add pointers input support to the input manager.
  106897. * @returns the current input manager
  106898. */
  106899. addPointers(): FollowCameraInputsManager;
  106900. /**
  106901. * Add orientation input support to the input manager.
  106902. * @returns the current input manager
  106903. */
  106904. addVRDeviceOrientation(): FollowCameraInputsManager;
  106905. }
  106906. }
  106907. declare module BABYLON {
  106908. /**
  106909. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  106910. * an arc rotate version arcFollowCamera are available.
  106911. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106912. */
  106913. export class FollowCamera extends TargetCamera {
  106914. /**
  106915. * Distance the follow camera should follow an object at
  106916. */
  106917. radius: number;
  106918. /**
  106919. * Minimum allowed distance of the camera to the axis of rotation
  106920. * (The camera can not get closer).
  106921. * This can help limiting how the Camera is able to move in the scene.
  106922. */
  106923. lowerRadiusLimit: Nullable<number>;
  106924. /**
  106925. * Maximum allowed distance of the camera to the axis of rotation
  106926. * (The camera can not get further).
  106927. * This can help limiting how the Camera is able to move in the scene.
  106928. */
  106929. upperRadiusLimit: Nullable<number>;
  106930. /**
  106931. * Define a rotation offset between the camera and the object it follows
  106932. */
  106933. rotationOffset: number;
  106934. /**
  106935. * Minimum allowed angle to camera position relative to target object.
  106936. * This can help limiting how the Camera is able to move in the scene.
  106937. */
  106938. lowerRotationOffsetLimit: Nullable<number>;
  106939. /**
  106940. * Maximum allowed angle to camera position relative to target object.
  106941. * This can help limiting how the Camera is able to move in the scene.
  106942. */
  106943. upperRotationOffsetLimit: Nullable<number>;
  106944. /**
  106945. * Define a height offset between the camera and the object it follows.
  106946. * It can help following an object from the top (like a car chaing a plane)
  106947. */
  106948. heightOffset: number;
  106949. /**
  106950. * Minimum allowed height of camera position relative to target object.
  106951. * This can help limiting how the Camera is able to move in the scene.
  106952. */
  106953. lowerHeightOffsetLimit: Nullable<number>;
  106954. /**
  106955. * Maximum allowed height of camera position relative to target object.
  106956. * This can help limiting how the Camera is able to move in the scene.
  106957. */
  106958. upperHeightOffsetLimit: Nullable<number>;
  106959. /**
  106960. * Define how fast the camera can accelerate to follow it s target.
  106961. */
  106962. cameraAcceleration: number;
  106963. /**
  106964. * Define the speed limit of the camera following an object.
  106965. */
  106966. maxCameraSpeed: number;
  106967. /**
  106968. * Define the target of the camera.
  106969. */
  106970. lockedTarget: Nullable<AbstractMesh>;
  106971. /**
  106972. * Defines the input associated with the camera.
  106973. */
  106974. inputs: FollowCameraInputsManager;
  106975. /**
  106976. * Instantiates the follow camera.
  106977. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106978. * @param name Define the name of the camera in the scene
  106979. * @param position Define the position of the camera
  106980. * @param scene Define the scene the camera belong to
  106981. * @param lockedTarget Define the target of the camera
  106982. */
  106983. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  106984. private _follow;
  106985. /**
  106986. * Attached controls to the current camera.
  106987. * @param element Defines the element the controls should be listened from
  106988. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106989. */
  106990. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106991. /**
  106992. * Detach the current controls from the camera.
  106993. * The camera will stop reacting to inputs.
  106994. * @param element Defines the element to stop listening the inputs from
  106995. */
  106996. detachControl(element: HTMLElement): void;
  106997. /** @hidden */
  106998. _checkInputs(): void;
  106999. private _checkLimits;
  107000. /**
  107001. * Gets the camera class name.
  107002. * @returns the class name
  107003. */
  107004. getClassName(): string;
  107005. }
  107006. /**
  107007. * Arc Rotate version of the follow camera.
  107008. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  107009. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  107010. */
  107011. export class ArcFollowCamera extends TargetCamera {
  107012. /** The longitudinal angle of the camera */
  107013. alpha: number;
  107014. /** The latitudinal angle of the camera */
  107015. beta: number;
  107016. /** The radius of the camera from its target */
  107017. radius: number;
  107018. /** Define the camera target (the messh it should follow) */
  107019. target: Nullable<AbstractMesh>;
  107020. private _cartesianCoordinates;
  107021. /**
  107022. * Instantiates a new ArcFollowCamera
  107023. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  107024. * @param name Define the name of the camera
  107025. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  107026. * @param beta Define the rotation angle of the camera around the elevation axis
  107027. * @param radius Define the radius of the camera from its target point
  107028. * @param target Define the target of the camera
  107029. * @param scene Define the scene the camera belongs to
  107030. */
  107031. constructor(name: string,
  107032. /** The longitudinal angle of the camera */
  107033. alpha: number,
  107034. /** The latitudinal angle of the camera */
  107035. beta: number,
  107036. /** The radius of the camera from its target */
  107037. radius: number,
  107038. /** Define the camera target (the messh it should follow) */
  107039. target: Nullable<AbstractMesh>, scene: Scene);
  107040. private _follow;
  107041. /** @hidden */
  107042. _checkInputs(): void;
  107043. /**
  107044. * Returns the class name of the object.
  107045. * It is mostly used internally for serialization purposes.
  107046. */
  107047. getClassName(): string;
  107048. }
  107049. }
  107050. declare module BABYLON {
  107051. /**
  107052. * Manage the keyboard inputs to control the movement of a follow camera.
  107053. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107054. */
  107055. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  107056. /**
  107057. * Defines the camera the input is attached to.
  107058. */
  107059. camera: FollowCamera;
  107060. /**
  107061. * Defines the list of key codes associated with the up action (increase heightOffset)
  107062. */
  107063. keysHeightOffsetIncr: number[];
  107064. /**
  107065. * Defines the list of key codes associated with the down action (decrease heightOffset)
  107066. */
  107067. keysHeightOffsetDecr: number[];
  107068. /**
  107069. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  107070. */
  107071. keysHeightOffsetModifierAlt: boolean;
  107072. /**
  107073. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  107074. */
  107075. keysHeightOffsetModifierCtrl: boolean;
  107076. /**
  107077. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  107078. */
  107079. keysHeightOffsetModifierShift: boolean;
  107080. /**
  107081. * Defines the list of key codes associated with the left action (increase rotationOffset)
  107082. */
  107083. keysRotationOffsetIncr: number[];
  107084. /**
  107085. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  107086. */
  107087. keysRotationOffsetDecr: number[];
  107088. /**
  107089. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  107090. */
  107091. keysRotationOffsetModifierAlt: boolean;
  107092. /**
  107093. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  107094. */
  107095. keysRotationOffsetModifierCtrl: boolean;
  107096. /**
  107097. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  107098. */
  107099. keysRotationOffsetModifierShift: boolean;
  107100. /**
  107101. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  107102. */
  107103. keysRadiusIncr: number[];
  107104. /**
  107105. * Defines the list of key codes associated with the zoom-out action (increase radius)
  107106. */
  107107. keysRadiusDecr: number[];
  107108. /**
  107109. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  107110. */
  107111. keysRadiusModifierAlt: boolean;
  107112. /**
  107113. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  107114. */
  107115. keysRadiusModifierCtrl: boolean;
  107116. /**
  107117. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  107118. */
  107119. keysRadiusModifierShift: boolean;
  107120. /**
  107121. * Defines the rate of change of heightOffset.
  107122. */
  107123. heightSensibility: number;
  107124. /**
  107125. * Defines the rate of change of rotationOffset.
  107126. */
  107127. rotationSensibility: number;
  107128. /**
  107129. * Defines the rate of change of radius.
  107130. */
  107131. radiusSensibility: number;
  107132. private _keys;
  107133. private _ctrlPressed;
  107134. private _altPressed;
  107135. private _shiftPressed;
  107136. private _onCanvasBlurObserver;
  107137. private _onKeyboardObserver;
  107138. private _engine;
  107139. private _scene;
  107140. /**
  107141. * Attach the input controls to a specific dom element to get the input from.
  107142. * @param element Defines the element the controls should be listened from
  107143. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107144. */
  107145. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107146. /**
  107147. * Detach the current controls from the specified dom element.
  107148. * @param element Defines the element to stop listening the inputs from
  107149. */
  107150. detachControl(element: Nullable<HTMLElement>): void;
  107151. /**
  107152. * Update the current camera state depending on the inputs that have been used this frame.
  107153. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107154. */
  107155. checkInputs(): void;
  107156. /**
  107157. * Gets the class name of the current input.
  107158. * @returns the class name
  107159. */
  107160. getClassName(): string;
  107161. /**
  107162. * Get the friendly name associated with the input class.
  107163. * @returns the input friendly name
  107164. */
  107165. getSimpleName(): string;
  107166. /**
  107167. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  107168. * allow modification of the heightOffset value.
  107169. */
  107170. private _modifierHeightOffset;
  107171. /**
  107172. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  107173. * allow modification of the rotationOffset value.
  107174. */
  107175. private _modifierRotationOffset;
  107176. /**
  107177. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  107178. * allow modification of the radius value.
  107179. */
  107180. private _modifierRadius;
  107181. }
  107182. }
  107183. declare module BABYLON {
  107184. interface FreeCameraInputsManager {
  107185. /**
  107186. * @hidden
  107187. */
  107188. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  107189. /**
  107190. * Add orientation input support to the input manager.
  107191. * @returns the current input manager
  107192. */
  107193. addDeviceOrientation(): FreeCameraInputsManager;
  107194. }
  107195. /**
  107196. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  107197. * Screen rotation is taken into account.
  107198. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107199. */
  107200. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  107201. private _camera;
  107202. private _screenOrientationAngle;
  107203. private _constantTranform;
  107204. private _screenQuaternion;
  107205. private _alpha;
  107206. private _beta;
  107207. private _gamma;
  107208. /**
  107209. * Can be used to detect if a device orientation sensor is availible on a device
  107210. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  107211. * @returns a promise that will resolve on orientation change
  107212. */
  107213. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  107214. /**
  107215. * @hidden
  107216. */
  107217. _onDeviceOrientationChangedObservable: Observable<void>;
  107218. /**
  107219. * Instantiates a new input
  107220. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107221. */
  107222. constructor();
  107223. /**
  107224. * Define the camera controlled by the input.
  107225. */
  107226. camera: FreeCamera;
  107227. /**
  107228. * Attach the input controls to a specific dom element to get the input from.
  107229. * @param element Defines the element the controls should be listened from
  107230. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107231. */
  107232. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107233. private _orientationChanged;
  107234. private _deviceOrientation;
  107235. /**
  107236. * Detach the current controls from the specified dom element.
  107237. * @param element Defines the element to stop listening the inputs from
  107238. */
  107239. detachControl(element: Nullable<HTMLElement>): void;
  107240. /**
  107241. * Update the current camera state depending on the inputs that have been used this frame.
  107242. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107243. */
  107244. checkInputs(): void;
  107245. /**
  107246. * Gets the class name of the current intput.
  107247. * @returns the class name
  107248. */
  107249. getClassName(): string;
  107250. /**
  107251. * Get the friendly name associated with the input class.
  107252. * @returns the input friendly name
  107253. */
  107254. getSimpleName(): string;
  107255. }
  107256. }
  107257. declare module BABYLON {
  107258. /**
  107259. * Manage the gamepad inputs to control a free camera.
  107260. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107261. */
  107262. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  107263. /**
  107264. * Define the camera the input is attached to.
  107265. */
  107266. camera: FreeCamera;
  107267. /**
  107268. * Define the Gamepad controlling the input
  107269. */
  107270. gamepad: Nullable<Gamepad>;
  107271. /**
  107272. * Defines the gamepad rotation sensiblity.
  107273. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  107274. */
  107275. gamepadAngularSensibility: number;
  107276. /**
  107277. * Defines the gamepad move sensiblity.
  107278. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  107279. */
  107280. gamepadMoveSensibility: number;
  107281. private _yAxisScale;
  107282. /**
  107283. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  107284. */
  107285. invertYAxis: boolean;
  107286. private _onGamepadConnectedObserver;
  107287. private _onGamepadDisconnectedObserver;
  107288. private _cameraTransform;
  107289. private _deltaTransform;
  107290. private _vector3;
  107291. private _vector2;
  107292. /**
  107293. * Attach the input controls to a specific dom element to get the input from.
  107294. * @param element Defines the element the controls should be listened from
  107295. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107296. */
  107297. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107298. /**
  107299. * Detach the current controls from the specified dom element.
  107300. * @param element Defines the element to stop listening the inputs from
  107301. */
  107302. detachControl(element: Nullable<HTMLElement>): void;
  107303. /**
  107304. * Update the current camera state depending on the inputs that have been used this frame.
  107305. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107306. */
  107307. checkInputs(): void;
  107308. /**
  107309. * Gets the class name of the current intput.
  107310. * @returns the class name
  107311. */
  107312. getClassName(): string;
  107313. /**
  107314. * Get the friendly name associated with the input class.
  107315. * @returns the input friendly name
  107316. */
  107317. getSimpleName(): string;
  107318. }
  107319. }
  107320. declare module BABYLON {
  107321. /**
  107322. * Defines the potential axis of a Joystick
  107323. */
  107324. export enum JoystickAxis {
  107325. /** X axis */
  107326. X = 0,
  107327. /** Y axis */
  107328. Y = 1,
  107329. /** Z axis */
  107330. Z = 2
  107331. }
  107332. /**
  107333. * Class used to define virtual joystick (used in touch mode)
  107334. */
  107335. export class VirtualJoystick {
  107336. /**
  107337. * Gets or sets a boolean indicating that left and right values must be inverted
  107338. */
  107339. reverseLeftRight: boolean;
  107340. /**
  107341. * Gets or sets a boolean indicating that up and down values must be inverted
  107342. */
  107343. reverseUpDown: boolean;
  107344. /**
  107345. * Gets the offset value for the position (ie. the change of the position value)
  107346. */
  107347. deltaPosition: Vector3;
  107348. /**
  107349. * Gets a boolean indicating if the virtual joystick was pressed
  107350. */
  107351. pressed: boolean;
  107352. /**
  107353. * Canvas the virtual joystick will render onto, default z-index of this is 5
  107354. */
  107355. static Canvas: Nullable<HTMLCanvasElement>;
  107356. private static _globalJoystickIndex;
  107357. private static vjCanvasContext;
  107358. private static vjCanvasWidth;
  107359. private static vjCanvasHeight;
  107360. private static halfWidth;
  107361. private _action;
  107362. private _axisTargetedByLeftAndRight;
  107363. private _axisTargetedByUpAndDown;
  107364. private _joystickSensibility;
  107365. private _inversedSensibility;
  107366. private _joystickPointerID;
  107367. private _joystickColor;
  107368. private _joystickPointerPos;
  107369. private _joystickPreviousPointerPos;
  107370. private _joystickPointerStartPos;
  107371. private _deltaJoystickVector;
  107372. private _leftJoystick;
  107373. private _touches;
  107374. private _onPointerDownHandlerRef;
  107375. private _onPointerMoveHandlerRef;
  107376. private _onPointerUpHandlerRef;
  107377. private _onResize;
  107378. /**
  107379. * Creates a new virtual joystick
  107380. * @param leftJoystick defines that the joystick is for left hand (false by default)
  107381. */
  107382. constructor(leftJoystick?: boolean);
  107383. /**
  107384. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  107385. * @param newJoystickSensibility defines the new sensibility
  107386. */
  107387. setJoystickSensibility(newJoystickSensibility: number): void;
  107388. private _onPointerDown;
  107389. private _onPointerMove;
  107390. private _onPointerUp;
  107391. /**
  107392. * Change the color of the virtual joystick
  107393. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  107394. */
  107395. setJoystickColor(newColor: string): void;
  107396. /**
  107397. * Defines a callback to call when the joystick is touched
  107398. * @param action defines the callback
  107399. */
  107400. setActionOnTouch(action: () => any): void;
  107401. /**
  107402. * Defines which axis you'd like to control for left & right
  107403. * @param axis defines the axis to use
  107404. */
  107405. setAxisForLeftRight(axis: JoystickAxis): void;
  107406. /**
  107407. * Defines which axis you'd like to control for up & down
  107408. * @param axis defines the axis to use
  107409. */
  107410. setAxisForUpDown(axis: JoystickAxis): void;
  107411. private _drawVirtualJoystick;
  107412. /**
  107413. * Release internal HTML canvas
  107414. */
  107415. releaseCanvas(): void;
  107416. }
  107417. }
  107418. declare module BABYLON {
  107419. interface FreeCameraInputsManager {
  107420. /**
  107421. * Add virtual joystick input support to the input manager.
  107422. * @returns the current input manager
  107423. */
  107424. addVirtualJoystick(): FreeCameraInputsManager;
  107425. }
  107426. /**
  107427. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  107428. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107429. */
  107430. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  107431. /**
  107432. * Defines the camera the input is attached to.
  107433. */
  107434. camera: FreeCamera;
  107435. private _leftjoystick;
  107436. private _rightjoystick;
  107437. /**
  107438. * Gets the left stick of the virtual joystick.
  107439. * @returns The virtual Joystick
  107440. */
  107441. getLeftJoystick(): VirtualJoystick;
  107442. /**
  107443. * Gets the right stick of the virtual joystick.
  107444. * @returns The virtual Joystick
  107445. */
  107446. getRightJoystick(): VirtualJoystick;
  107447. /**
  107448. * Update the current camera state depending on the inputs that have been used this frame.
  107449. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107450. */
  107451. checkInputs(): void;
  107452. /**
  107453. * Attach the input controls to a specific dom element to get the input from.
  107454. * @param element Defines the element the controls should be listened from
  107455. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107456. */
  107457. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107458. /**
  107459. * Detach the current controls from the specified dom element.
  107460. * @param element Defines the element to stop listening the inputs from
  107461. */
  107462. detachControl(element: Nullable<HTMLElement>): void;
  107463. /**
  107464. * Gets the class name of the current intput.
  107465. * @returns the class name
  107466. */
  107467. getClassName(): string;
  107468. /**
  107469. * Get the friendly name associated with the input class.
  107470. * @returns the input friendly name
  107471. */
  107472. getSimpleName(): string;
  107473. }
  107474. }
  107475. declare module BABYLON {
  107476. /**
  107477. * This represents a FPS type of camera controlled by touch.
  107478. * This is like a universal camera minus the Gamepad controls.
  107479. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107480. */
  107481. export class TouchCamera extends FreeCamera {
  107482. /**
  107483. * Defines the touch sensibility for rotation.
  107484. * The higher the faster.
  107485. */
  107486. touchAngularSensibility: number;
  107487. /**
  107488. * Defines the touch sensibility for move.
  107489. * The higher the faster.
  107490. */
  107491. touchMoveSensibility: number;
  107492. /**
  107493. * Instantiates a new touch camera.
  107494. * This represents a FPS type of camera controlled by touch.
  107495. * This is like a universal camera minus the Gamepad controls.
  107496. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107497. * @param name Define the name of the camera in the scene
  107498. * @param position Define the start position of the camera in the scene
  107499. * @param scene Define the scene the camera belongs to
  107500. */
  107501. constructor(name: string, position: Vector3, scene: Scene);
  107502. /**
  107503. * Gets the current object class name.
  107504. * @return the class name
  107505. */
  107506. getClassName(): string;
  107507. /** @hidden */
  107508. _setupInputs(): void;
  107509. }
  107510. }
  107511. declare module BABYLON {
  107512. /**
  107513. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  107514. * being tilted forward or back and left or right.
  107515. */
  107516. export class DeviceOrientationCamera extends FreeCamera {
  107517. private _initialQuaternion;
  107518. private _quaternionCache;
  107519. private _tmpDragQuaternion;
  107520. private _disablePointerInputWhenUsingDeviceOrientation;
  107521. /**
  107522. * Creates a new device orientation camera
  107523. * @param name The name of the camera
  107524. * @param position The start position camera
  107525. * @param scene The scene the camera belongs to
  107526. */
  107527. constructor(name: string, position: Vector3, scene: Scene);
  107528. /**
  107529. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  107530. */
  107531. disablePointerInputWhenUsingDeviceOrientation: boolean;
  107532. private _dragFactor;
  107533. /**
  107534. * Enabled turning on the y axis when the orientation sensor is active
  107535. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  107536. */
  107537. enableHorizontalDragging(dragFactor?: number): void;
  107538. /**
  107539. * Gets the current instance class name ("DeviceOrientationCamera").
  107540. * This helps avoiding instanceof at run time.
  107541. * @returns the class name
  107542. */
  107543. getClassName(): string;
  107544. /**
  107545. * @hidden
  107546. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  107547. */
  107548. _checkInputs(): void;
  107549. /**
  107550. * Reset the camera to its default orientation on the specified axis only.
  107551. * @param axis The axis to reset
  107552. */
  107553. resetToCurrentRotation(axis?: Axis): void;
  107554. }
  107555. }
  107556. declare module BABYLON {
  107557. /**
  107558. * Defines supported buttons for XBox360 compatible gamepads
  107559. */
  107560. export enum Xbox360Button {
  107561. /** A */
  107562. A = 0,
  107563. /** B */
  107564. B = 1,
  107565. /** X */
  107566. X = 2,
  107567. /** Y */
  107568. Y = 3,
  107569. /** Start */
  107570. Start = 4,
  107571. /** Back */
  107572. Back = 5,
  107573. /** Left button */
  107574. LB = 6,
  107575. /** Right button */
  107576. RB = 7,
  107577. /** Left stick */
  107578. LeftStick = 8,
  107579. /** Right stick */
  107580. RightStick = 9
  107581. }
  107582. /** Defines values for XBox360 DPad */
  107583. export enum Xbox360Dpad {
  107584. /** Up */
  107585. Up = 0,
  107586. /** Down */
  107587. Down = 1,
  107588. /** Left */
  107589. Left = 2,
  107590. /** Right */
  107591. Right = 3
  107592. }
  107593. /**
  107594. * Defines a XBox360 gamepad
  107595. */
  107596. export class Xbox360Pad extends Gamepad {
  107597. private _leftTrigger;
  107598. private _rightTrigger;
  107599. private _onlefttriggerchanged;
  107600. private _onrighttriggerchanged;
  107601. private _onbuttondown;
  107602. private _onbuttonup;
  107603. private _ondpaddown;
  107604. private _ondpadup;
  107605. /** Observable raised when a button is pressed */
  107606. onButtonDownObservable: Observable<Xbox360Button>;
  107607. /** Observable raised when a button is released */
  107608. onButtonUpObservable: Observable<Xbox360Button>;
  107609. /** Observable raised when a pad is pressed */
  107610. onPadDownObservable: Observable<Xbox360Dpad>;
  107611. /** Observable raised when a pad is released */
  107612. onPadUpObservable: Observable<Xbox360Dpad>;
  107613. private _buttonA;
  107614. private _buttonB;
  107615. private _buttonX;
  107616. private _buttonY;
  107617. private _buttonBack;
  107618. private _buttonStart;
  107619. private _buttonLB;
  107620. private _buttonRB;
  107621. private _buttonLeftStick;
  107622. private _buttonRightStick;
  107623. private _dPadUp;
  107624. private _dPadDown;
  107625. private _dPadLeft;
  107626. private _dPadRight;
  107627. private _isXboxOnePad;
  107628. /**
  107629. * Creates a new XBox360 gamepad object
  107630. * @param id defines the id of this gamepad
  107631. * @param index defines its index
  107632. * @param gamepad defines the internal HTML gamepad object
  107633. * @param xboxOne defines if it is a XBox One gamepad
  107634. */
  107635. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  107636. /**
  107637. * Defines the callback to call when left trigger is pressed
  107638. * @param callback defines the callback to use
  107639. */
  107640. onlefttriggerchanged(callback: (value: number) => void): void;
  107641. /**
  107642. * Defines the callback to call when right trigger is pressed
  107643. * @param callback defines the callback to use
  107644. */
  107645. onrighttriggerchanged(callback: (value: number) => void): void;
  107646. /**
  107647. * Gets the left trigger value
  107648. */
  107649. /**
  107650. * Sets the left trigger value
  107651. */
  107652. leftTrigger: number;
  107653. /**
  107654. * Gets the right trigger value
  107655. */
  107656. /**
  107657. * Sets the right trigger value
  107658. */
  107659. rightTrigger: number;
  107660. /**
  107661. * Defines the callback to call when a button is pressed
  107662. * @param callback defines the callback to use
  107663. */
  107664. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  107665. /**
  107666. * Defines the callback to call when a button is released
  107667. * @param callback defines the callback to use
  107668. */
  107669. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  107670. /**
  107671. * Defines the callback to call when a pad is pressed
  107672. * @param callback defines the callback to use
  107673. */
  107674. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  107675. /**
  107676. * Defines the callback to call when a pad is released
  107677. * @param callback defines the callback to use
  107678. */
  107679. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  107680. private _setButtonValue;
  107681. private _setDPadValue;
  107682. /**
  107683. * Gets the value of the `A` button
  107684. */
  107685. /**
  107686. * Sets the value of the `A` button
  107687. */
  107688. buttonA: number;
  107689. /**
  107690. * Gets the value of the `B` button
  107691. */
  107692. /**
  107693. * Sets the value of the `B` button
  107694. */
  107695. buttonB: number;
  107696. /**
  107697. * Gets the value of the `X` button
  107698. */
  107699. /**
  107700. * Sets the value of the `X` button
  107701. */
  107702. buttonX: number;
  107703. /**
  107704. * Gets the value of the `Y` button
  107705. */
  107706. /**
  107707. * Sets the value of the `Y` button
  107708. */
  107709. buttonY: number;
  107710. /**
  107711. * Gets the value of the `Start` button
  107712. */
  107713. /**
  107714. * Sets the value of the `Start` button
  107715. */
  107716. buttonStart: number;
  107717. /**
  107718. * Gets the value of the `Back` button
  107719. */
  107720. /**
  107721. * Sets the value of the `Back` button
  107722. */
  107723. buttonBack: number;
  107724. /**
  107725. * Gets the value of the `Left` button
  107726. */
  107727. /**
  107728. * Sets the value of the `Left` button
  107729. */
  107730. buttonLB: number;
  107731. /**
  107732. * Gets the value of the `Right` button
  107733. */
  107734. /**
  107735. * Sets the value of the `Right` button
  107736. */
  107737. buttonRB: number;
  107738. /**
  107739. * Gets the value of the Left joystick
  107740. */
  107741. /**
  107742. * Sets the value of the Left joystick
  107743. */
  107744. buttonLeftStick: number;
  107745. /**
  107746. * Gets the value of the Right joystick
  107747. */
  107748. /**
  107749. * Sets the value of the Right joystick
  107750. */
  107751. buttonRightStick: number;
  107752. /**
  107753. * Gets the value of D-pad up
  107754. */
  107755. /**
  107756. * Sets the value of D-pad up
  107757. */
  107758. dPadUp: number;
  107759. /**
  107760. * Gets the value of D-pad down
  107761. */
  107762. /**
  107763. * Sets the value of D-pad down
  107764. */
  107765. dPadDown: number;
  107766. /**
  107767. * Gets the value of D-pad left
  107768. */
  107769. /**
  107770. * Sets the value of D-pad left
  107771. */
  107772. dPadLeft: number;
  107773. /**
  107774. * Gets the value of D-pad right
  107775. */
  107776. /**
  107777. * Sets the value of D-pad right
  107778. */
  107779. dPadRight: number;
  107780. /**
  107781. * Force the gamepad to synchronize with device values
  107782. */
  107783. update(): void;
  107784. /**
  107785. * Disposes the gamepad
  107786. */
  107787. dispose(): void;
  107788. }
  107789. }
  107790. declare module BABYLON {
  107791. /**
  107792. * Defines supported buttons for DualShock compatible gamepads
  107793. */
  107794. export enum DualShockButton {
  107795. /** Cross */
  107796. Cross = 0,
  107797. /** Circle */
  107798. Circle = 1,
  107799. /** Square */
  107800. Square = 2,
  107801. /** Triangle */
  107802. Triangle = 3,
  107803. /** Options */
  107804. Options = 4,
  107805. /** Share */
  107806. Share = 5,
  107807. /** L1 */
  107808. L1 = 6,
  107809. /** R1 */
  107810. R1 = 7,
  107811. /** Left stick */
  107812. LeftStick = 8,
  107813. /** Right stick */
  107814. RightStick = 9
  107815. }
  107816. /** Defines values for DualShock DPad */
  107817. export enum DualShockDpad {
  107818. /** Up */
  107819. Up = 0,
  107820. /** Down */
  107821. Down = 1,
  107822. /** Left */
  107823. Left = 2,
  107824. /** Right */
  107825. Right = 3
  107826. }
  107827. /**
  107828. * Defines a DualShock gamepad
  107829. */
  107830. export class DualShockPad extends Gamepad {
  107831. private _leftTrigger;
  107832. private _rightTrigger;
  107833. private _onlefttriggerchanged;
  107834. private _onrighttriggerchanged;
  107835. private _onbuttondown;
  107836. private _onbuttonup;
  107837. private _ondpaddown;
  107838. private _ondpadup;
  107839. /** Observable raised when a button is pressed */
  107840. onButtonDownObservable: Observable<DualShockButton>;
  107841. /** Observable raised when a button is released */
  107842. onButtonUpObservable: Observable<DualShockButton>;
  107843. /** Observable raised when a pad is pressed */
  107844. onPadDownObservable: Observable<DualShockDpad>;
  107845. /** Observable raised when a pad is released */
  107846. onPadUpObservable: Observable<DualShockDpad>;
  107847. private _buttonCross;
  107848. private _buttonCircle;
  107849. private _buttonSquare;
  107850. private _buttonTriangle;
  107851. private _buttonShare;
  107852. private _buttonOptions;
  107853. private _buttonL1;
  107854. private _buttonR1;
  107855. private _buttonLeftStick;
  107856. private _buttonRightStick;
  107857. private _dPadUp;
  107858. private _dPadDown;
  107859. private _dPadLeft;
  107860. private _dPadRight;
  107861. /**
  107862. * Creates a new DualShock gamepad object
  107863. * @param id defines the id of this gamepad
  107864. * @param index defines its index
  107865. * @param gamepad defines the internal HTML gamepad object
  107866. */
  107867. constructor(id: string, index: number, gamepad: any);
  107868. /**
  107869. * Defines the callback to call when left trigger is pressed
  107870. * @param callback defines the callback to use
  107871. */
  107872. onlefttriggerchanged(callback: (value: number) => void): void;
  107873. /**
  107874. * Defines the callback to call when right trigger is pressed
  107875. * @param callback defines the callback to use
  107876. */
  107877. onrighttriggerchanged(callback: (value: number) => void): void;
  107878. /**
  107879. * Gets the left trigger value
  107880. */
  107881. /**
  107882. * Sets the left trigger value
  107883. */
  107884. leftTrigger: number;
  107885. /**
  107886. * Gets the right trigger value
  107887. */
  107888. /**
  107889. * Sets the right trigger value
  107890. */
  107891. rightTrigger: number;
  107892. /**
  107893. * Defines the callback to call when a button is pressed
  107894. * @param callback defines the callback to use
  107895. */
  107896. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  107897. /**
  107898. * Defines the callback to call when a button is released
  107899. * @param callback defines the callback to use
  107900. */
  107901. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  107902. /**
  107903. * Defines the callback to call when a pad is pressed
  107904. * @param callback defines the callback to use
  107905. */
  107906. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  107907. /**
  107908. * Defines the callback to call when a pad is released
  107909. * @param callback defines the callback to use
  107910. */
  107911. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  107912. private _setButtonValue;
  107913. private _setDPadValue;
  107914. /**
  107915. * Gets the value of the `Cross` button
  107916. */
  107917. /**
  107918. * Sets the value of the `Cross` button
  107919. */
  107920. buttonCross: number;
  107921. /**
  107922. * Gets the value of the `Circle` button
  107923. */
  107924. /**
  107925. * Sets the value of the `Circle` button
  107926. */
  107927. buttonCircle: number;
  107928. /**
  107929. * Gets the value of the `Square` button
  107930. */
  107931. /**
  107932. * Sets the value of the `Square` button
  107933. */
  107934. buttonSquare: number;
  107935. /**
  107936. * Gets the value of the `Triangle` button
  107937. */
  107938. /**
  107939. * Sets the value of the `Triangle` button
  107940. */
  107941. buttonTriangle: number;
  107942. /**
  107943. * Gets the value of the `Options` button
  107944. */
  107945. /**
  107946. * Sets the value of the `Options` button
  107947. */
  107948. buttonOptions: number;
  107949. /**
  107950. * Gets the value of the `Share` button
  107951. */
  107952. /**
  107953. * Sets the value of the `Share` button
  107954. */
  107955. buttonShare: number;
  107956. /**
  107957. * Gets the value of the `L1` button
  107958. */
  107959. /**
  107960. * Sets the value of the `L1` button
  107961. */
  107962. buttonL1: number;
  107963. /**
  107964. * Gets the value of the `R1` button
  107965. */
  107966. /**
  107967. * Sets the value of the `R1` button
  107968. */
  107969. buttonR1: number;
  107970. /**
  107971. * Gets the value of the Left joystick
  107972. */
  107973. /**
  107974. * Sets the value of the Left joystick
  107975. */
  107976. buttonLeftStick: number;
  107977. /**
  107978. * Gets the value of the Right joystick
  107979. */
  107980. /**
  107981. * Sets the value of the Right joystick
  107982. */
  107983. buttonRightStick: number;
  107984. /**
  107985. * Gets the value of D-pad up
  107986. */
  107987. /**
  107988. * Sets the value of D-pad up
  107989. */
  107990. dPadUp: number;
  107991. /**
  107992. * Gets the value of D-pad down
  107993. */
  107994. /**
  107995. * Sets the value of D-pad down
  107996. */
  107997. dPadDown: number;
  107998. /**
  107999. * Gets the value of D-pad left
  108000. */
  108001. /**
  108002. * Sets the value of D-pad left
  108003. */
  108004. dPadLeft: number;
  108005. /**
  108006. * Gets the value of D-pad right
  108007. */
  108008. /**
  108009. * Sets the value of D-pad right
  108010. */
  108011. dPadRight: number;
  108012. /**
  108013. * Force the gamepad to synchronize with device values
  108014. */
  108015. update(): void;
  108016. /**
  108017. * Disposes the gamepad
  108018. */
  108019. dispose(): void;
  108020. }
  108021. }
  108022. declare module BABYLON {
  108023. /**
  108024. * Manager for handling gamepads
  108025. */
  108026. export class GamepadManager {
  108027. private _scene?;
  108028. private _babylonGamepads;
  108029. private _oneGamepadConnected;
  108030. /** @hidden */
  108031. _isMonitoring: boolean;
  108032. private _gamepadEventSupported;
  108033. private _gamepadSupport;
  108034. /**
  108035. * observable to be triggered when the gamepad controller has been connected
  108036. */
  108037. onGamepadConnectedObservable: Observable<Gamepad>;
  108038. /**
  108039. * observable to be triggered when the gamepad controller has been disconnected
  108040. */
  108041. onGamepadDisconnectedObservable: Observable<Gamepad>;
  108042. private _onGamepadConnectedEvent;
  108043. private _onGamepadDisconnectedEvent;
  108044. /**
  108045. * Initializes the gamepad manager
  108046. * @param _scene BabylonJS scene
  108047. */
  108048. constructor(_scene?: Scene | undefined);
  108049. /**
  108050. * The gamepads in the game pad manager
  108051. */
  108052. readonly gamepads: Gamepad[];
  108053. /**
  108054. * Get the gamepad controllers based on type
  108055. * @param type The type of gamepad controller
  108056. * @returns Nullable gamepad
  108057. */
  108058. getGamepadByType(type?: number): Nullable<Gamepad>;
  108059. /**
  108060. * Disposes the gamepad manager
  108061. */
  108062. dispose(): void;
  108063. private _addNewGamepad;
  108064. private _startMonitoringGamepads;
  108065. private _stopMonitoringGamepads;
  108066. /** @hidden */
  108067. _checkGamepadsStatus(): void;
  108068. private _updateGamepadObjects;
  108069. }
  108070. }
  108071. declare module BABYLON {
  108072. interface Scene {
  108073. /** @hidden */
  108074. _gamepadManager: Nullable<GamepadManager>;
  108075. /**
  108076. * Gets the gamepad manager associated with the scene
  108077. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  108078. */
  108079. gamepadManager: GamepadManager;
  108080. }
  108081. /**
  108082. * Interface representing a free camera inputs manager
  108083. */
  108084. interface FreeCameraInputsManager {
  108085. /**
  108086. * Adds gamepad input support to the FreeCameraInputsManager.
  108087. * @returns the FreeCameraInputsManager
  108088. */
  108089. addGamepad(): FreeCameraInputsManager;
  108090. }
  108091. /**
  108092. * Interface representing an arc rotate camera inputs manager
  108093. */
  108094. interface ArcRotateCameraInputsManager {
  108095. /**
  108096. * Adds gamepad input support to the ArcRotateCamera InputManager.
  108097. * @returns the camera inputs manager
  108098. */
  108099. addGamepad(): ArcRotateCameraInputsManager;
  108100. }
  108101. /**
  108102. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  108103. */
  108104. export class GamepadSystemSceneComponent implements ISceneComponent {
  108105. /**
  108106. * The component name helpfull to identify the component in the list of scene components.
  108107. */
  108108. readonly name: string;
  108109. /**
  108110. * The scene the component belongs to.
  108111. */
  108112. scene: Scene;
  108113. /**
  108114. * Creates a new instance of the component for the given scene
  108115. * @param scene Defines the scene to register the component in
  108116. */
  108117. constructor(scene: Scene);
  108118. /**
  108119. * Registers the component in a given scene
  108120. */
  108121. register(): void;
  108122. /**
  108123. * Rebuilds the elements related to this component in case of
  108124. * context lost for instance.
  108125. */
  108126. rebuild(): void;
  108127. /**
  108128. * Disposes the component and the associated ressources
  108129. */
  108130. dispose(): void;
  108131. private _beforeCameraUpdate;
  108132. }
  108133. }
  108134. declare module BABYLON {
  108135. /**
  108136. * 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,
  108137. * which still works and will still be found in many Playgrounds.
  108138. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108139. */
  108140. export class UniversalCamera extends TouchCamera {
  108141. /**
  108142. * Defines the gamepad rotation sensiblity.
  108143. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  108144. */
  108145. gamepadAngularSensibility: number;
  108146. /**
  108147. * Defines the gamepad move sensiblity.
  108148. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  108149. */
  108150. gamepadMoveSensibility: number;
  108151. /**
  108152. * 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,
  108153. * which still works and will still be found in many Playgrounds.
  108154. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108155. * @param name Define the name of the camera in the scene
  108156. * @param position Define the start position of the camera in the scene
  108157. * @param scene Define the scene the camera belongs to
  108158. */
  108159. constructor(name: string, position: Vector3, scene: Scene);
  108160. /**
  108161. * Gets the current object class name.
  108162. * @return the class name
  108163. */
  108164. getClassName(): string;
  108165. }
  108166. }
  108167. declare module BABYLON {
  108168. /**
  108169. * This represents a FPS type of camera. This is only here for back compat purpose.
  108170. * Please use the UniversalCamera instead as both are identical.
  108171. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108172. */
  108173. export class GamepadCamera extends UniversalCamera {
  108174. /**
  108175. * Instantiates a new Gamepad Camera
  108176. * This represents a FPS type of camera. This is only here for back compat purpose.
  108177. * Please use the UniversalCamera instead as both are identical.
  108178. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108179. * @param name Define the name of the camera in the scene
  108180. * @param position Define the start position of the camera in the scene
  108181. * @param scene Define the scene the camera belongs to
  108182. */
  108183. constructor(name: string, position: Vector3, scene: Scene);
  108184. /**
  108185. * Gets the current object class name.
  108186. * @return the class name
  108187. */
  108188. getClassName(): string;
  108189. }
  108190. }
  108191. declare module BABYLON {
  108192. /** @hidden */
  108193. export var passPixelShader: {
  108194. name: string;
  108195. shader: string;
  108196. };
  108197. }
  108198. declare module BABYLON {
  108199. /** @hidden */
  108200. export var passCubePixelShader: {
  108201. name: string;
  108202. shader: string;
  108203. };
  108204. }
  108205. declare module BABYLON {
  108206. /**
  108207. * PassPostProcess which produces an output the same as it's input
  108208. */
  108209. export class PassPostProcess extends PostProcess {
  108210. /**
  108211. * Creates the PassPostProcess
  108212. * @param name The name of the effect.
  108213. * @param options The required width/height ratio to downsize to before computing the render pass.
  108214. * @param camera The camera to apply the render pass to.
  108215. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108216. * @param engine The engine which the post process will be applied. (default: current engine)
  108217. * @param reusable If the post process can be reused on the same frame. (default: false)
  108218. * @param textureType The type of texture to be used when performing the post processing.
  108219. * @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)
  108220. */
  108221. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  108222. }
  108223. /**
  108224. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  108225. */
  108226. export class PassCubePostProcess extends PostProcess {
  108227. private _face;
  108228. /**
  108229. * Gets or sets the cube face to display.
  108230. * * 0 is +X
  108231. * * 1 is -X
  108232. * * 2 is +Y
  108233. * * 3 is -Y
  108234. * * 4 is +Z
  108235. * * 5 is -Z
  108236. */
  108237. face: number;
  108238. /**
  108239. * Creates the PassCubePostProcess
  108240. * @param name The name of the effect.
  108241. * @param options The required width/height ratio to downsize to before computing the render pass.
  108242. * @param camera The camera to apply the render pass to.
  108243. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108244. * @param engine The engine which the post process will be applied. (default: current engine)
  108245. * @param reusable If the post process can be reused on the same frame. (default: false)
  108246. * @param textureType The type of texture to be used when performing the post processing.
  108247. * @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)
  108248. */
  108249. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  108250. }
  108251. }
  108252. declare module BABYLON {
  108253. /** @hidden */
  108254. export var anaglyphPixelShader: {
  108255. name: string;
  108256. shader: string;
  108257. };
  108258. }
  108259. declare module BABYLON {
  108260. /**
  108261. * Postprocess used to generate anaglyphic rendering
  108262. */
  108263. export class AnaglyphPostProcess extends PostProcess {
  108264. private _passedProcess;
  108265. /**
  108266. * Creates a new AnaglyphPostProcess
  108267. * @param name defines postprocess name
  108268. * @param options defines creation options or target ratio scale
  108269. * @param rigCameras defines cameras using this postprocess
  108270. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  108271. * @param engine defines hosting engine
  108272. * @param reusable defines if the postprocess will be reused multiple times per frame
  108273. */
  108274. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  108275. }
  108276. }
  108277. declare module BABYLON {
  108278. /**
  108279. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  108280. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108281. */
  108282. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  108283. /**
  108284. * Creates a new AnaglyphArcRotateCamera
  108285. * @param name defines camera name
  108286. * @param alpha defines alpha angle (in radians)
  108287. * @param beta defines beta angle (in radians)
  108288. * @param radius defines radius
  108289. * @param target defines camera target
  108290. * @param interaxialDistance defines distance between each color axis
  108291. * @param scene defines the hosting scene
  108292. */
  108293. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  108294. /**
  108295. * Gets camera class name
  108296. * @returns AnaglyphArcRotateCamera
  108297. */
  108298. getClassName(): string;
  108299. }
  108300. }
  108301. declare module BABYLON {
  108302. /**
  108303. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  108304. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108305. */
  108306. export class AnaglyphFreeCamera extends FreeCamera {
  108307. /**
  108308. * Creates a new AnaglyphFreeCamera
  108309. * @param name defines camera name
  108310. * @param position defines initial position
  108311. * @param interaxialDistance defines distance between each color axis
  108312. * @param scene defines the hosting scene
  108313. */
  108314. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  108315. /**
  108316. * Gets camera class name
  108317. * @returns AnaglyphFreeCamera
  108318. */
  108319. getClassName(): string;
  108320. }
  108321. }
  108322. declare module BABYLON {
  108323. /**
  108324. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  108325. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108326. */
  108327. export class AnaglyphGamepadCamera extends GamepadCamera {
  108328. /**
  108329. * Creates a new AnaglyphGamepadCamera
  108330. * @param name defines camera name
  108331. * @param position defines initial position
  108332. * @param interaxialDistance defines distance between each color axis
  108333. * @param scene defines the hosting scene
  108334. */
  108335. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  108336. /**
  108337. * Gets camera class name
  108338. * @returns AnaglyphGamepadCamera
  108339. */
  108340. getClassName(): string;
  108341. }
  108342. }
  108343. declare module BABYLON {
  108344. /**
  108345. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  108346. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108347. */
  108348. export class AnaglyphUniversalCamera extends UniversalCamera {
  108349. /**
  108350. * Creates a new AnaglyphUniversalCamera
  108351. * @param name defines camera name
  108352. * @param position defines initial position
  108353. * @param interaxialDistance defines distance between each color axis
  108354. * @param scene defines the hosting scene
  108355. */
  108356. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  108357. /**
  108358. * Gets camera class name
  108359. * @returns AnaglyphUniversalCamera
  108360. */
  108361. getClassName(): string;
  108362. }
  108363. }
  108364. declare module BABYLON {
  108365. /** @hidden */
  108366. export var stereoscopicInterlacePixelShader: {
  108367. name: string;
  108368. shader: string;
  108369. };
  108370. }
  108371. declare module BABYLON {
  108372. /**
  108373. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  108374. */
  108375. export class StereoscopicInterlacePostProcess extends PostProcess {
  108376. private _stepSize;
  108377. private _passedProcess;
  108378. /**
  108379. * Initializes a StereoscopicInterlacePostProcess
  108380. * @param name The name of the effect.
  108381. * @param rigCameras The rig cameras to be appled to the post process
  108382. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  108383. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108384. * @param engine The engine which the post process will be applied. (default: current engine)
  108385. * @param reusable If the post process can be reused on the same frame. (default: false)
  108386. */
  108387. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  108388. }
  108389. }
  108390. declare module BABYLON {
  108391. /**
  108392. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  108393. * @see http://doc.babylonjs.com/features/cameras
  108394. */
  108395. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  108396. /**
  108397. * Creates a new StereoscopicArcRotateCamera
  108398. * @param name defines camera name
  108399. * @param alpha defines alpha angle (in radians)
  108400. * @param beta defines beta angle (in radians)
  108401. * @param radius defines radius
  108402. * @param target defines camera target
  108403. * @param interaxialDistance defines distance between each color axis
  108404. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108405. * @param scene defines the hosting scene
  108406. */
  108407. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108408. /**
  108409. * Gets camera class name
  108410. * @returns StereoscopicArcRotateCamera
  108411. */
  108412. getClassName(): string;
  108413. }
  108414. }
  108415. declare module BABYLON {
  108416. /**
  108417. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  108418. * @see http://doc.babylonjs.com/features/cameras
  108419. */
  108420. export class StereoscopicFreeCamera extends FreeCamera {
  108421. /**
  108422. * Creates a new StereoscopicFreeCamera
  108423. * @param name defines camera name
  108424. * @param position defines initial position
  108425. * @param interaxialDistance defines distance between each color axis
  108426. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108427. * @param scene defines the hosting scene
  108428. */
  108429. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108430. /**
  108431. * Gets camera class name
  108432. * @returns StereoscopicFreeCamera
  108433. */
  108434. getClassName(): string;
  108435. }
  108436. }
  108437. declare module BABYLON {
  108438. /**
  108439. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  108440. * @see http://doc.babylonjs.com/features/cameras
  108441. */
  108442. export class StereoscopicGamepadCamera extends GamepadCamera {
  108443. /**
  108444. * Creates a new StereoscopicGamepadCamera
  108445. * @param name defines camera name
  108446. * @param position defines initial position
  108447. * @param interaxialDistance defines distance between each color axis
  108448. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108449. * @param scene defines the hosting scene
  108450. */
  108451. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108452. /**
  108453. * Gets camera class name
  108454. * @returns StereoscopicGamepadCamera
  108455. */
  108456. getClassName(): string;
  108457. }
  108458. }
  108459. declare module BABYLON {
  108460. /**
  108461. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  108462. * @see http://doc.babylonjs.com/features/cameras
  108463. */
  108464. export class StereoscopicUniversalCamera extends UniversalCamera {
  108465. /**
  108466. * Creates a new StereoscopicUniversalCamera
  108467. * @param name defines camera name
  108468. * @param position defines initial position
  108469. * @param interaxialDistance defines distance between each color axis
  108470. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108471. * @param scene defines the hosting scene
  108472. */
  108473. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108474. /**
  108475. * Gets camera class name
  108476. * @returns StereoscopicUniversalCamera
  108477. */
  108478. getClassName(): string;
  108479. }
  108480. }
  108481. declare module BABYLON {
  108482. /**
  108483. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  108484. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  108485. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  108486. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  108487. */
  108488. export class VirtualJoysticksCamera extends FreeCamera {
  108489. /**
  108490. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  108491. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  108492. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  108493. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  108494. * @param name Define the name of the camera in the scene
  108495. * @param position Define the start position of the camera in the scene
  108496. * @param scene Define the scene the camera belongs to
  108497. */
  108498. constructor(name: string, position: Vector3, scene: Scene);
  108499. /**
  108500. * Gets the current object class name.
  108501. * @return the class name
  108502. */
  108503. getClassName(): string;
  108504. }
  108505. }
  108506. declare module BABYLON {
  108507. /**
  108508. * This represents all the required metrics to create a VR camera.
  108509. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  108510. */
  108511. export class VRCameraMetrics {
  108512. /**
  108513. * Define the horizontal resolution off the screen.
  108514. */
  108515. hResolution: number;
  108516. /**
  108517. * Define the vertical resolution off the screen.
  108518. */
  108519. vResolution: number;
  108520. /**
  108521. * Define the horizontal screen size.
  108522. */
  108523. hScreenSize: number;
  108524. /**
  108525. * Define the vertical screen size.
  108526. */
  108527. vScreenSize: number;
  108528. /**
  108529. * Define the vertical screen center position.
  108530. */
  108531. vScreenCenter: number;
  108532. /**
  108533. * Define the distance of the eyes to the screen.
  108534. */
  108535. eyeToScreenDistance: number;
  108536. /**
  108537. * Define the distance between both lenses
  108538. */
  108539. lensSeparationDistance: number;
  108540. /**
  108541. * Define the distance between both viewer's eyes.
  108542. */
  108543. interpupillaryDistance: number;
  108544. /**
  108545. * Define the distortion factor of the VR postprocess.
  108546. * Please, touch with care.
  108547. */
  108548. distortionK: number[];
  108549. /**
  108550. * Define the chromatic aberration correction factors for the VR post process.
  108551. */
  108552. chromaAbCorrection: number[];
  108553. /**
  108554. * Define the scale factor of the post process.
  108555. * The smaller the better but the slower.
  108556. */
  108557. postProcessScaleFactor: number;
  108558. /**
  108559. * Define an offset for the lens center.
  108560. */
  108561. lensCenterOffset: number;
  108562. /**
  108563. * Define if the current vr camera should compensate the distortion of the lense or not.
  108564. */
  108565. compensateDistortion: boolean;
  108566. /**
  108567. * Defines if multiview should be enabled when rendering (Default: false)
  108568. */
  108569. multiviewEnabled: boolean;
  108570. /**
  108571. * Gets the rendering aspect ratio based on the provided resolutions.
  108572. */
  108573. readonly aspectRatio: number;
  108574. /**
  108575. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  108576. */
  108577. readonly aspectRatioFov: number;
  108578. /**
  108579. * @hidden
  108580. */
  108581. readonly leftHMatrix: Matrix;
  108582. /**
  108583. * @hidden
  108584. */
  108585. readonly rightHMatrix: Matrix;
  108586. /**
  108587. * @hidden
  108588. */
  108589. readonly leftPreViewMatrix: Matrix;
  108590. /**
  108591. * @hidden
  108592. */
  108593. readonly rightPreViewMatrix: Matrix;
  108594. /**
  108595. * Get the default VRMetrics based on the most generic setup.
  108596. * @returns the default vr metrics
  108597. */
  108598. static GetDefault(): VRCameraMetrics;
  108599. }
  108600. }
  108601. declare module BABYLON {
  108602. /** @hidden */
  108603. export var vrDistortionCorrectionPixelShader: {
  108604. name: string;
  108605. shader: string;
  108606. };
  108607. }
  108608. declare module BABYLON {
  108609. /**
  108610. * VRDistortionCorrectionPostProcess used for mobile VR
  108611. */
  108612. export class VRDistortionCorrectionPostProcess extends PostProcess {
  108613. private _isRightEye;
  108614. private _distortionFactors;
  108615. private _postProcessScaleFactor;
  108616. private _lensCenterOffset;
  108617. private _scaleIn;
  108618. private _scaleFactor;
  108619. private _lensCenter;
  108620. /**
  108621. * Initializes the VRDistortionCorrectionPostProcess
  108622. * @param name The name of the effect.
  108623. * @param camera The camera to apply the render pass to.
  108624. * @param isRightEye If this is for the right eye distortion
  108625. * @param vrMetrics All the required metrics for the VR camera
  108626. */
  108627. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  108628. }
  108629. }
  108630. declare module BABYLON {
  108631. /**
  108632. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  108633. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108634. */
  108635. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  108636. /**
  108637. * Creates a new VRDeviceOrientationArcRotateCamera
  108638. * @param name defines camera name
  108639. * @param alpha defines the camera rotation along the logitudinal axis
  108640. * @param beta defines the camera rotation along the latitudinal axis
  108641. * @param radius defines the camera distance from its target
  108642. * @param target defines the camera target
  108643. * @param scene defines the scene the camera belongs to
  108644. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108645. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108646. */
  108647. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108648. /**
  108649. * Gets camera class name
  108650. * @returns VRDeviceOrientationArcRotateCamera
  108651. */
  108652. getClassName(): string;
  108653. }
  108654. }
  108655. declare module BABYLON {
  108656. /**
  108657. * Camera used to simulate VR rendering (based on FreeCamera)
  108658. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108659. */
  108660. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  108661. /**
  108662. * Creates a new VRDeviceOrientationFreeCamera
  108663. * @param name defines camera name
  108664. * @param position defines the start position of the camera
  108665. * @param scene defines the scene the camera belongs to
  108666. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108667. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108668. */
  108669. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108670. /**
  108671. * Gets camera class name
  108672. * @returns VRDeviceOrientationFreeCamera
  108673. */
  108674. getClassName(): string;
  108675. }
  108676. }
  108677. declare module BABYLON {
  108678. /**
  108679. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  108680. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108681. */
  108682. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  108683. /**
  108684. * Creates a new VRDeviceOrientationGamepadCamera
  108685. * @param name defines camera name
  108686. * @param position defines the start position of the camera
  108687. * @param scene defines the scene the camera belongs to
  108688. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108689. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108690. */
  108691. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108692. /**
  108693. * Gets camera class name
  108694. * @returns VRDeviceOrientationGamepadCamera
  108695. */
  108696. getClassName(): string;
  108697. }
  108698. }
  108699. declare module BABYLON {
  108700. /**
  108701. * Base class of materials working in push mode in babylon JS
  108702. * @hidden
  108703. */
  108704. export class PushMaterial extends Material {
  108705. protected _activeEffect: Effect;
  108706. protected _normalMatrix: Matrix;
  108707. /**
  108708. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  108709. * This means that the material can keep using a previous shader while a new one is being compiled.
  108710. * This is mostly used when shader parallel compilation is supported (true by default)
  108711. */
  108712. allowShaderHotSwapping: boolean;
  108713. constructor(name: string, scene: Scene);
  108714. getEffect(): Effect;
  108715. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  108716. /**
  108717. * Binds the given world matrix to the active effect
  108718. *
  108719. * @param world the matrix to bind
  108720. */
  108721. bindOnlyWorldMatrix(world: Matrix): void;
  108722. /**
  108723. * Binds the given normal matrix to the active effect
  108724. *
  108725. * @param normalMatrix the matrix to bind
  108726. */
  108727. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  108728. bind(world: Matrix, mesh?: Mesh): void;
  108729. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  108730. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  108731. }
  108732. }
  108733. declare module BABYLON {
  108734. /**
  108735. * This groups all the flags used to control the materials channel.
  108736. */
  108737. export class MaterialFlags {
  108738. private static _DiffuseTextureEnabled;
  108739. /**
  108740. * Are diffuse textures enabled in the application.
  108741. */
  108742. static DiffuseTextureEnabled: boolean;
  108743. private static _AmbientTextureEnabled;
  108744. /**
  108745. * Are ambient textures enabled in the application.
  108746. */
  108747. static AmbientTextureEnabled: boolean;
  108748. private static _OpacityTextureEnabled;
  108749. /**
  108750. * Are opacity textures enabled in the application.
  108751. */
  108752. static OpacityTextureEnabled: boolean;
  108753. private static _ReflectionTextureEnabled;
  108754. /**
  108755. * Are reflection textures enabled in the application.
  108756. */
  108757. static ReflectionTextureEnabled: boolean;
  108758. private static _EmissiveTextureEnabled;
  108759. /**
  108760. * Are emissive textures enabled in the application.
  108761. */
  108762. static EmissiveTextureEnabled: boolean;
  108763. private static _SpecularTextureEnabled;
  108764. /**
  108765. * Are specular textures enabled in the application.
  108766. */
  108767. static SpecularTextureEnabled: boolean;
  108768. private static _BumpTextureEnabled;
  108769. /**
  108770. * Are bump textures enabled in the application.
  108771. */
  108772. static BumpTextureEnabled: boolean;
  108773. private static _LightmapTextureEnabled;
  108774. /**
  108775. * Are lightmap textures enabled in the application.
  108776. */
  108777. static LightmapTextureEnabled: boolean;
  108778. private static _RefractionTextureEnabled;
  108779. /**
  108780. * Are refraction textures enabled in the application.
  108781. */
  108782. static RefractionTextureEnabled: boolean;
  108783. private static _ColorGradingTextureEnabled;
  108784. /**
  108785. * Are color grading textures enabled in the application.
  108786. */
  108787. static ColorGradingTextureEnabled: boolean;
  108788. private static _FresnelEnabled;
  108789. /**
  108790. * Are fresnels enabled in the application.
  108791. */
  108792. static FresnelEnabled: boolean;
  108793. private static _ClearCoatTextureEnabled;
  108794. /**
  108795. * Are clear coat textures enabled in the application.
  108796. */
  108797. static ClearCoatTextureEnabled: boolean;
  108798. private static _ClearCoatBumpTextureEnabled;
  108799. /**
  108800. * Are clear coat bump textures enabled in the application.
  108801. */
  108802. static ClearCoatBumpTextureEnabled: boolean;
  108803. private static _ClearCoatTintTextureEnabled;
  108804. /**
  108805. * Are clear coat tint textures enabled in the application.
  108806. */
  108807. static ClearCoatTintTextureEnabled: boolean;
  108808. private static _SheenTextureEnabled;
  108809. /**
  108810. * Are sheen textures enabled in the application.
  108811. */
  108812. static SheenTextureEnabled: boolean;
  108813. private static _AnisotropicTextureEnabled;
  108814. /**
  108815. * Are anisotropic textures enabled in the application.
  108816. */
  108817. static AnisotropicTextureEnabled: boolean;
  108818. private static _ThicknessTextureEnabled;
  108819. /**
  108820. * Are thickness textures enabled in the application.
  108821. */
  108822. static ThicknessTextureEnabled: boolean;
  108823. }
  108824. }
  108825. declare module BABYLON {
  108826. /** @hidden */
  108827. export var defaultFragmentDeclaration: {
  108828. name: string;
  108829. shader: string;
  108830. };
  108831. }
  108832. declare module BABYLON {
  108833. /** @hidden */
  108834. export var defaultUboDeclaration: {
  108835. name: string;
  108836. shader: string;
  108837. };
  108838. }
  108839. declare module BABYLON {
  108840. /** @hidden */
  108841. export var lightFragmentDeclaration: {
  108842. name: string;
  108843. shader: string;
  108844. };
  108845. }
  108846. declare module BABYLON {
  108847. /** @hidden */
  108848. export var lightUboDeclaration: {
  108849. name: string;
  108850. shader: string;
  108851. };
  108852. }
  108853. declare module BABYLON {
  108854. /** @hidden */
  108855. export var lightsFragmentFunctions: {
  108856. name: string;
  108857. shader: string;
  108858. };
  108859. }
  108860. declare module BABYLON {
  108861. /** @hidden */
  108862. export var shadowsFragmentFunctions: {
  108863. name: string;
  108864. shader: string;
  108865. };
  108866. }
  108867. declare module BABYLON {
  108868. /** @hidden */
  108869. export var fresnelFunction: {
  108870. name: string;
  108871. shader: string;
  108872. };
  108873. }
  108874. declare module BABYLON {
  108875. /** @hidden */
  108876. export var reflectionFunction: {
  108877. name: string;
  108878. shader: string;
  108879. };
  108880. }
  108881. declare module BABYLON {
  108882. /** @hidden */
  108883. export var bumpFragmentFunctions: {
  108884. name: string;
  108885. shader: string;
  108886. };
  108887. }
  108888. declare module BABYLON {
  108889. /** @hidden */
  108890. export var logDepthDeclaration: {
  108891. name: string;
  108892. shader: string;
  108893. };
  108894. }
  108895. declare module BABYLON {
  108896. /** @hidden */
  108897. export var bumpFragment: {
  108898. name: string;
  108899. shader: string;
  108900. };
  108901. }
  108902. declare module BABYLON {
  108903. /** @hidden */
  108904. export var depthPrePass: {
  108905. name: string;
  108906. shader: string;
  108907. };
  108908. }
  108909. declare module BABYLON {
  108910. /** @hidden */
  108911. export var lightFragment: {
  108912. name: string;
  108913. shader: string;
  108914. };
  108915. }
  108916. declare module BABYLON {
  108917. /** @hidden */
  108918. export var logDepthFragment: {
  108919. name: string;
  108920. shader: string;
  108921. };
  108922. }
  108923. declare module BABYLON {
  108924. /** @hidden */
  108925. export var defaultPixelShader: {
  108926. name: string;
  108927. shader: string;
  108928. };
  108929. }
  108930. declare module BABYLON {
  108931. /** @hidden */
  108932. export var defaultVertexDeclaration: {
  108933. name: string;
  108934. shader: string;
  108935. };
  108936. }
  108937. declare module BABYLON {
  108938. /** @hidden */
  108939. export var bumpVertexDeclaration: {
  108940. name: string;
  108941. shader: string;
  108942. };
  108943. }
  108944. declare module BABYLON {
  108945. /** @hidden */
  108946. export var bumpVertex: {
  108947. name: string;
  108948. shader: string;
  108949. };
  108950. }
  108951. declare module BABYLON {
  108952. /** @hidden */
  108953. export var fogVertex: {
  108954. name: string;
  108955. shader: string;
  108956. };
  108957. }
  108958. declare module BABYLON {
  108959. /** @hidden */
  108960. export var shadowsVertex: {
  108961. name: string;
  108962. shader: string;
  108963. };
  108964. }
  108965. declare module BABYLON {
  108966. /** @hidden */
  108967. export var pointCloudVertex: {
  108968. name: string;
  108969. shader: string;
  108970. };
  108971. }
  108972. declare module BABYLON {
  108973. /** @hidden */
  108974. export var logDepthVertex: {
  108975. name: string;
  108976. shader: string;
  108977. };
  108978. }
  108979. declare module BABYLON {
  108980. /** @hidden */
  108981. export var defaultVertexShader: {
  108982. name: string;
  108983. shader: string;
  108984. };
  108985. }
  108986. declare module BABYLON {
  108987. /** @hidden */
  108988. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  108989. MAINUV1: boolean;
  108990. MAINUV2: boolean;
  108991. DIFFUSE: boolean;
  108992. DIFFUSEDIRECTUV: number;
  108993. AMBIENT: boolean;
  108994. AMBIENTDIRECTUV: number;
  108995. OPACITY: boolean;
  108996. OPACITYDIRECTUV: number;
  108997. OPACITYRGB: boolean;
  108998. REFLECTION: boolean;
  108999. EMISSIVE: boolean;
  109000. EMISSIVEDIRECTUV: number;
  109001. SPECULAR: boolean;
  109002. SPECULARDIRECTUV: number;
  109003. BUMP: boolean;
  109004. BUMPDIRECTUV: number;
  109005. PARALLAX: boolean;
  109006. PARALLAXOCCLUSION: boolean;
  109007. SPECULAROVERALPHA: boolean;
  109008. CLIPPLANE: boolean;
  109009. CLIPPLANE2: boolean;
  109010. CLIPPLANE3: boolean;
  109011. CLIPPLANE4: boolean;
  109012. ALPHATEST: boolean;
  109013. DEPTHPREPASS: boolean;
  109014. ALPHAFROMDIFFUSE: boolean;
  109015. POINTSIZE: boolean;
  109016. FOG: boolean;
  109017. SPECULARTERM: boolean;
  109018. DIFFUSEFRESNEL: boolean;
  109019. OPACITYFRESNEL: boolean;
  109020. REFLECTIONFRESNEL: boolean;
  109021. REFRACTIONFRESNEL: boolean;
  109022. EMISSIVEFRESNEL: boolean;
  109023. FRESNEL: boolean;
  109024. NORMAL: boolean;
  109025. UV1: boolean;
  109026. UV2: boolean;
  109027. VERTEXCOLOR: boolean;
  109028. VERTEXALPHA: boolean;
  109029. NUM_BONE_INFLUENCERS: number;
  109030. BonesPerMesh: number;
  109031. BONETEXTURE: boolean;
  109032. INSTANCES: boolean;
  109033. GLOSSINESS: boolean;
  109034. ROUGHNESS: boolean;
  109035. EMISSIVEASILLUMINATION: boolean;
  109036. LINKEMISSIVEWITHDIFFUSE: boolean;
  109037. REFLECTIONFRESNELFROMSPECULAR: boolean;
  109038. LIGHTMAP: boolean;
  109039. LIGHTMAPDIRECTUV: number;
  109040. OBJECTSPACE_NORMALMAP: boolean;
  109041. USELIGHTMAPASSHADOWMAP: boolean;
  109042. REFLECTIONMAP_3D: boolean;
  109043. REFLECTIONMAP_SPHERICAL: boolean;
  109044. REFLECTIONMAP_PLANAR: boolean;
  109045. REFLECTIONMAP_CUBIC: boolean;
  109046. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  109047. REFLECTIONMAP_PROJECTION: boolean;
  109048. REFLECTIONMAP_SKYBOX: boolean;
  109049. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  109050. REFLECTIONMAP_EXPLICIT: boolean;
  109051. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  109052. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  109053. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  109054. INVERTCUBICMAP: boolean;
  109055. LOGARITHMICDEPTH: boolean;
  109056. REFRACTION: boolean;
  109057. REFRACTIONMAP_3D: boolean;
  109058. REFLECTIONOVERALPHA: boolean;
  109059. TWOSIDEDLIGHTING: boolean;
  109060. SHADOWFLOAT: boolean;
  109061. MORPHTARGETS: boolean;
  109062. MORPHTARGETS_NORMAL: boolean;
  109063. MORPHTARGETS_TANGENT: boolean;
  109064. MORPHTARGETS_UV: boolean;
  109065. NUM_MORPH_INFLUENCERS: number;
  109066. NONUNIFORMSCALING: boolean;
  109067. PREMULTIPLYALPHA: boolean;
  109068. IMAGEPROCESSING: boolean;
  109069. VIGNETTE: boolean;
  109070. VIGNETTEBLENDMODEMULTIPLY: boolean;
  109071. VIGNETTEBLENDMODEOPAQUE: boolean;
  109072. TONEMAPPING: boolean;
  109073. TONEMAPPING_ACES: boolean;
  109074. CONTRAST: boolean;
  109075. COLORCURVES: boolean;
  109076. COLORGRADING: boolean;
  109077. COLORGRADING3D: boolean;
  109078. SAMPLER3DGREENDEPTH: boolean;
  109079. SAMPLER3DBGRMAP: boolean;
  109080. IMAGEPROCESSINGPOSTPROCESS: boolean;
  109081. MULTIVIEW: boolean;
  109082. /**
  109083. * If the reflection texture on this material is in linear color space
  109084. * @hidden
  109085. */
  109086. IS_REFLECTION_LINEAR: boolean;
  109087. /**
  109088. * If the refraction texture on this material is in linear color space
  109089. * @hidden
  109090. */
  109091. IS_REFRACTION_LINEAR: boolean;
  109092. EXPOSURE: boolean;
  109093. constructor();
  109094. setReflectionMode(modeToEnable: string): void;
  109095. }
  109096. /**
  109097. * This is the default material used in Babylon. It is the best trade off between quality
  109098. * and performances.
  109099. * @see http://doc.babylonjs.com/babylon101/materials
  109100. */
  109101. export class StandardMaterial extends PushMaterial {
  109102. private _diffuseTexture;
  109103. /**
  109104. * The basic texture of the material as viewed under a light.
  109105. */
  109106. diffuseTexture: Nullable<BaseTexture>;
  109107. private _ambientTexture;
  109108. /**
  109109. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  109110. */
  109111. ambientTexture: Nullable<BaseTexture>;
  109112. private _opacityTexture;
  109113. /**
  109114. * Define the transparency of the material from a texture.
  109115. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  109116. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  109117. */
  109118. opacityTexture: Nullable<BaseTexture>;
  109119. private _reflectionTexture;
  109120. /**
  109121. * Define the texture used to display the reflection.
  109122. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109123. */
  109124. reflectionTexture: Nullable<BaseTexture>;
  109125. private _emissiveTexture;
  109126. /**
  109127. * Define texture of the material as if self lit.
  109128. * This will be mixed in the final result even in the absence of light.
  109129. */
  109130. emissiveTexture: Nullable<BaseTexture>;
  109131. private _specularTexture;
  109132. /**
  109133. * Define how the color and intensity of the highlight given by the light in the material.
  109134. */
  109135. specularTexture: Nullable<BaseTexture>;
  109136. private _bumpTexture;
  109137. /**
  109138. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  109139. * 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.
  109140. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  109141. */
  109142. bumpTexture: Nullable<BaseTexture>;
  109143. private _lightmapTexture;
  109144. /**
  109145. * Complex lighting can be computationally expensive to compute at runtime.
  109146. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  109147. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  109148. */
  109149. lightmapTexture: Nullable<BaseTexture>;
  109150. private _refractionTexture;
  109151. /**
  109152. * Define the texture used to display the refraction.
  109153. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109154. */
  109155. refractionTexture: Nullable<BaseTexture>;
  109156. /**
  109157. * The color of the material lit by the environmental background lighting.
  109158. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  109159. */
  109160. ambientColor: Color3;
  109161. /**
  109162. * The basic color of the material as viewed under a light.
  109163. */
  109164. diffuseColor: Color3;
  109165. /**
  109166. * Define how the color and intensity of the highlight given by the light in the material.
  109167. */
  109168. specularColor: Color3;
  109169. /**
  109170. * Define the color of the material as if self lit.
  109171. * This will be mixed in the final result even in the absence of light.
  109172. */
  109173. emissiveColor: Color3;
  109174. /**
  109175. * Defines how sharp are the highlights in the material.
  109176. * The bigger the value the sharper giving a more glossy feeling to the result.
  109177. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  109178. */
  109179. specularPower: number;
  109180. private _useAlphaFromDiffuseTexture;
  109181. /**
  109182. * Does the transparency come from the diffuse texture alpha channel.
  109183. */
  109184. useAlphaFromDiffuseTexture: boolean;
  109185. private _useEmissiveAsIllumination;
  109186. /**
  109187. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  109188. */
  109189. useEmissiveAsIllumination: boolean;
  109190. private _linkEmissiveWithDiffuse;
  109191. /**
  109192. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  109193. * the emissive level when the final color is close to one.
  109194. */
  109195. linkEmissiveWithDiffuse: boolean;
  109196. private _useSpecularOverAlpha;
  109197. /**
  109198. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  109199. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  109200. */
  109201. useSpecularOverAlpha: boolean;
  109202. private _useReflectionOverAlpha;
  109203. /**
  109204. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  109205. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  109206. */
  109207. useReflectionOverAlpha: boolean;
  109208. private _disableLighting;
  109209. /**
  109210. * Does lights from the scene impacts this material.
  109211. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  109212. */
  109213. disableLighting: boolean;
  109214. private _useObjectSpaceNormalMap;
  109215. /**
  109216. * Allows using an object space normal map (instead of tangent space).
  109217. */
  109218. useObjectSpaceNormalMap: boolean;
  109219. private _useParallax;
  109220. /**
  109221. * Is parallax enabled or not.
  109222. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  109223. */
  109224. useParallax: boolean;
  109225. private _useParallaxOcclusion;
  109226. /**
  109227. * Is parallax occlusion enabled or not.
  109228. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  109229. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  109230. */
  109231. useParallaxOcclusion: boolean;
  109232. /**
  109233. * 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.
  109234. */
  109235. parallaxScaleBias: number;
  109236. private _roughness;
  109237. /**
  109238. * Helps to define how blurry the reflections should appears in the material.
  109239. */
  109240. roughness: number;
  109241. /**
  109242. * In case of refraction, define the value of the index of refraction.
  109243. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109244. */
  109245. indexOfRefraction: number;
  109246. /**
  109247. * Invert the refraction texture alongside the y axis.
  109248. * It can be useful with procedural textures or probe for instance.
  109249. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109250. */
  109251. invertRefractionY: boolean;
  109252. /**
  109253. * Defines the alpha limits in alpha test mode.
  109254. */
  109255. alphaCutOff: number;
  109256. private _useLightmapAsShadowmap;
  109257. /**
  109258. * In case of light mapping, define whether the map contains light or shadow informations.
  109259. */
  109260. useLightmapAsShadowmap: boolean;
  109261. private _diffuseFresnelParameters;
  109262. /**
  109263. * Define the diffuse fresnel parameters of the material.
  109264. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109265. */
  109266. diffuseFresnelParameters: FresnelParameters;
  109267. private _opacityFresnelParameters;
  109268. /**
  109269. * Define the opacity fresnel parameters of the material.
  109270. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109271. */
  109272. opacityFresnelParameters: FresnelParameters;
  109273. private _reflectionFresnelParameters;
  109274. /**
  109275. * Define the reflection fresnel parameters of the material.
  109276. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109277. */
  109278. reflectionFresnelParameters: FresnelParameters;
  109279. private _refractionFresnelParameters;
  109280. /**
  109281. * Define the refraction fresnel parameters of the material.
  109282. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109283. */
  109284. refractionFresnelParameters: FresnelParameters;
  109285. private _emissiveFresnelParameters;
  109286. /**
  109287. * Define the emissive fresnel parameters of the material.
  109288. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109289. */
  109290. emissiveFresnelParameters: FresnelParameters;
  109291. private _useReflectionFresnelFromSpecular;
  109292. /**
  109293. * If true automatically deducts the fresnels values from the material specularity.
  109294. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109295. */
  109296. useReflectionFresnelFromSpecular: boolean;
  109297. private _useGlossinessFromSpecularMapAlpha;
  109298. /**
  109299. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  109300. */
  109301. useGlossinessFromSpecularMapAlpha: boolean;
  109302. private _maxSimultaneousLights;
  109303. /**
  109304. * Defines the maximum number of lights that can be used in the material
  109305. */
  109306. maxSimultaneousLights: number;
  109307. private _invertNormalMapX;
  109308. /**
  109309. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  109310. */
  109311. invertNormalMapX: boolean;
  109312. private _invertNormalMapY;
  109313. /**
  109314. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  109315. */
  109316. invertNormalMapY: boolean;
  109317. private _twoSidedLighting;
  109318. /**
  109319. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  109320. */
  109321. twoSidedLighting: boolean;
  109322. /**
  109323. * Default configuration related to image processing available in the standard Material.
  109324. */
  109325. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109326. /**
  109327. * Gets the image processing configuration used either in this material.
  109328. */
  109329. /**
  109330. * Sets the Default image processing configuration used either in the this material.
  109331. *
  109332. * If sets to null, the scene one is in use.
  109333. */
  109334. imageProcessingConfiguration: ImageProcessingConfiguration;
  109335. /**
  109336. * Keep track of the image processing observer to allow dispose and replace.
  109337. */
  109338. private _imageProcessingObserver;
  109339. /**
  109340. * Attaches a new image processing configuration to the Standard Material.
  109341. * @param configuration
  109342. */
  109343. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  109344. /**
  109345. * Gets wether the color curves effect is enabled.
  109346. */
  109347. /**
  109348. * Sets wether the color curves effect is enabled.
  109349. */
  109350. cameraColorCurvesEnabled: boolean;
  109351. /**
  109352. * Gets wether the color grading effect is enabled.
  109353. */
  109354. /**
  109355. * Gets wether the color grading effect is enabled.
  109356. */
  109357. cameraColorGradingEnabled: boolean;
  109358. /**
  109359. * Gets wether tonemapping is enabled or not.
  109360. */
  109361. /**
  109362. * Sets wether tonemapping is enabled or not
  109363. */
  109364. cameraToneMappingEnabled: boolean;
  109365. /**
  109366. * The camera exposure used on this material.
  109367. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109368. * This corresponds to a photographic exposure.
  109369. */
  109370. /**
  109371. * The camera exposure used on this material.
  109372. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109373. * This corresponds to a photographic exposure.
  109374. */
  109375. cameraExposure: number;
  109376. /**
  109377. * Gets The camera contrast used on this material.
  109378. */
  109379. /**
  109380. * Sets The camera contrast used on this material.
  109381. */
  109382. cameraContrast: number;
  109383. /**
  109384. * Gets the Color Grading 2D Lookup Texture.
  109385. */
  109386. /**
  109387. * Sets the Color Grading 2D Lookup Texture.
  109388. */
  109389. cameraColorGradingTexture: Nullable<BaseTexture>;
  109390. /**
  109391. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109392. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109393. * 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;
  109394. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109395. */
  109396. /**
  109397. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109398. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109399. * 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;
  109400. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109401. */
  109402. cameraColorCurves: Nullable<ColorCurves>;
  109403. /**
  109404. * Custom callback helping to override the default shader used in the material.
  109405. */
  109406. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  109407. protected _renderTargets: SmartArray<RenderTargetTexture>;
  109408. protected _worldViewProjectionMatrix: Matrix;
  109409. protected _globalAmbientColor: Color3;
  109410. protected _useLogarithmicDepth: boolean;
  109411. protected _rebuildInParallel: boolean;
  109412. /**
  109413. * Instantiates a new standard material.
  109414. * This is the default material used in Babylon. It is the best trade off between quality
  109415. * and performances.
  109416. * @see http://doc.babylonjs.com/babylon101/materials
  109417. * @param name Define the name of the material in the scene
  109418. * @param scene Define the scene the material belong to
  109419. */
  109420. constructor(name: string, scene: Scene);
  109421. /**
  109422. * Gets a boolean indicating that current material needs to register RTT
  109423. */
  109424. readonly hasRenderTargetTextures: boolean;
  109425. /**
  109426. * Gets the current class name of the material e.g. "StandardMaterial"
  109427. * Mainly use in serialization.
  109428. * @returns the class name
  109429. */
  109430. getClassName(): string;
  109431. /**
  109432. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  109433. * You can try switching to logarithmic depth.
  109434. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  109435. */
  109436. useLogarithmicDepth: boolean;
  109437. /**
  109438. * Specifies if the material will require alpha blending
  109439. * @returns a boolean specifying if alpha blending is needed
  109440. */
  109441. needAlphaBlending(): boolean;
  109442. /**
  109443. * Specifies if this material should be rendered in alpha test mode
  109444. * @returns a boolean specifying if an alpha test is needed.
  109445. */
  109446. needAlphaTesting(): boolean;
  109447. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  109448. /**
  109449. * Get the texture used for alpha test purpose.
  109450. * @returns the diffuse texture in case of the standard material.
  109451. */
  109452. getAlphaTestTexture(): Nullable<BaseTexture>;
  109453. /**
  109454. * Get if the submesh is ready to be used and all its information available.
  109455. * Child classes can use it to update shaders
  109456. * @param mesh defines the mesh to check
  109457. * @param subMesh defines which submesh to check
  109458. * @param useInstances specifies that instances should be used
  109459. * @returns a boolean indicating that the submesh is ready or not
  109460. */
  109461. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  109462. /**
  109463. * Builds the material UBO layouts.
  109464. * Used internally during the effect preparation.
  109465. */
  109466. buildUniformLayout(): void;
  109467. /**
  109468. * Unbinds the material from the mesh
  109469. */
  109470. unbind(): void;
  109471. /**
  109472. * Binds the submesh to this material by preparing the effect and shader to draw
  109473. * @param world defines the world transformation matrix
  109474. * @param mesh defines the mesh containing the submesh
  109475. * @param subMesh defines the submesh to bind the material to
  109476. */
  109477. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  109478. /**
  109479. * Get the list of animatables in the material.
  109480. * @returns the list of animatables object used in the material
  109481. */
  109482. getAnimatables(): IAnimatable[];
  109483. /**
  109484. * Gets the active textures from the material
  109485. * @returns an array of textures
  109486. */
  109487. getActiveTextures(): BaseTexture[];
  109488. /**
  109489. * Specifies if the material uses a texture
  109490. * @param texture defines the texture to check against the material
  109491. * @returns a boolean specifying if the material uses the texture
  109492. */
  109493. hasTexture(texture: BaseTexture): boolean;
  109494. /**
  109495. * Disposes the material
  109496. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  109497. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  109498. */
  109499. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  109500. /**
  109501. * Makes a duplicate of the material, and gives it a new name
  109502. * @param name defines the new name for the duplicated material
  109503. * @returns the cloned material
  109504. */
  109505. clone(name: string): StandardMaterial;
  109506. /**
  109507. * Serializes this material in a JSON representation
  109508. * @returns the serialized material object
  109509. */
  109510. serialize(): any;
  109511. /**
  109512. * Creates a standard material from parsed material data
  109513. * @param source defines the JSON representation of the material
  109514. * @param scene defines the hosting scene
  109515. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  109516. * @returns a new standard material
  109517. */
  109518. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  109519. /**
  109520. * Are diffuse textures enabled in the application.
  109521. */
  109522. static DiffuseTextureEnabled: boolean;
  109523. /**
  109524. * Are ambient textures enabled in the application.
  109525. */
  109526. static AmbientTextureEnabled: boolean;
  109527. /**
  109528. * Are opacity textures enabled in the application.
  109529. */
  109530. static OpacityTextureEnabled: boolean;
  109531. /**
  109532. * Are reflection textures enabled in the application.
  109533. */
  109534. static ReflectionTextureEnabled: boolean;
  109535. /**
  109536. * Are emissive textures enabled in the application.
  109537. */
  109538. static EmissiveTextureEnabled: boolean;
  109539. /**
  109540. * Are specular textures enabled in the application.
  109541. */
  109542. static SpecularTextureEnabled: boolean;
  109543. /**
  109544. * Are bump textures enabled in the application.
  109545. */
  109546. static BumpTextureEnabled: boolean;
  109547. /**
  109548. * Are lightmap textures enabled in the application.
  109549. */
  109550. static LightmapTextureEnabled: boolean;
  109551. /**
  109552. * Are refraction textures enabled in the application.
  109553. */
  109554. static RefractionTextureEnabled: boolean;
  109555. /**
  109556. * Are color grading textures enabled in the application.
  109557. */
  109558. static ColorGradingTextureEnabled: boolean;
  109559. /**
  109560. * Are fresnels enabled in the application.
  109561. */
  109562. static FresnelEnabled: boolean;
  109563. }
  109564. }
  109565. declare module BABYLON {
  109566. /** @hidden */
  109567. export var imageProcessingPixelShader: {
  109568. name: string;
  109569. shader: string;
  109570. };
  109571. }
  109572. declare module BABYLON {
  109573. /**
  109574. * ImageProcessingPostProcess
  109575. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  109576. */
  109577. export class ImageProcessingPostProcess extends PostProcess {
  109578. /**
  109579. * Default configuration related to image processing available in the PBR Material.
  109580. */
  109581. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109582. /**
  109583. * Gets the image processing configuration used either in this material.
  109584. */
  109585. /**
  109586. * Sets the Default image processing configuration used either in the this material.
  109587. *
  109588. * If sets to null, the scene one is in use.
  109589. */
  109590. imageProcessingConfiguration: ImageProcessingConfiguration;
  109591. /**
  109592. * Keep track of the image processing observer to allow dispose and replace.
  109593. */
  109594. private _imageProcessingObserver;
  109595. /**
  109596. * Attaches a new image processing configuration to the PBR Material.
  109597. * @param configuration
  109598. */
  109599. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  109600. /**
  109601. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  109602. */
  109603. /**
  109604. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  109605. */
  109606. colorCurves: Nullable<ColorCurves>;
  109607. /**
  109608. * Gets wether the color curves effect is enabled.
  109609. */
  109610. /**
  109611. * Sets wether the color curves effect is enabled.
  109612. */
  109613. colorCurvesEnabled: boolean;
  109614. /**
  109615. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  109616. */
  109617. /**
  109618. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  109619. */
  109620. colorGradingTexture: Nullable<BaseTexture>;
  109621. /**
  109622. * Gets wether the color grading effect is enabled.
  109623. */
  109624. /**
  109625. * Gets wether the color grading effect is enabled.
  109626. */
  109627. colorGradingEnabled: boolean;
  109628. /**
  109629. * Gets exposure used in the effect.
  109630. */
  109631. /**
  109632. * Sets exposure used in the effect.
  109633. */
  109634. exposure: number;
  109635. /**
  109636. * Gets wether tonemapping is enabled or not.
  109637. */
  109638. /**
  109639. * Sets wether tonemapping is enabled or not
  109640. */
  109641. toneMappingEnabled: boolean;
  109642. /**
  109643. * Gets the type of tone mapping effect.
  109644. */
  109645. /**
  109646. * Sets the type of tone mapping effect.
  109647. */
  109648. toneMappingType: number;
  109649. /**
  109650. * Gets contrast used in the effect.
  109651. */
  109652. /**
  109653. * Sets contrast used in the effect.
  109654. */
  109655. contrast: number;
  109656. /**
  109657. * Gets Vignette stretch size.
  109658. */
  109659. /**
  109660. * Sets Vignette stretch size.
  109661. */
  109662. vignetteStretch: number;
  109663. /**
  109664. * Gets Vignette centre X Offset.
  109665. */
  109666. /**
  109667. * Sets Vignette centre X Offset.
  109668. */
  109669. vignetteCentreX: number;
  109670. /**
  109671. * Gets Vignette centre Y Offset.
  109672. */
  109673. /**
  109674. * Sets Vignette centre Y Offset.
  109675. */
  109676. vignetteCentreY: number;
  109677. /**
  109678. * Gets Vignette weight or intensity of the vignette effect.
  109679. */
  109680. /**
  109681. * Sets Vignette weight or intensity of the vignette effect.
  109682. */
  109683. vignetteWeight: number;
  109684. /**
  109685. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  109686. * if vignetteEnabled is set to true.
  109687. */
  109688. /**
  109689. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  109690. * if vignetteEnabled is set to true.
  109691. */
  109692. vignetteColor: Color4;
  109693. /**
  109694. * Gets Camera field of view used by the Vignette effect.
  109695. */
  109696. /**
  109697. * Sets Camera field of view used by the Vignette effect.
  109698. */
  109699. vignetteCameraFov: number;
  109700. /**
  109701. * Gets the vignette blend mode allowing different kind of effect.
  109702. */
  109703. /**
  109704. * Sets the vignette blend mode allowing different kind of effect.
  109705. */
  109706. vignetteBlendMode: number;
  109707. /**
  109708. * Gets wether the vignette effect is enabled.
  109709. */
  109710. /**
  109711. * Sets wether the vignette effect is enabled.
  109712. */
  109713. vignetteEnabled: boolean;
  109714. private _fromLinearSpace;
  109715. /**
  109716. * Gets wether the input of the processing is in Gamma or Linear Space.
  109717. */
  109718. /**
  109719. * Sets wether the input of the processing is in Gamma or Linear Space.
  109720. */
  109721. fromLinearSpace: boolean;
  109722. /**
  109723. * Defines cache preventing GC.
  109724. */
  109725. private _defines;
  109726. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  109727. /**
  109728. * "ImageProcessingPostProcess"
  109729. * @returns "ImageProcessingPostProcess"
  109730. */
  109731. getClassName(): string;
  109732. protected _updateParameters(): void;
  109733. dispose(camera?: Camera): void;
  109734. }
  109735. }
  109736. declare module BABYLON {
  109737. /**
  109738. * Class containing static functions to help procedurally build meshes
  109739. */
  109740. export class GroundBuilder {
  109741. /**
  109742. * Creates a ground mesh
  109743. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  109744. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  109745. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109746. * @param name defines the name of the mesh
  109747. * @param options defines the options used to create the mesh
  109748. * @param scene defines the hosting scene
  109749. * @returns the ground mesh
  109750. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  109751. */
  109752. static CreateGround(name: string, options: {
  109753. width?: number;
  109754. height?: number;
  109755. subdivisions?: number;
  109756. subdivisionsX?: number;
  109757. subdivisionsY?: number;
  109758. updatable?: boolean;
  109759. }, scene: any): Mesh;
  109760. /**
  109761. * Creates a tiled ground mesh
  109762. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  109763. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  109764. * * 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
  109765. * * 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
  109766. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109767. * @param name defines the name of the mesh
  109768. * @param options defines the options used to create the mesh
  109769. * @param scene defines the hosting scene
  109770. * @returns the tiled ground mesh
  109771. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  109772. */
  109773. static CreateTiledGround(name: string, options: {
  109774. xmin: number;
  109775. zmin: number;
  109776. xmax: number;
  109777. zmax: number;
  109778. subdivisions?: {
  109779. w: number;
  109780. h: number;
  109781. };
  109782. precision?: {
  109783. w: number;
  109784. h: number;
  109785. };
  109786. updatable?: boolean;
  109787. }, scene?: Nullable<Scene>): Mesh;
  109788. /**
  109789. * Creates a ground mesh from a height map
  109790. * * The parameter `url` sets the URL of the height map image resource.
  109791. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  109792. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  109793. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  109794. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  109795. * * 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.
  109796. * * 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).
  109797. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  109798. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109799. * @param name defines the name of the mesh
  109800. * @param url defines the url to the height map
  109801. * @param options defines the options used to create the mesh
  109802. * @param scene defines the hosting scene
  109803. * @returns the ground mesh
  109804. * @see https://doc.babylonjs.com/babylon101/height_map
  109805. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  109806. */
  109807. static CreateGroundFromHeightMap(name: string, url: string, options: {
  109808. width?: number;
  109809. height?: number;
  109810. subdivisions?: number;
  109811. minHeight?: number;
  109812. maxHeight?: number;
  109813. colorFilter?: Color3;
  109814. alphaFilter?: number;
  109815. updatable?: boolean;
  109816. onReady?: (mesh: GroundMesh) => void;
  109817. }, scene?: Nullable<Scene>): GroundMesh;
  109818. }
  109819. }
  109820. declare module BABYLON {
  109821. /**
  109822. * Class containing static functions to help procedurally build meshes
  109823. */
  109824. export class TorusBuilder {
  109825. /**
  109826. * Creates a torus mesh
  109827. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  109828. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  109829. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  109830. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109831. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109832. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109833. * @param name defines the name of the mesh
  109834. * @param options defines the options used to create the mesh
  109835. * @param scene defines the hosting scene
  109836. * @returns the torus mesh
  109837. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  109838. */
  109839. static CreateTorus(name: string, options: {
  109840. diameter?: number;
  109841. thickness?: number;
  109842. tessellation?: number;
  109843. updatable?: boolean;
  109844. sideOrientation?: number;
  109845. frontUVs?: Vector4;
  109846. backUVs?: Vector4;
  109847. }, scene: any): Mesh;
  109848. }
  109849. }
  109850. declare module BABYLON {
  109851. /**
  109852. * Class containing static functions to help procedurally build meshes
  109853. */
  109854. export class CylinderBuilder {
  109855. /**
  109856. * Creates a cylinder or a cone mesh
  109857. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  109858. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  109859. * * 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.
  109860. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  109861. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  109862. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  109863. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  109864. * * 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).
  109865. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  109866. * * 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).
  109867. * * 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
  109868. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  109869. * * 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
  109870. * * 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.
  109871. * * If `enclose` is false, a ring surface is one element.
  109872. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  109873. * * 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
  109874. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109875. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109876. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109877. * @param name defines the name of the mesh
  109878. * @param options defines the options used to create the mesh
  109879. * @param scene defines the hosting scene
  109880. * @returns the cylinder mesh
  109881. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  109882. */
  109883. static CreateCylinder(name: string, options: {
  109884. height?: number;
  109885. diameterTop?: number;
  109886. diameterBottom?: number;
  109887. diameter?: number;
  109888. tessellation?: number;
  109889. subdivisions?: number;
  109890. arc?: number;
  109891. faceColors?: Color4[];
  109892. faceUV?: Vector4[];
  109893. updatable?: boolean;
  109894. hasRings?: boolean;
  109895. enclose?: boolean;
  109896. cap?: number;
  109897. sideOrientation?: number;
  109898. frontUVs?: Vector4;
  109899. backUVs?: Vector4;
  109900. }, scene: any): Mesh;
  109901. }
  109902. }
  109903. declare module BABYLON {
  109904. /**
  109905. * Options to modify the vr teleportation behavior.
  109906. */
  109907. export interface VRTeleportationOptions {
  109908. /**
  109909. * The name of the mesh which should be used as the teleportation floor. (default: null)
  109910. */
  109911. floorMeshName?: string;
  109912. /**
  109913. * A list of meshes to be used as the teleportation floor. (default: empty)
  109914. */
  109915. floorMeshes?: Mesh[];
  109916. }
  109917. /**
  109918. * Options to modify the vr experience helper's behavior.
  109919. */
  109920. export interface VRExperienceHelperOptions extends WebVROptions {
  109921. /**
  109922. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  109923. */
  109924. createDeviceOrientationCamera?: boolean;
  109925. /**
  109926. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  109927. */
  109928. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  109929. /**
  109930. * Uses the main button on the controller to toggle the laser casted. (default: true)
  109931. */
  109932. laserToggle?: boolean;
  109933. /**
  109934. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  109935. */
  109936. floorMeshes?: Mesh[];
  109937. /**
  109938. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  109939. */
  109940. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  109941. }
  109942. /**
  109943. * Event containing information after VR has been entered
  109944. */
  109945. export class OnAfterEnteringVRObservableEvent {
  109946. /**
  109947. * If entering vr was successful
  109948. */
  109949. success: boolean;
  109950. }
  109951. /**
  109952. * Helps to quickly add VR support to an existing scene.
  109953. * See http://doc.babylonjs.com/how_to/webvr_helper
  109954. */
  109955. export class VRExperienceHelper {
  109956. /** Options to modify the vr experience helper's behavior. */
  109957. webVROptions: VRExperienceHelperOptions;
  109958. private _scene;
  109959. private _position;
  109960. private _btnVR;
  109961. private _btnVRDisplayed;
  109962. private _webVRsupported;
  109963. private _webVRready;
  109964. private _webVRrequesting;
  109965. private _webVRpresenting;
  109966. private _hasEnteredVR;
  109967. private _fullscreenVRpresenting;
  109968. private _inputElement;
  109969. private _webVRCamera;
  109970. private _vrDeviceOrientationCamera;
  109971. private _deviceOrientationCamera;
  109972. private _existingCamera;
  109973. private _onKeyDown;
  109974. private _onVrDisplayPresentChange;
  109975. private _onVRDisplayChanged;
  109976. private _onVRRequestPresentStart;
  109977. private _onVRRequestPresentComplete;
  109978. /**
  109979. * 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)
  109980. */
  109981. enableGazeEvenWhenNoPointerLock: boolean;
  109982. /**
  109983. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  109984. */
  109985. exitVROnDoubleTap: boolean;
  109986. /**
  109987. * Observable raised right before entering VR.
  109988. */
  109989. onEnteringVRObservable: Observable<VRExperienceHelper>;
  109990. /**
  109991. * Observable raised when entering VR has completed.
  109992. */
  109993. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  109994. /**
  109995. * Observable raised when exiting VR.
  109996. */
  109997. onExitingVRObservable: Observable<VRExperienceHelper>;
  109998. /**
  109999. * Observable raised when controller mesh is loaded.
  110000. */
  110001. onControllerMeshLoadedObservable: Observable<WebVRController>;
  110002. /** Return this.onEnteringVRObservable
  110003. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  110004. */
  110005. readonly onEnteringVR: Observable<VRExperienceHelper>;
  110006. /** Return this.onExitingVRObservable
  110007. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  110008. */
  110009. readonly onExitingVR: Observable<VRExperienceHelper>;
  110010. /** Return this.onControllerMeshLoadedObservable
  110011. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  110012. */
  110013. readonly onControllerMeshLoaded: Observable<WebVRController>;
  110014. private _rayLength;
  110015. private _useCustomVRButton;
  110016. private _teleportationRequested;
  110017. private _teleportActive;
  110018. private _floorMeshName;
  110019. private _floorMeshesCollection;
  110020. private _rotationAllowed;
  110021. private _teleportBackwardsVector;
  110022. private _teleportationTarget;
  110023. private _isDefaultTeleportationTarget;
  110024. private _postProcessMove;
  110025. private _teleportationFillColor;
  110026. private _teleportationBorderColor;
  110027. private _rotationAngle;
  110028. private _haloCenter;
  110029. private _cameraGazer;
  110030. private _padSensibilityUp;
  110031. private _padSensibilityDown;
  110032. private _leftController;
  110033. private _rightController;
  110034. /**
  110035. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  110036. */
  110037. onNewMeshSelected: Observable<AbstractMesh>;
  110038. /**
  110039. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  110040. * This observable will provide the mesh and the controller used to select the mesh
  110041. */
  110042. onMeshSelectedWithController: Observable<{
  110043. mesh: AbstractMesh;
  110044. controller: WebVRController;
  110045. }>;
  110046. /**
  110047. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  110048. */
  110049. onNewMeshPicked: Observable<PickingInfo>;
  110050. private _circleEase;
  110051. /**
  110052. * Observable raised before camera teleportation
  110053. */
  110054. onBeforeCameraTeleport: Observable<Vector3>;
  110055. /**
  110056. * Observable raised after camera teleportation
  110057. */
  110058. onAfterCameraTeleport: Observable<Vector3>;
  110059. /**
  110060. * Observable raised when current selected mesh gets unselected
  110061. */
  110062. onSelectedMeshUnselected: Observable<AbstractMesh>;
  110063. private _raySelectionPredicate;
  110064. /**
  110065. * To be optionaly changed by user to define custom ray selection
  110066. */
  110067. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  110068. /**
  110069. * To be optionaly changed by user to define custom selection logic (after ray selection)
  110070. */
  110071. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  110072. /**
  110073. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  110074. */
  110075. teleportationEnabled: boolean;
  110076. private _defaultHeight;
  110077. private _teleportationInitialized;
  110078. private _interactionsEnabled;
  110079. private _interactionsRequested;
  110080. private _displayGaze;
  110081. private _displayLaserPointer;
  110082. /**
  110083. * The mesh used to display where the user is going to teleport.
  110084. */
  110085. /**
  110086. * Sets the mesh to be used to display where the user is going to teleport.
  110087. */
  110088. teleportationTarget: Mesh;
  110089. /**
  110090. * 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
  110091. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  110092. * See http://doc.babylonjs.com/resources/baking_transformations
  110093. */
  110094. gazeTrackerMesh: Mesh;
  110095. /**
  110096. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  110097. */
  110098. updateGazeTrackerScale: boolean;
  110099. /**
  110100. * If the gaze trackers color should be updated when selecting meshes
  110101. */
  110102. updateGazeTrackerColor: boolean;
  110103. /**
  110104. * If the controller laser color should be updated when selecting meshes
  110105. */
  110106. updateControllerLaserColor: boolean;
  110107. /**
  110108. * The gaze tracking mesh corresponding to the left controller
  110109. */
  110110. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  110111. /**
  110112. * The gaze tracking mesh corresponding to the right controller
  110113. */
  110114. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  110115. /**
  110116. * If the ray of the gaze should be displayed.
  110117. */
  110118. /**
  110119. * Sets if the ray of the gaze should be displayed.
  110120. */
  110121. displayGaze: boolean;
  110122. /**
  110123. * If the ray of the LaserPointer should be displayed.
  110124. */
  110125. /**
  110126. * Sets if the ray of the LaserPointer should be displayed.
  110127. */
  110128. displayLaserPointer: boolean;
  110129. /**
  110130. * The deviceOrientationCamera used as the camera when not in VR.
  110131. */
  110132. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  110133. /**
  110134. * Based on the current WebVR support, returns the current VR camera used.
  110135. */
  110136. readonly currentVRCamera: Nullable<Camera>;
  110137. /**
  110138. * The webVRCamera which is used when in VR.
  110139. */
  110140. readonly webVRCamera: WebVRFreeCamera;
  110141. /**
  110142. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  110143. */
  110144. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  110145. /**
  110146. * The html button that is used to trigger entering into VR.
  110147. */
  110148. readonly vrButton: Nullable<HTMLButtonElement>;
  110149. private readonly _teleportationRequestInitiated;
  110150. /**
  110151. * Defines wether or not Pointer lock should be requested when switching to
  110152. * full screen.
  110153. */
  110154. requestPointerLockOnFullScreen: boolean;
  110155. /**
  110156. * Instantiates a VRExperienceHelper.
  110157. * Helps to quickly add VR support to an existing scene.
  110158. * @param scene The scene the VRExperienceHelper belongs to.
  110159. * @param webVROptions Options to modify the vr experience helper's behavior.
  110160. */
  110161. constructor(scene: Scene,
  110162. /** Options to modify the vr experience helper's behavior. */
  110163. webVROptions?: VRExperienceHelperOptions);
  110164. private _onDefaultMeshLoaded;
  110165. private _onResize;
  110166. private _onFullscreenChange;
  110167. /**
  110168. * Gets a value indicating if we are currently in VR mode.
  110169. */
  110170. readonly isInVRMode: boolean;
  110171. private onVrDisplayPresentChange;
  110172. private onVRDisplayChanged;
  110173. private moveButtonToBottomRight;
  110174. private displayVRButton;
  110175. private updateButtonVisibility;
  110176. private _cachedAngularSensibility;
  110177. /**
  110178. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  110179. * Otherwise, will use the fullscreen API.
  110180. */
  110181. enterVR(): void;
  110182. /**
  110183. * Attempt to exit VR, or fullscreen.
  110184. */
  110185. exitVR(): void;
  110186. /**
  110187. * The position of the vr experience helper.
  110188. */
  110189. /**
  110190. * Sets the position of the vr experience helper.
  110191. */
  110192. position: Vector3;
  110193. /**
  110194. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  110195. */
  110196. enableInteractions(): void;
  110197. private readonly _noControllerIsActive;
  110198. private beforeRender;
  110199. private _isTeleportationFloor;
  110200. /**
  110201. * Adds a floor mesh to be used for teleportation.
  110202. * @param floorMesh the mesh to be used for teleportation.
  110203. */
  110204. addFloorMesh(floorMesh: Mesh): void;
  110205. /**
  110206. * Removes a floor mesh from being used for teleportation.
  110207. * @param floorMesh the mesh to be removed.
  110208. */
  110209. removeFloorMesh(floorMesh: Mesh): void;
  110210. /**
  110211. * Enables interactions and teleportation using the VR controllers and gaze.
  110212. * @param vrTeleportationOptions options to modify teleportation behavior.
  110213. */
  110214. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  110215. private _onNewGamepadConnected;
  110216. private _tryEnableInteractionOnController;
  110217. private _onNewGamepadDisconnected;
  110218. private _enableInteractionOnController;
  110219. private _checkTeleportWithRay;
  110220. private _checkRotate;
  110221. private _checkTeleportBackwards;
  110222. private _enableTeleportationOnController;
  110223. private _createTeleportationCircles;
  110224. private _displayTeleportationTarget;
  110225. private _hideTeleportationTarget;
  110226. private _rotateCamera;
  110227. private _moveTeleportationSelectorTo;
  110228. private _workingVector;
  110229. private _workingQuaternion;
  110230. private _workingMatrix;
  110231. /**
  110232. * Teleports the users feet to the desired location
  110233. * @param location The location where the user's feet should be placed
  110234. */
  110235. teleportCamera(location: Vector3): void;
  110236. private _convertNormalToDirectionOfRay;
  110237. private _castRayAndSelectObject;
  110238. private _notifySelectedMeshUnselected;
  110239. /**
  110240. * Sets the color of the laser ray from the vr controllers.
  110241. * @param color new color for the ray.
  110242. */
  110243. changeLaserColor(color: Color3): void;
  110244. /**
  110245. * Sets the color of the ray from the vr headsets gaze.
  110246. * @param color new color for the ray.
  110247. */
  110248. changeGazeColor(color: Color3): void;
  110249. /**
  110250. * Exits VR and disposes of the vr experience helper
  110251. */
  110252. dispose(): void;
  110253. /**
  110254. * Gets the name of the VRExperienceHelper class
  110255. * @returns "VRExperienceHelper"
  110256. */
  110257. getClassName(): string;
  110258. }
  110259. }
  110260. declare module BABYLON {
  110261. /**
  110262. * States of the webXR experience
  110263. */
  110264. export enum WebXRState {
  110265. /**
  110266. * Transitioning to being in XR mode
  110267. */
  110268. ENTERING_XR = 0,
  110269. /**
  110270. * Transitioning to non XR mode
  110271. */
  110272. EXITING_XR = 1,
  110273. /**
  110274. * In XR mode and presenting
  110275. */
  110276. IN_XR = 2,
  110277. /**
  110278. * Not entered XR mode
  110279. */
  110280. NOT_IN_XR = 3
  110281. }
  110282. /**
  110283. * Abstraction of the XR render target
  110284. */
  110285. export interface WebXRRenderTarget extends IDisposable {
  110286. /**
  110287. * xrpresent context of the canvas which can be used to display/mirror xr content
  110288. */
  110289. canvasContext: WebGLRenderingContext;
  110290. /**
  110291. * xr layer for the canvas
  110292. */
  110293. xrLayer: Nullable<XRWebGLLayer>;
  110294. /**
  110295. * Initializes the xr layer for the session
  110296. * @param xrSession xr session
  110297. * @returns a promise that will resolve once the XR Layer has been created
  110298. */
  110299. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  110300. }
  110301. }
  110302. declare module BABYLON {
  110303. /**
  110304. * COnfiguration object for WebXR output canvas
  110305. */
  110306. export class WebXRManagedOutputCanvasOptions {
  110307. /**
  110308. * Options for this XR Layer output
  110309. */
  110310. canvasOptions: XRWebGLLayerOptions;
  110311. /**
  110312. * CSS styling for a newly created canvas (if not provided)
  110313. */
  110314. newCanvasCssStyle?: string;
  110315. /**
  110316. * Get the default values of the configuration object
  110317. * @returns default values of this configuration object
  110318. */
  110319. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  110320. }
  110321. /**
  110322. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  110323. */
  110324. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  110325. private configuration;
  110326. private _engine;
  110327. private _canvas;
  110328. /**
  110329. * xrpresent context of the canvas which can be used to display/mirror xr content
  110330. */
  110331. canvasContext: WebGLRenderingContext;
  110332. /**
  110333. * xr layer for the canvas
  110334. */
  110335. xrLayer: Nullable<XRWebGLLayer>;
  110336. /**
  110337. * Initializes the xr layer for the session
  110338. * @param xrSession xr session
  110339. * @returns a promise that will resolve once the XR Layer has been created
  110340. */
  110341. initializeXRLayerAsync(xrSession: any): any;
  110342. /**
  110343. * Initializes the canvas to be added/removed upon entering/exiting xr
  110344. * @param engine the Babylon engine
  110345. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  110346. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  110347. * @param configuration optional configuration for this canvas output. defaults will be used if not provided
  110348. */
  110349. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>, configuration?: WebXRManagedOutputCanvasOptions);
  110350. /**
  110351. * Disposes of the object
  110352. */
  110353. dispose(): void;
  110354. private _setManagedOutputCanvas;
  110355. private _addCanvas;
  110356. private _removeCanvas;
  110357. }
  110358. }
  110359. declare module BABYLON {
  110360. /**
  110361. * Manages an XRSession to work with Babylon's engine
  110362. * @see https://doc.babylonjs.com/how_to/webxr
  110363. */
  110364. export class WebXRSessionManager implements IDisposable {
  110365. private scene;
  110366. /**
  110367. * Fires every time a new xrFrame arrives which can be used to update the camera
  110368. */
  110369. onXRFrameObservable: Observable<any>;
  110370. /**
  110371. * Fires when the xr session is ended either by the device or manually done
  110372. */
  110373. onXRSessionEnded: Observable<any>;
  110374. /**
  110375. * Underlying xr session
  110376. */
  110377. session: XRSession;
  110378. /**
  110379. * Type of reference space used when creating the session
  110380. */
  110381. referenceSpace: XRReferenceSpace;
  110382. /**
  110383. * Current XR frame
  110384. */
  110385. currentFrame: Nullable<XRFrame>;
  110386. private _xrNavigator;
  110387. private baseLayer;
  110388. private _rttProvider;
  110389. private _sessionEnded;
  110390. /**
  110391. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  110392. * @param scene The scene which the session should be created for
  110393. */
  110394. constructor(scene: Scene);
  110395. /**
  110396. * Initializes the manager
  110397. * After initialization enterXR can be called to start an XR session
  110398. * @returns Promise which resolves after it is initialized
  110399. */
  110400. initializeAsync(): Promise<void>;
  110401. /**
  110402. * Initializes an xr session
  110403. * @param xrSessionMode mode to initialize
  110404. * @param optionalFeatures defines optional values to pass to the session builder
  110405. * @returns a promise which will resolve once the session has been initialized
  110406. */
  110407. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): Promise<XRSession>;
  110408. /**
  110409. * Sets the reference space on the xr session
  110410. * @param referenceSpace space to set
  110411. * @returns a promise that will resolve once the reference space has been set
  110412. */
  110413. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  110414. /**
  110415. * Updates the render state of the session
  110416. * @param state state to set
  110417. * @returns a promise that resolves once the render state has been updated
  110418. */
  110419. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  110420. /**
  110421. * Starts rendering to the xr layer
  110422. * @returns a promise that will resolve once rendering has started
  110423. */
  110424. startRenderingToXRAsync(): Promise<void>;
  110425. /**
  110426. * Gets the correct render target texture to be rendered this frame for this eye
  110427. * @param eye the eye for which to get the render target
  110428. * @returns the render target for the specified eye
  110429. */
  110430. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  110431. /**
  110432. * Stops the xrSession and restores the renderloop
  110433. * @returns Promise which resolves after it exits XR
  110434. */
  110435. exitXRAsync(): Promise<void>;
  110436. /**
  110437. * Checks if a session would be supported for the creation options specified
  110438. * @param sessionMode session mode to check if supported eg. immersive-vr
  110439. * @returns true if supported
  110440. */
  110441. supportsSessionAsync(sessionMode: XRSessionMode): any;
  110442. /**
  110443. * Creates a WebXRRenderTarget object for the XR session
  110444. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  110445. * @param options optional options to provide when creating a new render target
  110446. * @returns a WebXR render target to which the session can render
  110447. */
  110448. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>, options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  110449. /**
  110450. * @hidden
  110451. * Converts the render layer of xrSession to a render target
  110452. * @param session session to create render target for
  110453. * @param scene scene the new render target should be created for
  110454. */
  110455. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  110456. /**
  110457. * Disposes of the session manager
  110458. */
  110459. dispose(): void;
  110460. }
  110461. }
  110462. declare module BABYLON {
  110463. /**
  110464. * WebXR Camera which holds the views for the xrSession
  110465. * @see https://doc.babylonjs.com/how_to/webxr
  110466. */
  110467. export class WebXRCamera extends FreeCamera {
  110468. /**
  110469. * Is the camera in debug mode. Used when using an emulator
  110470. */
  110471. debugMode: boolean;
  110472. /**
  110473. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  110474. * @param name the name of the camera
  110475. * @param scene the scene to add the camera to
  110476. */
  110477. constructor(name: string, scene: Scene);
  110478. private _updateNumberOfRigCameras;
  110479. /** @hidden */
  110480. _updateForDualEyeDebugging(): void;
  110481. /**
  110482. * Updates the cameras position from the current pose information of the XR session
  110483. * @param xrSessionManager the session containing pose information
  110484. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  110485. */
  110486. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  110487. }
  110488. }
  110489. declare module BABYLON {
  110490. /**
  110491. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  110492. * @see https://doc.babylonjs.com/how_to/webxr
  110493. */
  110494. export class WebXRExperienceHelper implements IDisposable {
  110495. private scene;
  110496. /**
  110497. * 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
  110498. */
  110499. container: AbstractMesh;
  110500. /**
  110501. * Camera used to render xr content
  110502. */
  110503. camera: WebXRCamera;
  110504. /**
  110505. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  110506. */
  110507. state: WebXRState;
  110508. private _setState;
  110509. private static _TmpVector;
  110510. /**
  110511. * Fires when the state of the experience helper has changed
  110512. */
  110513. onStateChangedObservable: Observable<WebXRState>;
  110514. /** Session manager used to keep track of xr session */
  110515. sessionManager: WebXRSessionManager;
  110516. private _nonVRCamera;
  110517. private _originalSceneAutoClear;
  110518. private _supported;
  110519. /**
  110520. * Creates the experience helper
  110521. * @param scene the scene to attach the experience helper to
  110522. * @returns a promise for the experience helper
  110523. */
  110524. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  110525. /**
  110526. * Creates a WebXRExperienceHelper
  110527. * @param scene The scene the helper should be created in
  110528. */
  110529. private constructor();
  110530. /**
  110531. * Exits XR mode and returns the scene to its original state
  110532. * @returns promise that resolves after xr mode has exited
  110533. */
  110534. exitXRAsync(): Promise<void>;
  110535. /**
  110536. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  110537. * @param sessionMode options for the XR session
  110538. * @param referenceSpaceType frame of reference of the XR session
  110539. * @param renderTarget the output canvas that will be used to enter XR mode
  110540. * @returns promise that resolves after xr mode has entered
  110541. */
  110542. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): Promise<WebXRSessionManager>;
  110543. /**
  110544. * Updates the global position of the camera by moving the camera's container
  110545. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  110546. * @param position The desired global position of the camera
  110547. */
  110548. setPositionOfCameraUsingContainer(position: Vector3): void;
  110549. /**
  110550. * Rotates the xr camera by rotating the camera's container around the camera's position
  110551. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  110552. * @param rotation the desired quaternion rotation to apply to the camera
  110553. */
  110554. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  110555. /**
  110556. * Disposes of the experience helper
  110557. */
  110558. dispose(): void;
  110559. }
  110560. }
  110561. declare module BABYLON {
  110562. /**
  110563. * Button which can be used to enter a different mode of XR
  110564. */
  110565. export class WebXREnterExitUIButton {
  110566. /** button element */
  110567. element: HTMLElement;
  110568. /** XR initialization options for the button */
  110569. sessionMode: XRSessionMode;
  110570. /** Reference space type */
  110571. referenceSpaceType: XRReferenceSpaceType;
  110572. /**
  110573. * Creates a WebXREnterExitUIButton
  110574. * @param element button element
  110575. * @param sessionMode XR initialization session mode
  110576. * @param referenceSpaceType the type of reference space to be used
  110577. */
  110578. constructor(
  110579. /** button element */
  110580. element: HTMLElement,
  110581. /** XR initialization options for the button */
  110582. sessionMode: XRSessionMode,
  110583. /** Reference space type */
  110584. referenceSpaceType: XRReferenceSpaceType);
  110585. /**
  110586. * Overwritable function which can be used to update the button's visuals when the state changes
  110587. * @param activeButton the current active button in the UI
  110588. */
  110589. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  110590. }
  110591. /**
  110592. * Options to create the webXR UI
  110593. */
  110594. export class WebXREnterExitUIOptions {
  110595. /**
  110596. * Context to enter xr with
  110597. */
  110598. renderTarget?: Nullable<WebXRRenderTarget>;
  110599. /**
  110600. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  110601. */
  110602. customButtons?: Array<WebXREnterExitUIButton>;
  110603. /**
  110604. * A session mode to use when creating the default button.
  110605. * Default is immersive-vr
  110606. */
  110607. sessionMode?: XRSessionMode;
  110608. /**
  110609. * A reference space type to use when creating the default button.
  110610. * Default is local-floor
  110611. */
  110612. referenceSpaceType?: XRReferenceSpaceType;
  110613. }
  110614. /**
  110615. * UI to allow the user to enter/exit XR mode
  110616. */
  110617. export class WebXREnterExitUI implements IDisposable {
  110618. private scene;
  110619. private _overlay;
  110620. private _buttons;
  110621. private _activeButton;
  110622. /**
  110623. * Fired every time the active button is changed.
  110624. *
  110625. * When xr is entered via a button that launches xr that button will be the callback parameter
  110626. *
  110627. * When exiting xr the callback parameter will be null)
  110628. */
  110629. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  110630. /**
  110631. * Creates UI to allow the user to enter/exit XR mode
  110632. * @param scene the scene to add the ui to
  110633. * @param helper the xr experience helper to enter/exit xr with
  110634. * @param options options to configure the UI
  110635. * @returns the created ui
  110636. */
  110637. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  110638. private constructor();
  110639. private _updateButtons;
  110640. /**
  110641. * Disposes of the object
  110642. */
  110643. dispose(): void;
  110644. }
  110645. }
  110646. declare module BABYLON {
  110647. /**
  110648. * Represents an XR input
  110649. */
  110650. export class WebXRController {
  110651. private scene;
  110652. /** The underlying input source for the controller */
  110653. inputSource: XRInputSource;
  110654. private parentContainer;
  110655. /**
  110656. * 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
  110657. */
  110658. grip?: AbstractMesh;
  110659. /**
  110660. * Pointer which can be used to select objects or attach a visible laser to
  110661. */
  110662. pointer: AbstractMesh;
  110663. private _gamepadMode;
  110664. /**
  110665. * If available, this is the gamepad object related to this controller.
  110666. * Using this object it is possible to get click events and trackpad changes of the
  110667. * webxr controller that is currently being used.
  110668. */
  110669. gamepadController?: WebVRController;
  110670. /**
  110671. * Event that fires when the controller is removed/disposed
  110672. */
  110673. onDisposeObservable: Observable<{}>;
  110674. private _tmpMatrix;
  110675. private _tmpQuaternion;
  110676. private _tmpVector;
  110677. /**
  110678. * Creates the controller
  110679. * @see https://doc.babylonjs.com/how_to/webxr
  110680. * @param scene the scene which the controller should be associated to
  110681. * @param inputSource the underlying input source for the controller
  110682. * @param parentContainer parent that the controller meshes should be children of
  110683. */
  110684. constructor(scene: Scene,
  110685. /** The underlying input source for the controller */
  110686. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  110687. /**
  110688. * Updates the controller pose based on the given XRFrame
  110689. * @param xrFrame xr frame to update the pose with
  110690. * @param referenceSpace reference space to use
  110691. */
  110692. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  110693. /**
  110694. * Gets a world space ray coming from the controller
  110695. * @param result the resulting ray
  110696. */
  110697. getWorldPointerRayToRef(result: Ray): void;
  110698. /**
  110699. * Get the scene associated with this controller
  110700. * @returns the scene object
  110701. */
  110702. getScene(): Scene;
  110703. /**
  110704. * Disposes of the object
  110705. */
  110706. dispose(): void;
  110707. }
  110708. }
  110709. declare module BABYLON {
  110710. /**
  110711. * XR input used to track XR inputs such as controllers/rays
  110712. */
  110713. export class WebXRInput implements IDisposable {
  110714. /**
  110715. * Base experience the input listens to
  110716. */
  110717. baseExperience: WebXRExperienceHelper;
  110718. /**
  110719. * XR controllers being tracked
  110720. */
  110721. controllers: Array<WebXRController>;
  110722. private _frameObserver;
  110723. private _stateObserver;
  110724. /**
  110725. * Event when a controller has been connected/added
  110726. */
  110727. onControllerAddedObservable: Observable<WebXRController>;
  110728. /**
  110729. * Event when a controller has been removed/disconnected
  110730. */
  110731. onControllerRemovedObservable: Observable<WebXRController>;
  110732. /**
  110733. * Initializes the WebXRInput
  110734. * @param baseExperience experience helper which the input should be created for
  110735. */
  110736. constructor(
  110737. /**
  110738. * Base experience the input listens to
  110739. */
  110740. baseExperience: WebXRExperienceHelper);
  110741. private _onInputSourcesChange;
  110742. private _addAndRemoveControllers;
  110743. /**
  110744. * Disposes of the object
  110745. */
  110746. dispose(): void;
  110747. }
  110748. }
  110749. declare module BABYLON {
  110750. /**
  110751. * Enables teleportation
  110752. */
  110753. export class WebXRControllerTeleportation {
  110754. private _teleportationFillColor;
  110755. private _teleportationBorderColor;
  110756. private _tmpRay;
  110757. private _tmpVector;
  110758. /**
  110759. * Creates a WebXRControllerTeleportation
  110760. * @param input input manager to add teleportation to
  110761. * @param floorMeshes floormeshes which can be teleported to
  110762. */
  110763. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  110764. }
  110765. }
  110766. declare module BABYLON {
  110767. /**
  110768. * Handles pointer input automatically for the pointer of XR controllers
  110769. */
  110770. export class WebXRControllerPointerSelection {
  110771. private static _idCounter;
  110772. private _tmpRay;
  110773. /**
  110774. * Creates a WebXRControllerPointerSelection
  110775. * @param input input manager to setup pointer selection
  110776. */
  110777. constructor(input: WebXRInput);
  110778. private _convertNormalToDirectionOfRay;
  110779. private _updatePointerDistance;
  110780. }
  110781. }
  110782. declare module BABYLON {
  110783. /**
  110784. * Class used to represent data loading progression
  110785. */
  110786. export class SceneLoaderProgressEvent {
  110787. /** defines if data length to load can be evaluated */
  110788. readonly lengthComputable: boolean;
  110789. /** defines the loaded data length */
  110790. readonly loaded: number;
  110791. /** defines the data length to load */
  110792. readonly total: number;
  110793. /**
  110794. * Create a new progress event
  110795. * @param lengthComputable defines if data length to load can be evaluated
  110796. * @param loaded defines the loaded data length
  110797. * @param total defines the data length to load
  110798. */
  110799. constructor(
  110800. /** defines if data length to load can be evaluated */
  110801. lengthComputable: boolean,
  110802. /** defines the loaded data length */
  110803. loaded: number,
  110804. /** defines the data length to load */
  110805. total: number);
  110806. /**
  110807. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  110808. * @param event defines the source event
  110809. * @returns a new SceneLoaderProgressEvent
  110810. */
  110811. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  110812. }
  110813. /**
  110814. * Interface used by SceneLoader plugins to define supported file extensions
  110815. */
  110816. export interface ISceneLoaderPluginExtensions {
  110817. /**
  110818. * Defines the list of supported extensions
  110819. */
  110820. [extension: string]: {
  110821. isBinary: boolean;
  110822. };
  110823. }
  110824. /**
  110825. * Interface used by SceneLoader plugin factory
  110826. */
  110827. export interface ISceneLoaderPluginFactory {
  110828. /**
  110829. * Defines the name of the factory
  110830. */
  110831. name: string;
  110832. /**
  110833. * Function called to create a new plugin
  110834. * @return the new plugin
  110835. */
  110836. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  110837. /**
  110838. * The callback that returns true if the data can be directly loaded.
  110839. * @param data string containing the file data
  110840. * @returns if the data can be loaded directly
  110841. */
  110842. canDirectLoad?(data: string): boolean;
  110843. }
  110844. /**
  110845. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  110846. */
  110847. export interface ISceneLoaderPluginBase {
  110848. /**
  110849. * The friendly name of this plugin.
  110850. */
  110851. name: string;
  110852. /**
  110853. * The file extensions supported by this plugin.
  110854. */
  110855. extensions: string | ISceneLoaderPluginExtensions;
  110856. /**
  110857. * The callback called when loading from a url.
  110858. * @param scene scene loading this url
  110859. * @param url url to load
  110860. * @param onSuccess callback called when the file successfully loads
  110861. * @param onProgress callback called while file is loading (if the server supports this mode)
  110862. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  110863. * @param onError callback called when the file fails to load
  110864. * @returns a file request object
  110865. */
  110866. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  110867. /**
  110868. * The callback called when loading from a file object.
  110869. * @param scene scene loading this file
  110870. * @param file defines the file to load
  110871. * @param onSuccess defines the callback to call when data is loaded
  110872. * @param onProgress defines the callback to call during loading process
  110873. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  110874. * @param onError defines the callback to call when an error occurs
  110875. * @returns a file request object
  110876. */
  110877. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  110878. /**
  110879. * The callback that returns true if the data can be directly loaded.
  110880. * @param data string containing the file data
  110881. * @returns if the data can be loaded directly
  110882. */
  110883. canDirectLoad?(data: string): boolean;
  110884. /**
  110885. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  110886. * @param scene scene loading this data
  110887. * @param data string containing the data
  110888. * @returns data to pass to the plugin
  110889. */
  110890. directLoad?(scene: Scene, data: string): any;
  110891. /**
  110892. * The callback that allows custom handling of the root url based on the response url.
  110893. * @param rootUrl the original root url
  110894. * @param responseURL the response url if available
  110895. * @returns the new root url
  110896. */
  110897. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  110898. }
  110899. /**
  110900. * Interface used to define a SceneLoader plugin
  110901. */
  110902. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  110903. /**
  110904. * Import meshes into a scene.
  110905. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110906. * @param scene The scene to import into
  110907. * @param data The data to import
  110908. * @param rootUrl The root url for scene and resources
  110909. * @param meshes The meshes array to import into
  110910. * @param particleSystems The particle systems array to import into
  110911. * @param skeletons The skeletons array to import into
  110912. * @param onError The callback when import fails
  110913. * @returns True if successful or false otherwise
  110914. */
  110915. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  110916. /**
  110917. * Load into a scene.
  110918. * @param scene The scene to load into
  110919. * @param data The data to import
  110920. * @param rootUrl The root url for scene and resources
  110921. * @param onError The callback when import fails
  110922. * @returns True if successful or false otherwise
  110923. */
  110924. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  110925. /**
  110926. * Load into an asset container.
  110927. * @param scene The scene to load into
  110928. * @param data The data to import
  110929. * @param rootUrl The root url for scene and resources
  110930. * @param onError The callback when import fails
  110931. * @returns The loaded asset container
  110932. */
  110933. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  110934. }
  110935. /**
  110936. * Interface used to define an async SceneLoader plugin
  110937. */
  110938. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  110939. /**
  110940. * Import meshes into a scene.
  110941. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110942. * @param scene The scene to import into
  110943. * @param data The data to import
  110944. * @param rootUrl The root url for scene and resources
  110945. * @param onProgress The callback when the load progresses
  110946. * @param fileName Defines the name of the file to load
  110947. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  110948. */
  110949. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  110950. meshes: AbstractMesh[];
  110951. particleSystems: IParticleSystem[];
  110952. skeletons: Skeleton[];
  110953. animationGroups: AnimationGroup[];
  110954. }>;
  110955. /**
  110956. * Load into a scene.
  110957. * @param scene The scene to load into
  110958. * @param data The data to import
  110959. * @param rootUrl The root url for scene and resources
  110960. * @param onProgress The callback when the load progresses
  110961. * @param fileName Defines the name of the file to load
  110962. * @returns Nothing
  110963. */
  110964. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  110965. /**
  110966. * Load into an asset container.
  110967. * @param scene The scene to load into
  110968. * @param data The data to import
  110969. * @param rootUrl The root url for scene and resources
  110970. * @param onProgress The callback when the load progresses
  110971. * @param fileName Defines the name of the file to load
  110972. * @returns The loaded asset container
  110973. */
  110974. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  110975. }
  110976. /**
  110977. * Class used to load scene from various file formats using registered plugins
  110978. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  110979. */
  110980. export class SceneLoader {
  110981. /**
  110982. * No logging while loading
  110983. */
  110984. static readonly NO_LOGGING: number;
  110985. /**
  110986. * Minimal logging while loading
  110987. */
  110988. static readonly MINIMAL_LOGGING: number;
  110989. /**
  110990. * Summary logging while loading
  110991. */
  110992. static readonly SUMMARY_LOGGING: number;
  110993. /**
  110994. * Detailled logging while loading
  110995. */
  110996. static readonly DETAILED_LOGGING: number;
  110997. /**
  110998. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  110999. */
  111000. static ForceFullSceneLoadingForIncremental: boolean;
  111001. /**
  111002. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  111003. */
  111004. static ShowLoadingScreen: boolean;
  111005. /**
  111006. * Defines the current logging level (while loading the scene)
  111007. * @ignorenaming
  111008. */
  111009. static loggingLevel: number;
  111010. /**
  111011. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  111012. */
  111013. static CleanBoneMatrixWeights: boolean;
  111014. /**
  111015. * Event raised when a plugin is used to load a scene
  111016. */
  111017. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  111018. private static _registeredPlugins;
  111019. private static _getDefaultPlugin;
  111020. private static _getPluginForExtension;
  111021. private static _getPluginForDirectLoad;
  111022. private static _getPluginForFilename;
  111023. private static _getDirectLoad;
  111024. private static _loadData;
  111025. private static _getFileInfo;
  111026. /**
  111027. * Gets a plugin that can load the given extension
  111028. * @param extension defines the extension to load
  111029. * @returns a plugin or null if none works
  111030. */
  111031. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  111032. /**
  111033. * Gets a boolean indicating that the given extension can be loaded
  111034. * @param extension defines the extension to load
  111035. * @returns true if the extension is supported
  111036. */
  111037. static IsPluginForExtensionAvailable(extension: string): boolean;
  111038. /**
  111039. * Adds a new plugin to the list of registered plugins
  111040. * @param plugin defines the plugin to add
  111041. */
  111042. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  111043. /**
  111044. * Import meshes into a scene
  111045. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  111046. * @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)
  111047. * @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)
  111048. * @param scene the instance of BABYLON.Scene to append to
  111049. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  111050. * @param onProgress a callback with a progress event for each file being loaded
  111051. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  111052. * @param pluginExtension the extension used to determine the plugin
  111053. * @returns The loaded plugin
  111054. */
  111055. 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>;
  111056. /**
  111057. * Import meshes into a scene
  111058. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  111059. * @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)
  111060. * @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)
  111061. * @param scene the instance of BABYLON.Scene to append to
  111062. * @param onProgress a callback with a progress event for each file being loaded
  111063. * @param pluginExtension the extension used to determine the plugin
  111064. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  111065. */
  111066. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  111067. meshes: AbstractMesh[];
  111068. particleSystems: IParticleSystem[];
  111069. skeletons: Skeleton[];
  111070. animationGroups: AnimationGroup[];
  111071. }>;
  111072. /**
  111073. * Load a scene
  111074. * @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)
  111075. * @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)
  111076. * @param engine is the instance of BABYLON.Engine to use to create the scene
  111077. * @param onSuccess a callback with the scene when import succeeds
  111078. * @param onProgress a callback with a progress event for each file being loaded
  111079. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  111080. * @param pluginExtension the extension used to determine the plugin
  111081. * @returns The loaded plugin
  111082. */
  111083. 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>;
  111084. /**
  111085. * Load a scene
  111086. * @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)
  111087. * @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)
  111088. * @param engine is the instance of BABYLON.Engine to use to create the scene
  111089. * @param onProgress a callback with a progress event for each file being loaded
  111090. * @param pluginExtension the extension used to determine the plugin
  111091. * @returns The loaded scene
  111092. */
  111093. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  111094. /**
  111095. * Append a scene
  111096. * @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)
  111097. * @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)
  111098. * @param scene is the instance of BABYLON.Scene to append to
  111099. * @param onSuccess a callback with the scene when import succeeds
  111100. * @param onProgress a callback with a progress event for each file being loaded
  111101. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  111102. * @param pluginExtension the extension used to determine the plugin
  111103. * @returns The loaded plugin
  111104. */
  111105. 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>;
  111106. /**
  111107. * Append a scene
  111108. * @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)
  111109. * @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)
  111110. * @param scene is the instance of BABYLON.Scene to append to
  111111. * @param onProgress a callback with a progress event for each file being loaded
  111112. * @param pluginExtension the extension used to determine the plugin
  111113. * @returns The given scene
  111114. */
  111115. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  111116. /**
  111117. * Load a scene into an asset container
  111118. * @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)
  111119. * @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)
  111120. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  111121. * @param onSuccess a callback with the scene when import succeeds
  111122. * @param onProgress a callback with a progress event for each file being loaded
  111123. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  111124. * @param pluginExtension the extension used to determine the plugin
  111125. * @returns The loaded plugin
  111126. */
  111127. 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>;
  111128. /**
  111129. * Load a scene into an asset container
  111130. * @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)
  111131. * @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)
  111132. * @param scene is the instance of Scene to append to
  111133. * @param onProgress a callback with a progress event for each file being loaded
  111134. * @param pluginExtension the extension used to determine the plugin
  111135. * @returns The loaded asset container
  111136. */
  111137. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  111138. }
  111139. }
  111140. declare module BABYLON {
  111141. /**
  111142. * Generic Controller
  111143. */
  111144. export class GenericController extends WebVRController {
  111145. /**
  111146. * Base Url for the controller model.
  111147. */
  111148. static readonly MODEL_BASE_URL: string;
  111149. /**
  111150. * File name for the controller model.
  111151. */
  111152. static readonly MODEL_FILENAME: string;
  111153. /**
  111154. * Creates a new GenericController from a gamepad
  111155. * @param vrGamepad the gamepad that the controller should be created from
  111156. */
  111157. constructor(vrGamepad: any);
  111158. /**
  111159. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111160. * @param scene scene in which to add meshes
  111161. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111162. */
  111163. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  111164. /**
  111165. * Called once for each button that changed state since the last frame
  111166. * @param buttonIdx Which button index changed
  111167. * @param state New state of the button
  111168. * @param changes Which properties on the state changed since last frame
  111169. */
  111170. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111171. }
  111172. }
  111173. declare module BABYLON {
  111174. /**
  111175. * Defines the WindowsMotionController object that the state of the windows motion controller
  111176. */
  111177. export class WindowsMotionController extends WebVRController {
  111178. /**
  111179. * The base url used to load the left and right controller models
  111180. */
  111181. static MODEL_BASE_URL: string;
  111182. /**
  111183. * The name of the left controller model file
  111184. */
  111185. static MODEL_LEFT_FILENAME: string;
  111186. /**
  111187. * The name of the right controller model file
  111188. */
  111189. static MODEL_RIGHT_FILENAME: string;
  111190. /**
  111191. * The controller name prefix for this controller type
  111192. */
  111193. static readonly GAMEPAD_ID_PREFIX: string;
  111194. /**
  111195. * The controller id pattern for this controller type
  111196. */
  111197. private static readonly GAMEPAD_ID_PATTERN;
  111198. private _loadedMeshInfo;
  111199. private readonly _mapping;
  111200. /**
  111201. * Fired when the trackpad on this controller is clicked
  111202. */
  111203. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  111204. /**
  111205. * Fired when the trackpad on this controller is modified
  111206. */
  111207. onTrackpadValuesChangedObservable: Observable<StickValues>;
  111208. /**
  111209. * The current x and y values of this controller's trackpad
  111210. */
  111211. trackpad: StickValues;
  111212. /**
  111213. * Creates a new WindowsMotionController from a gamepad
  111214. * @param vrGamepad the gamepad that the controller should be created from
  111215. */
  111216. constructor(vrGamepad: any);
  111217. /**
  111218. * Fired when the trigger on this controller is modified
  111219. */
  111220. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111221. /**
  111222. * Fired when the menu button on this controller is modified
  111223. */
  111224. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111225. /**
  111226. * Fired when the grip button on this controller is modified
  111227. */
  111228. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111229. /**
  111230. * Fired when the thumbstick button on this controller is modified
  111231. */
  111232. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111233. /**
  111234. * Fired when the touchpad button on this controller is modified
  111235. */
  111236. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111237. /**
  111238. * Fired when the touchpad values on this controller are modified
  111239. */
  111240. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  111241. private _updateTrackpad;
  111242. /**
  111243. * Called once per frame by the engine.
  111244. */
  111245. update(): void;
  111246. /**
  111247. * Called once for each button that changed state since the last frame
  111248. * @param buttonIdx Which button index changed
  111249. * @param state New state of the button
  111250. * @param changes Which properties on the state changed since last frame
  111251. */
  111252. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111253. /**
  111254. * Moves the buttons on the controller mesh based on their current state
  111255. * @param buttonName the name of the button to move
  111256. * @param buttonValue the value of the button which determines the buttons new position
  111257. */
  111258. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  111259. /**
  111260. * Moves the axis on the controller mesh based on its current state
  111261. * @param axis the index of the axis
  111262. * @param axisValue the value of the axis which determines the meshes new position
  111263. * @hidden
  111264. */
  111265. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  111266. /**
  111267. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111268. * @param scene scene in which to add meshes
  111269. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111270. */
  111271. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  111272. /**
  111273. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  111274. * can be transformed by button presses and axes values, based on this._mapping.
  111275. *
  111276. * @param scene scene in which the meshes exist
  111277. * @param meshes list of meshes that make up the controller model to process
  111278. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  111279. */
  111280. private processModel;
  111281. private createMeshInfo;
  111282. /**
  111283. * Gets the ray of the controller in the direction the controller is pointing
  111284. * @param length the length the resulting ray should be
  111285. * @returns a ray in the direction the controller is pointing
  111286. */
  111287. getForwardRay(length?: number): Ray;
  111288. /**
  111289. * Disposes of the controller
  111290. */
  111291. dispose(): void;
  111292. }
  111293. }
  111294. declare module BABYLON {
  111295. /**
  111296. * Oculus Touch Controller
  111297. */
  111298. export class OculusTouchController extends WebVRController {
  111299. /**
  111300. * Base Url for the controller model.
  111301. */
  111302. static MODEL_BASE_URL: string;
  111303. /**
  111304. * File name for the left controller model.
  111305. */
  111306. static MODEL_LEFT_FILENAME: string;
  111307. /**
  111308. * File name for the right controller model.
  111309. */
  111310. static MODEL_RIGHT_FILENAME: string;
  111311. /**
  111312. * Base Url for the Quest controller model.
  111313. */
  111314. static QUEST_MODEL_BASE_URL: string;
  111315. /**
  111316. * @hidden
  111317. * If the controllers are running on a device that needs the updated Quest controller models
  111318. */
  111319. static _IsQuest: boolean;
  111320. /**
  111321. * Fired when the secondary trigger on this controller is modified
  111322. */
  111323. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  111324. /**
  111325. * Fired when the thumb rest on this controller is modified
  111326. */
  111327. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  111328. /**
  111329. * Creates a new OculusTouchController from a gamepad
  111330. * @param vrGamepad the gamepad that the controller should be created from
  111331. */
  111332. constructor(vrGamepad: any);
  111333. /**
  111334. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111335. * @param scene scene in which to add meshes
  111336. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111337. */
  111338. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  111339. /**
  111340. * Fired when the A button on this controller is modified
  111341. */
  111342. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111343. /**
  111344. * Fired when the B button on this controller is modified
  111345. */
  111346. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111347. /**
  111348. * Fired when the X button on this controller is modified
  111349. */
  111350. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111351. /**
  111352. * Fired when the Y button on this controller is modified
  111353. */
  111354. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111355. /**
  111356. * Called once for each button that changed state since the last frame
  111357. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  111358. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  111359. * 2) secondary trigger (same)
  111360. * 3) A (right) X (left), touch, pressed = value
  111361. * 4) B / Y
  111362. * 5) thumb rest
  111363. * @param buttonIdx Which button index changed
  111364. * @param state New state of the button
  111365. * @param changes Which properties on the state changed since last frame
  111366. */
  111367. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111368. }
  111369. }
  111370. declare module BABYLON {
  111371. /**
  111372. * Vive Controller
  111373. */
  111374. export class ViveController extends WebVRController {
  111375. /**
  111376. * Base Url for the controller model.
  111377. */
  111378. static MODEL_BASE_URL: string;
  111379. /**
  111380. * File name for the controller model.
  111381. */
  111382. static MODEL_FILENAME: string;
  111383. /**
  111384. * Creates a new ViveController from a gamepad
  111385. * @param vrGamepad the gamepad that the controller should be created from
  111386. */
  111387. constructor(vrGamepad: any);
  111388. /**
  111389. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111390. * @param scene scene in which to add meshes
  111391. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111392. */
  111393. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  111394. /**
  111395. * Fired when the left button on this controller is modified
  111396. */
  111397. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111398. /**
  111399. * Fired when the right button on this controller is modified
  111400. */
  111401. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111402. /**
  111403. * Fired when the menu button on this controller is modified
  111404. */
  111405. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111406. /**
  111407. * Called once for each button that changed state since the last frame
  111408. * Vive mapping:
  111409. * 0: touchpad
  111410. * 1: trigger
  111411. * 2: left AND right buttons
  111412. * 3: menu button
  111413. * @param buttonIdx Which button index changed
  111414. * @param state New state of the button
  111415. * @param changes Which properties on the state changed since last frame
  111416. */
  111417. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111418. }
  111419. }
  111420. declare module BABYLON {
  111421. /**
  111422. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  111423. */
  111424. export class WebXRControllerModelLoader {
  111425. /**
  111426. * Creates the WebXRControllerModelLoader
  111427. * @param input xr input that creates the controllers
  111428. */
  111429. constructor(input: WebXRInput);
  111430. }
  111431. }
  111432. declare module BABYLON {
  111433. /**
  111434. * Options for the default xr helper
  111435. */
  111436. export class WebXRDefaultExperienceOptions {
  111437. /**
  111438. * Floor meshes that should be used for teleporting
  111439. */
  111440. floorMeshes: Array<AbstractMesh>;
  111441. /**
  111442. * Enable or disable default UI to enter XR
  111443. */
  111444. disableDefaultUI: boolean;
  111445. /**
  111446. * optional configuration for the output canvas
  111447. */
  111448. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  111449. }
  111450. /**
  111451. * Default experience which provides a similar setup to the previous webVRExperience
  111452. */
  111453. export class WebXRDefaultExperience {
  111454. /**
  111455. * Base experience
  111456. */
  111457. baseExperience: WebXRExperienceHelper;
  111458. /**
  111459. * Input experience extension
  111460. */
  111461. input: WebXRInput;
  111462. /**
  111463. * Loads the controller models
  111464. */
  111465. controllerModelLoader: WebXRControllerModelLoader;
  111466. /**
  111467. * Enables laser pointer and selection
  111468. */
  111469. pointerSelection: WebXRControllerPointerSelection;
  111470. /**
  111471. * Enables teleportation
  111472. */
  111473. teleportation: WebXRControllerTeleportation;
  111474. /**
  111475. * Enables ui for enetering/exiting xr
  111476. */
  111477. enterExitUI: WebXREnterExitUI;
  111478. /**
  111479. * Default target xr should render to
  111480. */
  111481. renderTarget: WebXRRenderTarget;
  111482. /**
  111483. * Creates the default xr experience
  111484. * @param scene scene
  111485. * @param options options for basic configuration
  111486. * @returns resulting WebXRDefaultExperience
  111487. */
  111488. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  111489. private constructor();
  111490. /**
  111491. * DIsposes of the experience helper
  111492. */
  111493. dispose(): void;
  111494. }
  111495. }
  111496. declare module BABYLON {
  111497. /**
  111498. * Contains an array of blocks representing the octree
  111499. */
  111500. export interface IOctreeContainer<T> {
  111501. /**
  111502. * Blocks within the octree
  111503. */
  111504. blocks: Array<OctreeBlock<T>>;
  111505. }
  111506. /**
  111507. * Class used to store a cell in an octree
  111508. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111509. */
  111510. export class OctreeBlock<T> {
  111511. /**
  111512. * Gets the content of the current block
  111513. */
  111514. entries: T[];
  111515. /**
  111516. * Gets the list of block children
  111517. */
  111518. blocks: Array<OctreeBlock<T>>;
  111519. private _depth;
  111520. private _maxDepth;
  111521. private _capacity;
  111522. private _minPoint;
  111523. private _maxPoint;
  111524. private _boundingVectors;
  111525. private _creationFunc;
  111526. /**
  111527. * Creates a new block
  111528. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  111529. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  111530. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  111531. * @param depth defines the current depth of this block in the octree
  111532. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  111533. * @param creationFunc defines a callback to call when an element is added to the block
  111534. */
  111535. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  111536. /**
  111537. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  111538. */
  111539. readonly capacity: number;
  111540. /**
  111541. * Gets the minimum vector (in world space) of the block's bounding box
  111542. */
  111543. readonly minPoint: Vector3;
  111544. /**
  111545. * Gets the maximum vector (in world space) of the block's bounding box
  111546. */
  111547. readonly maxPoint: Vector3;
  111548. /**
  111549. * Add a new element to this block
  111550. * @param entry defines the element to add
  111551. */
  111552. addEntry(entry: T): void;
  111553. /**
  111554. * Remove an element from this block
  111555. * @param entry defines the element to remove
  111556. */
  111557. removeEntry(entry: T): void;
  111558. /**
  111559. * Add an array of elements to this block
  111560. * @param entries defines the array of elements to add
  111561. */
  111562. addEntries(entries: T[]): void;
  111563. /**
  111564. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  111565. * @param frustumPlanes defines the frustum planes to test
  111566. * @param selection defines the array to store current content if selection is positive
  111567. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111568. */
  111569. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  111570. /**
  111571. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  111572. * @param sphereCenter defines the bounding sphere center
  111573. * @param sphereRadius defines the bounding sphere radius
  111574. * @param selection defines the array to store current content if selection is positive
  111575. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111576. */
  111577. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  111578. /**
  111579. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  111580. * @param ray defines the ray to test with
  111581. * @param selection defines the array to store current content if selection is positive
  111582. */
  111583. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  111584. /**
  111585. * Subdivide the content into child blocks (this block will then be empty)
  111586. */
  111587. createInnerBlocks(): void;
  111588. /**
  111589. * @hidden
  111590. */
  111591. 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;
  111592. }
  111593. }
  111594. declare module BABYLON {
  111595. /**
  111596. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  111597. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111598. */
  111599. export class Octree<T> {
  111600. /** 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.) */
  111601. maxDepth: number;
  111602. /**
  111603. * Blocks within the octree containing objects
  111604. */
  111605. blocks: Array<OctreeBlock<T>>;
  111606. /**
  111607. * Content stored in the octree
  111608. */
  111609. dynamicContent: T[];
  111610. private _maxBlockCapacity;
  111611. private _selectionContent;
  111612. private _creationFunc;
  111613. /**
  111614. * Creates a octree
  111615. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111616. * @param creationFunc function to be used to instatiate the octree
  111617. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  111618. * @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.)
  111619. */
  111620. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  111621. /** 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.) */
  111622. maxDepth?: number);
  111623. /**
  111624. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  111625. * @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);
  111626. * @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);
  111627. * @param entries meshes to be added to the octree blocks
  111628. */
  111629. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  111630. /**
  111631. * Adds a mesh to the octree
  111632. * @param entry Mesh to add to the octree
  111633. */
  111634. addMesh(entry: T): void;
  111635. /**
  111636. * Remove an element from the octree
  111637. * @param entry defines the element to remove
  111638. */
  111639. removeMesh(entry: T): void;
  111640. /**
  111641. * Selects an array of meshes within the frustum
  111642. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  111643. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  111644. * @returns array of meshes within the frustum
  111645. */
  111646. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  111647. /**
  111648. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  111649. * @param sphereCenter defines the bounding sphere center
  111650. * @param sphereRadius defines the bounding sphere radius
  111651. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111652. * @returns an array of objects that intersect the sphere
  111653. */
  111654. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  111655. /**
  111656. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  111657. * @param ray defines the ray to test with
  111658. * @returns array of intersected objects
  111659. */
  111660. intersectsRay(ray: Ray): SmartArray<T>;
  111661. /**
  111662. * Adds a mesh into the octree block if it intersects the block
  111663. */
  111664. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  111665. /**
  111666. * Adds a submesh into the octree block if it intersects the block
  111667. */
  111668. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  111669. }
  111670. }
  111671. declare module BABYLON {
  111672. interface Scene {
  111673. /**
  111674. * @hidden
  111675. * Backing Filed
  111676. */
  111677. _selectionOctree: Octree<AbstractMesh>;
  111678. /**
  111679. * Gets the octree used to boost mesh selection (picking)
  111680. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111681. */
  111682. selectionOctree: Octree<AbstractMesh>;
  111683. /**
  111684. * Creates or updates the octree used to boost selection (picking)
  111685. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111686. * @param maxCapacity defines the maximum capacity per leaf
  111687. * @param maxDepth defines the maximum depth of the octree
  111688. * @returns an octree of AbstractMesh
  111689. */
  111690. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  111691. }
  111692. interface AbstractMesh {
  111693. /**
  111694. * @hidden
  111695. * Backing Field
  111696. */
  111697. _submeshesOctree: Octree<SubMesh>;
  111698. /**
  111699. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  111700. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  111701. * @param maxCapacity defines the maximum size of each block (64 by default)
  111702. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  111703. * @returns the new octree
  111704. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  111705. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111706. */
  111707. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  111708. }
  111709. /**
  111710. * Defines the octree scene component responsible to manage any octrees
  111711. * in a given scene.
  111712. */
  111713. export class OctreeSceneComponent {
  111714. /**
  111715. * The component name help to identify the component in the list of scene components.
  111716. */
  111717. readonly name: string;
  111718. /**
  111719. * The scene the component belongs to.
  111720. */
  111721. scene: Scene;
  111722. /**
  111723. * Indicates if the meshes have been checked to make sure they are isEnabled()
  111724. */
  111725. readonly checksIsEnabled: boolean;
  111726. /**
  111727. * Creates a new instance of the component for the given scene
  111728. * @param scene Defines the scene to register the component in
  111729. */
  111730. constructor(scene: Scene);
  111731. /**
  111732. * Registers the component in a given scene
  111733. */
  111734. register(): void;
  111735. /**
  111736. * Return the list of active meshes
  111737. * @returns the list of active meshes
  111738. */
  111739. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  111740. /**
  111741. * Return the list of active sub meshes
  111742. * @param mesh The mesh to get the candidates sub meshes from
  111743. * @returns the list of active sub meshes
  111744. */
  111745. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  111746. private _tempRay;
  111747. /**
  111748. * Return the list of sub meshes intersecting with a given local ray
  111749. * @param mesh defines the mesh to find the submesh for
  111750. * @param localRay defines the ray in local space
  111751. * @returns the list of intersecting sub meshes
  111752. */
  111753. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  111754. /**
  111755. * Return the list of sub meshes colliding with a collider
  111756. * @param mesh defines the mesh to find the submesh for
  111757. * @param collider defines the collider to evaluate the collision against
  111758. * @returns the list of colliding sub meshes
  111759. */
  111760. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  111761. /**
  111762. * Rebuilds the elements related to this component in case of
  111763. * context lost for instance.
  111764. */
  111765. rebuild(): void;
  111766. /**
  111767. * Disposes the component and the associated ressources.
  111768. */
  111769. dispose(): void;
  111770. }
  111771. }
  111772. declare module BABYLON {
  111773. /**
  111774. * Renders a layer on top of an existing scene
  111775. */
  111776. export class UtilityLayerRenderer implements IDisposable {
  111777. /** the original scene that will be rendered on top of */
  111778. originalScene: Scene;
  111779. private _pointerCaptures;
  111780. private _lastPointerEvents;
  111781. private static _DefaultUtilityLayer;
  111782. private static _DefaultKeepDepthUtilityLayer;
  111783. private _sharedGizmoLight;
  111784. private _renderCamera;
  111785. /**
  111786. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  111787. * @returns the camera that is used when rendering the utility layer
  111788. */
  111789. getRenderCamera(): Nullable<Camera>;
  111790. /**
  111791. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  111792. * @param cam the camera that should be used when rendering the utility layer
  111793. */
  111794. setRenderCamera(cam: Nullable<Camera>): void;
  111795. /**
  111796. * @hidden
  111797. * Light which used by gizmos to get light shading
  111798. */
  111799. _getSharedGizmoLight(): HemisphericLight;
  111800. /**
  111801. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  111802. */
  111803. pickUtilitySceneFirst: boolean;
  111804. /**
  111805. * 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)
  111806. */
  111807. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  111808. /**
  111809. * 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)
  111810. */
  111811. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  111812. /**
  111813. * The scene that is rendered on top of the original scene
  111814. */
  111815. utilityLayerScene: Scene;
  111816. /**
  111817. * If the utility layer should automatically be rendered on top of existing scene
  111818. */
  111819. shouldRender: boolean;
  111820. /**
  111821. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  111822. */
  111823. onlyCheckPointerDownEvents: boolean;
  111824. /**
  111825. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  111826. */
  111827. processAllEvents: boolean;
  111828. /**
  111829. * Observable raised when the pointer move from the utility layer scene to the main scene
  111830. */
  111831. onPointerOutObservable: Observable<number>;
  111832. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  111833. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  111834. private _afterRenderObserver;
  111835. private _sceneDisposeObserver;
  111836. private _originalPointerObserver;
  111837. /**
  111838. * Instantiates a UtilityLayerRenderer
  111839. * @param originalScene the original scene that will be rendered on top of
  111840. * @param handleEvents boolean indicating if the utility layer should handle events
  111841. */
  111842. constructor(
  111843. /** the original scene that will be rendered on top of */
  111844. originalScene: Scene, handleEvents?: boolean);
  111845. private _notifyObservers;
  111846. /**
  111847. * Renders the utility layers scene on top of the original scene
  111848. */
  111849. render(): void;
  111850. /**
  111851. * Disposes of the renderer
  111852. */
  111853. dispose(): void;
  111854. private _updateCamera;
  111855. }
  111856. }
  111857. declare module BABYLON {
  111858. /**
  111859. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  111860. */
  111861. export class Gizmo implements IDisposable {
  111862. /** The utility layer the gizmo will be added to */
  111863. gizmoLayer: UtilityLayerRenderer;
  111864. /**
  111865. * The root mesh of the gizmo
  111866. */
  111867. _rootMesh: Mesh;
  111868. private _attachedMesh;
  111869. /**
  111870. * Ratio for the scale of the gizmo (Default: 1)
  111871. */
  111872. scaleRatio: number;
  111873. /**
  111874. * If a custom mesh has been set (Default: false)
  111875. */
  111876. protected _customMeshSet: boolean;
  111877. /**
  111878. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  111879. * * When set, interactions will be enabled
  111880. */
  111881. attachedMesh: Nullable<AbstractMesh>;
  111882. /**
  111883. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  111884. * @param mesh The mesh to replace the default mesh of the gizmo
  111885. */
  111886. setCustomMesh(mesh: Mesh): void;
  111887. /**
  111888. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  111889. */
  111890. updateGizmoRotationToMatchAttachedMesh: boolean;
  111891. /**
  111892. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  111893. */
  111894. updateGizmoPositionToMatchAttachedMesh: boolean;
  111895. /**
  111896. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  111897. */
  111898. updateScale: boolean;
  111899. protected _interactionsEnabled: boolean;
  111900. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111901. private _beforeRenderObserver;
  111902. private _tempVector;
  111903. /**
  111904. * Creates a gizmo
  111905. * @param gizmoLayer The utility layer the gizmo will be added to
  111906. */
  111907. constructor(
  111908. /** The utility layer the gizmo will be added to */
  111909. gizmoLayer?: UtilityLayerRenderer);
  111910. /**
  111911. * Updates the gizmo to match the attached mesh's position/rotation
  111912. */
  111913. protected _update(): void;
  111914. /**
  111915. * Disposes of the gizmo
  111916. */
  111917. dispose(): void;
  111918. }
  111919. }
  111920. declare module BABYLON {
  111921. /**
  111922. * Single plane drag gizmo
  111923. */
  111924. export class PlaneDragGizmo extends Gizmo {
  111925. /**
  111926. * Drag behavior responsible for the gizmos dragging interactions
  111927. */
  111928. dragBehavior: PointerDragBehavior;
  111929. private _pointerObserver;
  111930. /**
  111931. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111932. */
  111933. snapDistance: number;
  111934. /**
  111935. * Event that fires each time the gizmo snaps to a new location.
  111936. * * snapDistance is the the change in distance
  111937. */
  111938. onSnapObservable: Observable<{
  111939. snapDistance: number;
  111940. }>;
  111941. private _plane;
  111942. private _coloredMaterial;
  111943. private _hoverMaterial;
  111944. private _isEnabled;
  111945. private _parent;
  111946. /** @hidden */
  111947. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  111948. /** @hidden */
  111949. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  111950. /**
  111951. * Creates a PlaneDragGizmo
  111952. * @param gizmoLayer The utility layer the gizmo will be added to
  111953. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  111954. * @param color The color of the gizmo
  111955. */
  111956. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  111957. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111958. /**
  111959. * If the gizmo is enabled
  111960. */
  111961. isEnabled: boolean;
  111962. /**
  111963. * Disposes of the gizmo
  111964. */
  111965. dispose(): void;
  111966. }
  111967. }
  111968. declare module BABYLON {
  111969. /**
  111970. * Gizmo that enables dragging a mesh along 3 axis
  111971. */
  111972. export class PositionGizmo extends Gizmo {
  111973. /**
  111974. * Internal gizmo used for interactions on the x axis
  111975. */
  111976. xGizmo: AxisDragGizmo;
  111977. /**
  111978. * Internal gizmo used for interactions on the y axis
  111979. */
  111980. yGizmo: AxisDragGizmo;
  111981. /**
  111982. * Internal gizmo used for interactions on the z axis
  111983. */
  111984. zGizmo: AxisDragGizmo;
  111985. /**
  111986. * Internal gizmo used for interactions on the yz plane
  111987. */
  111988. xPlaneGizmo: PlaneDragGizmo;
  111989. /**
  111990. * Internal gizmo used for interactions on the xz plane
  111991. */
  111992. yPlaneGizmo: PlaneDragGizmo;
  111993. /**
  111994. * Internal gizmo used for interactions on the xy plane
  111995. */
  111996. zPlaneGizmo: PlaneDragGizmo;
  111997. /**
  111998. * private variables
  111999. */
  112000. private _meshAttached;
  112001. private _updateGizmoRotationToMatchAttachedMesh;
  112002. private _snapDistance;
  112003. private _scaleRatio;
  112004. /** Fires an event when any of it's sub gizmos are dragged */
  112005. onDragStartObservable: Observable<unknown>;
  112006. /** Fires an event when any of it's sub gizmos are released from dragging */
  112007. onDragEndObservable: Observable<unknown>;
  112008. /**
  112009. * If set to true, planar drag is enabled
  112010. */
  112011. private _planarGizmoEnabled;
  112012. attachedMesh: Nullable<AbstractMesh>;
  112013. /**
  112014. * Creates a PositionGizmo
  112015. * @param gizmoLayer The utility layer the gizmo will be added to
  112016. */
  112017. constructor(gizmoLayer?: UtilityLayerRenderer);
  112018. /**
  112019. * If the planar drag gizmo is enabled
  112020. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  112021. */
  112022. planarGizmoEnabled: boolean;
  112023. updateGizmoRotationToMatchAttachedMesh: boolean;
  112024. /**
  112025. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  112026. */
  112027. snapDistance: number;
  112028. /**
  112029. * Ratio for the scale of the gizmo (Default: 1)
  112030. */
  112031. scaleRatio: number;
  112032. /**
  112033. * Disposes of the gizmo
  112034. */
  112035. dispose(): void;
  112036. /**
  112037. * CustomMeshes are not supported by this gizmo
  112038. * @param mesh The mesh to replace the default mesh of the gizmo
  112039. */
  112040. setCustomMesh(mesh: Mesh): void;
  112041. }
  112042. }
  112043. declare module BABYLON {
  112044. /**
  112045. * Single axis drag gizmo
  112046. */
  112047. export class AxisDragGizmo extends Gizmo {
  112048. /**
  112049. * Drag behavior responsible for the gizmos dragging interactions
  112050. */
  112051. dragBehavior: PointerDragBehavior;
  112052. private _pointerObserver;
  112053. /**
  112054. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  112055. */
  112056. snapDistance: number;
  112057. /**
  112058. * Event that fires each time the gizmo snaps to a new location.
  112059. * * snapDistance is the the change in distance
  112060. */
  112061. onSnapObservable: Observable<{
  112062. snapDistance: number;
  112063. }>;
  112064. private _isEnabled;
  112065. private _parent;
  112066. private _arrow;
  112067. private _coloredMaterial;
  112068. private _hoverMaterial;
  112069. /** @hidden */
  112070. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  112071. /** @hidden */
  112072. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  112073. /**
  112074. * Creates an AxisDragGizmo
  112075. * @param gizmoLayer The utility layer the gizmo will be added to
  112076. * @param dragAxis The axis which the gizmo will be able to drag on
  112077. * @param color The color of the gizmo
  112078. */
  112079. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  112080. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  112081. /**
  112082. * If the gizmo is enabled
  112083. */
  112084. isEnabled: boolean;
  112085. /**
  112086. * Disposes of the gizmo
  112087. */
  112088. dispose(): void;
  112089. }
  112090. }
  112091. declare module BABYLON.Debug {
  112092. /**
  112093. * The Axes viewer will show 3 axes in a specific point in space
  112094. */
  112095. export class AxesViewer {
  112096. private _xAxis;
  112097. private _yAxis;
  112098. private _zAxis;
  112099. private _scaleLinesFactor;
  112100. private _instanced;
  112101. /**
  112102. * Gets the hosting scene
  112103. */
  112104. scene: Scene;
  112105. /**
  112106. * Gets or sets a number used to scale line length
  112107. */
  112108. scaleLines: number;
  112109. /** Gets the node hierarchy used to render x-axis */
  112110. readonly xAxis: TransformNode;
  112111. /** Gets the node hierarchy used to render y-axis */
  112112. readonly yAxis: TransformNode;
  112113. /** Gets the node hierarchy used to render z-axis */
  112114. readonly zAxis: TransformNode;
  112115. /**
  112116. * Creates a new AxesViewer
  112117. * @param scene defines the hosting scene
  112118. * @param scaleLines defines a number used to scale line length (1 by default)
  112119. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  112120. * @param xAxis defines the node hierarchy used to render the x-axis
  112121. * @param yAxis defines the node hierarchy used to render the y-axis
  112122. * @param zAxis defines the node hierarchy used to render the z-axis
  112123. */
  112124. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  112125. /**
  112126. * Force the viewer to update
  112127. * @param position defines the position of the viewer
  112128. * @param xaxis defines the x axis of the viewer
  112129. * @param yaxis defines the y axis of the viewer
  112130. * @param zaxis defines the z axis of the viewer
  112131. */
  112132. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  112133. /**
  112134. * Creates an instance of this axes viewer.
  112135. * @returns a new axes viewer with instanced meshes
  112136. */
  112137. createInstance(): AxesViewer;
  112138. /** Releases resources */
  112139. dispose(): void;
  112140. private static _SetRenderingGroupId;
  112141. }
  112142. }
  112143. declare module BABYLON.Debug {
  112144. /**
  112145. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  112146. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  112147. */
  112148. export class BoneAxesViewer extends AxesViewer {
  112149. /**
  112150. * Gets or sets the target mesh where to display the axes viewer
  112151. */
  112152. mesh: Nullable<Mesh>;
  112153. /**
  112154. * Gets or sets the target bone where to display the axes viewer
  112155. */
  112156. bone: Nullable<Bone>;
  112157. /** Gets current position */
  112158. pos: Vector3;
  112159. /** Gets direction of X axis */
  112160. xaxis: Vector3;
  112161. /** Gets direction of Y axis */
  112162. yaxis: Vector3;
  112163. /** Gets direction of Z axis */
  112164. zaxis: Vector3;
  112165. /**
  112166. * Creates a new BoneAxesViewer
  112167. * @param scene defines the hosting scene
  112168. * @param bone defines the target bone
  112169. * @param mesh defines the target mesh
  112170. * @param scaleLines defines a scaling factor for line length (1 by default)
  112171. */
  112172. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  112173. /**
  112174. * Force the viewer to update
  112175. */
  112176. update(): void;
  112177. /** Releases resources */
  112178. dispose(): void;
  112179. }
  112180. }
  112181. declare module BABYLON {
  112182. /**
  112183. * Interface used to define scene explorer extensibility option
  112184. */
  112185. export interface IExplorerExtensibilityOption {
  112186. /**
  112187. * Define the option label
  112188. */
  112189. label: string;
  112190. /**
  112191. * Defines the action to execute on click
  112192. */
  112193. action: (entity: any) => void;
  112194. }
  112195. /**
  112196. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  112197. */
  112198. export interface IExplorerExtensibilityGroup {
  112199. /**
  112200. * Defines a predicate to test if a given type mut be extended
  112201. */
  112202. predicate: (entity: any) => boolean;
  112203. /**
  112204. * Gets the list of options added to a type
  112205. */
  112206. entries: IExplorerExtensibilityOption[];
  112207. }
  112208. /**
  112209. * Interface used to define the options to use to create the Inspector
  112210. */
  112211. export interface IInspectorOptions {
  112212. /**
  112213. * Display in overlay mode (default: false)
  112214. */
  112215. overlay?: boolean;
  112216. /**
  112217. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  112218. */
  112219. globalRoot?: HTMLElement;
  112220. /**
  112221. * Display the Scene explorer
  112222. */
  112223. showExplorer?: boolean;
  112224. /**
  112225. * Display the property inspector
  112226. */
  112227. showInspector?: boolean;
  112228. /**
  112229. * Display in embed mode (both panes on the right)
  112230. */
  112231. embedMode?: boolean;
  112232. /**
  112233. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  112234. */
  112235. handleResize?: boolean;
  112236. /**
  112237. * Allow the panes to popup (default: true)
  112238. */
  112239. enablePopup?: boolean;
  112240. /**
  112241. * Allow the panes to be closed by users (default: true)
  112242. */
  112243. enableClose?: boolean;
  112244. /**
  112245. * Optional list of extensibility entries
  112246. */
  112247. explorerExtensibility?: IExplorerExtensibilityGroup[];
  112248. /**
  112249. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  112250. */
  112251. inspectorURL?: string;
  112252. }
  112253. interface Scene {
  112254. /**
  112255. * @hidden
  112256. * Backing field
  112257. */
  112258. _debugLayer: DebugLayer;
  112259. /**
  112260. * Gets the debug layer (aka Inspector) associated with the scene
  112261. * @see http://doc.babylonjs.com/features/playground_debuglayer
  112262. */
  112263. debugLayer: DebugLayer;
  112264. }
  112265. /**
  112266. * The debug layer (aka Inspector) is the go to tool in order to better understand
  112267. * what is happening in your scene
  112268. * @see http://doc.babylonjs.com/features/playground_debuglayer
  112269. */
  112270. export class DebugLayer {
  112271. /**
  112272. * Define the url to get the inspector script from.
  112273. * By default it uses the babylonjs CDN.
  112274. * @ignoreNaming
  112275. */
  112276. static InspectorURL: string;
  112277. private _scene;
  112278. private BJSINSPECTOR;
  112279. private _onPropertyChangedObservable?;
  112280. /**
  112281. * Observable triggered when a property is changed through the inspector.
  112282. */
  112283. readonly onPropertyChangedObservable: any;
  112284. /**
  112285. * Instantiates a new debug layer.
  112286. * The debug layer (aka Inspector) is the go to tool in order to better understand
  112287. * what is happening in your scene
  112288. * @see http://doc.babylonjs.com/features/playground_debuglayer
  112289. * @param scene Defines the scene to inspect
  112290. */
  112291. constructor(scene: Scene);
  112292. /** Creates the inspector window. */
  112293. private _createInspector;
  112294. /**
  112295. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  112296. * @param entity defines the entity to select
  112297. * @param lineContainerTitle defines the specific block to highlight
  112298. */
  112299. select(entity: any, lineContainerTitle?: string): void;
  112300. /** Get the inspector from bundle or global */
  112301. private _getGlobalInspector;
  112302. /**
  112303. * Get if the inspector is visible or not.
  112304. * @returns true if visible otherwise, false
  112305. */
  112306. isVisible(): boolean;
  112307. /**
  112308. * Hide the inspector and close its window.
  112309. */
  112310. hide(): void;
  112311. /**
  112312. * Launch the debugLayer.
  112313. * @param config Define the configuration of the inspector
  112314. * @return a promise fulfilled when the debug layer is visible
  112315. */
  112316. show(config?: IInspectorOptions): Promise<DebugLayer>;
  112317. }
  112318. }
  112319. declare module BABYLON {
  112320. /**
  112321. * Class containing static functions to help procedurally build meshes
  112322. */
  112323. export class BoxBuilder {
  112324. /**
  112325. * Creates a box mesh
  112326. * * The parameter `size` sets the size (float) of each box side (default 1)
  112327. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  112328. * * 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)
  112329. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  112330. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  112331. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  112332. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112333. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  112334. * @param name defines the name of the mesh
  112335. * @param options defines the options used to create the mesh
  112336. * @param scene defines the hosting scene
  112337. * @returns the box mesh
  112338. */
  112339. static CreateBox(name: string, options: {
  112340. size?: number;
  112341. width?: number;
  112342. height?: number;
  112343. depth?: number;
  112344. faceUV?: Vector4[];
  112345. faceColors?: Color4[];
  112346. sideOrientation?: number;
  112347. frontUVs?: Vector4;
  112348. backUVs?: Vector4;
  112349. wrap?: boolean;
  112350. topBaseAt?: number;
  112351. bottomBaseAt?: number;
  112352. updatable?: boolean;
  112353. }, scene?: Nullable<Scene>): Mesh;
  112354. }
  112355. }
  112356. declare module BABYLON {
  112357. /**
  112358. * Class containing static functions to help procedurally build meshes
  112359. */
  112360. export class SphereBuilder {
  112361. /**
  112362. * Creates a sphere mesh
  112363. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  112364. * * 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`)
  112365. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  112366. * * 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
  112367. * * 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)
  112368. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  112369. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  112370. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112371. * @param name defines the name of the mesh
  112372. * @param options defines the options used to create the mesh
  112373. * @param scene defines the hosting scene
  112374. * @returns the sphere mesh
  112375. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  112376. */
  112377. static CreateSphere(name: string, options: {
  112378. segments?: number;
  112379. diameter?: number;
  112380. diameterX?: number;
  112381. diameterY?: number;
  112382. diameterZ?: number;
  112383. arc?: number;
  112384. slice?: number;
  112385. sideOrientation?: number;
  112386. frontUVs?: Vector4;
  112387. backUVs?: Vector4;
  112388. updatable?: boolean;
  112389. }, scene?: Nullable<Scene>): Mesh;
  112390. }
  112391. }
  112392. declare module BABYLON.Debug {
  112393. /**
  112394. * Used to show the physics impostor around the specific mesh
  112395. */
  112396. export class PhysicsViewer {
  112397. /** @hidden */
  112398. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  112399. /** @hidden */
  112400. protected _meshes: Array<Nullable<AbstractMesh>>;
  112401. /** @hidden */
  112402. protected _scene: Nullable<Scene>;
  112403. /** @hidden */
  112404. protected _numMeshes: number;
  112405. /** @hidden */
  112406. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  112407. private _renderFunction;
  112408. private _utilityLayer;
  112409. private _debugBoxMesh;
  112410. private _debugSphereMesh;
  112411. private _debugCylinderMesh;
  112412. private _debugMaterial;
  112413. private _debugMeshMeshes;
  112414. /**
  112415. * Creates a new PhysicsViewer
  112416. * @param scene defines the hosting scene
  112417. */
  112418. constructor(scene: Scene);
  112419. /** @hidden */
  112420. protected _updateDebugMeshes(): void;
  112421. /**
  112422. * Renders a specified physic impostor
  112423. * @param impostor defines the impostor to render
  112424. * @param targetMesh defines the mesh represented by the impostor
  112425. * @returns the new debug mesh used to render the impostor
  112426. */
  112427. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  112428. /**
  112429. * Hides a specified physic impostor
  112430. * @param impostor defines the impostor to hide
  112431. */
  112432. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  112433. private _getDebugMaterial;
  112434. private _getDebugBoxMesh;
  112435. private _getDebugSphereMesh;
  112436. private _getDebugCylinderMesh;
  112437. private _getDebugMeshMesh;
  112438. private _getDebugMesh;
  112439. /** Releases all resources */
  112440. dispose(): void;
  112441. }
  112442. }
  112443. declare module BABYLON {
  112444. /**
  112445. * Class containing static functions to help procedurally build meshes
  112446. */
  112447. export class LinesBuilder {
  112448. /**
  112449. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  112450. * * 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
  112451. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  112452. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  112453. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  112454. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  112455. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  112456. * * 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
  112457. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  112458. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112459. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  112460. * @param name defines the name of the new line system
  112461. * @param options defines the options used to create the line system
  112462. * @param scene defines the hosting scene
  112463. * @returns a new line system mesh
  112464. */
  112465. static CreateLineSystem(name: string, options: {
  112466. lines: Vector3[][];
  112467. updatable?: boolean;
  112468. instance?: Nullable<LinesMesh>;
  112469. colors?: Nullable<Color4[][]>;
  112470. useVertexAlpha?: boolean;
  112471. }, scene: Nullable<Scene>): LinesMesh;
  112472. /**
  112473. * Creates a line mesh
  112474. * 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
  112475. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  112476. * * The parameter `points` is an array successive Vector3
  112477. * * 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
  112478. * * The optional parameter `colors` is an array of successive Color4, one per line point
  112479. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  112480. * * When updating an instance, remember that only point positions can change, not the number of points
  112481. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112482. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  112483. * @param name defines the name of the new line system
  112484. * @param options defines the options used to create the line system
  112485. * @param scene defines the hosting scene
  112486. * @returns a new line mesh
  112487. */
  112488. static CreateLines(name: string, options: {
  112489. points: Vector3[];
  112490. updatable?: boolean;
  112491. instance?: Nullable<LinesMesh>;
  112492. colors?: Color4[];
  112493. useVertexAlpha?: boolean;
  112494. }, scene?: Nullable<Scene>): LinesMesh;
  112495. /**
  112496. * Creates a dashed line mesh
  112497. * * 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
  112498. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  112499. * * The parameter `points` is an array successive Vector3
  112500. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  112501. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  112502. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  112503. * * 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
  112504. * * When updating an instance, remember that only point positions can change, not the number of points
  112505. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112506. * @param name defines the name of the mesh
  112507. * @param options defines the options used to create the mesh
  112508. * @param scene defines the hosting scene
  112509. * @returns the dashed line mesh
  112510. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  112511. */
  112512. static CreateDashedLines(name: string, options: {
  112513. points: Vector3[];
  112514. dashSize?: number;
  112515. gapSize?: number;
  112516. dashNb?: number;
  112517. updatable?: boolean;
  112518. instance?: LinesMesh;
  112519. }, scene?: Nullable<Scene>): LinesMesh;
  112520. }
  112521. }
  112522. declare module BABYLON {
  112523. /**
  112524. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  112525. * in order to better appreciate the issue one might have.
  112526. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  112527. */
  112528. export class RayHelper {
  112529. /**
  112530. * Defines the ray we are currently tryin to visualize.
  112531. */
  112532. ray: Nullable<Ray>;
  112533. private _renderPoints;
  112534. private _renderLine;
  112535. private _renderFunction;
  112536. private _scene;
  112537. private _updateToMeshFunction;
  112538. private _attachedToMesh;
  112539. private _meshSpaceDirection;
  112540. private _meshSpaceOrigin;
  112541. /**
  112542. * Helper function to create a colored helper in a scene in one line.
  112543. * @param ray Defines the ray we are currently tryin to visualize
  112544. * @param scene Defines the scene the ray is used in
  112545. * @param color Defines the color we want to see the ray in
  112546. * @returns The newly created ray helper.
  112547. */
  112548. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  112549. /**
  112550. * Instantiate a new ray helper.
  112551. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  112552. * in order to better appreciate the issue one might have.
  112553. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  112554. * @param ray Defines the ray we are currently tryin to visualize
  112555. */
  112556. constructor(ray: Ray);
  112557. /**
  112558. * Shows the ray we are willing to debug.
  112559. * @param scene Defines the scene the ray needs to be rendered in
  112560. * @param color Defines the color the ray needs to be rendered in
  112561. */
  112562. show(scene: Scene, color?: Color3): void;
  112563. /**
  112564. * Hides the ray we are debugging.
  112565. */
  112566. hide(): void;
  112567. private _render;
  112568. /**
  112569. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  112570. * @param mesh Defines the mesh we want the helper attached to
  112571. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  112572. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  112573. * @param length Defines the length of the ray
  112574. */
  112575. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  112576. /**
  112577. * Detach the ray helper from the mesh it has previously been attached to.
  112578. */
  112579. detachFromMesh(): void;
  112580. private _updateToMesh;
  112581. /**
  112582. * Dispose the helper and release its associated resources.
  112583. */
  112584. dispose(): void;
  112585. }
  112586. }
  112587. declare module BABYLON.Debug {
  112588. /**
  112589. * Class used to render a debug view of a given skeleton
  112590. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  112591. */
  112592. export class SkeletonViewer {
  112593. /** defines the skeleton to render */
  112594. skeleton: Skeleton;
  112595. /** defines the mesh attached to the skeleton */
  112596. mesh: AbstractMesh;
  112597. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  112598. autoUpdateBonesMatrices: boolean;
  112599. /** defines the rendering group id to use with the viewer */
  112600. renderingGroupId: number;
  112601. /** Gets or sets the color used to render the skeleton */
  112602. color: Color3;
  112603. private _scene;
  112604. private _debugLines;
  112605. private _debugMesh;
  112606. private _isEnabled;
  112607. private _renderFunction;
  112608. private _utilityLayer;
  112609. /**
  112610. * Returns the mesh used to render the bones
  112611. */
  112612. readonly debugMesh: Nullable<LinesMesh>;
  112613. /**
  112614. * Creates a new SkeletonViewer
  112615. * @param skeleton defines the skeleton to render
  112616. * @param mesh defines the mesh attached to the skeleton
  112617. * @param scene defines the hosting scene
  112618. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  112619. * @param renderingGroupId defines the rendering group id to use with the viewer
  112620. */
  112621. constructor(
  112622. /** defines the skeleton to render */
  112623. skeleton: Skeleton,
  112624. /** defines the mesh attached to the skeleton */
  112625. mesh: AbstractMesh, scene: Scene,
  112626. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  112627. autoUpdateBonesMatrices?: boolean,
  112628. /** defines the rendering group id to use with the viewer */
  112629. renderingGroupId?: number);
  112630. /** Gets or sets a boolean indicating if the viewer is enabled */
  112631. isEnabled: boolean;
  112632. private _getBonePosition;
  112633. private _getLinesForBonesWithLength;
  112634. private _getLinesForBonesNoLength;
  112635. /** Update the viewer to sync with current skeleton state */
  112636. update(): void;
  112637. /** Release associated resources */
  112638. dispose(): void;
  112639. }
  112640. }
  112641. declare module BABYLON {
  112642. /**
  112643. * Options to create the null engine
  112644. */
  112645. export class NullEngineOptions {
  112646. /**
  112647. * Render width (Default: 512)
  112648. */
  112649. renderWidth: number;
  112650. /**
  112651. * Render height (Default: 256)
  112652. */
  112653. renderHeight: number;
  112654. /**
  112655. * Texture size (Default: 512)
  112656. */
  112657. textureSize: number;
  112658. /**
  112659. * If delta time between frames should be constant
  112660. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112661. */
  112662. deterministicLockstep: boolean;
  112663. /**
  112664. * Maximum about of steps between frames (Default: 4)
  112665. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112666. */
  112667. lockstepMaxSteps: number;
  112668. }
  112669. /**
  112670. * The null engine class provides support for headless version of babylon.js.
  112671. * This can be used in server side scenario or for testing purposes
  112672. */
  112673. export class NullEngine extends Engine {
  112674. private _options;
  112675. /**
  112676. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  112677. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112678. * @returns true if engine is in deterministic lock step mode
  112679. */
  112680. isDeterministicLockStep(): boolean;
  112681. /**
  112682. * Gets the max steps when engine is running in deterministic lock step
  112683. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112684. * @returns the max steps
  112685. */
  112686. getLockstepMaxSteps(): number;
  112687. /**
  112688. * Gets the current hardware scaling level.
  112689. * By default the hardware scaling level is computed from the window device ratio.
  112690. * 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.
  112691. * @returns a number indicating the current hardware scaling level
  112692. */
  112693. getHardwareScalingLevel(): number;
  112694. constructor(options?: NullEngineOptions);
  112695. /**
  112696. * Creates a vertex buffer
  112697. * @param vertices the data for the vertex buffer
  112698. * @returns the new WebGL static buffer
  112699. */
  112700. createVertexBuffer(vertices: FloatArray): DataBuffer;
  112701. /**
  112702. * Creates a new index buffer
  112703. * @param indices defines the content of the index buffer
  112704. * @param updatable defines if the index buffer must be updatable
  112705. * @returns a new webGL buffer
  112706. */
  112707. createIndexBuffer(indices: IndicesArray): DataBuffer;
  112708. /**
  112709. * Clear the current render buffer or the current render target (if any is set up)
  112710. * @param color defines the color to use
  112711. * @param backBuffer defines if the back buffer must be cleared
  112712. * @param depth defines if the depth buffer must be cleared
  112713. * @param stencil defines if the stencil buffer must be cleared
  112714. */
  112715. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  112716. /**
  112717. * Gets the current render width
  112718. * @param useScreen defines if screen size must be used (or the current render target if any)
  112719. * @returns a number defining the current render width
  112720. */
  112721. getRenderWidth(useScreen?: boolean): number;
  112722. /**
  112723. * Gets the current render height
  112724. * @param useScreen defines if screen size must be used (or the current render target if any)
  112725. * @returns a number defining the current render height
  112726. */
  112727. getRenderHeight(useScreen?: boolean): number;
  112728. /**
  112729. * Set the WebGL's viewport
  112730. * @param viewport defines the viewport element to be used
  112731. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  112732. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  112733. */
  112734. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  112735. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  112736. /**
  112737. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  112738. * @param pipelineContext defines the pipeline context to use
  112739. * @param uniformsNames defines the list of uniform names
  112740. * @returns an array of webGL uniform locations
  112741. */
  112742. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  112743. /**
  112744. * Gets the lsit of active attributes for a given webGL program
  112745. * @param pipelineContext defines the pipeline context to use
  112746. * @param attributesNames defines the list of attribute names to get
  112747. * @returns an array of indices indicating the offset of each attribute
  112748. */
  112749. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  112750. /**
  112751. * Binds an effect to the webGL context
  112752. * @param effect defines the effect to bind
  112753. */
  112754. bindSamplers(effect: Effect): void;
  112755. /**
  112756. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  112757. * @param effect defines the effect to activate
  112758. */
  112759. enableEffect(effect: Effect): void;
  112760. /**
  112761. * Set various states to the webGL context
  112762. * @param culling defines backface culling state
  112763. * @param zOffset defines the value to apply to zOffset (0 by default)
  112764. * @param force defines if states must be applied even if cache is up to date
  112765. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  112766. */
  112767. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  112768. /**
  112769. * Set the value of an uniform to an array of int32
  112770. * @param uniform defines the webGL uniform location where to store the value
  112771. * @param array defines the array of int32 to store
  112772. */
  112773. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  112774. /**
  112775. * Set the value of an uniform to an array of int32 (stored as vec2)
  112776. * @param uniform defines the webGL uniform location where to store the value
  112777. * @param array defines the array of int32 to store
  112778. */
  112779. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  112780. /**
  112781. * Set the value of an uniform to an array of int32 (stored as vec3)
  112782. * @param uniform defines the webGL uniform location where to store the value
  112783. * @param array defines the array of int32 to store
  112784. */
  112785. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  112786. /**
  112787. * Set the value of an uniform to an array of int32 (stored as vec4)
  112788. * @param uniform defines the webGL uniform location where to store the value
  112789. * @param array defines the array of int32 to store
  112790. */
  112791. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  112792. /**
  112793. * Set the value of an uniform to an array of float32
  112794. * @param uniform defines the webGL uniform location where to store the value
  112795. * @param array defines the array of float32 to store
  112796. */
  112797. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  112798. /**
  112799. * Set the value of an uniform to an array of float32 (stored as vec2)
  112800. * @param uniform defines the webGL uniform location where to store the value
  112801. * @param array defines the array of float32 to store
  112802. */
  112803. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  112804. /**
  112805. * Set the value of an uniform to an array of float32 (stored as vec3)
  112806. * @param uniform defines the webGL uniform location where to store the value
  112807. * @param array defines the array of float32 to store
  112808. */
  112809. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  112810. /**
  112811. * Set the value of an uniform to an array of float32 (stored as vec4)
  112812. * @param uniform defines the webGL uniform location where to store the value
  112813. * @param array defines the array of float32 to store
  112814. */
  112815. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  112816. /**
  112817. * Set the value of an uniform to an array of number
  112818. * @param uniform defines the webGL uniform location where to store the value
  112819. * @param array defines the array of number to store
  112820. */
  112821. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  112822. /**
  112823. * Set the value of an uniform to an array of number (stored as vec2)
  112824. * @param uniform defines the webGL uniform location where to store the value
  112825. * @param array defines the array of number to store
  112826. */
  112827. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  112828. /**
  112829. * Set the value of an uniform to an array of number (stored as vec3)
  112830. * @param uniform defines the webGL uniform location where to store the value
  112831. * @param array defines the array of number to store
  112832. */
  112833. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  112834. /**
  112835. * Set the value of an uniform to an array of number (stored as vec4)
  112836. * @param uniform defines the webGL uniform location where to store the value
  112837. * @param array defines the array of number to store
  112838. */
  112839. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  112840. /**
  112841. * Set the value of an uniform to an array of float32 (stored as matrices)
  112842. * @param uniform defines the webGL uniform location where to store the value
  112843. * @param matrices defines the array of float32 to store
  112844. */
  112845. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  112846. /**
  112847. * Set the value of an uniform to a matrix (3x3)
  112848. * @param uniform defines the webGL uniform location where to store the value
  112849. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  112850. */
  112851. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112852. /**
  112853. * Set the value of an uniform to a matrix (2x2)
  112854. * @param uniform defines the webGL uniform location where to store the value
  112855. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  112856. */
  112857. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112858. /**
  112859. * Set the value of an uniform to a number (float)
  112860. * @param uniform defines the webGL uniform location where to store the value
  112861. * @param value defines the float number to store
  112862. */
  112863. setFloat(uniform: WebGLUniformLocation, value: number): void;
  112864. /**
  112865. * Set the value of an uniform to a vec2
  112866. * @param uniform defines the webGL uniform location where to store the value
  112867. * @param x defines the 1st component of the value
  112868. * @param y defines the 2nd component of the value
  112869. */
  112870. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  112871. /**
  112872. * Set the value of an uniform to a vec3
  112873. * @param uniform defines the webGL uniform location where to store the value
  112874. * @param x defines the 1st component of the value
  112875. * @param y defines the 2nd component of the value
  112876. * @param z defines the 3rd component of the value
  112877. */
  112878. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  112879. /**
  112880. * Set the value of an uniform to a boolean
  112881. * @param uniform defines the webGL uniform location where to store the value
  112882. * @param bool defines the boolean to store
  112883. */
  112884. setBool(uniform: WebGLUniformLocation, bool: number): void;
  112885. /**
  112886. * Set the value of an uniform to a vec4
  112887. * @param uniform defines the webGL uniform location where to store the value
  112888. * @param x defines the 1st component of the value
  112889. * @param y defines the 2nd component of the value
  112890. * @param z defines the 3rd component of the value
  112891. * @param w defines the 4th component of the value
  112892. */
  112893. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  112894. /**
  112895. * Sets the current alpha mode
  112896. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  112897. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  112898. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112899. */
  112900. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  112901. /**
  112902. * Bind webGl buffers directly to the webGL context
  112903. * @param vertexBuffers defines the vertex buffer to bind
  112904. * @param indexBuffer defines the index buffer to bind
  112905. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  112906. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  112907. * @param effect defines the effect associated with the vertex buffer
  112908. */
  112909. bindBuffers(vertexBuffers: {
  112910. [key: string]: VertexBuffer;
  112911. }, indexBuffer: DataBuffer, effect: Effect): void;
  112912. /**
  112913. * Force the entire cache to be cleared
  112914. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  112915. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  112916. */
  112917. wipeCaches(bruteForce?: boolean): void;
  112918. /**
  112919. * Send a draw order
  112920. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  112921. * @param indexStart defines the starting index
  112922. * @param indexCount defines the number of index to draw
  112923. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112924. */
  112925. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  112926. /**
  112927. * Draw a list of indexed primitives
  112928. * @param fillMode defines the primitive to use
  112929. * @param indexStart defines the starting index
  112930. * @param indexCount defines the number of index to draw
  112931. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112932. */
  112933. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  112934. /**
  112935. * Draw a list of unindexed primitives
  112936. * @param fillMode defines the primitive to use
  112937. * @param verticesStart defines the index of first vertex to draw
  112938. * @param verticesCount defines the count of vertices to draw
  112939. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112940. */
  112941. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112942. /** @hidden */
  112943. _createTexture(): WebGLTexture;
  112944. /** @hidden */
  112945. _releaseTexture(texture: InternalTexture): void;
  112946. /**
  112947. * Usually called from Texture.ts.
  112948. * Passed information to create a WebGLTexture
  112949. * @param urlArg defines a value which contains one of the following:
  112950. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  112951. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  112952. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  112953. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  112954. * @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)
  112955. * @param scene needed for loading to the correct scene
  112956. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  112957. * @param onLoad optional callback to be called upon successful completion
  112958. * @param onError optional callback to be called upon failure
  112959. * @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
  112960. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  112961. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  112962. * @param forcedExtension defines the extension to use to pick the right loader
  112963. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  112964. * @returns a InternalTexture for assignment back into BABYLON.Texture
  112965. */
  112966. 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;
  112967. /**
  112968. * Creates a new render target texture
  112969. * @param size defines the size of the texture
  112970. * @param options defines the options used to create the texture
  112971. * @returns a new render target texture stored in an InternalTexture
  112972. */
  112973. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  112974. /**
  112975. * Update the sampling mode of a given texture
  112976. * @param samplingMode defines the required sampling mode
  112977. * @param texture defines the texture to update
  112978. */
  112979. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  112980. /**
  112981. * Binds the frame buffer to the specified texture.
  112982. * @param texture The texture to render to or null for the default canvas
  112983. * @param faceIndex The face of the texture to render to in case of cube texture
  112984. * @param requiredWidth The width of the target to render to
  112985. * @param requiredHeight The height of the target to render to
  112986. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  112987. * @param depthStencilTexture The depth stencil texture to use to render
  112988. * @param lodLevel defines le lod level to bind to the frame buffer
  112989. */
  112990. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  112991. /**
  112992. * Unbind the current render target texture from the webGL context
  112993. * @param texture defines the render target texture to unbind
  112994. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112995. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112996. */
  112997. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  112998. /**
  112999. * Creates a dynamic vertex buffer
  113000. * @param vertices the data for the dynamic vertex buffer
  113001. * @returns the new WebGL dynamic buffer
  113002. */
  113003. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  113004. /**
  113005. * Update the content of a dynamic texture
  113006. * @param texture defines the texture to update
  113007. * @param canvas defines the canvas containing the source
  113008. * @param invertY defines if data must be stored with Y axis inverted
  113009. * @param premulAlpha defines if alpha is stored as premultiplied
  113010. * @param format defines the format of the data
  113011. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  113012. */
  113013. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  113014. /**
  113015. * Gets a boolean indicating if all created effects are ready
  113016. * @returns true if all effects are ready
  113017. */
  113018. areAllEffectsReady(): boolean;
  113019. /**
  113020. * @hidden
  113021. * Get the current error code of the webGL context
  113022. * @returns the error code
  113023. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  113024. */
  113025. getError(): number;
  113026. /** @hidden */
  113027. _getUnpackAlignement(): number;
  113028. /** @hidden */
  113029. _unpackFlipY(value: boolean): void;
  113030. /**
  113031. * Update a dynamic index buffer
  113032. * @param indexBuffer defines the target index buffer
  113033. * @param indices defines the data to update
  113034. * @param offset defines the offset in the target index buffer where update should start
  113035. */
  113036. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  113037. /**
  113038. * Updates a dynamic vertex buffer.
  113039. * @param vertexBuffer the vertex buffer to update
  113040. * @param vertices the data used to update the vertex buffer
  113041. * @param byteOffset the byte offset of the data (optional)
  113042. * @param byteLength the byte length of the data (optional)
  113043. */
  113044. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  113045. /** @hidden */
  113046. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  113047. /** @hidden */
  113048. _bindTexture(channel: number, texture: InternalTexture): void;
  113049. protected _deleteBuffer(buffer: WebGLBuffer): void;
  113050. /**
  113051. * 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
  113052. */
  113053. releaseEffects(): void;
  113054. displayLoadingUI(): void;
  113055. hideLoadingUI(): void;
  113056. /** @hidden */
  113057. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113058. /** @hidden */
  113059. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113060. /** @hidden */
  113061. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113062. /** @hidden */
  113063. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  113064. }
  113065. }
  113066. declare module BABYLON {
  113067. /** @hidden */
  113068. export class _OcclusionDataStorage {
  113069. /** @hidden */
  113070. occlusionInternalRetryCounter: number;
  113071. /** @hidden */
  113072. isOcclusionQueryInProgress: boolean;
  113073. /** @hidden */
  113074. isOccluded: boolean;
  113075. /** @hidden */
  113076. occlusionRetryCount: number;
  113077. /** @hidden */
  113078. occlusionType: number;
  113079. /** @hidden */
  113080. occlusionQueryAlgorithmType: number;
  113081. }
  113082. interface Engine {
  113083. /**
  113084. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  113085. * @return the new query
  113086. */
  113087. createQuery(): WebGLQuery;
  113088. /**
  113089. * Delete and release a webGL query
  113090. * @param query defines the query to delete
  113091. * @return the current engine
  113092. */
  113093. deleteQuery(query: WebGLQuery): Engine;
  113094. /**
  113095. * Check if a given query has resolved and got its value
  113096. * @param query defines the query to check
  113097. * @returns true if the query got its value
  113098. */
  113099. isQueryResultAvailable(query: WebGLQuery): boolean;
  113100. /**
  113101. * Gets the value of a given query
  113102. * @param query defines the query to check
  113103. * @returns the value of the query
  113104. */
  113105. getQueryResult(query: WebGLQuery): number;
  113106. /**
  113107. * Initiates an occlusion query
  113108. * @param algorithmType defines the algorithm to use
  113109. * @param query defines the query to use
  113110. * @returns the current engine
  113111. * @see http://doc.babylonjs.com/features/occlusionquery
  113112. */
  113113. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  113114. /**
  113115. * Ends an occlusion query
  113116. * @see http://doc.babylonjs.com/features/occlusionquery
  113117. * @param algorithmType defines the algorithm to use
  113118. * @returns the current engine
  113119. */
  113120. endOcclusionQuery(algorithmType: number): Engine;
  113121. /**
  113122. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  113123. * Please note that only one query can be issued at a time
  113124. * @returns a time token used to track the time span
  113125. */
  113126. startTimeQuery(): Nullable<_TimeToken>;
  113127. /**
  113128. * Ends a time query
  113129. * @param token defines the token used to measure the time span
  113130. * @returns the time spent (in ns)
  113131. */
  113132. endTimeQuery(token: _TimeToken): int;
  113133. /** @hidden */
  113134. _currentNonTimestampToken: Nullable<_TimeToken>;
  113135. /** @hidden */
  113136. _createTimeQuery(): WebGLQuery;
  113137. /** @hidden */
  113138. _deleteTimeQuery(query: WebGLQuery): void;
  113139. /** @hidden */
  113140. _getGlAlgorithmType(algorithmType: number): number;
  113141. /** @hidden */
  113142. _getTimeQueryResult(query: WebGLQuery): any;
  113143. /** @hidden */
  113144. _getTimeQueryAvailability(query: WebGLQuery): any;
  113145. }
  113146. interface AbstractMesh {
  113147. /**
  113148. * Backing filed
  113149. * @hidden
  113150. */
  113151. __occlusionDataStorage: _OcclusionDataStorage;
  113152. /**
  113153. * Access property
  113154. * @hidden
  113155. */
  113156. _occlusionDataStorage: _OcclusionDataStorage;
  113157. /**
  113158. * 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.
  113159. * The default value is -1 which means don't break the query and wait till the result
  113160. * @see http://doc.babylonjs.com/features/occlusionquery
  113161. */
  113162. occlusionRetryCount: number;
  113163. /**
  113164. * 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:
  113165. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  113166. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  113167. * * 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.
  113168. * @see http://doc.babylonjs.com/features/occlusionquery
  113169. */
  113170. occlusionType: number;
  113171. /**
  113172. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  113173. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  113174. * * 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.
  113175. * @see http://doc.babylonjs.com/features/occlusionquery
  113176. */
  113177. occlusionQueryAlgorithmType: number;
  113178. /**
  113179. * 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
  113180. * @see http://doc.babylonjs.com/features/occlusionquery
  113181. */
  113182. isOccluded: boolean;
  113183. /**
  113184. * Flag to check the progress status of the query
  113185. * @see http://doc.babylonjs.com/features/occlusionquery
  113186. */
  113187. isOcclusionQueryInProgress: boolean;
  113188. }
  113189. }
  113190. declare module BABYLON {
  113191. /** @hidden */
  113192. export var _forceTransformFeedbackToBundle: boolean;
  113193. interface Engine {
  113194. /**
  113195. * Creates a webGL transform feedback object
  113196. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  113197. * @returns the webGL transform feedback object
  113198. */
  113199. createTransformFeedback(): WebGLTransformFeedback;
  113200. /**
  113201. * Delete a webGL transform feedback object
  113202. * @param value defines the webGL transform feedback object to delete
  113203. */
  113204. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  113205. /**
  113206. * Bind a webGL transform feedback object to the webgl context
  113207. * @param value defines the webGL transform feedback object to bind
  113208. */
  113209. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  113210. /**
  113211. * Begins a transform feedback operation
  113212. * @param usePoints defines if points or triangles must be used
  113213. */
  113214. beginTransformFeedback(usePoints: boolean): void;
  113215. /**
  113216. * Ends a transform feedback operation
  113217. */
  113218. endTransformFeedback(): void;
  113219. /**
  113220. * Specify the varyings to use with transform feedback
  113221. * @param program defines the associated webGL program
  113222. * @param value defines the list of strings representing the varying names
  113223. */
  113224. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  113225. /**
  113226. * Bind a webGL buffer for a transform feedback operation
  113227. * @param value defines the webGL buffer to bind
  113228. */
  113229. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  113230. }
  113231. }
  113232. declare module BABYLON {
  113233. /**
  113234. * Creation options of the multi render target texture.
  113235. */
  113236. export interface IMultiRenderTargetOptions {
  113237. /**
  113238. * Define if the texture needs to create mip maps after render.
  113239. */
  113240. generateMipMaps?: boolean;
  113241. /**
  113242. * Define the types of all the draw buffers we want to create
  113243. */
  113244. types?: number[];
  113245. /**
  113246. * Define the sampling modes of all the draw buffers we want to create
  113247. */
  113248. samplingModes?: number[];
  113249. /**
  113250. * Define if a depth buffer is required
  113251. */
  113252. generateDepthBuffer?: boolean;
  113253. /**
  113254. * Define if a stencil buffer is required
  113255. */
  113256. generateStencilBuffer?: boolean;
  113257. /**
  113258. * Define if a depth texture is required instead of a depth buffer
  113259. */
  113260. generateDepthTexture?: boolean;
  113261. /**
  113262. * Define the number of desired draw buffers
  113263. */
  113264. textureCount?: number;
  113265. /**
  113266. * Define if aspect ratio should be adapted to the texture or stay the scene one
  113267. */
  113268. doNotChangeAspectRatio?: boolean;
  113269. /**
  113270. * Define the default type of the buffers we are creating
  113271. */
  113272. defaultType?: number;
  113273. }
  113274. /**
  113275. * A multi render target, like a render target provides the ability to render to a texture.
  113276. * Unlike the render target, it can render to several draw buffers in one draw.
  113277. * This is specially interesting in deferred rendering or for any effects requiring more than
  113278. * just one color from a single pass.
  113279. */
  113280. export class MultiRenderTarget extends RenderTargetTexture {
  113281. private _internalTextures;
  113282. private _textures;
  113283. private _multiRenderTargetOptions;
  113284. /**
  113285. * Get if draw buffers are currently supported by the used hardware and browser.
  113286. */
  113287. readonly isSupported: boolean;
  113288. /**
  113289. * Get the list of textures generated by the multi render target.
  113290. */
  113291. readonly textures: Texture[];
  113292. /**
  113293. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  113294. */
  113295. readonly depthTexture: Texture;
  113296. /**
  113297. * Set the wrapping mode on U of all the textures we are rendering to.
  113298. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  113299. */
  113300. wrapU: number;
  113301. /**
  113302. * Set the wrapping mode on V of all the textures we are rendering to.
  113303. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  113304. */
  113305. wrapV: number;
  113306. /**
  113307. * Instantiate a new multi render target texture.
  113308. * A multi render target, like a render target provides the ability to render to a texture.
  113309. * Unlike the render target, it can render to several draw buffers in one draw.
  113310. * This is specially interesting in deferred rendering or for any effects requiring more than
  113311. * just one color from a single pass.
  113312. * @param name Define the name of the texture
  113313. * @param size Define the size of the buffers to render to
  113314. * @param count Define the number of target we are rendering into
  113315. * @param scene Define the scene the texture belongs to
  113316. * @param options Define the options used to create the multi render target
  113317. */
  113318. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  113319. /** @hidden */
  113320. _rebuild(): void;
  113321. private _createInternalTextures;
  113322. private _createTextures;
  113323. /**
  113324. * Define the number of samples used if MSAA is enabled.
  113325. */
  113326. samples: number;
  113327. /**
  113328. * Resize all the textures in the multi render target.
  113329. * Be carrefull as it will recreate all the data in the new texture.
  113330. * @param size Define the new size
  113331. */
  113332. resize(size: any): void;
  113333. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  113334. /**
  113335. * Dispose the render targets and their associated resources
  113336. */
  113337. dispose(): void;
  113338. /**
  113339. * Release all the underlying texture used as draw buffers.
  113340. */
  113341. releaseInternalTextures(): void;
  113342. }
  113343. }
  113344. declare module BABYLON {
  113345. interface ThinEngine {
  113346. /**
  113347. * Unbind a list of render target textures from the webGL context
  113348. * This is used only when drawBuffer extension or webGL2 are active
  113349. * @param textures defines the render target textures to unbind
  113350. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  113351. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  113352. */
  113353. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  113354. /**
  113355. * Create a multi render target texture
  113356. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  113357. * @param size defines the size of the texture
  113358. * @param options defines the creation options
  113359. * @returns the cube texture as an InternalTexture
  113360. */
  113361. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  113362. /**
  113363. * Update the sample count for a given multiple render target texture
  113364. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  113365. * @param textures defines the textures to update
  113366. * @param samples defines the sample count to set
  113367. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  113368. */
  113369. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  113370. }
  113371. }
  113372. declare module BABYLON {
  113373. /**
  113374. * Class used to define an additional view for the engine
  113375. * @see https://doc.babylonjs.com/how_to/multi_canvases
  113376. */
  113377. export class EngineView {
  113378. /** Defines the canvas where to render the view */
  113379. target: HTMLCanvasElement;
  113380. /** Defines an optional camera used to render the view (will use active camera else) */
  113381. camera?: Camera;
  113382. }
  113383. interface Engine {
  113384. /**
  113385. * Gets or sets the HTML element to use for attaching events
  113386. */
  113387. inputElement: Nullable<HTMLElement>;
  113388. /**
  113389. * Gets the current engine view
  113390. * @see https://doc.babylonjs.com/how_to/multi_canvases
  113391. */
  113392. activeView: Nullable<EngineView>;
  113393. /** Gets or sets the list of views */
  113394. views: EngineView[];
  113395. /**
  113396. * Register a new child canvas
  113397. * @param canvas defines the canvas to register
  113398. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  113399. * @returns the associated view
  113400. */
  113401. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  113402. /**
  113403. * Remove a registered child canvas
  113404. * @param canvas defines the canvas to remove
  113405. * @returns the current engine
  113406. */
  113407. unRegisterView(canvas: HTMLCanvasElement): Engine;
  113408. }
  113409. }
  113410. declare module BABYLON {
  113411. /**
  113412. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  113413. */
  113414. export interface CubeMapInfo {
  113415. /**
  113416. * The pixel array for the front face.
  113417. * This is stored in format, left to right, up to down format.
  113418. */
  113419. front: Nullable<ArrayBufferView>;
  113420. /**
  113421. * The pixel array for the back face.
  113422. * This is stored in format, left to right, up to down format.
  113423. */
  113424. back: Nullable<ArrayBufferView>;
  113425. /**
  113426. * The pixel array for the left face.
  113427. * This is stored in format, left to right, up to down format.
  113428. */
  113429. left: Nullable<ArrayBufferView>;
  113430. /**
  113431. * The pixel array for the right face.
  113432. * This is stored in format, left to right, up to down format.
  113433. */
  113434. right: Nullable<ArrayBufferView>;
  113435. /**
  113436. * The pixel array for the up face.
  113437. * This is stored in format, left to right, up to down format.
  113438. */
  113439. up: Nullable<ArrayBufferView>;
  113440. /**
  113441. * The pixel array for the down face.
  113442. * This is stored in format, left to right, up to down format.
  113443. */
  113444. down: Nullable<ArrayBufferView>;
  113445. /**
  113446. * The size of the cubemap stored.
  113447. *
  113448. * Each faces will be size * size pixels.
  113449. */
  113450. size: number;
  113451. /**
  113452. * The format of the texture.
  113453. *
  113454. * RGBA, RGB.
  113455. */
  113456. format: number;
  113457. /**
  113458. * The type of the texture data.
  113459. *
  113460. * UNSIGNED_INT, FLOAT.
  113461. */
  113462. type: number;
  113463. /**
  113464. * Specifies whether the texture is in gamma space.
  113465. */
  113466. gammaSpace: boolean;
  113467. }
  113468. /**
  113469. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  113470. */
  113471. export class PanoramaToCubeMapTools {
  113472. private static FACE_FRONT;
  113473. private static FACE_BACK;
  113474. private static FACE_RIGHT;
  113475. private static FACE_LEFT;
  113476. private static FACE_DOWN;
  113477. private static FACE_UP;
  113478. /**
  113479. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  113480. *
  113481. * @param float32Array The source data.
  113482. * @param inputWidth The width of the input panorama.
  113483. * @param inputHeight The height of the input panorama.
  113484. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  113485. * @return The cubemap data
  113486. */
  113487. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  113488. private static CreateCubemapTexture;
  113489. private static CalcProjectionSpherical;
  113490. }
  113491. }
  113492. declare module BABYLON {
  113493. /**
  113494. * Helper class dealing with the extraction of spherical polynomial dataArray
  113495. * from a cube map.
  113496. */
  113497. export class CubeMapToSphericalPolynomialTools {
  113498. private static FileFaces;
  113499. /**
  113500. * Converts a texture to the according Spherical Polynomial data.
  113501. * This extracts the first 3 orders only as they are the only one used in the lighting.
  113502. *
  113503. * @param texture The texture to extract the information from.
  113504. * @return The Spherical Polynomial data.
  113505. */
  113506. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  113507. /**
  113508. * Converts a cubemap to the according Spherical Polynomial data.
  113509. * This extracts the first 3 orders only as they are the only one used in the lighting.
  113510. *
  113511. * @param cubeInfo The Cube map to extract the information from.
  113512. * @return The Spherical Polynomial data.
  113513. */
  113514. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  113515. }
  113516. }
  113517. declare module BABYLON {
  113518. interface BaseTexture {
  113519. /**
  113520. * Get the polynomial representation of the texture data.
  113521. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  113522. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  113523. */
  113524. sphericalPolynomial: Nullable<SphericalPolynomial>;
  113525. }
  113526. }
  113527. declare module BABYLON {
  113528. /** @hidden */
  113529. export var rgbdEncodePixelShader: {
  113530. name: string;
  113531. shader: string;
  113532. };
  113533. }
  113534. declare module BABYLON {
  113535. /** @hidden */
  113536. export var rgbdDecodePixelShader: {
  113537. name: string;
  113538. shader: string;
  113539. };
  113540. }
  113541. declare module BABYLON {
  113542. /**
  113543. * Raw texture data and descriptor sufficient for WebGL texture upload
  113544. */
  113545. export interface EnvironmentTextureInfo {
  113546. /**
  113547. * Version of the environment map
  113548. */
  113549. version: number;
  113550. /**
  113551. * Width of image
  113552. */
  113553. width: number;
  113554. /**
  113555. * Irradiance information stored in the file.
  113556. */
  113557. irradiance: any;
  113558. /**
  113559. * Specular information stored in the file.
  113560. */
  113561. specular: any;
  113562. }
  113563. /**
  113564. * Defines One Image in the file. It requires only the position in the file
  113565. * as well as the length.
  113566. */
  113567. interface BufferImageData {
  113568. /**
  113569. * Length of the image data.
  113570. */
  113571. length: number;
  113572. /**
  113573. * Position of the data from the null terminator delimiting the end of the JSON.
  113574. */
  113575. position: number;
  113576. }
  113577. /**
  113578. * Defines the specular data enclosed in the file.
  113579. * This corresponds to the version 1 of the data.
  113580. */
  113581. export interface EnvironmentTextureSpecularInfoV1 {
  113582. /**
  113583. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  113584. */
  113585. specularDataPosition?: number;
  113586. /**
  113587. * This contains all the images data needed to reconstruct the cubemap.
  113588. */
  113589. mipmaps: Array<BufferImageData>;
  113590. /**
  113591. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  113592. */
  113593. lodGenerationScale: number;
  113594. }
  113595. /**
  113596. * Sets of helpers addressing the serialization and deserialization of environment texture
  113597. * stored in a BabylonJS env file.
  113598. * Those files are usually stored as .env files.
  113599. */
  113600. export class EnvironmentTextureTools {
  113601. /**
  113602. * Magic number identifying the env file.
  113603. */
  113604. private static _MagicBytes;
  113605. /**
  113606. * Gets the environment info from an env file.
  113607. * @param data The array buffer containing the .env bytes.
  113608. * @returns the environment file info (the json header) if successfully parsed.
  113609. */
  113610. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  113611. /**
  113612. * Creates an environment texture from a loaded cube texture.
  113613. * @param texture defines the cube texture to convert in env file
  113614. * @return a promise containing the environment data if succesfull.
  113615. */
  113616. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  113617. /**
  113618. * Creates a JSON representation of the spherical data.
  113619. * @param texture defines the texture containing the polynomials
  113620. * @return the JSON representation of the spherical info
  113621. */
  113622. private static _CreateEnvTextureIrradiance;
  113623. /**
  113624. * Creates the ArrayBufferViews used for initializing environment texture image data.
  113625. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  113626. * @param info parameters that determine what views will be created for accessing the underlying buffer
  113627. * @return the views described by info providing access to the underlying buffer
  113628. */
  113629. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  113630. /**
  113631. * Uploads the texture info contained in the env file to the GPU.
  113632. * @param texture defines the internal texture to upload to
  113633. * @param arrayBuffer defines the buffer cotaining the data to load
  113634. * @param info defines the texture info retrieved through the GetEnvInfo method
  113635. * @returns a promise
  113636. */
  113637. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  113638. private static _OnImageReadyAsync;
  113639. /**
  113640. * Uploads the levels of image data to the GPU.
  113641. * @param texture defines the internal texture to upload to
  113642. * @param imageData defines the array buffer views of image data [mipmap][face]
  113643. * @returns a promise
  113644. */
  113645. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  113646. /**
  113647. * Uploads spherical polynomials information to the texture.
  113648. * @param texture defines the texture we are trying to upload the information to
  113649. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  113650. */
  113651. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  113652. /** @hidden */
  113653. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  113654. }
  113655. }
  113656. declare module BABYLON {
  113657. /**
  113658. * Contains position and normal vectors for a vertex
  113659. */
  113660. export class PositionNormalVertex {
  113661. /** the position of the vertex (defaut: 0,0,0) */
  113662. position: Vector3;
  113663. /** the normal of the vertex (defaut: 0,1,0) */
  113664. normal: Vector3;
  113665. /**
  113666. * Creates a PositionNormalVertex
  113667. * @param position the position of the vertex (defaut: 0,0,0)
  113668. * @param normal the normal of the vertex (defaut: 0,1,0)
  113669. */
  113670. constructor(
  113671. /** the position of the vertex (defaut: 0,0,0) */
  113672. position?: Vector3,
  113673. /** the normal of the vertex (defaut: 0,1,0) */
  113674. normal?: Vector3);
  113675. /**
  113676. * Clones the PositionNormalVertex
  113677. * @returns the cloned PositionNormalVertex
  113678. */
  113679. clone(): PositionNormalVertex;
  113680. }
  113681. /**
  113682. * Contains position, normal and uv vectors for a vertex
  113683. */
  113684. export class PositionNormalTextureVertex {
  113685. /** the position of the vertex (defaut: 0,0,0) */
  113686. position: Vector3;
  113687. /** the normal of the vertex (defaut: 0,1,0) */
  113688. normal: Vector3;
  113689. /** the uv of the vertex (default: 0,0) */
  113690. uv: Vector2;
  113691. /**
  113692. * Creates a PositionNormalTextureVertex
  113693. * @param position the position of the vertex (defaut: 0,0,0)
  113694. * @param normal the normal of the vertex (defaut: 0,1,0)
  113695. * @param uv the uv of the vertex (default: 0,0)
  113696. */
  113697. constructor(
  113698. /** the position of the vertex (defaut: 0,0,0) */
  113699. position?: Vector3,
  113700. /** the normal of the vertex (defaut: 0,1,0) */
  113701. normal?: Vector3,
  113702. /** the uv of the vertex (default: 0,0) */
  113703. uv?: Vector2);
  113704. /**
  113705. * Clones the PositionNormalTextureVertex
  113706. * @returns the cloned PositionNormalTextureVertex
  113707. */
  113708. clone(): PositionNormalTextureVertex;
  113709. }
  113710. }
  113711. declare module BABYLON {
  113712. /** @hidden */
  113713. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  113714. private _genericAttributeLocation;
  113715. private _varyingLocationCount;
  113716. private _varyingLocationMap;
  113717. private _replacements;
  113718. private _textureCount;
  113719. private _uniforms;
  113720. lineProcessor(line: string): string;
  113721. attributeProcessor(attribute: string): string;
  113722. varyingProcessor(varying: string, isFragment: boolean): string;
  113723. uniformProcessor(uniform: string): string;
  113724. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  113725. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  113726. }
  113727. }
  113728. declare module BABYLON {
  113729. /**
  113730. * Container for accessors for natively-stored mesh data buffers.
  113731. */
  113732. class NativeDataBuffer extends DataBuffer {
  113733. /**
  113734. * Accessor value used to identify/retrieve a natively-stored index buffer.
  113735. */
  113736. nativeIndexBuffer?: any;
  113737. /**
  113738. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  113739. */
  113740. nativeVertexBuffer?: any;
  113741. }
  113742. /** @hidden */
  113743. class NativeTexture extends InternalTexture {
  113744. getInternalTexture(): InternalTexture;
  113745. getViewCount(): number;
  113746. }
  113747. /** @hidden */
  113748. export class NativeEngine extends Engine {
  113749. private readonly _native;
  113750. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  113751. private readonly INVALID_HANDLE;
  113752. getHardwareScalingLevel(): number;
  113753. constructor();
  113754. /**
  113755. * Can be used to override the current requestAnimationFrame requester.
  113756. * @hidden
  113757. */
  113758. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  113759. /**
  113760. * Override default engine behavior.
  113761. * @param color
  113762. * @param backBuffer
  113763. * @param depth
  113764. * @param stencil
  113765. */
  113766. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  113767. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  113768. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  113769. createVertexBuffer(data: DataArray): NativeDataBuffer;
  113770. recordVertexArrayObject(vertexBuffers: {
  113771. [key: string]: VertexBuffer;
  113772. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  113773. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  113774. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  113775. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  113776. /**
  113777. * Draw a list of indexed primitives
  113778. * @param fillMode defines the primitive to use
  113779. * @param indexStart defines the starting index
  113780. * @param indexCount defines the number of index to draw
  113781. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  113782. */
  113783. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  113784. /**
  113785. * Draw a list of unindexed primitives
  113786. * @param fillMode defines the primitive to use
  113787. * @param verticesStart defines the index of first vertex to draw
  113788. * @param verticesCount defines the count of vertices to draw
  113789. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  113790. */
  113791. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  113792. createPipelineContext(): IPipelineContext;
  113793. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  113794. /** @hidden */
  113795. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  113796. /** @hidden */
  113797. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  113798. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  113799. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  113800. protected _setProgram(program: WebGLProgram): void;
  113801. _releaseEffect(effect: Effect): void;
  113802. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  113803. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  113804. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  113805. bindSamplers(effect: Effect): void;
  113806. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  113807. getRenderWidth(useScreen?: boolean): number;
  113808. getRenderHeight(useScreen?: boolean): number;
  113809. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  113810. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  113811. /**
  113812. * Set the z offset to apply to current rendering
  113813. * @param value defines the offset to apply
  113814. */
  113815. setZOffset(value: number): void;
  113816. /**
  113817. * Gets the current value of the zOffset
  113818. * @returns the current zOffset state
  113819. */
  113820. getZOffset(): number;
  113821. /**
  113822. * Enable or disable depth buffering
  113823. * @param enable defines the state to set
  113824. */
  113825. setDepthBuffer(enable: boolean): void;
  113826. /**
  113827. * Gets a boolean indicating if depth writing is enabled
  113828. * @returns the current depth writing state
  113829. */
  113830. getDepthWrite(): boolean;
  113831. /**
  113832. * Enable or disable depth writing
  113833. * @param enable defines the state to set
  113834. */
  113835. setDepthWrite(enable: boolean): void;
  113836. /**
  113837. * Enable or disable color writing
  113838. * @param enable defines the state to set
  113839. */
  113840. setColorWrite(enable: boolean): void;
  113841. /**
  113842. * Gets a boolean indicating if color writing is enabled
  113843. * @returns the current color writing state
  113844. */
  113845. getColorWrite(): boolean;
  113846. /**
  113847. * Sets alpha constants used by some alpha blending modes
  113848. * @param r defines the red component
  113849. * @param g defines the green component
  113850. * @param b defines the blue component
  113851. * @param a defines the alpha component
  113852. */
  113853. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  113854. /**
  113855. * Sets the current alpha mode
  113856. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  113857. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  113858. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  113859. */
  113860. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  113861. /**
  113862. * Gets the current alpha mode
  113863. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  113864. * @returns the current alpha mode
  113865. */
  113866. getAlphaMode(): number;
  113867. setInt(uniform: WebGLUniformLocation, int: number): void;
  113868. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  113869. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  113870. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  113871. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  113872. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  113873. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  113874. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  113875. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  113876. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  113877. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  113878. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  113879. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  113880. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  113881. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  113882. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  113883. setFloat(uniform: WebGLUniformLocation, value: number): void;
  113884. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  113885. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  113886. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  113887. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  113888. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  113889. wipeCaches(bruteForce?: boolean): void;
  113890. _createTexture(): WebGLTexture;
  113891. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  113892. /**
  113893. * Usually called from BABYLON.Texture.ts.
  113894. * Passed information to create a WebGLTexture
  113895. * @param urlArg defines a value which contains one of the following:
  113896. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  113897. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  113898. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  113899. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  113900. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  113901. * @param scene needed for loading to the correct scene
  113902. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  113903. * @param onLoad optional callback to be called upon successful completion
  113904. * @param onError optional callback to be called upon failure
  113905. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  113906. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  113907. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  113908. * @param forcedExtension defines the extension to use to pick the right loader
  113909. * @returns a InternalTexture for assignment back into BABYLON.Texture
  113910. */
  113911. createTexture(urlArg: Nullable<string>, noMipmap: boolean, invertY: boolean, scene: Nullable<Scene>, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message: string, exception: any) => void>, buffer?: Nullable<string | ArrayBuffer | Blob>, fallback?: Nullable<InternalTexture>, format?: Nullable<number>, forcedExtension?: Nullable<string>): InternalTexture;
  113912. /**
  113913. * Creates a cube texture
  113914. * @param rootUrl defines the url where the files to load is located
  113915. * @param scene defines the current scene
  113916. * @param files defines the list of files to load (1 per face)
  113917. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  113918. * @param onLoad defines an optional callback raised when the texture is loaded
  113919. * @param onError defines an optional callback raised if there is an issue to load the texture
  113920. * @param format defines the format of the data
  113921. * @param forcedExtension defines the extension to use to pick the right loader
  113922. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  113923. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  113924. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  113925. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  113926. * @returns the cube texture as an InternalTexture
  113927. */
  113928. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap?: boolean, onLoad?: Nullable<(data?: any) => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number, fallback?: Nullable<InternalTexture>): InternalTexture;
  113929. private _getSamplingFilter;
  113930. private static _GetNativeTextureFormat;
  113931. createRenderTargetTexture(size: number | {
  113932. width: number;
  113933. height: number;
  113934. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  113935. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  113936. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  113937. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  113938. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  113939. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  113940. /**
  113941. * Updates a dynamic vertex buffer.
  113942. * @param vertexBuffer the vertex buffer to update
  113943. * @param data the data used to update the vertex buffer
  113944. * @param byteOffset the byte offset of the data (optional)
  113945. * @param byteLength the byte length of the data (optional)
  113946. */
  113947. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  113948. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  113949. private _updateAnisotropicLevel;
  113950. private _getAddressMode;
  113951. /** @hidden */
  113952. _bindTexture(channel: number, texture: InternalTexture): void;
  113953. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  113954. releaseEffects(): void;
  113955. /** @hidden */
  113956. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113957. /** @hidden */
  113958. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113959. /** @hidden */
  113960. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113961. /** @hidden */
  113962. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  113963. }
  113964. }
  113965. declare module BABYLON {
  113966. /**
  113967. * Gather the list of clipboard event types as constants.
  113968. */
  113969. export class ClipboardEventTypes {
  113970. /**
  113971. * The clipboard event is fired when a copy command is active (pressed).
  113972. */
  113973. static readonly COPY: number;
  113974. /**
  113975. * The clipboard event is fired when a cut command is active (pressed).
  113976. */
  113977. static readonly CUT: number;
  113978. /**
  113979. * The clipboard event is fired when a paste command is active (pressed).
  113980. */
  113981. static readonly PASTE: number;
  113982. }
  113983. /**
  113984. * This class is used to store clipboard related info for the onClipboardObservable event.
  113985. */
  113986. export class ClipboardInfo {
  113987. /**
  113988. * Defines the type of event (BABYLON.ClipboardEventTypes)
  113989. */
  113990. type: number;
  113991. /**
  113992. * Defines the related dom event
  113993. */
  113994. event: ClipboardEvent;
  113995. /**
  113996. *Creates an instance of ClipboardInfo.
  113997. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  113998. * @param event Defines the related dom event
  113999. */
  114000. constructor(
  114001. /**
  114002. * Defines the type of event (BABYLON.ClipboardEventTypes)
  114003. */
  114004. type: number,
  114005. /**
  114006. * Defines the related dom event
  114007. */
  114008. event: ClipboardEvent);
  114009. /**
  114010. * Get the clipboard event's type from the keycode.
  114011. * @param keyCode Defines the keyCode for the current keyboard event.
  114012. * @return {number}
  114013. */
  114014. static GetTypeFromCharacter(keyCode: number): number;
  114015. }
  114016. }
  114017. declare module BABYLON {
  114018. /**
  114019. * Google Daydream controller
  114020. */
  114021. export class DaydreamController extends WebVRController {
  114022. /**
  114023. * Base Url for the controller model.
  114024. */
  114025. static MODEL_BASE_URL: string;
  114026. /**
  114027. * File name for the controller model.
  114028. */
  114029. static MODEL_FILENAME: string;
  114030. /**
  114031. * Gamepad Id prefix used to identify Daydream Controller.
  114032. */
  114033. static readonly GAMEPAD_ID_PREFIX: string;
  114034. /**
  114035. * Creates a new DaydreamController from a gamepad
  114036. * @param vrGamepad the gamepad that the controller should be created from
  114037. */
  114038. constructor(vrGamepad: any);
  114039. /**
  114040. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  114041. * @param scene scene in which to add meshes
  114042. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  114043. */
  114044. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  114045. /**
  114046. * Called once for each button that changed state since the last frame
  114047. * @param buttonIdx Which button index changed
  114048. * @param state New state of the button
  114049. * @param changes Which properties on the state changed since last frame
  114050. */
  114051. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  114052. }
  114053. }
  114054. declare module BABYLON {
  114055. /**
  114056. * Gear VR Controller
  114057. */
  114058. export class GearVRController extends WebVRController {
  114059. /**
  114060. * Base Url for the controller model.
  114061. */
  114062. static MODEL_BASE_URL: string;
  114063. /**
  114064. * File name for the controller model.
  114065. */
  114066. static MODEL_FILENAME: string;
  114067. /**
  114068. * Gamepad Id prefix used to identify this controller.
  114069. */
  114070. static readonly GAMEPAD_ID_PREFIX: string;
  114071. private readonly _buttonIndexToObservableNameMap;
  114072. /**
  114073. * Creates a new GearVRController from a gamepad
  114074. * @param vrGamepad the gamepad that the controller should be created from
  114075. */
  114076. constructor(vrGamepad: any);
  114077. /**
  114078. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  114079. * @param scene scene in which to add meshes
  114080. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  114081. */
  114082. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  114083. /**
  114084. * Called once for each button that changed state since the last frame
  114085. * @param buttonIdx Which button index changed
  114086. * @param state New state of the button
  114087. * @param changes Which properties on the state changed since last frame
  114088. */
  114089. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  114090. }
  114091. }
  114092. declare module BABYLON {
  114093. /**
  114094. * Class containing static functions to help procedurally build meshes
  114095. */
  114096. export class PolyhedronBuilder {
  114097. /**
  114098. * Creates a polyhedron mesh
  114099. * * 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
  114100. * * The parameter `size` (positive float, default 1) sets the polygon size
  114101. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  114102. * * 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`
  114103. * * 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
  114104. * * 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)`)
  114105. * * 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
  114106. * * 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
  114107. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  114108. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114109. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114110. * @param name defines the name of the mesh
  114111. * @param options defines the options used to create the mesh
  114112. * @param scene defines the hosting scene
  114113. * @returns the polyhedron mesh
  114114. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  114115. */
  114116. static CreatePolyhedron(name: string, options: {
  114117. type?: number;
  114118. size?: number;
  114119. sizeX?: number;
  114120. sizeY?: number;
  114121. sizeZ?: number;
  114122. custom?: any;
  114123. faceUV?: Vector4[];
  114124. faceColors?: Color4[];
  114125. flat?: boolean;
  114126. updatable?: boolean;
  114127. sideOrientation?: number;
  114128. frontUVs?: Vector4;
  114129. backUVs?: Vector4;
  114130. }, scene?: Nullable<Scene>): Mesh;
  114131. }
  114132. }
  114133. declare module BABYLON {
  114134. /**
  114135. * Gizmo that enables scaling a mesh along 3 axis
  114136. */
  114137. export class ScaleGizmo extends Gizmo {
  114138. /**
  114139. * Internal gizmo used for interactions on the x axis
  114140. */
  114141. xGizmo: AxisScaleGizmo;
  114142. /**
  114143. * Internal gizmo used for interactions on the y axis
  114144. */
  114145. yGizmo: AxisScaleGizmo;
  114146. /**
  114147. * Internal gizmo used for interactions on the z axis
  114148. */
  114149. zGizmo: AxisScaleGizmo;
  114150. /**
  114151. * Internal gizmo used to scale all axis equally
  114152. */
  114153. uniformScaleGizmo: AxisScaleGizmo;
  114154. private _meshAttached;
  114155. private _updateGizmoRotationToMatchAttachedMesh;
  114156. private _snapDistance;
  114157. private _scaleRatio;
  114158. private _uniformScalingMesh;
  114159. private _octahedron;
  114160. private _sensitivity;
  114161. /** Fires an event when any of it's sub gizmos are dragged */
  114162. onDragStartObservable: Observable<unknown>;
  114163. /** Fires an event when any of it's sub gizmos are released from dragging */
  114164. onDragEndObservable: Observable<unknown>;
  114165. attachedMesh: Nullable<AbstractMesh>;
  114166. /**
  114167. * Creates a ScaleGizmo
  114168. * @param gizmoLayer The utility layer the gizmo will be added to
  114169. */
  114170. constructor(gizmoLayer?: UtilityLayerRenderer);
  114171. updateGizmoRotationToMatchAttachedMesh: boolean;
  114172. /**
  114173. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  114174. */
  114175. snapDistance: number;
  114176. /**
  114177. * Ratio for the scale of the gizmo (Default: 1)
  114178. */
  114179. scaleRatio: number;
  114180. /**
  114181. * Sensitivity factor for dragging (Default: 1)
  114182. */
  114183. sensitivity: number;
  114184. /**
  114185. * Disposes of the gizmo
  114186. */
  114187. dispose(): void;
  114188. }
  114189. }
  114190. declare module BABYLON {
  114191. /**
  114192. * Single axis scale gizmo
  114193. */
  114194. export class AxisScaleGizmo extends Gizmo {
  114195. /**
  114196. * Drag behavior responsible for the gizmos dragging interactions
  114197. */
  114198. dragBehavior: PointerDragBehavior;
  114199. private _pointerObserver;
  114200. /**
  114201. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  114202. */
  114203. snapDistance: number;
  114204. /**
  114205. * Event that fires each time the gizmo snaps to a new location.
  114206. * * snapDistance is the the change in distance
  114207. */
  114208. onSnapObservable: Observable<{
  114209. snapDistance: number;
  114210. }>;
  114211. /**
  114212. * If the scaling operation should be done on all axis (default: false)
  114213. */
  114214. uniformScaling: boolean;
  114215. /**
  114216. * Custom sensitivity value for the drag strength
  114217. */
  114218. sensitivity: number;
  114219. private _isEnabled;
  114220. private _parent;
  114221. private _arrow;
  114222. private _coloredMaterial;
  114223. private _hoverMaterial;
  114224. /**
  114225. * Creates an AxisScaleGizmo
  114226. * @param gizmoLayer The utility layer the gizmo will be added to
  114227. * @param dragAxis The axis which the gizmo will be able to scale on
  114228. * @param color The color of the gizmo
  114229. */
  114230. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  114231. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  114232. /**
  114233. * If the gizmo is enabled
  114234. */
  114235. isEnabled: boolean;
  114236. /**
  114237. * Disposes of the gizmo
  114238. */
  114239. dispose(): void;
  114240. /**
  114241. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  114242. * @param mesh The mesh to replace the default mesh of the gizmo
  114243. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  114244. */
  114245. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  114246. }
  114247. }
  114248. declare module BABYLON {
  114249. /**
  114250. * Bounding box gizmo
  114251. */
  114252. export class BoundingBoxGizmo extends Gizmo {
  114253. private _lineBoundingBox;
  114254. private _rotateSpheresParent;
  114255. private _scaleBoxesParent;
  114256. private _boundingDimensions;
  114257. private _renderObserver;
  114258. private _pointerObserver;
  114259. private _scaleDragSpeed;
  114260. private _tmpQuaternion;
  114261. private _tmpVector;
  114262. private _tmpRotationMatrix;
  114263. /**
  114264. * 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)
  114265. */
  114266. ignoreChildren: boolean;
  114267. /**
  114268. * 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)
  114269. */
  114270. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  114271. /**
  114272. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  114273. */
  114274. rotationSphereSize: number;
  114275. /**
  114276. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  114277. */
  114278. scaleBoxSize: number;
  114279. /**
  114280. * 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)
  114281. */
  114282. fixedDragMeshScreenSize: boolean;
  114283. /**
  114284. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  114285. */
  114286. fixedDragMeshScreenSizeDistanceFactor: number;
  114287. /**
  114288. * Fired when a rotation sphere or scale box is dragged
  114289. */
  114290. onDragStartObservable: Observable<{}>;
  114291. /**
  114292. * Fired when a scale box is dragged
  114293. */
  114294. onScaleBoxDragObservable: Observable<{}>;
  114295. /**
  114296. * Fired when a scale box drag is ended
  114297. */
  114298. onScaleBoxDragEndObservable: Observable<{}>;
  114299. /**
  114300. * Fired when a rotation sphere is dragged
  114301. */
  114302. onRotationSphereDragObservable: Observable<{}>;
  114303. /**
  114304. * Fired when a rotation sphere drag is ended
  114305. */
  114306. onRotationSphereDragEndObservable: Observable<{}>;
  114307. /**
  114308. * 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)
  114309. */
  114310. scalePivot: Nullable<Vector3>;
  114311. /**
  114312. * Mesh used as a pivot to rotate the attached mesh
  114313. */
  114314. private _anchorMesh;
  114315. private _existingMeshScale;
  114316. private _dragMesh;
  114317. private pointerDragBehavior;
  114318. private coloredMaterial;
  114319. private hoverColoredMaterial;
  114320. /**
  114321. * Sets the color of the bounding box gizmo
  114322. * @param color the color to set
  114323. */
  114324. setColor(color: Color3): void;
  114325. /**
  114326. * Creates an BoundingBoxGizmo
  114327. * @param gizmoLayer The utility layer the gizmo will be added to
  114328. * @param color The color of the gizmo
  114329. */
  114330. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  114331. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  114332. private _selectNode;
  114333. /**
  114334. * Updates the bounding box information for the Gizmo
  114335. */
  114336. updateBoundingBox(): void;
  114337. private _updateRotationSpheres;
  114338. private _updateScaleBoxes;
  114339. /**
  114340. * Enables rotation on the specified axis and disables rotation on the others
  114341. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  114342. */
  114343. setEnabledRotationAxis(axis: string): void;
  114344. /**
  114345. * Enables/disables scaling
  114346. * @param enable if scaling should be enabled
  114347. */
  114348. setEnabledScaling(enable: boolean): void;
  114349. private _updateDummy;
  114350. /**
  114351. * Enables a pointer drag behavior on the bounding box of the gizmo
  114352. */
  114353. enableDragBehavior(): void;
  114354. /**
  114355. * Disposes of the gizmo
  114356. */
  114357. dispose(): void;
  114358. /**
  114359. * 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)
  114360. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  114361. * @returns the bounding box mesh with the passed in mesh as a child
  114362. */
  114363. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  114364. /**
  114365. * CustomMeshes are not supported by this gizmo
  114366. * @param mesh The mesh to replace the default mesh of the gizmo
  114367. */
  114368. setCustomMesh(mesh: Mesh): void;
  114369. }
  114370. }
  114371. declare module BABYLON {
  114372. /**
  114373. * Single plane rotation gizmo
  114374. */
  114375. export class PlaneRotationGizmo extends Gizmo {
  114376. /**
  114377. * Drag behavior responsible for the gizmos dragging interactions
  114378. */
  114379. dragBehavior: PointerDragBehavior;
  114380. private _pointerObserver;
  114381. /**
  114382. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  114383. */
  114384. snapDistance: number;
  114385. /**
  114386. * Event that fires each time the gizmo snaps to a new location.
  114387. * * snapDistance is the the change in distance
  114388. */
  114389. onSnapObservable: Observable<{
  114390. snapDistance: number;
  114391. }>;
  114392. private _isEnabled;
  114393. private _parent;
  114394. /**
  114395. * Creates a PlaneRotationGizmo
  114396. * @param gizmoLayer The utility layer the gizmo will be added to
  114397. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  114398. * @param color The color of the gizmo
  114399. * @param tessellation Amount of tessellation to be used when creating rotation circles
  114400. * @param useEulerRotation Use and update Euler angle instead of quaternion
  114401. */
  114402. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  114403. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  114404. /**
  114405. * If the gizmo is enabled
  114406. */
  114407. isEnabled: boolean;
  114408. /**
  114409. * Disposes of the gizmo
  114410. */
  114411. dispose(): void;
  114412. }
  114413. }
  114414. declare module BABYLON {
  114415. /**
  114416. * Gizmo that enables rotating a mesh along 3 axis
  114417. */
  114418. export class RotationGizmo extends Gizmo {
  114419. /**
  114420. * Internal gizmo used for interactions on the x axis
  114421. */
  114422. xGizmo: PlaneRotationGizmo;
  114423. /**
  114424. * Internal gizmo used for interactions on the y axis
  114425. */
  114426. yGizmo: PlaneRotationGizmo;
  114427. /**
  114428. * Internal gizmo used for interactions on the z axis
  114429. */
  114430. zGizmo: PlaneRotationGizmo;
  114431. /** Fires an event when any of it's sub gizmos are dragged */
  114432. onDragStartObservable: Observable<unknown>;
  114433. /** Fires an event when any of it's sub gizmos are released from dragging */
  114434. onDragEndObservable: Observable<unknown>;
  114435. private _meshAttached;
  114436. attachedMesh: Nullable<AbstractMesh>;
  114437. /**
  114438. * Creates a RotationGizmo
  114439. * @param gizmoLayer The utility layer the gizmo will be added to
  114440. * @param tessellation Amount of tessellation to be used when creating rotation circles
  114441. * @param useEulerRotation Use and update Euler angle instead of quaternion
  114442. */
  114443. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  114444. updateGizmoRotationToMatchAttachedMesh: boolean;
  114445. /**
  114446. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  114447. */
  114448. snapDistance: number;
  114449. /**
  114450. * Ratio for the scale of the gizmo (Default: 1)
  114451. */
  114452. scaleRatio: number;
  114453. /**
  114454. * Disposes of the gizmo
  114455. */
  114456. dispose(): void;
  114457. /**
  114458. * CustomMeshes are not supported by this gizmo
  114459. * @param mesh The mesh to replace the default mesh of the gizmo
  114460. */
  114461. setCustomMesh(mesh: Mesh): void;
  114462. }
  114463. }
  114464. declare module BABYLON {
  114465. /**
  114466. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  114467. */
  114468. export class GizmoManager implements IDisposable {
  114469. private scene;
  114470. /**
  114471. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  114472. */
  114473. gizmos: {
  114474. positionGizmo: Nullable<PositionGizmo>;
  114475. rotationGizmo: Nullable<RotationGizmo>;
  114476. scaleGizmo: Nullable<ScaleGizmo>;
  114477. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  114478. };
  114479. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  114480. clearGizmoOnEmptyPointerEvent: boolean;
  114481. /** Fires an event when the manager is attached to a mesh */
  114482. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  114483. private _gizmosEnabled;
  114484. private _pointerObserver;
  114485. private _attachedMesh;
  114486. private _boundingBoxColor;
  114487. private _defaultUtilityLayer;
  114488. private _defaultKeepDepthUtilityLayer;
  114489. /**
  114490. * When bounding box gizmo is enabled, this can be used to track drag/end events
  114491. */
  114492. boundingBoxDragBehavior: SixDofDragBehavior;
  114493. /**
  114494. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  114495. */
  114496. attachableMeshes: Nullable<Array<AbstractMesh>>;
  114497. /**
  114498. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  114499. */
  114500. usePointerToAttachGizmos: boolean;
  114501. /**
  114502. * Utility layer that the bounding box gizmo belongs to
  114503. */
  114504. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  114505. /**
  114506. * Utility layer that all gizmos besides bounding box belong to
  114507. */
  114508. readonly utilityLayer: UtilityLayerRenderer;
  114509. /**
  114510. * Instatiates a gizmo manager
  114511. * @param scene the scene to overlay the gizmos on top of
  114512. */
  114513. constructor(scene: Scene);
  114514. /**
  114515. * Attaches a set of gizmos to the specified mesh
  114516. * @param mesh The mesh the gizmo's should be attached to
  114517. */
  114518. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  114519. /**
  114520. * If the position gizmo is enabled
  114521. */
  114522. positionGizmoEnabled: boolean;
  114523. /**
  114524. * If the rotation gizmo is enabled
  114525. */
  114526. rotationGizmoEnabled: boolean;
  114527. /**
  114528. * If the scale gizmo is enabled
  114529. */
  114530. scaleGizmoEnabled: boolean;
  114531. /**
  114532. * If the boundingBox gizmo is enabled
  114533. */
  114534. boundingBoxGizmoEnabled: boolean;
  114535. /**
  114536. * Disposes of the gizmo manager
  114537. */
  114538. dispose(): void;
  114539. }
  114540. }
  114541. declare module BABYLON {
  114542. /**
  114543. * A directional light is defined by a direction (what a surprise!).
  114544. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  114545. * 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.
  114546. * Documentation: https://doc.babylonjs.com/babylon101/lights
  114547. */
  114548. export class DirectionalLight extends ShadowLight {
  114549. private _shadowFrustumSize;
  114550. /**
  114551. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  114552. */
  114553. /**
  114554. * Specifies a fix frustum size for the shadow generation.
  114555. */
  114556. shadowFrustumSize: number;
  114557. private _shadowOrthoScale;
  114558. /**
  114559. * Gets the shadow projection scale against the optimal computed one.
  114560. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  114561. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  114562. */
  114563. /**
  114564. * Sets the shadow projection scale against the optimal computed one.
  114565. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  114566. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  114567. */
  114568. shadowOrthoScale: number;
  114569. /**
  114570. * Automatically compute the projection matrix to best fit (including all the casters)
  114571. * on each frame.
  114572. */
  114573. autoUpdateExtends: boolean;
  114574. private _orthoLeft;
  114575. private _orthoRight;
  114576. private _orthoTop;
  114577. private _orthoBottom;
  114578. /**
  114579. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  114580. * The directional light is emitted from everywhere in the given direction.
  114581. * It can cast shadows.
  114582. * Documentation : https://doc.babylonjs.com/babylon101/lights
  114583. * @param name The friendly name of the light
  114584. * @param direction The direction of the light
  114585. * @param scene The scene the light belongs to
  114586. */
  114587. constructor(name: string, direction: Vector3, scene: Scene);
  114588. /**
  114589. * Returns the string "DirectionalLight".
  114590. * @return The class name
  114591. */
  114592. getClassName(): string;
  114593. /**
  114594. * Returns the integer 1.
  114595. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  114596. */
  114597. getTypeID(): number;
  114598. /**
  114599. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  114600. * Returns the DirectionalLight Shadow projection matrix.
  114601. */
  114602. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114603. /**
  114604. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  114605. * Returns the DirectionalLight Shadow projection matrix.
  114606. */
  114607. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  114608. /**
  114609. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  114610. * Returns the DirectionalLight Shadow projection matrix.
  114611. */
  114612. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114613. protected _buildUniformLayout(): void;
  114614. /**
  114615. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  114616. * @param effect The effect to update
  114617. * @param lightIndex The index of the light in the effect to update
  114618. * @returns The directional light
  114619. */
  114620. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  114621. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  114622. /**
  114623. * Gets the minZ used for shadow according to both the scene and the light.
  114624. *
  114625. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  114626. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  114627. * @param activeCamera The camera we are returning the min for
  114628. * @returns the depth min z
  114629. */
  114630. getDepthMinZ(activeCamera: Camera): number;
  114631. /**
  114632. * Gets the maxZ used for shadow according to both the scene and the light.
  114633. *
  114634. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  114635. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  114636. * @param activeCamera The camera we are returning the max for
  114637. * @returns the depth max z
  114638. */
  114639. getDepthMaxZ(activeCamera: Camera): number;
  114640. /**
  114641. * Prepares the list of defines specific to the light type.
  114642. * @param defines the list of defines
  114643. * @param lightIndex defines the index of the light for the effect
  114644. */
  114645. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  114646. }
  114647. }
  114648. declare module BABYLON {
  114649. /**
  114650. * Class containing static functions to help procedurally build meshes
  114651. */
  114652. export class HemisphereBuilder {
  114653. /**
  114654. * Creates a hemisphere mesh
  114655. * @param name defines the name of the mesh
  114656. * @param options defines the options used to create the mesh
  114657. * @param scene defines the hosting scene
  114658. * @returns the hemisphere mesh
  114659. */
  114660. static CreateHemisphere(name: string, options: {
  114661. segments?: number;
  114662. diameter?: number;
  114663. sideOrientation?: number;
  114664. }, scene: any): Mesh;
  114665. }
  114666. }
  114667. declare module BABYLON {
  114668. /**
  114669. * A spot light is defined by a position, a direction, an angle, and an exponent.
  114670. * These values define a cone of light starting from the position, emitting toward the direction.
  114671. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  114672. * and the exponent defines the speed of the decay of the light with distance (reach).
  114673. * Documentation: https://doc.babylonjs.com/babylon101/lights
  114674. */
  114675. export class SpotLight extends ShadowLight {
  114676. private _angle;
  114677. private _innerAngle;
  114678. private _cosHalfAngle;
  114679. private _lightAngleScale;
  114680. private _lightAngleOffset;
  114681. /**
  114682. * Gets the cone angle of the spot light in Radians.
  114683. */
  114684. /**
  114685. * Sets the cone angle of the spot light in Radians.
  114686. */
  114687. angle: number;
  114688. /**
  114689. * Only used in gltf falloff mode, this defines the angle where
  114690. * the directional falloff will start before cutting at angle which could be seen
  114691. * as outer angle.
  114692. */
  114693. /**
  114694. * Only used in gltf falloff mode, this defines the angle where
  114695. * the directional falloff will start before cutting at angle which could be seen
  114696. * as outer angle.
  114697. */
  114698. innerAngle: number;
  114699. private _shadowAngleScale;
  114700. /**
  114701. * Allows scaling the angle of the light for shadow generation only.
  114702. */
  114703. /**
  114704. * Allows scaling the angle of the light for shadow generation only.
  114705. */
  114706. shadowAngleScale: number;
  114707. /**
  114708. * The light decay speed with the distance from the emission spot.
  114709. */
  114710. exponent: number;
  114711. private _projectionTextureMatrix;
  114712. /**
  114713. * Allows reading the projecton texture
  114714. */
  114715. readonly projectionTextureMatrix: Matrix;
  114716. protected _projectionTextureLightNear: number;
  114717. /**
  114718. * Gets the near clip of the Spotlight for texture projection.
  114719. */
  114720. /**
  114721. * Sets the near clip of the Spotlight for texture projection.
  114722. */
  114723. projectionTextureLightNear: number;
  114724. protected _projectionTextureLightFar: number;
  114725. /**
  114726. * Gets the far clip of the Spotlight for texture projection.
  114727. */
  114728. /**
  114729. * Sets the far clip of the Spotlight for texture projection.
  114730. */
  114731. projectionTextureLightFar: number;
  114732. protected _projectionTextureUpDirection: Vector3;
  114733. /**
  114734. * Gets the Up vector of the Spotlight for texture projection.
  114735. */
  114736. /**
  114737. * Sets the Up vector of the Spotlight for texture projection.
  114738. */
  114739. projectionTextureUpDirection: Vector3;
  114740. private _projectionTexture;
  114741. /**
  114742. * Gets the projection texture of the light.
  114743. */
  114744. /**
  114745. * Sets the projection texture of the light.
  114746. */
  114747. projectionTexture: Nullable<BaseTexture>;
  114748. private _projectionTextureViewLightDirty;
  114749. private _projectionTextureProjectionLightDirty;
  114750. private _projectionTextureDirty;
  114751. private _projectionTextureViewTargetVector;
  114752. private _projectionTextureViewLightMatrix;
  114753. private _projectionTextureProjectionLightMatrix;
  114754. private _projectionTextureScalingMatrix;
  114755. /**
  114756. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  114757. * It can cast shadows.
  114758. * Documentation : https://doc.babylonjs.com/babylon101/lights
  114759. * @param name The light friendly name
  114760. * @param position The position of the spot light in the scene
  114761. * @param direction The direction of the light in the scene
  114762. * @param angle The cone angle of the light in Radians
  114763. * @param exponent The light decay speed with the distance from the emission spot
  114764. * @param scene The scene the lights belongs to
  114765. */
  114766. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  114767. /**
  114768. * Returns the string "SpotLight".
  114769. * @returns the class name
  114770. */
  114771. getClassName(): string;
  114772. /**
  114773. * Returns the integer 2.
  114774. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  114775. */
  114776. getTypeID(): number;
  114777. /**
  114778. * Overrides the direction setter to recompute the projection texture view light Matrix.
  114779. */
  114780. protected _setDirection(value: Vector3): void;
  114781. /**
  114782. * Overrides the position setter to recompute the projection texture view light Matrix.
  114783. */
  114784. protected _setPosition(value: Vector3): void;
  114785. /**
  114786. * 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.
  114787. * Returns the SpotLight.
  114788. */
  114789. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114790. protected _computeProjectionTextureViewLightMatrix(): void;
  114791. protected _computeProjectionTextureProjectionLightMatrix(): void;
  114792. /**
  114793. * Main function for light texture projection matrix computing.
  114794. */
  114795. protected _computeProjectionTextureMatrix(): void;
  114796. protected _buildUniformLayout(): void;
  114797. private _computeAngleValues;
  114798. /**
  114799. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  114800. * @param effect The effect to update
  114801. * @param lightIndex The index of the light in the effect to update
  114802. * @returns The spot light
  114803. */
  114804. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  114805. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  114806. /**
  114807. * Disposes the light and the associated resources.
  114808. */
  114809. dispose(): void;
  114810. /**
  114811. * Prepares the list of defines specific to the light type.
  114812. * @param defines the list of defines
  114813. * @param lightIndex defines the index of the light for the effect
  114814. */
  114815. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  114816. }
  114817. }
  114818. declare module BABYLON {
  114819. /**
  114820. * Gizmo that enables viewing a light
  114821. */
  114822. export class LightGizmo extends Gizmo {
  114823. private _lightMesh;
  114824. private _material;
  114825. private _cachedPosition;
  114826. private _cachedForward;
  114827. private _attachedMeshParent;
  114828. /**
  114829. * Creates a LightGizmo
  114830. * @param gizmoLayer The utility layer the gizmo will be added to
  114831. */
  114832. constructor(gizmoLayer?: UtilityLayerRenderer);
  114833. private _light;
  114834. /**
  114835. * The light that the gizmo is attached to
  114836. */
  114837. light: Nullable<Light>;
  114838. /**
  114839. * Gets the material used to render the light gizmo
  114840. */
  114841. readonly material: StandardMaterial;
  114842. /**
  114843. * @hidden
  114844. * Updates the gizmo to match the attached mesh's position/rotation
  114845. */
  114846. protected _update(): void;
  114847. private static _Scale;
  114848. /**
  114849. * Creates the lines for a light mesh
  114850. */
  114851. private static _CreateLightLines;
  114852. /**
  114853. * Disposes of the light gizmo
  114854. */
  114855. dispose(): void;
  114856. private static _CreateHemisphericLightMesh;
  114857. private static _CreatePointLightMesh;
  114858. private static _CreateSpotLightMesh;
  114859. private static _CreateDirectionalLightMesh;
  114860. }
  114861. }
  114862. declare module BABYLON {
  114863. /** @hidden */
  114864. export var backgroundFragmentDeclaration: {
  114865. name: string;
  114866. shader: string;
  114867. };
  114868. }
  114869. declare module BABYLON {
  114870. /** @hidden */
  114871. export var backgroundUboDeclaration: {
  114872. name: string;
  114873. shader: string;
  114874. };
  114875. }
  114876. declare module BABYLON {
  114877. /** @hidden */
  114878. export var backgroundPixelShader: {
  114879. name: string;
  114880. shader: string;
  114881. };
  114882. }
  114883. declare module BABYLON {
  114884. /** @hidden */
  114885. export var backgroundVertexDeclaration: {
  114886. name: string;
  114887. shader: string;
  114888. };
  114889. }
  114890. declare module BABYLON {
  114891. /** @hidden */
  114892. export var backgroundVertexShader: {
  114893. name: string;
  114894. shader: string;
  114895. };
  114896. }
  114897. declare module BABYLON {
  114898. /**
  114899. * Background material used to create an efficient environement around your scene.
  114900. */
  114901. export class BackgroundMaterial extends PushMaterial {
  114902. /**
  114903. * Standard reflectance value at parallel view angle.
  114904. */
  114905. static StandardReflectance0: number;
  114906. /**
  114907. * Standard reflectance value at grazing angle.
  114908. */
  114909. static StandardReflectance90: number;
  114910. protected _primaryColor: Color3;
  114911. /**
  114912. * Key light Color (multiply against the environement texture)
  114913. */
  114914. primaryColor: Color3;
  114915. protected __perceptualColor: Nullable<Color3>;
  114916. /**
  114917. * Experimental Internal Use Only.
  114918. *
  114919. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  114920. * This acts as a helper to set the primary color to a more "human friendly" value.
  114921. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  114922. * output color as close as possible from the chosen value.
  114923. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  114924. * part of lighting setup.)
  114925. */
  114926. _perceptualColor: Nullable<Color3>;
  114927. protected _primaryColorShadowLevel: float;
  114928. /**
  114929. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  114930. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  114931. */
  114932. primaryColorShadowLevel: float;
  114933. protected _primaryColorHighlightLevel: float;
  114934. /**
  114935. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  114936. * The primary color is used at the level chosen to define what the white area would look.
  114937. */
  114938. primaryColorHighlightLevel: float;
  114939. protected _reflectionTexture: Nullable<BaseTexture>;
  114940. /**
  114941. * Reflection Texture used in the material.
  114942. * Should be author in a specific way for the best result (refer to the documentation).
  114943. */
  114944. reflectionTexture: Nullable<BaseTexture>;
  114945. protected _reflectionBlur: float;
  114946. /**
  114947. * Reflection Texture level of blur.
  114948. *
  114949. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  114950. * texture twice.
  114951. */
  114952. reflectionBlur: float;
  114953. protected _diffuseTexture: Nullable<BaseTexture>;
  114954. /**
  114955. * Diffuse Texture used in the material.
  114956. * Should be author in a specific way for the best result (refer to the documentation).
  114957. */
  114958. diffuseTexture: Nullable<BaseTexture>;
  114959. protected _shadowLights: Nullable<IShadowLight[]>;
  114960. /**
  114961. * Specify the list of lights casting shadow on the material.
  114962. * All scene shadow lights will be included if null.
  114963. */
  114964. shadowLights: Nullable<IShadowLight[]>;
  114965. protected _shadowLevel: float;
  114966. /**
  114967. * Helps adjusting the shadow to a softer level if required.
  114968. * 0 means black shadows and 1 means no shadows.
  114969. */
  114970. shadowLevel: float;
  114971. protected _sceneCenter: Vector3;
  114972. /**
  114973. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  114974. * It is usually zero but might be interesting to modify according to your setup.
  114975. */
  114976. sceneCenter: Vector3;
  114977. protected _opacityFresnel: boolean;
  114978. /**
  114979. * This helps specifying that the material is falling off to the sky box at grazing angle.
  114980. * This helps ensuring a nice transition when the camera goes under the ground.
  114981. */
  114982. opacityFresnel: boolean;
  114983. protected _reflectionFresnel: boolean;
  114984. /**
  114985. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  114986. * This helps adding a mirror texture on the ground.
  114987. */
  114988. reflectionFresnel: boolean;
  114989. protected _reflectionFalloffDistance: number;
  114990. /**
  114991. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  114992. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  114993. */
  114994. reflectionFalloffDistance: number;
  114995. protected _reflectionAmount: number;
  114996. /**
  114997. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  114998. */
  114999. reflectionAmount: number;
  115000. protected _reflectionReflectance0: number;
  115001. /**
  115002. * This specifies the weight of the reflection at grazing angle.
  115003. */
  115004. reflectionReflectance0: number;
  115005. protected _reflectionReflectance90: number;
  115006. /**
  115007. * This specifies the weight of the reflection at a perpendicular point of view.
  115008. */
  115009. reflectionReflectance90: number;
  115010. /**
  115011. * Sets the reflection reflectance fresnel values according to the default standard
  115012. * empirically know to work well :-)
  115013. */
  115014. reflectionStandardFresnelWeight: number;
  115015. protected _useRGBColor: boolean;
  115016. /**
  115017. * Helps to directly use the maps channels instead of their level.
  115018. */
  115019. useRGBColor: boolean;
  115020. protected _enableNoise: boolean;
  115021. /**
  115022. * This helps reducing the banding effect that could occur on the background.
  115023. */
  115024. enableNoise: boolean;
  115025. /**
  115026. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  115027. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  115028. * Recommended to be keep at 1.0 except for special cases.
  115029. */
  115030. fovMultiplier: number;
  115031. private _fovMultiplier;
  115032. /**
  115033. * Enable the FOV adjustment feature controlled by fovMultiplier.
  115034. */
  115035. useEquirectangularFOV: boolean;
  115036. private _maxSimultaneousLights;
  115037. /**
  115038. * Number of Simultaneous lights allowed on the material.
  115039. */
  115040. maxSimultaneousLights: int;
  115041. /**
  115042. * Default configuration related to image processing available in the Background Material.
  115043. */
  115044. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  115045. /**
  115046. * Keep track of the image processing observer to allow dispose and replace.
  115047. */
  115048. private _imageProcessingObserver;
  115049. /**
  115050. * Attaches a new image processing configuration to the PBR Material.
  115051. * @param configuration (if null the scene configuration will be use)
  115052. */
  115053. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  115054. /**
  115055. * Gets the image processing configuration used either in this material.
  115056. */
  115057. /**
  115058. * Sets the Default image processing configuration used either in the this material.
  115059. *
  115060. * If sets to null, the scene one is in use.
  115061. */
  115062. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  115063. /**
  115064. * Gets wether the color curves effect is enabled.
  115065. */
  115066. /**
  115067. * Sets wether the color curves effect is enabled.
  115068. */
  115069. cameraColorCurvesEnabled: boolean;
  115070. /**
  115071. * Gets wether the color grading effect is enabled.
  115072. */
  115073. /**
  115074. * Gets wether the color grading effect is enabled.
  115075. */
  115076. cameraColorGradingEnabled: boolean;
  115077. /**
  115078. * Gets wether tonemapping is enabled or not.
  115079. */
  115080. /**
  115081. * Sets wether tonemapping is enabled or not
  115082. */
  115083. cameraToneMappingEnabled: boolean;
  115084. /**
  115085. * The camera exposure used on this material.
  115086. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  115087. * This corresponds to a photographic exposure.
  115088. */
  115089. /**
  115090. * The camera exposure used on this material.
  115091. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  115092. * This corresponds to a photographic exposure.
  115093. */
  115094. cameraExposure: float;
  115095. /**
  115096. * Gets The camera contrast used on this material.
  115097. */
  115098. /**
  115099. * Sets The camera contrast used on this material.
  115100. */
  115101. cameraContrast: float;
  115102. /**
  115103. * Gets the Color Grading 2D Lookup Texture.
  115104. */
  115105. /**
  115106. * Sets the Color Grading 2D Lookup Texture.
  115107. */
  115108. cameraColorGradingTexture: Nullable<BaseTexture>;
  115109. /**
  115110. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  115111. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  115112. * 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;
  115113. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  115114. */
  115115. /**
  115116. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  115117. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  115118. * 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;
  115119. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  115120. */
  115121. cameraColorCurves: Nullable<ColorCurves>;
  115122. /**
  115123. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  115124. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  115125. */
  115126. switchToBGR: boolean;
  115127. private _renderTargets;
  115128. private _reflectionControls;
  115129. private _white;
  115130. private _primaryShadowColor;
  115131. private _primaryHighlightColor;
  115132. /**
  115133. * Instantiates a Background Material in the given scene
  115134. * @param name The friendly name of the material
  115135. * @param scene The scene to add the material to
  115136. */
  115137. constructor(name: string, scene: Scene);
  115138. /**
  115139. * Gets a boolean indicating that current material needs to register RTT
  115140. */
  115141. readonly hasRenderTargetTextures: boolean;
  115142. /**
  115143. * The entire material has been created in order to prevent overdraw.
  115144. * @returns false
  115145. */
  115146. needAlphaTesting(): boolean;
  115147. /**
  115148. * The entire material has been created in order to prevent overdraw.
  115149. * @returns true if blending is enable
  115150. */
  115151. needAlphaBlending(): boolean;
  115152. /**
  115153. * Checks wether the material is ready to be rendered for a given mesh.
  115154. * @param mesh The mesh to render
  115155. * @param subMesh The submesh to check against
  115156. * @param useInstances Specify wether or not the material is used with instances
  115157. * @returns true if all the dependencies are ready (Textures, Effects...)
  115158. */
  115159. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  115160. /**
  115161. * Compute the primary color according to the chosen perceptual color.
  115162. */
  115163. private _computePrimaryColorFromPerceptualColor;
  115164. /**
  115165. * Compute the highlights and shadow colors according to their chosen levels.
  115166. */
  115167. private _computePrimaryColors;
  115168. /**
  115169. * Build the uniform buffer used in the material.
  115170. */
  115171. buildUniformLayout(): void;
  115172. /**
  115173. * Unbind the material.
  115174. */
  115175. unbind(): void;
  115176. /**
  115177. * Bind only the world matrix to the material.
  115178. * @param world The world matrix to bind.
  115179. */
  115180. bindOnlyWorldMatrix(world: Matrix): void;
  115181. /**
  115182. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  115183. * @param world The world matrix to bind.
  115184. * @param subMesh The submesh to bind for.
  115185. */
  115186. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  115187. /**
  115188. * Checks to see if a texture is used in the material.
  115189. * @param texture - Base texture to use.
  115190. * @returns - Boolean specifying if a texture is used in the material.
  115191. */
  115192. hasTexture(texture: BaseTexture): boolean;
  115193. /**
  115194. * Dispose the material.
  115195. * @param forceDisposeEffect Force disposal of the associated effect.
  115196. * @param forceDisposeTextures Force disposal of the associated textures.
  115197. */
  115198. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  115199. /**
  115200. * Clones the material.
  115201. * @param name The cloned name.
  115202. * @returns The cloned material.
  115203. */
  115204. clone(name: string): BackgroundMaterial;
  115205. /**
  115206. * Serializes the current material to its JSON representation.
  115207. * @returns The JSON representation.
  115208. */
  115209. serialize(): any;
  115210. /**
  115211. * Gets the class name of the material
  115212. * @returns "BackgroundMaterial"
  115213. */
  115214. getClassName(): string;
  115215. /**
  115216. * Parse a JSON input to create back a background material.
  115217. * @param source The JSON data to parse
  115218. * @param scene The scene to create the parsed material in
  115219. * @param rootUrl The root url of the assets the material depends upon
  115220. * @returns the instantiated BackgroundMaterial.
  115221. */
  115222. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  115223. }
  115224. }
  115225. declare module BABYLON {
  115226. /**
  115227. * Represents the different options available during the creation of
  115228. * a Environment helper.
  115229. *
  115230. * This can control the default ground, skybox and image processing setup of your scene.
  115231. */
  115232. export interface IEnvironmentHelperOptions {
  115233. /**
  115234. * Specifies wether or not to create a ground.
  115235. * True by default.
  115236. */
  115237. createGround: boolean;
  115238. /**
  115239. * Specifies the ground size.
  115240. * 15 by default.
  115241. */
  115242. groundSize: number;
  115243. /**
  115244. * The texture used on the ground for the main color.
  115245. * Comes from the BabylonJS CDN by default.
  115246. *
  115247. * Remarks: Can be either a texture or a url.
  115248. */
  115249. groundTexture: string | BaseTexture;
  115250. /**
  115251. * The color mixed in the ground texture by default.
  115252. * BabylonJS clearColor by default.
  115253. */
  115254. groundColor: Color3;
  115255. /**
  115256. * Specifies the ground opacity.
  115257. * 1 by default.
  115258. */
  115259. groundOpacity: number;
  115260. /**
  115261. * Enables the ground to receive shadows.
  115262. * True by default.
  115263. */
  115264. enableGroundShadow: boolean;
  115265. /**
  115266. * Helps preventing the shadow to be fully black on the ground.
  115267. * 0.5 by default.
  115268. */
  115269. groundShadowLevel: number;
  115270. /**
  115271. * Creates a mirror texture attach to the ground.
  115272. * false by default.
  115273. */
  115274. enableGroundMirror: boolean;
  115275. /**
  115276. * Specifies the ground mirror size ratio.
  115277. * 0.3 by default as the default kernel is 64.
  115278. */
  115279. groundMirrorSizeRatio: number;
  115280. /**
  115281. * Specifies the ground mirror blur kernel size.
  115282. * 64 by default.
  115283. */
  115284. groundMirrorBlurKernel: number;
  115285. /**
  115286. * Specifies the ground mirror visibility amount.
  115287. * 1 by default
  115288. */
  115289. groundMirrorAmount: number;
  115290. /**
  115291. * Specifies the ground mirror reflectance weight.
  115292. * This uses the standard weight of the background material to setup the fresnel effect
  115293. * of the mirror.
  115294. * 1 by default.
  115295. */
  115296. groundMirrorFresnelWeight: number;
  115297. /**
  115298. * Specifies the ground mirror Falloff distance.
  115299. * This can helps reducing the size of the reflection.
  115300. * 0 by Default.
  115301. */
  115302. groundMirrorFallOffDistance: number;
  115303. /**
  115304. * Specifies the ground mirror texture type.
  115305. * Unsigned Int by Default.
  115306. */
  115307. groundMirrorTextureType: number;
  115308. /**
  115309. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  115310. * the shown objects.
  115311. */
  115312. groundYBias: number;
  115313. /**
  115314. * Specifies wether or not to create a skybox.
  115315. * True by default.
  115316. */
  115317. createSkybox: boolean;
  115318. /**
  115319. * Specifies the skybox size.
  115320. * 20 by default.
  115321. */
  115322. skyboxSize: number;
  115323. /**
  115324. * The texture used on the skybox for the main color.
  115325. * Comes from the BabylonJS CDN by default.
  115326. *
  115327. * Remarks: Can be either a texture or a url.
  115328. */
  115329. skyboxTexture: string | BaseTexture;
  115330. /**
  115331. * The color mixed in the skybox texture by default.
  115332. * BabylonJS clearColor by default.
  115333. */
  115334. skyboxColor: Color3;
  115335. /**
  115336. * The background rotation around the Y axis of the scene.
  115337. * This helps aligning the key lights of your scene with the background.
  115338. * 0 by default.
  115339. */
  115340. backgroundYRotation: number;
  115341. /**
  115342. * Compute automatically the size of the elements to best fit with the scene.
  115343. */
  115344. sizeAuto: boolean;
  115345. /**
  115346. * Default position of the rootMesh if autoSize is not true.
  115347. */
  115348. rootPosition: Vector3;
  115349. /**
  115350. * Sets up the image processing in the scene.
  115351. * true by default.
  115352. */
  115353. setupImageProcessing: boolean;
  115354. /**
  115355. * The texture used as your environment texture in the scene.
  115356. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  115357. *
  115358. * Remarks: Can be either a texture or a url.
  115359. */
  115360. environmentTexture: string | BaseTexture;
  115361. /**
  115362. * The value of the exposure to apply to the scene.
  115363. * 0.6 by default if setupImageProcessing is true.
  115364. */
  115365. cameraExposure: number;
  115366. /**
  115367. * The value of the contrast to apply to the scene.
  115368. * 1.6 by default if setupImageProcessing is true.
  115369. */
  115370. cameraContrast: number;
  115371. /**
  115372. * Specifies wether or not tonemapping should be enabled in the scene.
  115373. * true by default if setupImageProcessing is true.
  115374. */
  115375. toneMappingEnabled: boolean;
  115376. }
  115377. /**
  115378. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  115379. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  115380. * It also helps with the default setup of your imageProcessing configuration.
  115381. */
  115382. export class EnvironmentHelper {
  115383. /**
  115384. * Default ground texture URL.
  115385. */
  115386. private static _groundTextureCDNUrl;
  115387. /**
  115388. * Default skybox texture URL.
  115389. */
  115390. private static _skyboxTextureCDNUrl;
  115391. /**
  115392. * Default environment texture URL.
  115393. */
  115394. private static _environmentTextureCDNUrl;
  115395. /**
  115396. * Creates the default options for the helper.
  115397. */
  115398. private static _getDefaultOptions;
  115399. private _rootMesh;
  115400. /**
  115401. * Gets the root mesh created by the helper.
  115402. */
  115403. readonly rootMesh: Mesh;
  115404. private _skybox;
  115405. /**
  115406. * Gets the skybox created by the helper.
  115407. */
  115408. readonly skybox: Nullable<Mesh>;
  115409. private _skyboxTexture;
  115410. /**
  115411. * Gets the skybox texture created by the helper.
  115412. */
  115413. readonly skyboxTexture: Nullable<BaseTexture>;
  115414. private _skyboxMaterial;
  115415. /**
  115416. * Gets the skybox material created by the helper.
  115417. */
  115418. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  115419. private _ground;
  115420. /**
  115421. * Gets the ground mesh created by the helper.
  115422. */
  115423. readonly ground: Nullable<Mesh>;
  115424. private _groundTexture;
  115425. /**
  115426. * Gets the ground texture created by the helper.
  115427. */
  115428. readonly groundTexture: Nullable<BaseTexture>;
  115429. private _groundMirror;
  115430. /**
  115431. * Gets the ground mirror created by the helper.
  115432. */
  115433. readonly groundMirror: Nullable<MirrorTexture>;
  115434. /**
  115435. * Gets the ground mirror render list to helps pushing the meshes
  115436. * you wish in the ground reflection.
  115437. */
  115438. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  115439. private _groundMaterial;
  115440. /**
  115441. * Gets the ground material created by the helper.
  115442. */
  115443. readonly groundMaterial: Nullable<BackgroundMaterial>;
  115444. /**
  115445. * Stores the creation options.
  115446. */
  115447. private readonly _scene;
  115448. private _options;
  115449. /**
  115450. * This observable will be notified with any error during the creation of the environment,
  115451. * mainly texture creation errors.
  115452. */
  115453. onErrorObservable: Observable<{
  115454. message?: string;
  115455. exception?: any;
  115456. }>;
  115457. /**
  115458. * constructor
  115459. * @param options Defines the options we want to customize the helper
  115460. * @param scene The scene to add the material to
  115461. */
  115462. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  115463. /**
  115464. * Updates the background according to the new options
  115465. * @param options
  115466. */
  115467. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  115468. /**
  115469. * Sets the primary color of all the available elements.
  115470. * @param color the main color to affect to the ground and the background
  115471. */
  115472. setMainColor(color: Color3): void;
  115473. /**
  115474. * Setup the image processing according to the specified options.
  115475. */
  115476. private _setupImageProcessing;
  115477. /**
  115478. * Setup the environment texture according to the specified options.
  115479. */
  115480. private _setupEnvironmentTexture;
  115481. /**
  115482. * Setup the background according to the specified options.
  115483. */
  115484. private _setupBackground;
  115485. /**
  115486. * Get the scene sizes according to the setup.
  115487. */
  115488. private _getSceneSize;
  115489. /**
  115490. * Setup the ground according to the specified options.
  115491. */
  115492. private _setupGround;
  115493. /**
  115494. * Setup the ground material according to the specified options.
  115495. */
  115496. private _setupGroundMaterial;
  115497. /**
  115498. * Setup the ground diffuse texture according to the specified options.
  115499. */
  115500. private _setupGroundDiffuseTexture;
  115501. /**
  115502. * Setup the ground mirror texture according to the specified options.
  115503. */
  115504. private _setupGroundMirrorTexture;
  115505. /**
  115506. * Setup the ground to receive the mirror texture.
  115507. */
  115508. private _setupMirrorInGroundMaterial;
  115509. /**
  115510. * Setup the skybox according to the specified options.
  115511. */
  115512. private _setupSkybox;
  115513. /**
  115514. * Setup the skybox material according to the specified options.
  115515. */
  115516. private _setupSkyboxMaterial;
  115517. /**
  115518. * Setup the skybox reflection texture according to the specified options.
  115519. */
  115520. private _setupSkyboxReflectionTexture;
  115521. private _errorHandler;
  115522. /**
  115523. * Dispose all the elements created by the Helper.
  115524. */
  115525. dispose(): void;
  115526. }
  115527. }
  115528. declare module BABYLON {
  115529. /**
  115530. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  115531. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  115532. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  115533. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  115534. */
  115535. export class PhotoDome extends TransformNode {
  115536. /**
  115537. * Define the image as a Monoscopic panoramic 360 image.
  115538. */
  115539. static readonly MODE_MONOSCOPIC: number;
  115540. /**
  115541. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  115542. */
  115543. static readonly MODE_TOPBOTTOM: number;
  115544. /**
  115545. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  115546. */
  115547. static readonly MODE_SIDEBYSIDE: number;
  115548. private _useDirectMapping;
  115549. /**
  115550. * The texture being displayed on the sphere
  115551. */
  115552. protected _photoTexture: Texture;
  115553. /**
  115554. * Gets or sets the texture being displayed on the sphere
  115555. */
  115556. photoTexture: Texture;
  115557. /**
  115558. * Observable raised when an error occured while loading the 360 image
  115559. */
  115560. onLoadErrorObservable: Observable<string>;
  115561. /**
  115562. * The skybox material
  115563. */
  115564. protected _material: BackgroundMaterial;
  115565. /**
  115566. * The surface used for the skybox
  115567. */
  115568. protected _mesh: Mesh;
  115569. /**
  115570. * Gets the mesh used for the skybox.
  115571. */
  115572. readonly mesh: Mesh;
  115573. /**
  115574. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  115575. * Also see the options.resolution property.
  115576. */
  115577. fovMultiplier: number;
  115578. private _imageMode;
  115579. /**
  115580. * Gets or set the current video mode for the video. It can be:
  115581. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  115582. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  115583. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  115584. */
  115585. imageMode: number;
  115586. /**
  115587. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  115588. * @param name Element's name, child elements will append suffixes for their own names.
  115589. * @param urlsOfPhoto defines the url of the photo to display
  115590. * @param options defines an object containing optional or exposed sub element properties
  115591. * @param onError defines a callback called when an error occured while loading the texture
  115592. */
  115593. constructor(name: string, urlOfPhoto: string, options: {
  115594. resolution?: number;
  115595. size?: number;
  115596. useDirectMapping?: boolean;
  115597. faceForward?: boolean;
  115598. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  115599. private _onBeforeCameraRenderObserver;
  115600. private _changeImageMode;
  115601. /**
  115602. * Releases resources associated with this node.
  115603. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  115604. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  115605. */
  115606. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  115607. }
  115608. }
  115609. declare module BABYLON {
  115610. /**
  115611. * Class used to host RGBD texture specific utilities
  115612. */
  115613. export class RGBDTextureTools {
  115614. /**
  115615. * Expand the RGBD Texture from RGBD to Half Float if possible.
  115616. * @param texture the texture to expand.
  115617. */
  115618. static ExpandRGBDTexture(texture: Texture): void;
  115619. }
  115620. }
  115621. declare module BABYLON {
  115622. /**
  115623. * Class used to host texture specific utilities
  115624. */
  115625. export class BRDFTextureTools {
  115626. /**
  115627. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  115628. * @param scene defines the hosting scene
  115629. * @returns the environment BRDF texture
  115630. */
  115631. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  115632. private static _environmentBRDFBase64Texture;
  115633. }
  115634. }
  115635. declare module BABYLON {
  115636. /**
  115637. * @hidden
  115638. */
  115639. export interface IMaterialClearCoatDefines {
  115640. CLEARCOAT: boolean;
  115641. CLEARCOAT_DEFAULTIOR: boolean;
  115642. CLEARCOAT_TEXTURE: boolean;
  115643. CLEARCOAT_TEXTUREDIRECTUV: number;
  115644. CLEARCOAT_BUMP: boolean;
  115645. CLEARCOAT_BUMPDIRECTUV: number;
  115646. CLEARCOAT_TINT: boolean;
  115647. CLEARCOAT_TINT_TEXTURE: boolean;
  115648. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  115649. /** @hidden */
  115650. _areTexturesDirty: boolean;
  115651. }
  115652. /**
  115653. * Define the code related to the clear coat parameters of the pbr material.
  115654. */
  115655. export class PBRClearCoatConfiguration {
  115656. /**
  115657. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  115658. * The default fits with a polyurethane material.
  115659. */
  115660. private static readonly _DefaultIndexOfRefraction;
  115661. private _isEnabled;
  115662. /**
  115663. * Defines if the clear coat is enabled in the material.
  115664. */
  115665. isEnabled: boolean;
  115666. /**
  115667. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  115668. */
  115669. intensity: number;
  115670. /**
  115671. * Defines the clear coat layer roughness.
  115672. */
  115673. roughness: number;
  115674. private _indexOfRefraction;
  115675. /**
  115676. * Defines the index of refraction of the clear coat.
  115677. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  115678. * The default fits with a polyurethane material.
  115679. * Changing the default value is more performance intensive.
  115680. */
  115681. indexOfRefraction: number;
  115682. private _texture;
  115683. /**
  115684. * Stores the clear coat values in a texture.
  115685. */
  115686. texture: Nullable<BaseTexture>;
  115687. private _bumpTexture;
  115688. /**
  115689. * Define the clear coat specific bump texture.
  115690. */
  115691. bumpTexture: Nullable<BaseTexture>;
  115692. private _isTintEnabled;
  115693. /**
  115694. * Defines if the clear coat tint is enabled in the material.
  115695. */
  115696. isTintEnabled: boolean;
  115697. /**
  115698. * Defines the clear coat tint of the material.
  115699. * This is only use if tint is enabled
  115700. */
  115701. tintColor: Color3;
  115702. /**
  115703. * Defines the distance at which the tint color should be found in the
  115704. * clear coat media.
  115705. * This is only use if tint is enabled
  115706. */
  115707. tintColorAtDistance: number;
  115708. /**
  115709. * Defines the clear coat layer thickness.
  115710. * This is only use if tint is enabled
  115711. */
  115712. tintThickness: number;
  115713. private _tintTexture;
  115714. /**
  115715. * Stores the clear tint values in a texture.
  115716. * rgb is tint
  115717. * a is a thickness factor
  115718. */
  115719. tintTexture: Nullable<BaseTexture>;
  115720. /** @hidden */
  115721. private _internalMarkAllSubMeshesAsTexturesDirty;
  115722. /** @hidden */
  115723. _markAllSubMeshesAsTexturesDirty(): void;
  115724. /**
  115725. * Instantiate a new istance of clear coat configuration.
  115726. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115727. */
  115728. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115729. /**
  115730. * Gets wehter the submesh is ready to be used or not.
  115731. * @param defines the list of "defines" to update.
  115732. * @param scene defines the scene the material belongs to.
  115733. * @param engine defines the engine the material belongs to.
  115734. * @param disableBumpMap defines wether the material disables bump or not.
  115735. * @returns - boolean indicating that the submesh is ready or not.
  115736. */
  115737. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  115738. /**
  115739. * Checks to see if a texture is used in the material.
  115740. * @param defines the list of "defines" to update.
  115741. * @param scene defines the scene to the material belongs to.
  115742. */
  115743. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  115744. /**
  115745. * Binds the material data.
  115746. * @param uniformBuffer defines the Uniform buffer to fill in.
  115747. * @param scene defines the scene the material belongs to.
  115748. * @param engine defines the engine the material belongs to.
  115749. * @param disableBumpMap defines wether the material disables bump or not.
  115750. * @param isFrozen defines wether the material is frozen or not.
  115751. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  115752. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  115753. */
  115754. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  115755. /**
  115756. * Checks to see if a texture is used in the material.
  115757. * @param texture - Base texture to use.
  115758. * @returns - Boolean specifying if a texture is used in the material.
  115759. */
  115760. hasTexture(texture: BaseTexture): boolean;
  115761. /**
  115762. * Returns an array of the actively used textures.
  115763. * @param activeTextures Array of BaseTextures
  115764. */
  115765. getActiveTextures(activeTextures: BaseTexture[]): void;
  115766. /**
  115767. * Returns the animatable textures.
  115768. * @param animatables Array of animatable textures.
  115769. */
  115770. getAnimatables(animatables: IAnimatable[]): void;
  115771. /**
  115772. * Disposes the resources of the material.
  115773. * @param forceDisposeTextures - Forces the disposal of all textures.
  115774. */
  115775. dispose(forceDisposeTextures?: boolean): void;
  115776. /**
  115777. * Get the current class name of the texture useful for serialization or dynamic coding.
  115778. * @returns "PBRClearCoatConfiguration"
  115779. */
  115780. getClassName(): string;
  115781. /**
  115782. * Add fallbacks to the effect fallbacks list.
  115783. * @param defines defines the Base texture to use.
  115784. * @param fallbacks defines the current fallback list.
  115785. * @param currentRank defines the current fallback rank.
  115786. * @returns the new fallback rank.
  115787. */
  115788. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115789. /**
  115790. * Add the required uniforms to the current list.
  115791. * @param uniforms defines the current uniform list.
  115792. */
  115793. static AddUniforms(uniforms: string[]): void;
  115794. /**
  115795. * Add the required samplers to the current list.
  115796. * @param samplers defines the current sampler list.
  115797. */
  115798. static AddSamplers(samplers: string[]): void;
  115799. /**
  115800. * Add the required uniforms to the current buffer.
  115801. * @param uniformBuffer defines the current uniform buffer.
  115802. */
  115803. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115804. /**
  115805. * Makes a duplicate of the current configuration into another one.
  115806. * @param clearCoatConfiguration define the config where to copy the info
  115807. */
  115808. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  115809. /**
  115810. * Serializes this clear coat configuration.
  115811. * @returns - An object with the serialized config.
  115812. */
  115813. serialize(): any;
  115814. /**
  115815. * Parses a anisotropy Configuration from a serialized object.
  115816. * @param source - Serialized object.
  115817. * @param scene Defines the scene we are parsing for
  115818. * @param rootUrl Defines the rootUrl to load from
  115819. */
  115820. parse(source: any, scene: Scene, rootUrl: string): void;
  115821. }
  115822. }
  115823. declare module BABYLON {
  115824. /**
  115825. * @hidden
  115826. */
  115827. export interface IMaterialAnisotropicDefines {
  115828. ANISOTROPIC: boolean;
  115829. ANISOTROPIC_TEXTURE: boolean;
  115830. ANISOTROPIC_TEXTUREDIRECTUV: number;
  115831. MAINUV1: boolean;
  115832. _areTexturesDirty: boolean;
  115833. _needUVs: boolean;
  115834. }
  115835. /**
  115836. * Define the code related to the anisotropic parameters of the pbr material.
  115837. */
  115838. export class PBRAnisotropicConfiguration {
  115839. private _isEnabled;
  115840. /**
  115841. * Defines if the anisotropy is enabled in the material.
  115842. */
  115843. isEnabled: boolean;
  115844. /**
  115845. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  115846. */
  115847. intensity: number;
  115848. /**
  115849. * Defines if the effect is along the tangents, bitangents or in between.
  115850. * By default, the effect is "strectching" the highlights along the tangents.
  115851. */
  115852. direction: Vector2;
  115853. private _texture;
  115854. /**
  115855. * Stores the anisotropy values in a texture.
  115856. * rg is direction (like normal from -1 to 1)
  115857. * b is a intensity
  115858. */
  115859. texture: Nullable<BaseTexture>;
  115860. /** @hidden */
  115861. private _internalMarkAllSubMeshesAsTexturesDirty;
  115862. /** @hidden */
  115863. _markAllSubMeshesAsTexturesDirty(): void;
  115864. /**
  115865. * Instantiate a new istance of anisotropy configuration.
  115866. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115867. */
  115868. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115869. /**
  115870. * Specifies that the submesh is ready to be used.
  115871. * @param defines the list of "defines" to update.
  115872. * @param scene defines the scene the material belongs to.
  115873. * @returns - boolean indicating that the submesh is ready or not.
  115874. */
  115875. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  115876. /**
  115877. * Checks to see if a texture is used in the material.
  115878. * @param defines the list of "defines" to update.
  115879. * @param mesh the mesh we are preparing the defines for.
  115880. * @param scene defines the scene the material belongs to.
  115881. */
  115882. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  115883. /**
  115884. * Binds the material data.
  115885. * @param uniformBuffer defines the Uniform buffer to fill in.
  115886. * @param scene defines the scene the material belongs to.
  115887. * @param isFrozen defines wether the material is frozen or not.
  115888. */
  115889. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  115890. /**
  115891. * Checks to see if a texture is used in the material.
  115892. * @param texture - Base texture to use.
  115893. * @returns - Boolean specifying if a texture is used in the material.
  115894. */
  115895. hasTexture(texture: BaseTexture): boolean;
  115896. /**
  115897. * Returns an array of the actively used textures.
  115898. * @param activeTextures Array of BaseTextures
  115899. */
  115900. getActiveTextures(activeTextures: BaseTexture[]): void;
  115901. /**
  115902. * Returns the animatable textures.
  115903. * @param animatables Array of animatable textures.
  115904. */
  115905. getAnimatables(animatables: IAnimatable[]): void;
  115906. /**
  115907. * Disposes the resources of the material.
  115908. * @param forceDisposeTextures - Forces the disposal of all textures.
  115909. */
  115910. dispose(forceDisposeTextures?: boolean): void;
  115911. /**
  115912. * Get the current class name of the texture useful for serialization or dynamic coding.
  115913. * @returns "PBRAnisotropicConfiguration"
  115914. */
  115915. getClassName(): string;
  115916. /**
  115917. * Add fallbacks to the effect fallbacks list.
  115918. * @param defines defines the Base texture to use.
  115919. * @param fallbacks defines the current fallback list.
  115920. * @param currentRank defines the current fallback rank.
  115921. * @returns the new fallback rank.
  115922. */
  115923. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115924. /**
  115925. * Add the required uniforms to the current list.
  115926. * @param uniforms defines the current uniform list.
  115927. */
  115928. static AddUniforms(uniforms: string[]): void;
  115929. /**
  115930. * Add the required uniforms to the current buffer.
  115931. * @param uniformBuffer defines the current uniform buffer.
  115932. */
  115933. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115934. /**
  115935. * Add the required samplers to the current list.
  115936. * @param samplers defines the current sampler list.
  115937. */
  115938. static AddSamplers(samplers: string[]): void;
  115939. /**
  115940. * Makes a duplicate of the current configuration into another one.
  115941. * @param anisotropicConfiguration define the config where to copy the info
  115942. */
  115943. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  115944. /**
  115945. * Serializes this anisotropy configuration.
  115946. * @returns - An object with the serialized config.
  115947. */
  115948. serialize(): any;
  115949. /**
  115950. * Parses a anisotropy Configuration from a serialized object.
  115951. * @param source - Serialized object.
  115952. * @param scene Defines the scene we are parsing for
  115953. * @param rootUrl Defines the rootUrl to load from
  115954. */
  115955. parse(source: any, scene: Scene, rootUrl: string): void;
  115956. }
  115957. }
  115958. declare module BABYLON {
  115959. /**
  115960. * @hidden
  115961. */
  115962. export interface IMaterialBRDFDefines {
  115963. BRDF_V_HEIGHT_CORRELATED: boolean;
  115964. MS_BRDF_ENERGY_CONSERVATION: boolean;
  115965. SPHERICAL_HARMONICS: boolean;
  115966. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  115967. /** @hidden */
  115968. _areMiscDirty: boolean;
  115969. }
  115970. /**
  115971. * Define the code related to the BRDF parameters of the pbr material.
  115972. */
  115973. export class PBRBRDFConfiguration {
  115974. /**
  115975. * Default value used for the energy conservation.
  115976. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  115977. */
  115978. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  115979. /**
  115980. * Default value used for the Smith Visibility Height Correlated mode.
  115981. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  115982. */
  115983. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  115984. /**
  115985. * Default value used for the IBL diffuse part.
  115986. * This can help switching back to the polynomials mode globally which is a tiny bit
  115987. * less GPU intensive at the drawback of a lower quality.
  115988. */
  115989. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  115990. /**
  115991. * Default value used for activating energy conservation for the specular workflow.
  115992. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  115993. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  115994. */
  115995. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  115996. private _useEnergyConservation;
  115997. /**
  115998. * Defines if the material uses energy conservation.
  115999. */
  116000. useEnergyConservation: boolean;
  116001. private _useSmithVisibilityHeightCorrelated;
  116002. /**
  116003. * LEGACY Mode set to false
  116004. * Defines if the material uses height smith correlated visibility term.
  116005. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  116006. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  116007. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  116008. * Not relying on height correlated will also disable energy conservation.
  116009. */
  116010. useSmithVisibilityHeightCorrelated: boolean;
  116011. private _useSphericalHarmonics;
  116012. /**
  116013. * LEGACY Mode set to false
  116014. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  116015. * diffuse part of the IBL.
  116016. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  116017. * to the ground truth.
  116018. */
  116019. useSphericalHarmonics: boolean;
  116020. private _useSpecularGlossinessInputEnergyConservation;
  116021. /**
  116022. * Defines if the material uses energy conservation, when the specular workflow is active.
  116023. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  116024. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  116025. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  116026. */
  116027. useSpecularGlossinessInputEnergyConservation: boolean;
  116028. /** @hidden */
  116029. private _internalMarkAllSubMeshesAsMiscDirty;
  116030. /** @hidden */
  116031. _markAllSubMeshesAsMiscDirty(): void;
  116032. /**
  116033. * Instantiate a new istance of clear coat configuration.
  116034. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  116035. */
  116036. constructor(markAllSubMeshesAsMiscDirty: () => void);
  116037. /**
  116038. * Checks to see if a texture is used in the material.
  116039. * @param defines the list of "defines" to update.
  116040. */
  116041. prepareDefines(defines: IMaterialBRDFDefines): void;
  116042. /**
  116043. * Get the current class name of the texture useful for serialization or dynamic coding.
  116044. * @returns "PBRClearCoatConfiguration"
  116045. */
  116046. getClassName(): string;
  116047. /**
  116048. * Makes a duplicate of the current configuration into another one.
  116049. * @param brdfConfiguration define the config where to copy the info
  116050. */
  116051. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  116052. /**
  116053. * Serializes this BRDF configuration.
  116054. * @returns - An object with the serialized config.
  116055. */
  116056. serialize(): any;
  116057. /**
  116058. * Parses a anisotropy Configuration from a serialized object.
  116059. * @param source - Serialized object.
  116060. * @param scene Defines the scene we are parsing for
  116061. * @param rootUrl Defines the rootUrl to load from
  116062. */
  116063. parse(source: any, scene: Scene, rootUrl: string): void;
  116064. }
  116065. }
  116066. declare module BABYLON {
  116067. /**
  116068. * @hidden
  116069. */
  116070. export interface IMaterialSheenDefines {
  116071. SHEEN: boolean;
  116072. SHEEN_TEXTURE: boolean;
  116073. SHEEN_TEXTUREDIRECTUV: number;
  116074. SHEEN_LINKWITHALBEDO: boolean;
  116075. /** @hidden */
  116076. _areTexturesDirty: boolean;
  116077. }
  116078. /**
  116079. * Define the code related to the Sheen parameters of the pbr material.
  116080. */
  116081. export class PBRSheenConfiguration {
  116082. private _isEnabled;
  116083. /**
  116084. * Defines if the material uses sheen.
  116085. */
  116086. isEnabled: boolean;
  116087. private _linkSheenWithAlbedo;
  116088. /**
  116089. * Defines if the sheen is linked to the sheen color.
  116090. */
  116091. linkSheenWithAlbedo: boolean;
  116092. /**
  116093. * Defines the sheen intensity.
  116094. */
  116095. intensity: number;
  116096. /**
  116097. * Defines the sheen color.
  116098. */
  116099. color: Color3;
  116100. private _texture;
  116101. /**
  116102. * Stores the sheen tint values in a texture.
  116103. * rgb is tint
  116104. * a is a intensity
  116105. */
  116106. texture: Nullable<BaseTexture>;
  116107. /** @hidden */
  116108. private _internalMarkAllSubMeshesAsTexturesDirty;
  116109. /** @hidden */
  116110. _markAllSubMeshesAsTexturesDirty(): void;
  116111. /**
  116112. * Instantiate a new istance of clear coat configuration.
  116113. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  116114. */
  116115. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  116116. /**
  116117. * Specifies that the submesh is ready to be used.
  116118. * @param defines the list of "defines" to update.
  116119. * @param scene defines the scene the material belongs to.
  116120. * @returns - boolean indicating that the submesh is ready or not.
  116121. */
  116122. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  116123. /**
  116124. * Checks to see if a texture is used in the material.
  116125. * @param defines the list of "defines" to update.
  116126. * @param scene defines the scene the material belongs to.
  116127. */
  116128. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  116129. /**
  116130. * Binds the material data.
  116131. * @param uniformBuffer defines the Uniform buffer to fill in.
  116132. * @param scene defines the scene the material belongs to.
  116133. * @param isFrozen defines wether the material is frozen or not.
  116134. */
  116135. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  116136. /**
  116137. * Checks to see if a texture is used in the material.
  116138. * @param texture - Base texture to use.
  116139. * @returns - Boolean specifying if a texture is used in the material.
  116140. */
  116141. hasTexture(texture: BaseTexture): boolean;
  116142. /**
  116143. * Returns an array of the actively used textures.
  116144. * @param activeTextures Array of BaseTextures
  116145. */
  116146. getActiveTextures(activeTextures: BaseTexture[]): void;
  116147. /**
  116148. * Returns the animatable textures.
  116149. * @param animatables Array of animatable textures.
  116150. */
  116151. getAnimatables(animatables: IAnimatable[]): void;
  116152. /**
  116153. * Disposes the resources of the material.
  116154. * @param forceDisposeTextures - Forces the disposal of all textures.
  116155. */
  116156. dispose(forceDisposeTextures?: boolean): void;
  116157. /**
  116158. * Get the current class name of the texture useful for serialization or dynamic coding.
  116159. * @returns "PBRSheenConfiguration"
  116160. */
  116161. getClassName(): string;
  116162. /**
  116163. * Add fallbacks to the effect fallbacks list.
  116164. * @param defines defines the Base texture to use.
  116165. * @param fallbacks defines the current fallback list.
  116166. * @param currentRank defines the current fallback rank.
  116167. * @returns the new fallback rank.
  116168. */
  116169. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  116170. /**
  116171. * Add the required uniforms to the current list.
  116172. * @param uniforms defines the current uniform list.
  116173. */
  116174. static AddUniforms(uniforms: string[]): void;
  116175. /**
  116176. * Add the required uniforms to the current buffer.
  116177. * @param uniformBuffer defines the current uniform buffer.
  116178. */
  116179. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  116180. /**
  116181. * Add the required samplers to the current list.
  116182. * @param samplers defines the current sampler list.
  116183. */
  116184. static AddSamplers(samplers: string[]): void;
  116185. /**
  116186. * Makes a duplicate of the current configuration into another one.
  116187. * @param sheenConfiguration define the config where to copy the info
  116188. */
  116189. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  116190. /**
  116191. * Serializes this BRDF configuration.
  116192. * @returns - An object with the serialized config.
  116193. */
  116194. serialize(): any;
  116195. /**
  116196. * Parses a anisotropy Configuration from a serialized object.
  116197. * @param source - Serialized object.
  116198. * @param scene Defines the scene we are parsing for
  116199. * @param rootUrl Defines the rootUrl to load from
  116200. */
  116201. parse(source: any, scene: Scene, rootUrl: string): void;
  116202. }
  116203. }
  116204. declare module BABYLON {
  116205. /**
  116206. * @hidden
  116207. */
  116208. export interface IMaterialSubSurfaceDefines {
  116209. SUBSURFACE: boolean;
  116210. SS_REFRACTION: boolean;
  116211. SS_TRANSLUCENCY: boolean;
  116212. SS_SCATERRING: boolean;
  116213. SS_THICKNESSANDMASK_TEXTURE: boolean;
  116214. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  116215. SS_REFRACTIONMAP_3D: boolean;
  116216. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  116217. SS_LODINREFRACTIONALPHA: boolean;
  116218. SS_GAMMAREFRACTION: boolean;
  116219. SS_RGBDREFRACTION: boolean;
  116220. SS_LINEARSPECULARREFRACTION: boolean;
  116221. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  116222. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  116223. /** @hidden */
  116224. _areTexturesDirty: boolean;
  116225. }
  116226. /**
  116227. * Define the code related to the sub surface parameters of the pbr material.
  116228. */
  116229. export class PBRSubSurfaceConfiguration {
  116230. private _isRefractionEnabled;
  116231. /**
  116232. * Defines if the refraction is enabled in the material.
  116233. */
  116234. isRefractionEnabled: boolean;
  116235. private _isTranslucencyEnabled;
  116236. /**
  116237. * Defines if the translucency is enabled in the material.
  116238. */
  116239. isTranslucencyEnabled: boolean;
  116240. private _isScatteringEnabled;
  116241. /**
  116242. * Defines the refraction intensity of the material.
  116243. * The refraction when enabled replaces the Diffuse part of the material.
  116244. * The intensity helps transitionning between diffuse and refraction.
  116245. */
  116246. refractionIntensity: number;
  116247. /**
  116248. * Defines the translucency intensity of the material.
  116249. * When translucency has been enabled, this defines how much of the "translucency"
  116250. * is addded to the diffuse part of the material.
  116251. */
  116252. translucencyIntensity: number;
  116253. /**
  116254. * Defines the scattering intensity of the material.
  116255. * When scattering has been enabled, this defines how much of the "scattered light"
  116256. * is addded to the diffuse part of the material.
  116257. */
  116258. scatteringIntensity: number;
  116259. private _thicknessTexture;
  116260. /**
  116261. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  116262. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  116263. * 0 would mean minimumThickness
  116264. * 1 would mean maximumThickness
  116265. * The other channels might be use as a mask to vary the different effects intensity.
  116266. */
  116267. thicknessTexture: Nullable<BaseTexture>;
  116268. private _refractionTexture;
  116269. /**
  116270. * Defines the texture to use for refraction.
  116271. */
  116272. refractionTexture: Nullable<BaseTexture>;
  116273. private _indexOfRefraction;
  116274. /**
  116275. * Defines the index of refraction used in the material.
  116276. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  116277. */
  116278. indexOfRefraction: number;
  116279. private _invertRefractionY;
  116280. /**
  116281. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  116282. */
  116283. invertRefractionY: boolean;
  116284. private _linkRefractionWithTransparency;
  116285. /**
  116286. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  116287. * Materials half opaque for instance using refraction could benefit from this control.
  116288. */
  116289. linkRefractionWithTransparency: boolean;
  116290. /**
  116291. * Defines the minimum thickness stored in the thickness map.
  116292. * If no thickness map is defined, this value will be used to simulate thickness.
  116293. */
  116294. minimumThickness: number;
  116295. /**
  116296. * Defines the maximum thickness stored in the thickness map.
  116297. */
  116298. maximumThickness: number;
  116299. /**
  116300. * Defines the volume tint of the material.
  116301. * This is used for both translucency and scattering.
  116302. */
  116303. tintColor: Color3;
  116304. /**
  116305. * Defines the distance at which the tint color should be found in the media.
  116306. * This is used for refraction only.
  116307. */
  116308. tintColorAtDistance: number;
  116309. /**
  116310. * Defines how far each channel transmit through the media.
  116311. * It is defined as a color to simplify it selection.
  116312. */
  116313. diffusionDistance: Color3;
  116314. private _useMaskFromThicknessTexture;
  116315. /**
  116316. * Stores the intensity of the different subsurface effects in the thickness texture.
  116317. * * the green channel is the translucency intensity.
  116318. * * the blue channel is the scattering intensity.
  116319. * * the alpha channel is the refraction intensity.
  116320. */
  116321. useMaskFromThicknessTexture: boolean;
  116322. /** @hidden */
  116323. private _internalMarkAllSubMeshesAsTexturesDirty;
  116324. /** @hidden */
  116325. _markAllSubMeshesAsTexturesDirty(): void;
  116326. /**
  116327. * Instantiate a new istance of sub surface configuration.
  116328. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  116329. */
  116330. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  116331. /**
  116332. * Gets wehter the submesh is ready to be used or not.
  116333. * @param defines the list of "defines" to update.
  116334. * @param scene defines the scene the material belongs to.
  116335. * @returns - boolean indicating that the submesh is ready or not.
  116336. */
  116337. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  116338. /**
  116339. * Checks to see if a texture is used in the material.
  116340. * @param defines the list of "defines" to update.
  116341. * @param scene defines the scene to the material belongs to.
  116342. */
  116343. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  116344. /**
  116345. * Binds the material data.
  116346. * @param uniformBuffer defines the Uniform buffer to fill in.
  116347. * @param scene defines the scene the material belongs to.
  116348. * @param engine defines the engine the material belongs to.
  116349. * @param isFrozen defines wether the material is frozen or not.
  116350. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  116351. */
  116352. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  116353. /**
  116354. * Unbinds the material from the mesh.
  116355. * @param activeEffect defines the effect that should be unbound from.
  116356. * @returns true if unbound, otherwise false
  116357. */
  116358. unbind(activeEffect: Effect): boolean;
  116359. /**
  116360. * Returns the texture used for refraction or null if none is used.
  116361. * @param scene defines the scene the material belongs to.
  116362. * @returns - Refraction texture if present. If no refraction texture and refraction
  116363. * is linked with transparency, returns environment texture. Otherwise, returns null.
  116364. */
  116365. private _getRefractionTexture;
  116366. /**
  116367. * Returns true if alpha blending should be disabled.
  116368. */
  116369. readonly disableAlphaBlending: boolean;
  116370. /**
  116371. * Fills the list of render target textures.
  116372. * @param renderTargets the list of render targets to update
  116373. */
  116374. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  116375. /**
  116376. * Checks to see if a texture is used in the material.
  116377. * @param texture - Base texture to use.
  116378. * @returns - Boolean specifying if a texture is used in the material.
  116379. */
  116380. hasTexture(texture: BaseTexture): boolean;
  116381. /**
  116382. * Gets a boolean indicating that current material needs to register RTT
  116383. * @returns true if this uses a render target otherwise false.
  116384. */
  116385. hasRenderTargetTextures(): boolean;
  116386. /**
  116387. * Returns an array of the actively used textures.
  116388. * @param activeTextures Array of BaseTextures
  116389. */
  116390. getActiveTextures(activeTextures: BaseTexture[]): void;
  116391. /**
  116392. * Returns the animatable textures.
  116393. * @param animatables Array of animatable textures.
  116394. */
  116395. getAnimatables(animatables: IAnimatable[]): void;
  116396. /**
  116397. * Disposes the resources of the material.
  116398. * @param forceDisposeTextures - Forces the disposal of all textures.
  116399. */
  116400. dispose(forceDisposeTextures?: boolean): void;
  116401. /**
  116402. * Get the current class name of the texture useful for serialization or dynamic coding.
  116403. * @returns "PBRSubSurfaceConfiguration"
  116404. */
  116405. getClassName(): string;
  116406. /**
  116407. * Add fallbacks to the effect fallbacks list.
  116408. * @param defines defines the Base texture to use.
  116409. * @param fallbacks defines the current fallback list.
  116410. * @param currentRank defines the current fallback rank.
  116411. * @returns the new fallback rank.
  116412. */
  116413. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  116414. /**
  116415. * Add the required uniforms to the current list.
  116416. * @param uniforms defines the current uniform list.
  116417. */
  116418. static AddUniforms(uniforms: string[]): void;
  116419. /**
  116420. * Add the required samplers to the current list.
  116421. * @param samplers defines the current sampler list.
  116422. */
  116423. static AddSamplers(samplers: string[]): void;
  116424. /**
  116425. * Add the required uniforms to the current buffer.
  116426. * @param uniformBuffer defines the current uniform buffer.
  116427. */
  116428. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  116429. /**
  116430. * Makes a duplicate of the current configuration into another one.
  116431. * @param configuration define the config where to copy the info
  116432. */
  116433. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  116434. /**
  116435. * Serializes this Sub Surface configuration.
  116436. * @returns - An object with the serialized config.
  116437. */
  116438. serialize(): any;
  116439. /**
  116440. * Parses a anisotropy Configuration from a serialized object.
  116441. * @param source - Serialized object.
  116442. * @param scene Defines the scene we are parsing for
  116443. * @param rootUrl Defines the rootUrl to load from
  116444. */
  116445. parse(source: any, scene: Scene, rootUrl: string): void;
  116446. }
  116447. }
  116448. declare module BABYLON {
  116449. /** @hidden */
  116450. export var pbrFragmentDeclaration: {
  116451. name: string;
  116452. shader: string;
  116453. };
  116454. }
  116455. declare module BABYLON {
  116456. /** @hidden */
  116457. export var pbrUboDeclaration: {
  116458. name: string;
  116459. shader: string;
  116460. };
  116461. }
  116462. declare module BABYLON {
  116463. /** @hidden */
  116464. export var pbrFragmentExtraDeclaration: {
  116465. name: string;
  116466. shader: string;
  116467. };
  116468. }
  116469. declare module BABYLON {
  116470. /** @hidden */
  116471. export var pbrFragmentSamplersDeclaration: {
  116472. name: string;
  116473. shader: string;
  116474. };
  116475. }
  116476. declare module BABYLON {
  116477. /** @hidden */
  116478. export var pbrHelperFunctions: {
  116479. name: string;
  116480. shader: string;
  116481. };
  116482. }
  116483. declare module BABYLON {
  116484. /** @hidden */
  116485. export var harmonicsFunctions: {
  116486. name: string;
  116487. shader: string;
  116488. };
  116489. }
  116490. declare module BABYLON {
  116491. /** @hidden */
  116492. export var pbrDirectLightingSetupFunctions: {
  116493. name: string;
  116494. shader: string;
  116495. };
  116496. }
  116497. declare module BABYLON {
  116498. /** @hidden */
  116499. export var pbrDirectLightingFalloffFunctions: {
  116500. name: string;
  116501. shader: string;
  116502. };
  116503. }
  116504. declare module BABYLON {
  116505. /** @hidden */
  116506. export var pbrBRDFFunctions: {
  116507. name: string;
  116508. shader: string;
  116509. };
  116510. }
  116511. declare module BABYLON {
  116512. /** @hidden */
  116513. export var pbrDirectLightingFunctions: {
  116514. name: string;
  116515. shader: string;
  116516. };
  116517. }
  116518. declare module BABYLON {
  116519. /** @hidden */
  116520. export var pbrIBLFunctions: {
  116521. name: string;
  116522. shader: string;
  116523. };
  116524. }
  116525. declare module BABYLON {
  116526. /** @hidden */
  116527. export var pbrDebug: {
  116528. name: string;
  116529. shader: string;
  116530. };
  116531. }
  116532. declare module BABYLON {
  116533. /** @hidden */
  116534. export var pbrPixelShader: {
  116535. name: string;
  116536. shader: string;
  116537. };
  116538. }
  116539. declare module BABYLON {
  116540. /** @hidden */
  116541. export var pbrVertexDeclaration: {
  116542. name: string;
  116543. shader: string;
  116544. };
  116545. }
  116546. declare module BABYLON {
  116547. /** @hidden */
  116548. export var pbrVertexShader: {
  116549. name: string;
  116550. shader: string;
  116551. };
  116552. }
  116553. declare module BABYLON {
  116554. /**
  116555. * Manages the defines for the PBR Material.
  116556. * @hidden
  116557. */
  116558. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  116559. PBR: boolean;
  116560. MAINUV1: boolean;
  116561. MAINUV2: boolean;
  116562. UV1: boolean;
  116563. UV2: boolean;
  116564. ALBEDO: boolean;
  116565. ALBEDODIRECTUV: number;
  116566. VERTEXCOLOR: boolean;
  116567. AMBIENT: boolean;
  116568. AMBIENTDIRECTUV: number;
  116569. AMBIENTINGRAYSCALE: boolean;
  116570. OPACITY: boolean;
  116571. VERTEXALPHA: boolean;
  116572. OPACITYDIRECTUV: number;
  116573. OPACITYRGB: boolean;
  116574. ALPHATEST: boolean;
  116575. DEPTHPREPASS: boolean;
  116576. ALPHABLEND: boolean;
  116577. ALPHAFROMALBEDO: boolean;
  116578. ALPHATESTVALUE: string;
  116579. SPECULAROVERALPHA: boolean;
  116580. RADIANCEOVERALPHA: boolean;
  116581. ALPHAFRESNEL: boolean;
  116582. LINEARALPHAFRESNEL: boolean;
  116583. PREMULTIPLYALPHA: boolean;
  116584. EMISSIVE: boolean;
  116585. EMISSIVEDIRECTUV: number;
  116586. REFLECTIVITY: boolean;
  116587. REFLECTIVITYDIRECTUV: number;
  116588. SPECULARTERM: boolean;
  116589. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  116590. MICROSURFACEAUTOMATIC: boolean;
  116591. LODBASEDMICROSFURACE: boolean;
  116592. MICROSURFACEMAP: boolean;
  116593. MICROSURFACEMAPDIRECTUV: number;
  116594. METALLICWORKFLOW: boolean;
  116595. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  116596. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  116597. METALLNESSSTOREINMETALMAPBLUE: boolean;
  116598. AOSTOREINMETALMAPRED: boolean;
  116599. METALLICF0FACTORFROMMETALLICMAP: boolean;
  116600. ENVIRONMENTBRDF: boolean;
  116601. ENVIRONMENTBRDF_RGBD: boolean;
  116602. NORMAL: boolean;
  116603. TANGENT: boolean;
  116604. BUMP: boolean;
  116605. BUMPDIRECTUV: number;
  116606. OBJECTSPACE_NORMALMAP: boolean;
  116607. PARALLAX: boolean;
  116608. PARALLAXOCCLUSION: boolean;
  116609. NORMALXYSCALE: boolean;
  116610. LIGHTMAP: boolean;
  116611. LIGHTMAPDIRECTUV: number;
  116612. USELIGHTMAPASSHADOWMAP: boolean;
  116613. GAMMALIGHTMAP: boolean;
  116614. RGBDLIGHTMAP: boolean;
  116615. REFLECTION: boolean;
  116616. REFLECTIONMAP_3D: boolean;
  116617. REFLECTIONMAP_SPHERICAL: boolean;
  116618. REFLECTIONMAP_PLANAR: boolean;
  116619. REFLECTIONMAP_CUBIC: boolean;
  116620. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  116621. REFLECTIONMAP_PROJECTION: boolean;
  116622. REFLECTIONMAP_SKYBOX: boolean;
  116623. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  116624. REFLECTIONMAP_EXPLICIT: boolean;
  116625. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  116626. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  116627. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  116628. INVERTCUBICMAP: boolean;
  116629. USESPHERICALFROMREFLECTIONMAP: boolean;
  116630. USEIRRADIANCEMAP: boolean;
  116631. SPHERICAL_HARMONICS: boolean;
  116632. USESPHERICALINVERTEX: boolean;
  116633. REFLECTIONMAP_OPPOSITEZ: boolean;
  116634. LODINREFLECTIONALPHA: boolean;
  116635. GAMMAREFLECTION: boolean;
  116636. RGBDREFLECTION: boolean;
  116637. LINEARSPECULARREFLECTION: boolean;
  116638. RADIANCEOCCLUSION: boolean;
  116639. HORIZONOCCLUSION: boolean;
  116640. INSTANCES: boolean;
  116641. NUM_BONE_INFLUENCERS: number;
  116642. BonesPerMesh: number;
  116643. BONETEXTURE: boolean;
  116644. NONUNIFORMSCALING: boolean;
  116645. MORPHTARGETS: boolean;
  116646. MORPHTARGETS_NORMAL: boolean;
  116647. MORPHTARGETS_TANGENT: boolean;
  116648. MORPHTARGETS_UV: boolean;
  116649. NUM_MORPH_INFLUENCERS: number;
  116650. IMAGEPROCESSING: boolean;
  116651. VIGNETTE: boolean;
  116652. VIGNETTEBLENDMODEMULTIPLY: boolean;
  116653. VIGNETTEBLENDMODEOPAQUE: boolean;
  116654. TONEMAPPING: boolean;
  116655. TONEMAPPING_ACES: boolean;
  116656. CONTRAST: boolean;
  116657. COLORCURVES: boolean;
  116658. COLORGRADING: boolean;
  116659. COLORGRADING3D: boolean;
  116660. SAMPLER3DGREENDEPTH: boolean;
  116661. SAMPLER3DBGRMAP: boolean;
  116662. IMAGEPROCESSINGPOSTPROCESS: boolean;
  116663. EXPOSURE: boolean;
  116664. MULTIVIEW: boolean;
  116665. USEPHYSICALLIGHTFALLOFF: boolean;
  116666. USEGLTFLIGHTFALLOFF: boolean;
  116667. TWOSIDEDLIGHTING: boolean;
  116668. SHADOWFLOAT: boolean;
  116669. CLIPPLANE: boolean;
  116670. CLIPPLANE2: boolean;
  116671. CLIPPLANE3: boolean;
  116672. CLIPPLANE4: boolean;
  116673. POINTSIZE: boolean;
  116674. FOG: boolean;
  116675. LOGARITHMICDEPTH: boolean;
  116676. FORCENORMALFORWARD: boolean;
  116677. SPECULARAA: boolean;
  116678. CLEARCOAT: boolean;
  116679. CLEARCOAT_DEFAULTIOR: boolean;
  116680. CLEARCOAT_TEXTURE: boolean;
  116681. CLEARCOAT_TEXTUREDIRECTUV: number;
  116682. CLEARCOAT_BUMP: boolean;
  116683. CLEARCOAT_BUMPDIRECTUV: number;
  116684. CLEARCOAT_TINT: boolean;
  116685. CLEARCOAT_TINT_TEXTURE: boolean;
  116686. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  116687. ANISOTROPIC: boolean;
  116688. ANISOTROPIC_TEXTURE: boolean;
  116689. ANISOTROPIC_TEXTUREDIRECTUV: number;
  116690. BRDF_V_HEIGHT_CORRELATED: boolean;
  116691. MS_BRDF_ENERGY_CONSERVATION: boolean;
  116692. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  116693. SHEEN: boolean;
  116694. SHEEN_TEXTURE: boolean;
  116695. SHEEN_TEXTUREDIRECTUV: number;
  116696. SHEEN_LINKWITHALBEDO: boolean;
  116697. SUBSURFACE: boolean;
  116698. SS_REFRACTION: boolean;
  116699. SS_TRANSLUCENCY: boolean;
  116700. SS_SCATERRING: boolean;
  116701. SS_THICKNESSANDMASK_TEXTURE: boolean;
  116702. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  116703. SS_REFRACTIONMAP_3D: boolean;
  116704. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  116705. SS_LODINREFRACTIONALPHA: boolean;
  116706. SS_GAMMAREFRACTION: boolean;
  116707. SS_RGBDREFRACTION: boolean;
  116708. SS_LINEARSPECULARREFRACTION: boolean;
  116709. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  116710. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  116711. UNLIT: boolean;
  116712. DEBUGMODE: number;
  116713. /**
  116714. * Initializes the PBR Material defines.
  116715. */
  116716. constructor();
  116717. /**
  116718. * Resets the PBR Material defines.
  116719. */
  116720. reset(): void;
  116721. }
  116722. /**
  116723. * The Physically based material base class of BJS.
  116724. *
  116725. * This offers the main features of a standard PBR material.
  116726. * For more information, please refer to the documentation :
  116727. * https://doc.babylonjs.com/how_to/physically_based_rendering
  116728. */
  116729. export abstract class PBRBaseMaterial extends PushMaterial {
  116730. /**
  116731. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  116732. */
  116733. static readonly PBRMATERIAL_OPAQUE: number;
  116734. /**
  116735. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  116736. */
  116737. static readonly PBRMATERIAL_ALPHATEST: number;
  116738. /**
  116739. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116740. */
  116741. static readonly PBRMATERIAL_ALPHABLEND: number;
  116742. /**
  116743. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116744. * They are also discarded below the alpha cutoff threshold to improve performances.
  116745. */
  116746. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  116747. /**
  116748. * Defines the default value of how much AO map is occluding the analytical lights
  116749. * (point spot...).
  116750. */
  116751. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  116752. /**
  116753. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  116754. */
  116755. static readonly LIGHTFALLOFF_PHYSICAL: number;
  116756. /**
  116757. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  116758. * to enhance interoperability with other engines.
  116759. */
  116760. static readonly LIGHTFALLOFF_GLTF: number;
  116761. /**
  116762. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  116763. * to enhance interoperability with other materials.
  116764. */
  116765. static readonly LIGHTFALLOFF_STANDARD: number;
  116766. /**
  116767. * Intensity of the direct lights e.g. the four lights available in your scene.
  116768. * This impacts both the direct diffuse and specular highlights.
  116769. */
  116770. protected _directIntensity: number;
  116771. /**
  116772. * Intensity of the emissive part of the material.
  116773. * This helps controlling the emissive effect without modifying the emissive color.
  116774. */
  116775. protected _emissiveIntensity: number;
  116776. /**
  116777. * Intensity of the environment e.g. how much the environment will light the object
  116778. * either through harmonics for rough material or through the refelction for shiny ones.
  116779. */
  116780. protected _environmentIntensity: number;
  116781. /**
  116782. * This is a special control allowing the reduction of the specular highlights coming from the
  116783. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  116784. */
  116785. protected _specularIntensity: number;
  116786. /**
  116787. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  116788. */
  116789. private _lightingInfos;
  116790. /**
  116791. * Debug Control allowing disabling the bump map on this material.
  116792. */
  116793. protected _disableBumpMap: boolean;
  116794. /**
  116795. * AKA Diffuse Texture in standard nomenclature.
  116796. */
  116797. protected _albedoTexture: Nullable<BaseTexture>;
  116798. /**
  116799. * AKA Occlusion Texture in other nomenclature.
  116800. */
  116801. protected _ambientTexture: Nullable<BaseTexture>;
  116802. /**
  116803. * AKA Occlusion Texture Intensity in other nomenclature.
  116804. */
  116805. protected _ambientTextureStrength: number;
  116806. /**
  116807. * Defines how much the AO map is occluding the analytical lights (point spot...).
  116808. * 1 means it completely occludes it
  116809. * 0 mean it has no impact
  116810. */
  116811. protected _ambientTextureImpactOnAnalyticalLights: number;
  116812. /**
  116813. * Stores the alpha values in a texture.
  116814. */
  116815. protected _opacityTexture: Nullable<BaseTexture>;
  116816. /**
  116817. * Stores the reflection values in a texture.
  116818. */
  116819. protected _reflectionTexture: Nullable<BaseTexture>;
  116820. /**
  116821. * Stores the emissive values in a texture.
  116822. */
  116823. protected _emissiveTexture: Nullable<BaseTexture>;
  116824. /**
  116825. * AKA Specular texture in other nomenclature.
  116826. */
  116827. protected _reflectivityTexture: Nullable<BaseTexture>;
  116828. /**
  116829. * Used to switch from specular/glossiness to metallic/roughness workflow.
  116830. */
  116831. protected _metallicTexture: Nullable<BaseTexture>;
  116832. /**
  116833. * Specifies the metallic scalar of the metallic/roughness workflow.
  116834. * Can also be used to scale the metalness values of the metallic texture.
  116835. */
  116836. protected _metallic: Nullable<number>;
  116837. /**
  116838. * Specifies the roughness scalar of the metallic/roughness workflow.
  116839. * Can also be used to scale the roughness values of the metallic texture.
  116840. */
  116841. protected _roughness: Nullable<number>;
  116842. /**
  116843. * Specifies the an F0 factor to help configuring the material F0.
  116844. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  116845. * to 0.5 the previously hard coded value stays the same.
  116846. * Can also be used to scale the F0 values of the metallic texture.
  116847. */
  116848. protected _metallicF0Factor: number;
  116849. /**
  116850. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  116851. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  116852. * your expectation as it multiplies with the texture data.
  116853. */
  116854. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  116855. /**
  116856. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  116857. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  116858. */
  116859. protected _microSurfaceTexture: Nullable<BaseTexture>;
  116860. /**
  116861. * Stores surface normal data used to displace a mesh in a texture.
  116862. */
  116863. protected _bumpTexture: Nullable<BaseTexture>;
  116864. /**
  116865. * Stores the pre-calculated light information of a mesh in a texture.
  116866. */
  116867. protected _lightmapTexture: Nullable<BaseTexture>;
  116868. /**
  116869. * The color of a material in ambient lighting.
  116870. */
  116871. protected _ambientColor: Color3;
  116872. /**
  116873. * AKA Diffuse Color in other nomenclature.
  116874. */
  116875. protected _albedoColor: Color3;
  116876. /**
  116877. * AKA Specular Color in other nomenclature.
  116878. */
  116879. protected _reflectivityColor: Color3;
  116880. /**
  116881. * The color applied when light is reflected from a material.
  116882. */
  116883. protected _reflectionColor: Color3;
  116884. /**
  116885. * The color applied when light is emitted from a material.
  116886. */
  116887. protected _emissiveColor: Color3;
  116888. /**
  116889. * AKA Glossiness in other nomenclature.
  116890. */
  116891. protected _microSurface: number;
  116892. /**
  116893. * Specifies that the material will use the light map as a show map.
  116894. */
  116895. protected _useLightmapAsShadowmap: boolean;
  116896. /**
  116897. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  116898. * makes the reflect vector face the model (under horizon).
  116899. */
  116900. protected _useHorizonOcclusion: boolean;
  116901. /**
  116902. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  116903. * too much the area relying on ambient texture to define their ambient occlusion.
  116904. */
  116905. protected _useRadianceOcclusion: boolean;
  116906. /**
  116907. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  116908. */
  116909. protected _useAlphaFromAlbedoTexture: boolean;
  116910. /**
  116911. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  116912. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  116913. */
  116914. protected _useSpecularOverAlpha: boolean;
  116915. /**
  116916. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  116917. */
  116918. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  116919. /**
  116920. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  116921. */
  116922. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  116923. /**
  116924. * Specifies if the metallic texture contains the roughness information in its green channel.
  116925. */
  116926. protected _useRoughnessFromMetallicTextureGreen: boolean;
  116927. /**
  116928. * Specifies if the metallic texture contains the metallness information in its blue channel.
  116929. */
  116930. protected _useMetallnessFromMetallicTextureBlue: boolean;
  116931. /**
  116932. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  116933. */
  116934. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  116935. /**
  116936. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  116937. */
  116938. protected _useAmbientInGrayScale: boolean;
  116939. /**
  116940. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  116941. * The material will try to infer what glossiness each pixel should be.
  116942. */
  116943. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  116944. /**
  116945. * Defines the falloff type used in this material.
  116946. * It by default is Physical.
  116947. */
  116948. protected _lightFalloff: number;
  116949. /**
  116950. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  116951. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  116952. */
  116953. protected _useRadianceOverAlpha: boolean;
  116954. /**
  116955. * Allows using an object space normal map (instead of tangent space).
  116956. */
  116957. protected _useObjectSpaceNormalMap: boolean;
  116958. /**
  116959. * Allows using the bump map in parallax mode.
  116960. */
  116961. protected _useParallax: boolean;
  116962. /**
  116963. * Allows using the bump map in parallax occlusion mode.
  116964. */
  116965. protected _useParallaxOcclusion: boolean;
  116966. /**
  116967. * Controls the scale bias of the parallax mode.
  116968. */
  116969. protected _parallaxScaleBias: number;
  116970. /**
  116971. * If sets to true, disables all the lights affecting the material.
  116972. */
  116973. protected _disableLighting: boolean;
  116974. /**
  116975. * Number of Simultaneous lights allowed on the material.
  116976. */
  116977. protected _maxSimultaneousLights: number;
  116978. /**
  116979. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  116980. */
  116981. protected _invertNormalMapX: boolean;
  116982. /**
  116983. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  116984. */
  116985. protected _invertNormalMapY: boolean;
  116986. /**
  116987. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116988. */
  116989. protected _twoSidedLighting: boolean;
  116990. /**
  116991. * Defines the alpha limits in alpha test mode.
  116992. */
  116993. protected _alphaCutOff: number;
  116994. /**
  116995. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  116996. */
  116997. protected _forceAlphaTest: boolean;
  116998. /**
  116999. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  117000. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  117001. */
  117002. protected _useAlphaFresnel: boolean;
  117003. /**
  117004. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  117005. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  117006. */
  117007. protected _useLinearAlphaFresnel: boolean;
  117008. /**
  117009. * The transparency mode of the material.
  117010. */
  117011. protected _transparencyMode: Nullable<number>;
  117012. /**
  117013. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  117014. * from cos thetav and roughness:
  117015. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  117016. */
  117017. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  117018. /**
  117019. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  117020. */
  117021. protected _forceIrradianceInFragment: boolean;
  117022. /**
  117023. * Force normal to face away from face.
  117024. */
  117025. protected _forceNormalForward: boolean;
  117026. /**
  117027. * Enables specular anti aliasing in the PBR shader.
  117028. * It will both interacts on the Geometry for analytical and IBL lighting.
  117029. * It also prefilter the roughness map based on the bump values.
  117030. */
  117031. protected _enableSpecularAntiAliasing: boolean;
  117032. /**
  117033. * Default configuration related to image processing available in the PBR Material.
  117034. */
  117035. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  117036. /**
  117037. * Keep track of the image processing observer to allow dispose and replace.
  117038. */
  117039. private _imageProcessingObserver;
  117040. /**
  117041. * Attaches a new image processing configuration to the PBR Material.
  117042. * @param configuration
  117043. */
  117044. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  117045. /**
  117046. * Stores the available render targets.
  117047. */
  117048. private _renderTargets;
  117049. /**
  117050. * Sets the global ambient color for the material used in lighting calculations.
  117051. */
  117052. private _globalAmbientColor;
  117053. /**
  117054. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  117055. */
  117056. private _useLogarithmicDepth;
  117057. /**
  117058. * If set to true, no lighting calculations will be applied.
  117059. */
  117060. private _unlit;
  117061. private _debugMode;
  117062. /**
  117063. * @hidden
  117064. * This is reserved for the inspector.
  117065. * Defines the material debug mode.
  117066. * It helps seeing only some components of the material while troubleshooting.
  117067. */
  117068. debugMode: number;
  117069. /**
  117070. * @hidden
  117071. * This is reserved for the inspector.
  117072. * Specify from where on screen the debug mode should start.
  117073. * The value goes from -1 (full screen) to 1 (not visible)
  117074. * It helps with side by side comparison against the final render
  117075. * This defaults to -1
  117076. */
  117077. private debugLimit;
  117078. /**
  117079. * @hidden
  117080. * This is reserved for the inspector.
  117081. * As the default viewing range might not be enough (if the ambient is really small for instance)
  117082. * You can use the factor to better multiply the final value.
  117083. */
  117084. private debugFactor;
  117085. /**
  117086. * Defines the clear coat layer parameters for the material.
  117087. */
  117088. readonly clearCoat: PBRClearCoatConfiguration;
  117089. /**
  117090. * Defines the anisotropic parameters for the material.
  117091. */
  117092. readonly anisotropy: PBRAnisotropicConfiguration;
  117093. /**
  117094. * Defines the BRDF parameters for the material.
  117095. */
  117096. readonly brdf: PBRBRDFConfiguration;
  117097. /**
  117098. * Defines the Sheen parameters for the material.
  117099. */
  117100. readonly sheen: PBRSheenConfiguration;
  117101. /**
  117102. * Defines the SubSurface parameters for the material.
  117103. */
  117104. readonly subSurface: PBRSubSurfaceConfiguration;
  117105. /**
  117106. * Custom callback helping to override the default shader used in the material.
  117107. */
  117108. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  117109. protected _rebuildInParallel: boolean;
  117110. /**
  117111. * Instantiates a new PBRMaterial instance.
  117112. *
  117113. * @param name The material name
  117114. * @param scene The scene the material will be use in.
  117115. */
  117116. constructor(name: string, scene: Scene);
  117117. /**
  117118. * Gets a boolean indicating that current material needs to register RTT
  117119. */
  117120. readonly hasRenderTargetTextures: boolean;
  117121. /**
  117122. * Gets the name of the material class.
  117123. */
  117124. getClassName(): string;
  117125. /**
  117126. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  117127. */
  117128. /**
  117129. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  117130. */
  117131. useLogarithmicDepth: boolean;
  117132. /**
  117133. * Gets the current transparency mode.
  117134. */
  117135. /**
  117136. * Sets the transparency mode of the material.
  117137. *
  117138. * | Value | Type | Description |
  117139. * | ----- | ----------------------------------- | ----------- |
  117140. * | 0 | OPAQUE | |
  117141. * | 1 | ALPHATEST | |
  117142. * | 2 | ALPHABLEND | |
  117143. * | 3 | ALPHATESTANDBLEND | |
  117144. *
  117145. */
  117146. transparencyMode: Nullable<number>;
  117147. /**
  117148. * Returns true if alpha blending should be disabled.
  117149. */
  117150. private readonly _disableAlphaBlending;
  117151. /**
  117152. * Specifies whether or not this material should be rendered in alpha blend mode.
  117153. */
  117154. needAlphaBlending(): boolean;
  117155. /**
  117156. * Specifies if the mesh will require alpha blending.
  117157. * @param mesh - BJS mesh.
  117158. */
  117159. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  117160. /**
  117161. * Specifies whether or not this material should be rendered in alpha test mode.
  117162. */
  117163. needAlphaTesting(): boolean;
  117164. /**
  117165. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  117166. */
  117167. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  117168. /**
  117169. * Gets the texture used for the alpha test.
  117170. */
  117171. getAlphaTestTexture(): Nullable<BaseTexture>;
  117172. /**
  117173. * Specifies that the submesh is ready to be used.
  117174. * @param mesh - BJS mesh.
  117175. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  117176. * @param useInstances - Specifies that instances should be used.
  117177. * @returns - boolean indicating that the submesh is ready or not.
  117178. */
  117179. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  117180. /**
  117181. * Specifies if the material uses metallic roughness workflow.
  117182. * @returns boolean specifiying if the material uses metallic roughness workflow.
  117183. */
  117184. isMetallicWorkflow(): boolean;
  117185. private _prepareEffect;
  117186. private _prepareDefines;
  117187. /**
  117188. * Force shader compilation
  117189. */
  117190. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  117191. /**
  117192. * Initializes the uniform buffer layout for the shader.
  117193. */
  117194. buildUniformLayout(): void;
  117195. /**
  117196. * Unbinds the material from the mesh
  117197. */
  117198. unbind(): void;
  117199. /**
  117200. * Binds the submesh data.
  117201. * @param world - The world matrix.
  117202. * @param mesh - The BJS mesh.
  117203. * @param subMesh - A submesh of the BJS mesh.
  117204. */
  117205. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  117206. /**
  117207. * Returns the animatable textures.
  117208. * @returns - Array of animatable textures.
  117209. */
  117210. getAnimatables(): IAnimatable[];
  117211. /**
  117212. * Returns the texture used for reflections.
  117213. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  117214. */
  117215. private _getReflectionTexture;
  117216. /**
  117217. * Returns an array of the actively used textures.
  117218. * @returns - Array of BaseTextures
  117219. */
  117220. getActiveTextures(): BaseTexture[];
  117221. /**
  117222. * Checks to see if a texture is used in the material.
  117223. * @param texture - Base texture to use.
  117224. * @returns - Boolean specifying if a texture is used in the material.
  117225. */
  117226. hasTexture(texture: BaseTexture): boolean;
  117227. /**
  117228. * Disposes the resources of the material.
  117229. * @param forceDisposeEffect - Forces the disposal of effects.
  117230. * @param forceDisposeTextures - Forces the disposal of all textures.
  117231. */
  117232. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  117233. }
  117234. }
  117235. declare module BABYLON {
  117236. /**
  117237. * The Physically based material of BJS.
  117238. *
  117239. * This offers the main features of a standard PBR material.
  117240. * For more information, please refer to the documentation :
  117241. * https://doc.babylonjs.com/how_to/physically_based_rendering
  117242. */
  117243. export class PBRMaterial extends PBRBaseMaterial {
  117244. /**
  117245. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  117246. */
  117247. static readonly PBRMATERIAL_OPAQUE: number;
  117248. /**
  117249. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  117250. */
  117251. static readonly PBRMATERIAL_ALPHATEST: number;
  117252. /**
  117253. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  117254. */
  117255. static readonly PBRMATERIAL_ALPHABLEND: number;
  117256. /**
  117257. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  117258. * They are also discarded below the alpha cutoff threshold to improve performances.
  117259. */
  117260. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  117261. /**
  117262. * Defines the default value of how much AO map is occluding the analytical lights
  117263. * (point spot...).
  117264. */
  117265. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  117266. /**
  117267. * Intensity of the direct lights e.g. the four lights available in your scene.
  117268. * This impacts both the direct diffuse and specular highlights.
  117269. */
  117270. directIntensity: number;
  117271. /**
  117272. * Intensity of the emissive part of the material.
  117273. * This helps controlling the emissive effect without modifying the emissive color.
  117274. */
  117275. emissiveIntensity: number;
  117276. /**
  117277. * Intensity of the environment e.g. how much the environment will light the object
  117278. * either through harmonics for rough material or through the refelction for shiny ones.
  117279. */
  117280. environmentIntensity: number;
  117281. /**
  117282. * This is a special control allowing the reduction of the specular highlights coming from the
  117283. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  117284. */
  117285. specularIntensity: number;
  117286. /**
  117287. * Debug Control allowing disabling the bump map on this material.
  117288. */
  117289. disableBumpMap: boolean;
  117290. /**
  117291. * AKA Diffuse Texture in standard nomenclature.
  117292. */
  117293. albedoTexture: BaseTexture;
  117294. /**
  117295. * AKA Occlusion Texture in other nomenclature.
  117296. */
  117297. ambientTexture: BaseTexture;
  117298. /**
  117299. * AKA Occlusion Texture Intensity in other nomenclature.
  117300. */
  117301. ambientTextureStrength: number;
  117302. /**
  117303. * Defines how much the AO map is occluding the analytical lights (point spot...).
  117304. * 1 means it completely occludes it
  117305. * 0 mean it has no impact
  117306. */
  117307. ambientTextureImpactOnAnalyticalLights: number;
  117308. /**
  117309. * Stores the alpha values in a texture.
  117310. */
  117311. opacityTexture: BaseTexture;
  117312. /**
  117313. * Stores the reflection values in a texture.
  117314. */
  117315. reflectionTexture: Nullable<BaseTexture>;
  117316. /**
  117317. * Stores the emissive values in a texture.
  117318. */
  117319. emissiveTexture: BaseTexture;
  117320. /**
  117321. * AKA Specular texture in other nomenclature.
  117322. */
  117323. reflectivityTexture: BaseTexture;
  117324. /**
  117325. * Used to switch from specular/glossiness to metallic/roughness workflow.
  117326. */
  117327. metallicTexture: BaseTexture;
  117328. /**
  117329. * Specifies the metallic scalar of the metallic/roughness workflow.
  117330. * Can also be used to scale the metalness values of the metallic texture.
  117331. */
  117332. metallic: Nullable<number>;
  117333. /**
  117334. * Specifies the roughness scalar of the metallic/roughness workflow.
  117335. * Can also be used to scale the roughness values of the metallic texture.
  117336. */
  117337. roughness: Nullable<number>;
  117338. /**
  117339. * Specifies the an F0 factor to help configuring the material F0.
  117340. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  117341. * to 0.5 the previously hard coded value stays the same.
  117342. * Can also be used to scale the F0 values of the metallic texture.
  117343. */
  117344. metallicF0Factor: number;
  117345. /**
  117346. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  117347. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  117348. * your expectation as it multiplies with the texture data.
  117349. */
  117350. useMetallicF0FactorFromMetallicTexture: boolean;
  117351. /**
  117352. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  117353. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  117354. */
  117355. microSurfaceTexture: BaseTexture;
  117356. /**
  117357. * Stores surface normal data used to displace a mesh in a texture.
  117358. */
  117359. bumpTexture: BaseTexture;
  117360. /**
  117361. * Stores the pre-calculated light information of a mesh in a texture.
  117362. */
  117363. lightmapTexture: BaseTexture;
  117364. /**
  117365. * Stores the refracted light information in a texture.
  117366. */
  117367. refractionTexture: Nullable<BaseTexture>;
  117368. /**
  117369. * The color of a material in ambient lighting.
  117370. */
  117371. ambientColor: Color3;
  117372. /**
  117373. * AKA Diffuse Color in other nomenclature.
  117374. */
  117375. albedoColor: Color3;
  117376. /**
  117377. * AKA Specular Color in other nomenclature.
  117378. */
  117379. reflectivityColor: Color3;
  117380. /**
  117381. * The color reflected from the material.
  117382. */
  117383. reflectionColor: Color3;
  117384. /**
  117385. * The color emitted from the material.
  117386. */
  117387. emissiveColor: Color3;
  117388. /**
  117389. * AKA Glossiness in other nomenclature.
  117390. */
  117391. microSurface: number;
  117392. /**
  117393. * source material index of refraction (IOR)' / 'destination material IOR.
  117394. */
  117395. indexOfRefraction: number;
  117396. /**
  117397. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  117398. */
  117399. invertRefractionY: boolean;
  117400. /**
  117401. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  117402. * Materials half opaque for instance using refraction could benefit from this control.
  117403. */
  117404. linkRefractionWithTransparency: boolean;
  117405. /**
  117406. * If true, the light map contains occlusion information instead of lighting info.
  117407. */
  117408. useLightmapAsShadowmap: boolean;
  117409. /**
  117410. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  117411. */
  117412. useAlphaFromAlbedoTexture: boolean;
  117413. /**
  117414. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  117415. */
  117416. forceAlphaTest: boolean;
  117417. /**
  117418. * Defines the alpha limits in alpha test mode.
  117419. */
  117420. alphaCutOff: number;
  117421. /**
  117422. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  117423. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  117424. */
  117425. useSpecularOverAlpha: boolean;
  117426. /**
  117427. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  117428. */
  117429. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  117430. /**
  117431. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  117432. */
  117433. useRoughnessFromMetallicTextureAlpha: boolean;
  117434. /**
  117435. * Specifies if the metallic texture contains the roughness information in its green channel.
  117436. */
  117437. useRoughnessFromMetallicTextureGreen: boolean;
  117438. /**
  117439. * Specifies if the metallic texture contains the metallness information in its blue channel.
  117440. */
  117441. useMetallnessFromMetallicTextureBlue: boolean;
  117442. /**
  117443. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  117444. */
  117445. useAmbientOcclusionFromMetallicTextureRed: boolean;
  117446. /**
  117447. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  117448. */
  117449. useAmbientInGrayScale: boolean;
  117450. /**
  117451. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  117452. * The material will try to infer what glossiness each pixel should be.
  117453. */
  117454. useAutoMicroSurfaceFromReflectivityMap: boolean;
  117455. /**
  117456. * BJS is using an harcoded light falloff based on a manually sets up range.
  117457. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  117458. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  117459. */
  117460. /**
  117461. * BJS is using an harcoded light falloff based on a manually sets up range.
  117462. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  117463. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  117464. */
  117465. usePhysicalLightFalloff: boolean;
  117466. /**
  117467. * In order to support the falloff compatibility with gltf, a special mode has been added
  117468. * to reproduce the gltf light falloff.
  117469. */
  117470. /**
  117471. * In order to support the falloff compatibility with gltf, a special mode has been added
  117472. * to reproduce the gltf light falloff.
  117473. */
  117474. useGLTFLightFalloff: boolean;
  117475. /**
  117476. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  117477. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  117478. */
  117479. useRadianceOverAlpha: boolean;
  117480. /**
  117481. * Allows using an object space normal map (instead of tangent space).
  117482. */
  117483. useObjectSpaceNormalMap: boolean;
  117484. /**
  117485. * Allows using the bump map in parallax mode.
  117486. */
  117487. useParallax: boolean;
  117488. /**
  117489. * Allows using the bump map in parallax occlusion mode.
  117490. */
  117491. useParallaxOcclusion: boolean;
  117492. /**
  117493. * Controls the scale bias of the parallax mode.
  117494. */
  117495. parallaxScaleBias: number;
  117496. /**
  117497. * If sets to true, disables all the lights affecting the material.
  117498. */
  117499. disableLighting: boolean;
  117500. /**
  117501. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  117502. */
  117503. forceIrradianceInFragment: boolean;
  117504. /**
  117505. * Number of Simultaneous lights allowed on the material.
  117506. */
  117507. maxSimultaneousLights: number;
  117508. /**
  117509. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  117510. */
  117511. invertNormalMapX: boolean;
  117512. /**
  117513. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  117514. */
  117515. invertNormalMapY: boolean;
  117516. /**
  117517. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  117518. */
  117519. twoSidedLighting: boolean;
  117520. /**
  117521. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  117522. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  117523. */
  117524. useAlphaFresnel: boolean;
  117525. /**
  117526. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  117527. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  117528. */
  117529. useLinearAlphaFresnel: boolean;
  117530. /**
  117531. * Let user defines the brdf lookup texture used for IBL.
  117532. * A default 8bit version is embedded but you could point at :
  117533. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  117534. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  117535. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  117536. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  117537. */
  117538. environmentBRDFTexture: Nullable<BaseTexture>;
  117539. /**
  117540. * Force normal to face away from face.
  117541. */
  117542. forceNormalForward: boolean;
  117543. /**
  117544. * Enables specular anti aliasing in the PBR shader.
  117545. * It will both interacts on the Geometry for analytical and IBL lighting.
  117546. * It also prefilter the roughness map based on the bump values.
  117547. */
  117548. enableSpecularAntiAliasing: boolean;
  117549. /**
  117550. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  117551. * makes the reflect vector face the model (under horizon).
  117552. */
  117553. useHorizonOcclusion: boolean;
  117554. /**
  117555. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  117556. * too much the area relying on ambient texture to define their ambient occlusion.
  117557. */
  117558. useRadianceOcclusion: boolean;
  117559. /**
  117560. * If set to true, no lighting calculations will be applied.
  117561. */
  117562. unlit: boolean;
  117563. /**
  117564. * Gets the image processing configuration used either in this material.
  117565. */
  117566. /**
  117567. * Sets the Default image processing configuration used either in the this material.
  117568. *
  117569. * If sets to null, the scene one is in use.
  117570. */
  117571. imageProcessingConfiguration: ImageProcessingConfiguration;
  117572. /**
  117573. * Gets wether the color curves effect is enabled.
  117574. */
  117575. /**
  117576. * Sets wether the color curves effect is enabled.
  117577. */
  117578. cameraColorCurvesEnabled: boolean;
  117579. /**
  117580. * Gets wether the color grading effect is enabled.
  117581. */
  117582. /**
  117583. * Gets wether the color grading effect is enabled.
  117584. */
  117585. cameraColorGradingEnabled: boolean;
  117586. /**
  117587. * Gets wether tonemapping is enabled or not.
  117588. */
  117589. /**
  117590. * Sets wether tonemapping is enabled or not
  117591. */
  117592. cameraToneMappingEnabled: boolean;
  117593. /**
  117594. * The camera exposure used on this material.
  117595. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  117596. * This corresponds to a photographic exposure.
  117597. */
  117598. /**
  117599. * The camera exposure used on this material.
  117600. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  117601. * This corresponds to a photographic exposure.
  117602. */
  117603. cameraExposure: number;
  117604. /**
  117605. * Gets The camera contrast used on this material.
  117606. */
  117607. /**
  117608. * Sets The camera contrast used on this material.
  117609. */
  117610. cameraContrast: number;
  117611. /**
  117612. * Gets the Color Grading 2D Lookup Texture.
  117613. */
  117614. /**
  117615. * Sets the Color Grading 2D Lookup Texture.
  117616. */
  117617. cameraColorGradingTexture: Nullable<BaseTexture>;
  117618. /**
  117619. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  117620. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  117621. * 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;
  117622. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  117623. */
  117624. /**
  117625. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  117626. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  117627. * 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;
  117628. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  117629. */
  117630. cameraColorCurves: Nullable<ColorCurves>;
  117631. /**
  117632. * Instantiates a new PBRMaterial instance.
  117633. *
  117634. * @param name The material name
  117635. * @param scene The scene the material will be use in.
  117636. */
  117637. constructor(name: string, scene: Scene);
  117638. /**
  117639. * Returns the name of this material class.
  117640. */
  117641. getClassName(): string;
  117642. /**
  117643. * Makes a duplicate of the current material.
  117644. * @param name - name to use for the new material.
  117645. */
  117646. clone(name: string): PBRMaterial;
  117647. /**
  117648. * Serializes this PBR Material.
  117649. * @returns - An object with the serialized material.
  117650. */
  117651. serialize(): any;
  117652. /**
  117653. * Parses a PBR Material from a serialized object.
  117654. * @param source - Serialized object.
  117655. * @param scene - BJS scene instance.
  117656. * @param rootUrl - url for the scene object
  117657. * @returns - PBRMaterial
  117658. */
  117659. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  117660. }
  117661. }
  117662. declare module BABYLON {
  117663. /**
  117664. * Direct draw surface info
  117665. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  117666. */
  117667. export interface DDSInfo {
  117668. /**
  117669. * Width of the texture
  117670. */
  117671. width: number;
  117672. /**
  117673. * Width of the texture
  117674. */
  117675. height: number;
  117676. /**
  117677. * Number of Mipmaps for the texture
  117678. * @see https://en.wikipedia.org/wiki/Mipmap
  117679. */
  117680. mipmapCount: number;
  117681. /**
  117682. * If the textures format is a known fourCC format
  117683. * @see https://www.fourcc.org/
  117684. */
  117685. isFourCC: boolean;
  117686. /**
  117687. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  117688. */
  117689. isRGB: boolean;
  117690. /**
  117691. * If the texture is a lumincance format
  117692. */
  117693. isLuminance: boolean;
  117694. /**
  117695. * If this is a cube texture
  117696. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  117697. */
  117698. isCube: boolean;
  117699. /**
  117700. * If the texture is a compressed format eg. FOURCC_DXT1
  117701. */
  117702. isCompressed: boolean;
  117703. /**
  117704. * The dxgiFormat of the texture
  117705. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  117706. */
  117707. dxgiFormat: number;
  117708. /**
  117709. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  117710. */
  117711. textureType: number;
  117712. /**
  117713. * Sphericle polynomial created for the dds texture
  117714. */
  117715. sphericalPolynomial?: SphericalPolynomial;
  117716. }
  117717. /**
  117718. * Class used to provide DDS decompression tools
  117719. */
  117720. export class DDSTools {
  117721. /**
  117722. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  117723. */
  117724. static StoreLODInAlphaChannel: boolean;
  117725. /**
  117726. * Gets DDS information from an array buffer
  117727. * @param arrayBuffer defines the array buffer to read data from
  117728. * @returns the DDS information
  117729. */
  117730. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  117731. private static _FloatView;
  117732. private static _Int32View;
  117733. private static _ToHalfFloat;
  117734. private static _FromHalfFloat;
  117735. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  117736. private static _GetHalfFloatRGBAArrayBuffer;
  117737. private static _GetFloatRGBAArrayBuffer;
  117738. private static _GetFloatAsUIntRGBAArrayBuffer;
  117739. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  117740. private static _GetRGBAArrayBuffer;
  117741. private static _ExtractLongWordOrder;
  117742. private static _GetRGBArrayBuffer;
  117743. private static _GetLuminanceArrayBuffer;
  117744. /**
  117745. * Uploads DDS Levels to a Babylon Texture
  117746. * @hidden
  117747. */
  117748. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  117749. }
  117750. interface ThinEngine {
  117751. /**
  117752. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  117753. * @param rootUrl defines the url where the file to load is located
  117754. * @param scene defines the current scene
  117755. * @param lodScale defines scale to apply to the mip map selection
  117756. * @param lodOffset defines offset to apply to the mip map selection
  117757. * @param onLoad defines an optional callback raised when the texture is loaded
  117758. * @param onError defines an optional callback raised if there is an issue to load the texture
  117759. * @param format defines the format of the data
  117760. * @param forcedExtension defines the extension to use to pick the right loader
  117761. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  117762. * @returns the cube texture as an InternalTexture
  117763. */
  117764. 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;
  117765. }
  117766. }
  117767. declare module BABYLON {
  117768. /**
  117769. * Implementation of the DDS Texture Loader.
  117770. * @hidden
  117771. */
  117772. export class _DDSTextureLoader implements IInternalTextureLoader {
  117773. /**
  117774. * Defines wether the loader supports cascade loading the different faces.
  117775. */
  117776. readonly supportCascades: boolean;
  117777. /**
  117778. * This returns if the loader support the current file information.
  117779. * @param extension defines the file extension of the file being loaded
  117780. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117781. * @param fallback defines the fallback internal texture if any
  117782. * @param isBase64 defines whether the texture is encoded as a base64
  117783. * @param isBuffer defines whether the texture data are stored as a buffer
  117784. * @returns true if the loader can load the specified file
  117785. */
  117786. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117787. /**
  117788. * Transform the url before loading if required.
  117789. * @param rootUrl the url of the texture
  117790. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117791. * @returns the transformed texture
  117792. */
  117793. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117794. /**
  117795. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117796. * @param rootUrl the url of the texture
  117797. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117798. * @returns the fallback texture
  117799. */
  117800. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117801. /**
  117802. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117803. * @param data contains the texture data
  117804. * @param texture defines the BabylonJS internal texture
  117805. * @param createPolynomials will be true if polynomials have been requested
  117806. * @param onLoad defines the callback to trigger once the texture is ready
  117807. * @param onError defines the callback to trigger in case of error
  117808. */
  117809. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117810. /**
  117811. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117812. * @param data contains the texture data
  117813. * @param texture defines the BabylonJS internal texture
  117814. * @param callback defines the method to call once ready to upload
  117815. */
  117816. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117817. }
  117818. }
  117819. declare module BABYLON {
  117820. /**
  117821. * Implementation of the ENV Texture Loader.
  117822. * @hidden
  117823. */
  117824. export class _ENVTextureLoader implements IInternalTextureLoader {
  117825. /**
  117826. * Defines wether the loader supports cascade loading the different faces.
  117827. */
  117828. readonly supportCascades: boolean;
  117829. /**
  117830. * This returns if the loader support the current file information.
  117831. * @param extension defines the file extension of the file being loaded
  117832. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117833. * @param fallback defines the fallback internal texture if any
  117834. * @param isBase64 defines whether the texture is encoded as a base64
  117835. * @param isBuffer defines whether the texture data are stored as a buffer
  117836. * @returns true if the loader can load the specified file
  117837. */
  117838. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117839. /**
  117840. * Transform the url before loading if required.
  117841. * @param rootUrl the url of the texture
  117842. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117843. * @returns the transformed texture
  117844. */
  117845. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117846. /**
  117847. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117848. * @param rootUrl the url of the texture
  117849. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117850. * @returns the fallback texture
  117851. */
  117852. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117853. /**
  117854. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117855. * @param data contains the texture data
  117856. * @param texture defines the BabylonJS internal texture
  117857. * @param createPolynomials will be true if polynomials have been requested
  117858. * @param onLoad defines the callback to trigger once the texture is ready
  117859. * @param onError defines the callback to trigger in case of error
  117860. */
  117861. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117862. /**
  117863. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117864. * @param data contains the texture data
  117865. * @param texture defines the BabylonJS internal texture
  117866. * @param callback defines the method to call once ready to upload
  117867. */
  117868. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117869. }
  117870. }
  117871. declare module BABYLON {
  117872. /**
  117873. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  117874. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  117875. */
  117876. export class KhronosTextureContainer {
  117877. /** contents of the KTX container file */
  117878. arrayBuffer: any;
  117879. private static HEADER_LEN;
  117880. private static COMPRESSED_2D;
  117881. private static COMPRESSED_3D;
  117882. private static TEX_2D;
  117883. private static TEX_3D;
  117884. /**
  117885. * Gets the openGL type
  117886. */
  117887. glType: number;
  117888. /**
  117889. * Gets the openGL type size
  117890. */
  117891. glTypeSize: number;
  117892. /**
  117893. * Gets the openGL format
  117894. */
  117895. glFormat: number;
  117896. /**
  117897. * Gets the openGL internal format
  117898. */
  117899. glInternalFormat: number;
  117900. /**
  117901. * Gets the base internal format
  117902. */
  117903. glBaseInternalFormat: number;
  117904. /**
  117905. * Gets image width in pixel
  117906. */
  117907. pixelWidth: number;
  117908. /**
  117909. * Gets image height in pixel
  117910. */
  117911. pixelHeight: number;
  117912. /**
  117913. * Gets image depth in pixels
  117914. */
  117915. pixelDepth: number;
  117916. /**
  117917. * Gets the number of array elements
  117918. */
  117919. numberOfArrayElements: number;
  117920. /**
  117921. * Gets the number of faces
  117922. */
  117923. numberOfFaces: number;
  117924. /**
  117925. * Gets the number of mipmap levels
  117926. */
  117927. numberOfMipmapLevels: number;
  117928. /**
  117929. * Gets the bytes of key value data
  117930. */
  117931. bytesOfKeyValueData: number;
  117932. /**
  117933. * Gets the load type
  117934. */
  117935. loadType: number;
  117936. /**
  117937. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  117938. */
  117939. isInvalid: boolean;
  117940. /**
  117941. * Creates a new KhronosTextureContainer
  117942. * @param arrayBuffer contents of the KTX container file
  117943. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  117944. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  117945. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  117946. */
  117947. constructor(
  117948. /** contents of the KTX container file */
  117949. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  117950. /**
  117951. * Uploads KTX content to a Babylon Texture.
  117952. * It is assumed that the texture has already been created & is currently bound
  117953. * @hidden
  117954. */
  117955. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  117956. private _upload2DCompressedLevels;
  117957. }
  117958. }
  117959. declare module BABYLON {
  117960. /**
  117961. * Implementation of the KTX Texture Loader.
  117962. * @hidden
  117963. */
  117964. export class _KTXTextureLoader implements IInternalTextureLoader {
  117965. /**
  117966. * Defines wether the loader supports cascade loading the different faces.
  117967. */
  117968. readonly supportCascades: boolean;
  117969. /**
  117970. * This returns if the loader support the current file information.
  117971. * @param extension defines the file extension of the file being loaded
  117972. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117973. * @param fallback defines the fallback internal texture if any
  117974. * @param isBase64 defines whether the texture is encoded as a base64
  117975. * @param isBuffer defines whether the texture data are stored as a buffer
  117976. * @returns true if the loader can load the specified file
  117977. */
  117978. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117979. /**
  117980. * Transform the url before loading if required.
  117981. * @param rootUrl the url of the texture
  117982. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117983. * @returns the transformed texture
  117984. */
  117985. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117986. /**
  117987. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117988. * @param rootUrl the url of the texture
  117989. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117990. * @returns the fallback texture
  117991. */
  117992. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117993. /**
  117994. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117995. * @param data contains the texture data
  117996. * @param texture defines the BabylonJS internal texture
  117997. * @param createPolynomials will be true if polynomials have been requested
  117998. * @param onLoad defines the callback to trigger once the texture is ready
  117999. * @param onError defines the callback to trigger in case of error
  118000. */
  118001. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  118002. /**
  118003. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  118004. * @param data contains the texture data
  118005. * @param texture defines the BabylonJS internal texture
  118006. * @param callback defines the method to call once ready to upload
  118007. */
  118008. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  118009. }
  118010. }
  118011. declare module BABYLON {
  118012. /** @hidden */
  118013. export var _forceSceneHelpersToBundle: boolean;
  118014. interface Scene {
  118015. /**
  118016. * Creates a default light for the scene.
  118017. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  118018. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  118019. */
  118020. createDefaultLight(replace?: boolean): void;
  118021. /**
  118022. * Creates a default camera for the scene.
  118023. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  118024. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  118025. * @param replace has default false, when true replaces the active camera in the scene
  118026. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  118027. */
  118028. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  118029. /**
  118030. * Creates a default camera and a default light.
  118031. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  118032. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  118033. * @param replace has the default false, when true replaces the active camera/light in the scene
  118034. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  118035. */
  118036. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  118037. /**
  118038. * Creates a new sky box
  118039. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  118040. * @param environmentTexture defines the texture to use as environment texture
  118041. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  118042. * @param scale defines the overall scale of the skybox
  118043. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  118044. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  118045. * @returns a new mesh holding the sky box
  118046. */
  118047. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  118048. /**
  118049. * Creates a new environment
  118050. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  118051. * @param options defines the options you can use to configure the environment
  118052. * @returns the new EnvironmentHelper
  118053. */
  118054. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  118055. /**
  118056. * Creates a new VREXperienceHelper
  118057. * @see http://doc.babylonjs.com/how_to/webvr_helper
  118058. * @param webVROptions defines the options used to create the new VREXperienceHelper
  118059. * @returns a new VREXperienceHelper
  118060. */
  118061. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  118062. /**
  118063. * Creates a new WebXRDefaultExperience
  118064. * @see http://doc.babylonjs.com/how_to/webxr
  118065. * @param options experience options
  118066. * @returns a promise for a new WebXRDefaultExperience
  118067. */
  118068. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  118069. }
  118070. }
  118071. declare module BABYLON {
  118072. /**
  118073. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  118074. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  118075. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  118076. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  118077. */
  118078. export class VideoDome extends TransformNode {
  118079. /**
  118080. * Define the video source as a Monoscopic panoramic 360 video.
  118081. */
  118082. static readonly MODE_MONOSCOPIC: number;
  118083. /**
  118084. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  118085. */
  118086. static readonly MODE_TOPBOTTOM: number;
  118087. /**
  118088. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  118089. */
  118090. static readonly MODE_SIDEBYSIDE: number;
  118091. private _halfDome;
  118092. private _useDirectMapping;
  118093. /**
  118094. * The video texture being displayed on the sphere
  118095. */
  118096. protected _videoTexture: VideoTexture;
  118097. /**
  118098. * Gets the video texture being displayed on the sphere
  118099. */
  118100. readonly videoTexture: VideoTexture;
  118101. /**
  118102. * The skybox material
  118103. */
  118104. protected _material: BackgroundMaterial;
  118105. /**
  118106. * The surface used for the skybox
  118107. */
  118108. protected _mesh: Mesh;
  118109. /**
  118110. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  118111. */
  118112. private _halfDomeMask;
  118113. /**
  118114. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  118115. * Also see the options.resolution property.
  118116. */
  118117. fovMultiplier: number;
  118118. private _videoMode;
  118119. /**
  118120. * Gets or set the current video mode for the video. It can be:
  118121. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  118122. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  118123. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  118124. */
  118125. videoMode: number;
  118126. /**
  118127. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  118128. *
  118129. */
  118130. /**
  118131. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  118132. */
  118133. halfDome: boolean;
  118134. /**
  118135. * Oberserver used in Stereoscopic VR Mode.
  118136. */
  118137. private _onBeforeCameraRenderObserver;
  118138. /**
  118139. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  118140. * @param name Element's name, child elements will append suffixes for their own names.
  118141. * @param urlsOrVideo defines the url(s) or the video element to use
  118142. * @param options An object containing optional or exposed sub element properties
  118143. */
  118144. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  118145. resolution?: number;
  118146. clickToPlay?: boolean;
  118147. autoPlay?: boolean;
  118148. loop?: boolean;
  118149. size?: number;
  118150. poster?: string;
  118151. faceForward?: boolean;
  118152. useDirectMapping?: boolean;
  118153. halfDomeMode?: boolean;
  118154. }, scene: Scene);
  118155. private _changeVideoMode;
  118156. /**
  118157. * Releases resources associated with this node.
  118158. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  118159. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  118160. */
  118161. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  118162. }
  118163. }
  118164. declare module BABYLON {
  118165. /**
  118166. * This class can be used to get instrumentation data from a Babylon engine
  118167. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  118168. */
  118169. export class EngineInstrumentation implements IDisposable {
  118170. /**
  118171. * Define the instrumented engine.
  118172. */
  118173. engine: Engine;
  118174. private _captureGPUFrameTime;
  118175. private _gpuFrameTimeToken;
  118176. private _gpuFrameTime;
  118177. private _captureShaderCompilationTime;
  118178. private _shaderCompilationTime;
  118179. private _onBeginFrameObserver;
  118180. private _onEndFrameObserver;
  118181. private _onBeforeShaderCompilationObserver;
  118182. private _onAfterShaderCompilationObserver;
  118183. /**
  118184. * Gets the perf counter used for GPU frame time
  118185. */
  118186. readonly gpuFrameTimeCounter: PerfCounter;
  118187. /**
  118188. * Gets the GPU frame time capture status
  118189. */
  118190. /**
  118191. * Enable or disable the GPU frame time capture
  118192. */
  118193. captureGPUFrameTime: boolean;
  118194. /**
  118195. * Gets the perf counter used for shader compilation time
  118196. */
  118197. readonly shaderCompilationTimeCounter: PerfCounter;
  118198. /**
  118199. * Gets the shader compilation time capture status
  118200. */
  118201. /**
  118202. * Enable or disable the shader compilation time capture
  118203. */
  118204. captureShaderCompilationTime: boolean;
  118205. /**
  118206. * Instantiates a new engine instrumentation.
  118207. * This class can be used to get instrumentation data from a Babylon engine
  118208. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  118209. * @param engine Defines the engine to instrument
  118210. */
  118211. constructor(
  118212. /**
  118213. * Define the instrumented engine.
  118214. */
  118215. engine: Engine);
  118216. /**
  118217. * Dispose and release associated resources.
  118218. */
  118219. dispose(): void;
  118220. }
  118221. }
  118222. declare module BABYLON {
  118223. /**
  118224. * This class can be used to get instrumentation data from a Babylon engine
  118225. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  118226. */
  118227. export class SceneInstrumentation implements IDisposable {
  118228. /**
  118229. * Defines the scene to instrument
  118230. */
  118231. scene: Scene;
  118232. private _captureActiveMeshesEvaluationTime;
  118233. private _activeMeshesEvaluationTime;
  118234. private _captureRenderTargetsRenderTime;
  118235. private _renderTargetsRenderTime;
  118236. private _captureFrameTime;
  118237. private _frameTime;
  118238. private _captureRenderTime;
  118239. private _renderTime;
  118240. private _captureInterFrameTime;
  118241. private _interFrameTime;
  118242. private _captureParticlesRenderTime;
  118243. private _particlesRenderTime;
  118244. private _captureSpritesRenderTime;
  118245. private _spritesRenderTime;
  118246. private _capturePhysicsTime;
  118247. private _physicsTime;
  118248. private _captureAnimationsTime;
  118249. private _animationsTime;
  118250. private _captureCameraRenderTime;
  118251. private _cameraRenderTime;
  118252. private _onBeforeActiveMeshesEvaluationObserver;
  118253. private _onAfterActiveMeshesEvaluationObserver;
  118254. private _onBeforeRenderTargetsRenderObserver;
  118255. private _onAfterRenderTargetsRenderObserver;
  118256. private _onAfterRenderObserver;
  118257. private _onBeforeDrawPhaseObserver;
  118258. private _onAfterDrawPhaseObserver;
  118259. private _onBeforeAnimationsObserver;
  118260. private _onBeforeParticlesRenderingObserver;
  118261. private _onAfterParticlesRenderingObserver;
  118262. private _onBeforeSpritesRenderingObserver;
  118263. private _onAfterSpritesRenderingObserver;
  118264. private _onBeforePhysicsObserver;
  118265. private _onAfterPhysicsObserver;
  118266. private _onAfterAnimationsObserver;
  118267. private _onBeforeCameraRenderObserver;
  118268. private _onAfterCameraRenderObserver;
  118269. /**
  118270. * Gets the perf counter used for active meshes evaluation time
  118271. */
  118272. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  118273. /**
  118274. * Gets the active meshes evaluation time capture status
  118275. */
  118276. /**
  118277. * Enable or disable the active meshes evaluation time capture
  118278. */
  118279. captureActiveMeshesEvaluationTime: boolean;
  118280. /**
  118281. * Gets the perf counter used for render targets render time
  118282. */
  118283. readonly renderTargetsRenderTimeCounter: PerfCounter;
  118284. /**
  118285. * Gets the render targets render time capture status
  118286. */
  118287. /**
  118288. * Enable or disable the render targets render time capture
  118289. */
  118290. captureRenderTargetsRenderTime: boolean;
  118291. /**
  118292. * Gets the perf counter used for particles render time
  118293. */
  118294. readonly particlesRenderTimeCounter: PerfCounter;
  118295. /**
  118296. * Gets the particles render time capture status
  118297. */
  118298. /**
  118299. * Enable or disable the particles render time capture
  118300. */
  118301. captureParticlesRenderTime: boolean;
  118302. /**
  118303. * Gets the perf counter used for sprites render time
  118304. */
  118305. readonly spritesRenderTimeCounter: PerfCounter;
  118306. /**
  118307. * Gets the sprites render time capture status
  118308. */
  118309. /**
  118310. * Enable or disable the sprites render time capture
  118311. */
  118312. captureSpritesRenderTime: boolean;
  118313. /**
  118314. * Gets the perf counter used for physics time
  118315. */
  118316. readonly physicsTimeCounter: PerfCounter;
  118317. /**
  118318. * Gets the physics time capture status
  118319. */
  118320. /**
  118321. * Enable or disable the physics time capture
  118322. */
  118323. capturePhysicsTime: boolean;
  118324. /**
  118325. * Gets the perf counter used for animations time
  118326. */
  118327. readonly animationsTimeCounter: PerfCounter;
  118328. /**
  118329. * Gets the animations time capture status
  118330. */
  118331. /**
  118332. * Enable or disable the animations time capture
  118333. */
  118334. captureAnimationsTime: boolean;
  118335. /**
  118336. * Gets the perf counter used for frame time capture
  118337. */
  118338. readonly frameTimeCounter: PerfCounter;
  118339. /**
  118340. * Gets the frame time capture status
  118341. */
  118342. /**
  118343. * Enable or disable the frame time capture
  118344. */
  118345. captureFrameTime: boolean;
  118346. /**
  118347. * Gets the perf counter used for inter-frames time capture
  118348. */
  118349. readonly interFrameTimeCounter: PerfCounter;
  118350. /**
  118351. * Gets the inter-frames time capture status
  118352. */
  118353. /**
  118354. * Enable or disable the inter-frames time capture
  118355. */
  118356. captureInterFrameTime: boolean;
  118357. /**
  118358. * Gets the perf counter used for render time capture
  118359. */
  118360. readonly renderTimeCounter: PerfCounter;
  118361. /**
  118362. * Gets the render time capture status
  118363. */
  118364. /**
  118365. * Enable or disable the render time capture
  118366. */
  118367. captureRenderTime: boolean;
  118368. /**
  118369. * Gets the perf counter used for camera render time capture
  118370. */
  118371. readonly cameraRenderTimeCounter: PerfCounter;
  118372. /**
  118373. * Gets the camera render time capture status
  118374. */
  118375. /**
  118376. * Enable or disable the camera render time capture
  118377. */
  118378. captureCameraRenderTime: boolean;
  118379. /**
  118380. * Gets the perf counter used for draw calls
  118381. */
  118382. readonly drawCallsCounter: PerfCounter;
  118383. /**
  118384. * Instantiates a new scene instrumentation.
  118385. * This class can be used to get instrumentation data from a Babylon engine
  118386. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  118387. * @param scene Defines the scene to instrument
  118388. */
  118389. constructor(
  118390. /**
  118391. * Defines the scene to instrument
  118392. */
  118393. scene: Scene);
  118394. /**
  118395. * Dispose and release associated resources.
  118396. */
  118397. dispose(): void;
  118398. }
  118399. }
  118400. declare module BABYLON {
  118401. /** @hidden */
  118402. export var glowMapGenerationPixelShader: {
  118403. name: string;
  118404. shader: string;
  118405. };
  118406. }
  118407. declare module BABYLON {
  118408. /** @hidden */
  118409. export var glowMapGenerationVertexShader: {
  118410. name: string;
  118411. shader: string;
  118412. };
  118413. }
  118414. declare module BABYLON {
  118415. /**
  118416. * Effect layer options. This helps customizing the behaviour
  118417. * of the effect layer.
  118418. */
  118419. export interface IEffectLayerOptions {
  118420. /**
  118421. * Multiplication factor apply to the canvas size to compute the render target size
  118422. * used to generated the objects (the smaller the faster).
  118423. */
  118424. mainTextureRatio: number;
  118425. /**
  118426. * Enforces a fixed size texture to ensure effect stability across devices.
  118427. */
  118428. mainTextureFixedSize?: number;
  118429. /**
  118430. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  118431. */
  118432. alphaBlendingMode: number;
  118433. /**
  118434. * The camera attached to the layer.
  118435. */
  118436. camera: Nullable<Camera>;
  118437. /**
  118438. * The rendering group to draw the layer in.
  118439. */
  118440. renderingGroupId: number;
  118441. }
  118442. /**
  118443. * The effect layer Helps adding post process effect blended with the main pass.
  118444. *
  118445. * This can be for instance use to generate glow or higlight effects on the scene.
  118446. *
  118447. * The effect layer class can not be used directly and is intented to inherited from to be
  118448. * customized per effects.
  118449. */
  118450. export abstract class EffectLayer {
  118451. private _vertexBuffers;
  118452. private _indexBuffer;
  118453. private _cachedDefines;
  118454. private _effectLayerMapGenerationEffect;
  118455. private _effectLayerOptions;
  118456. private _mergeEffect;
  118457. protected _scene: Scene;
  118458. protected _engine: Engine;
  118459. protected _maxSize: number;
  118460. protected _mainTextureDesiredSize: ISize;
  118461. protected _mainTexture: RenderTargetTexture;
  118462. protected _shouldRender: boolean;
  118463. protected _postProcesses: PostProcess[];
  118464. protected _textures: BaseTexture[];
  118465. protected _emissiveTextureAndColor: {
  118466. texture: Nullable<BaseTexture>;
  118467. color: Color4;
  118468. };
  118469. /**
  118470. * The name of the layer
  118471. */
  118472. name: string;
  118473. /**
  118474. * The clear color of the texture used to generate the glow map.
  118475. */
  118476. neutralColor: Color4;
  118477. /**
  118478. * Specifies wether the highlight layer is enabled or not.
  118479. */
  118480. isEnabled: boolean;
  118481. /**
  118482. * Gets the camera attached to the layer.
  118483. */
  118484. readonly camera: Nullable<Camera>;
  118485. /**
  118486. * Gets the rendering group id the layer should render in.
  118487. */
  118488. renderingGroupId: number;
  118489. /**
  118490. * An event triggered when the effect layer has been disposed.
  118491. */
  118492. onDisposeObservable: Observable<EffectLayer>;
  118493. /**
  118494. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  118495. */
  118496. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  118497. /**
  118498. * An event triggered when the generated texture is being merged in the scene.
  118499. */
  118500. onBeforeComposeObservable: Observable<EffectLayer>;
  118501. /**
  118502. * An event triggered when the mesh is rendered into the effect render target.
  118503. */
  118504. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  118505. /**
  118506. * An event triggered after the mesh has been rendered into the effect render target.
  118507. */
  118508. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  118509. /**
  118510. * An event triggered when the generated texture has been merged in the scene.
  118511. */
  118512. onAfterComposeObservable: Observable<EffectLayer>;
  118513. /**
  118514. * An event triggered when the efffect layer changes its size.
  118515. */
  118516. onSizeChangedObservable: Observable<EffectLayer>;
  118517. /** @hidden */
  118518. static _SceneComponentInitialization: (scene: Scene) => void;
  118519. /**
  118520. * Instantiates a new effect Layer and references it in the scene.
  118521. * @param name The name of the layer
  118522. * @param scene The scene to use the layer in
  118523. */
  118524. constructor(
  118525. /** The Friendly of the effect in the scene */
  118526. name: string, scene: Scene);
  118527. /**
  118528. * Get the effect name of the layer.
  118529. * @return The effect name
  118530. */
  118531. abstract getEffectName(): string;
  118532. /**
  118533. * Checks for the readiness of the element composing the layer.
  118534. * @param subMesh the mesh to check for
  118535. * @param useInstances specify wether or not to use instances to render the mesh
  118536. * @return true if ready otherwise, false
  118537. */
  118538. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118539. /**
  118540. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118541. * @returns true if the effect requires stencil during the main canvas render pass.
  118542. */
  118543. abstract needStencil(): boolean;
  118544. /**
  118545. * Create the merge effect. This is the shader use to blit the information back
  118546. * to the main canvas at the end of the scene rendering.
  118547. * @returns The effect containing the shader used to merge the effect on the main canvas
  118548. */
  118549. protected abstract _createMergeEffect(): Effect;
  118550. /**
  118551. * Creates the render target textures and post processes used in the effect layer.
  118552. */
  118553. protected abstract _createTextureAndPostProcesses(): void;
  118554. /**
  118555. * Implementation specific of rendering the generating effect on the main canvas.
  118556. * @param effect The effect used to render through
  118557. */
  118558. protected abstract _internalRender(effect: Effect): void;
  118559. /**
  118560. * Sets the required values for both the emissive texture and and the main color.
  118561. */
  118562. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118563. /**
  118564. * Free any resources and references associated to a mesh.
  118565. * Internal use
  118566. * @param mesh The mesh to free.
  118567. */
  118568. abstract _disposeMesh(mesh: Mesh): void;
  118569. /**
  118570. * Serializes this layer (Glow or Highlight for example)
  118571. * @returns a serialized layer object
  118572. */
  118573. abstract serialize?(): any;
  118574. /**
  118575. * Initializes the effect layer with the required options.
  118576. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  118577. */
  118578. protected _init(options: Partial<IEffectLayerOptions>): void;
  118579. /**
  118580. * Generates the index buffer of the full screen quad blending to the main canvas.
  118581. */
  118582. private _generateIndexBuffer;
  118583. /**
  118584. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  118585. */
  118586. private _generateVertexBuffer;
  118587. /**
  118588. * Sets the main texture desired size which is the closest power of two
  118589. * of the engine canvas size.
  118590. */
  118591. private _setMainTextureSize;
  118592. /**
  118593. * Creates the main texture for the effect layer.
  118594. */
  118595. protected _createMainTexture(): void;
  118596. /**
  118597. * Adds specific effects defines.
  118598. * @param defines The defines to add specifics to.
  118599. */
  118600. protected _addCustomEffectDefines(defines: string[]): void;
  118601. /**
  118602. * Checks for the readiness of the element composing the layer.
  118603. * @param subMesh the mesh to check for
  118604. * @param useInstances specify wether or not to use instances to render the mesh
  118605. * @param emissiveTexture the associated emissive texture used to generate the glow
  118606. * @return true if ready otherwise, false
  118607. */
  118608. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  118609. /**
  118610. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  118611. */
  118612. render(): void;
  118613. /**
  118614. * Determine if a given mesh will be used in the current effect.
  118615. * @param mesh mesh to test
  118616. * @returns true if the mesh will be used
  118617. */
  118618. hasMesh(mesh: AbstractMesh): boolean;
  118619. /**
  118620. * Returns true if the layer contains information to display, otherwise false.
  118621. * @returns true if the glow layer should be rendered
  118622. */
  118623. shouldRender(): boolean;
  118624. /**
  118625. * Returns true if the mesh should render, otherwise false.
  118626. * @param mesh The mesh to render
  118627. * @returns true if it should render otherwise false
  118628. */
  118629. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  118630. /**
  118631. * Returns true if the mesh can be rendered, otherwise false.
  118632. * @param mesh The mesh to render
  118633. * @param material The material used on the mesh
  118634. * @returns true if it can be rendered otherwise false
  118635. */
  118636. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  118637. /**
  118638. * Returns true if the mesh should render, otherwise false.
  118639. * @param mesh The mesh to render
  118640. * @returns true if it should render otherwise false
  118641. */
  118642. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  118643. /**
  118644. * Renders the submesh passed in parameter to the generation map.
  118645. */
  118646. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  118647. /**
  118648. * Defines wether the current material of the mesh should be use to render the effect.
  118649. * @param mesh defines the current mesh to render
  118650. */
  118651. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  118652. /**
  118653. * Rebuild the required buffers.
  118654. * @hidden Internal use only.
  118655. */
  118656. _rebuild(): void;
  118657. /**
  118658. * Dispose only the render target textures and post process.
  118659. */
  118660. private _disposeTextureAndPostProcesses;
  118661. /**
  118662. * Dispose the highlight layer and free resources.
  118663. */
  118664. dispose(): void;
  118665. /**
  118666. * Gets the class name of the effect layer
  118667. * @returns the string with the class name of the effect layer
  118668. */
  118669. getClassName(): string;
  118670. /**
  118671. * Creates an effect layer from parsed effect layer data
  118672. * @param parsedEffectLayer defines effect layer data
  118673. * @param scene defines the current scene
  118674. * @param rootUrl defines the root URL containing the effect layer information
  118675. * @returns a parsed effect Layer
  118676. */
  118677. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  118678. }
  118679. }
  118680. declare module BABYLON {
  118681. interface AbstractScene {
  118682. /**
  118683. * The list of effect layers (highlights/glow) added to the scene
  118684. * @see http://doc.babylonjs.com/how_to/highlight_layer
  118685. * @see http://doc.babylonjs.com/how_to/glow_layer
  118686. */
  118687. effectLayers: Array<EffectLayer>;
  118688. /**
  118689. * Removes the given effect layer from this scene.
  118690. * @param toRemove defines the effect layer to remove
  118691. * @returns the index of the removed effect layer
  118692. */
  118693. removeEffectLayer(toRemove: EffectLayer): number;
  118694. /**
  118695. * Adds the given effect layer to this scene
  118696. * @param newEffectLayer defines the effect layer to add
  118697. */
  118698. addEffectLayer(newEffectLayer: EffectLayer): void;
  118699. }
  118700. /**
  118701. * Defines the layer scene component responsible to manage any effect layers
  118702. * in a given scene.
  118703. */
  118704. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  118705. /**
  118706. * The component name helpfull to identify the component in the list of scene components.
  118707. */
  118708. readonly name: string;
  118709. /**
  118710. * The scene the component belongs to.
  118711. */
  118712. scene: Scene;
  118713. private _engine;
  118714. private _renderEffects;
  118715. private _needStencil;
  118716. private _previousStencilState;
  118717. /**
  118718. * Creates a new instance of the component for the given scene
  118719. * @param scene Defines the scene to register the component in
  118720. */
  118721. constructor(scene: Scene);
  118722. /**
  118723. * Registers the component in a given scene
  118724. */
  118725. register(): void;
  118726. /**
  118727. * Rebuilds the elements related to this component in case of
  118728. * context lost for instance.
  118729. */
  118730. rebuild(): void;
  118731. /**
  118732. * Serializes the component data to the specified json object
  118733. * @param serializationObject The object to serialize to
  118734. */
  118735. serialize(serializationObject: any): void;
  118736. /**
  118737. * Adds all the elements from the container to the scene
  118738. * @param container the container holding the elements
  118739. */
  118740. addFromContainer(container: AbstractScene): void;
  118741. /**
  118742. * Removes all the elements in the container from the scene
  118743. * @param container contains the elements to remove
  118744. * @param dispose if the removed element should be disposed (default: false)
  118745. */
  118746. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118747. /**
  118748. * Disposes the component and the associated ressources.
  118749. */
  118750. dispose(): void;
  118751. private _isReadyForMesh;
  118752. private _renderMainTexture;
  118753. private _setStencil;
  118754. private _setStencilBack;
  118755. private _draw;
  118756. private _drawCamera;
  118757. private _drawRenderingGroup;
  118758. }
  118759. }
  118760. declare module BABYLON {
  118761. /** @hidden */
  118762. export var glowMapMergePixelShader: {
  118763. name: string;
  118764. shader: string;
  118765. };
  118766. }
  118767. declare module BABYLON {
  118768. /** @hidden */
  118769. export var glowMapMergeVertexShader: {
  118770. name: string;
  118771. shader: string;
  118772. };
  118773. }
  118774. declare module BABYLON {
  118775. interface AbstractScene {
  118776. /**
  118777. * Return a the first highlight layer of the scene with a given name.
  118778. * @param name The name of the highlight layer to look for.
  118779. * @return The highlight layer if found otherwise null.
  118780. */
  118781. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  118782. }
  118783. /**
  118784. * Glow layer options. This helps customizing the behaviour
  118785. * of the glow layer.
  118786. */
  118787. export interface IGlowLayerOptions {
  118788. /**
  118789. * Multiplication factor apply to the canvas size to compute the render target size
  118790. * used to generated the glowing objects (the smaller the faster).
  118791. */
  118792. mainTextureRatio: number;
  118793. /**
  118794. * Enforces a fixed size texture to ensure resize independant blur.
  118795. */
  118796. mainTextureFixedSize?: number;
  118797. /**
  118798. * How big is the kernel of the blur texture.
  118799. */
  118800. blurKernelSize: number;
  118801. /**
  118802. * The camera attached to the layer.
  118803. */
  118804. camera: Nullable<Camera>;
  118805. /**
  118806. * Enable MSAA by chosing the number of samples.
  118807. */
  118808. mainTextureSamples?: number;
  118809. /**
  118810. * The rendering group to draw the layer in.
  118811. */
  118812. renderingGroupId: number;
  118813. }
  118814. /**
  118815. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  118816. *
  118817. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  118818. *
  118819. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  118820. */
  118821. export class GlowLayer extends EffectLayer {
  118822. /**
  118823. * Effect Name of the layer.
  118824. */
  118825. static readonly EffectName: string;
  118826. /**
  118827. * The default blur kernel size used for the glow.
  118828. */
  118829. static DefaultBlurKernelSize: number;
  118830. /**
  118831. * The default texture size ratio used for the glow.
  118832. */
  118833. static DefaultTextureRatio: number;
  118834. /**
  118835. * Sets the kernel size of the blur.
  118836. */
  118837. /**
  118838. * Gets the kernel size of the blur.
  118839. */
  118840. blurKernelSize: number;
  118841. /**
  118842. * Sets the glow intensity.
  118843. */
  118844. /**
  118845. * Gets the glow intensity.
  118846. */
  118847. intensity: number;
  118848. private _options;
  118849. private _intensity;
  118850. private _horizontalBlurPostprocess1;
  118851. private _verticalBlurPostprocess1;
  118852. private _horizontalBlurPostprocess2;
  118853. private _verticalBlurPostprocess2;
  118854. private _blurTexture1;
  118855. private _blurTexture2;
  118856. private _postProcesses1;
  118857. private _postProcesses2;
  118858. private _includedOnlyMeshes;
  118859. private _excludedMeshes;
  118860. private _meshesUsingTheirOwnMaterials;
  118861. /**
  118862. * Callback used to let the user override the color selection on a per mesh basis
  118863. */
  118864. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  118865. /**
  118866. * Callback used to let the user override the texture selection on a per mesh basis
  118867. */
  118868. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  118869. /**
  118870. * Instantiates a new glow Layer and references it to the scene.
  118871. * @param name The name of the layer
  118872. * @param scene The scene to use the layer in
  118873. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  118874. */
  118875. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  118876. /**
  118877. * Get the effect name of the layer.
  118878. * @return The effect name
  118879. */
  118880. getEffectName(): string;
  118881. /**
  118882. * Create the merge effect. This is the shader use to blit the information back
  118883. * to the main canvas at the end of the scene rendering.
  118884. */
  118885. protected _createMergeEffect(): Effect;
  118886. /**
  118887. * Creates the render target textures and post processes used in the glow layer.
  118888. */
  118889. protected _createTextureAndPostProcesses(): void;
  118890. /**
  118891. * Checks for the readiness of the element composing the layer.
  118892. * @param subMesh the mesh to check for
  118893. * @param useInstances specify wether or not to use instances to render the mesh
  118894. * @param emissiveTexture the associated emissive texture used to generate the glow
  118895. * @return true if ready otherwise, false
  118896. */
  118897. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118898. /**
  118899. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118900. */
  118901. needStencil(): boolean;
  118902. /**
  118903. * Returns true if the mesh can be rendered, otherwise false.
  118904. * @param mesh The mesh to render
  118905. * @param material The material used on the mesh
  118906. * @returns true if it can be rendered otherwise false
  118907. */
  118908. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  118909. /**
  118910. * Implementation specific of rendering the generating effect on the main canvas.
  118911. * @param effect The effect used to render through
  118912. */
  118913. protected _internalRender(effect: Effect): void;
  118914. /**
  118915. * Sets the required values for both the emissive texture and and the main color.
  118916. */
  118917. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118918. /**
  118919. * Returns true if the mesh should render, otherwise false.
  118920. * @param mesh The mesh to render
  118921. * @returns true if it should render otherwise false
  118922. */
  118923. protected _shouldRenderMesh(mesh: Mesh): boolean;
  118924. /**
  118925. * Adds specific effects defines.
  118926. * @param defines The defines to add specifics to.
  118927. */
  118928. protected _addCustomEffectDefines(defines: string[]): void;
  118929. /**
  118930. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  118931. * @param mesh The mesh to exclude from the glow layer
  118932. */
  118933. addExcludedMesh(mesh: Mesh): void;
  118934. /**
  118935. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  118936. * @param mesh The mesh to remove
  118937. */
  118938. removeExcludedMesh(mesh: Mesh): void;
  118939. /**
  118940. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  118941. * @param mesh The mesh to include in the glow layer
  118942. */
  118943. addIncludedOnlyMesh(mesh: Mesh): void;
  118944. /**
  118945. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  118946. * @param mesh The mesh to remove
  118947. */
  118948. removeIncludedOnlyMesh(mesh: Mesh): void;
  118949. /**
  118950. * Determine if a given mesh will be used in the glow layer
  118951. * @param mesh The mesh to test
  118952. * @returns true if the mesh will be highlighted by the current glow layer
  118953. */
  118954. hasMesh(mesh: AbstractMesh): boolean;
  118955. /**
  118956. * Defines wether the current material of the mesh should be use to render the effect.
  118957. * @param mesh defines the current mesh to render
  118958. */
  118959. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  118960. /**
  118961. * Add a mesh to be rendered through its own material and not with emissive only.
  118962. * @param mesh The mesh for which we need to use its material
  118963. */
  118964. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  118965. /**
  118966. * Remove a mesh from being rendered through its own material and not with emissive only.
  118967. * @param mesh The mesh for which we need to not use its material
  118968. */
  118969. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  118970. /**
  118971. * Free any resources and references associated to a mesh.
  118972. * Internal use
  118973. * @param mesh The mesh to free.
  118974. * @hidden
  118975. */
  118976. _disposeMesh(mesh: Mesh): void;
  118977. /**
  118978. * Gets the class name of the effect layer
  118979. * @returns the string with the class name of the effect layer
  118980. */
  118981. getClassName(): string;
  118982. /**
  118983. * Serializes this glow layer
  118984. * @returns a serialized glow layer object
  118985. */
  118986. serialize(): any;
  118987. /**
  118988. * Creates a Glow Layer from parsed glow layer data
  118989. * @param parsedGlowLayer defines glow layer data
  118990. * @param scene defines the current scene
  118991. * @param rootUrl defines the root URL containing the glow layer information
  118992. * @returns a parsed Glow Layer
  118993. */
  118994. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  118995. }
  118996. }
  118997. declare module BABYLON {
  118998. /** @hidden */
  118999. export var glowBlurPostProcessPixelShader: {
  119000. name: string;
  119001. shader: string;
  119002. };
  119003. }
  119004. declare module BABYLON {
  119005. interface AbstractScene {
  119006. /**
  119007. * Return a the first highlight layer of the scene with a given name.
  119008. * @param name The name of the highlight layer to look for.
  119009. * @return The highlight layer if found otherwise null.
  119010. */
  119011. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  119012. }
  119013. /**
  119014. * Highlight layer options. This helps customizing the behaviour
  119015. * of the highlight layer.
  119016. */
  119017. export interface IHighlightLayerOptions {
  119018. /**
  119019. * Multiplication factor apply to the canvas size to compute the render target size
  119020. * used to generated the glowing objects (the smaller the faster).
  119021. */
  119022. mainTextureRatio: number;
  119023. /**
  119024. * Enforces a fixed size texture to ensure resize independant blur.
  119025. */
  119026. mainTextureFixedSize?: number;
  119027. /**
  119028. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  119029. * of the picture to blur (the smaller the faster).
  119030. */
  119031. blurTextureSizeRatio: number;
  119032. /**
  119033. * How big in texel of the blur texture is the vertical blur.
  119034. */
  119035. blurVerticalSize: number;
  119036. /**
  119037. * How big in texel of the blur texture is the horizontal blur.
  119038. */
  119039. blurHorizontalSize: number;
  119040. /**
  119041. * Alpha blending mode used to apply the blur. Default is combine.
  119042. */
  119043. alphaBlendingMode: number;
  119044. /**
  119045. * The camera attached to the layer.
  119046. */
  119047. camera: Nullable<Camera>;
  119048. /**
  119049. * Should we display highlight as a solid stroke?
  119050. */
  119051. isStroke?: boolean;
  119052. /**
  119053. * The rendering group to draw the layer in.
  119054. */
  119055. renderingGroupId: number;
  119056. }
  119057. /**
  119058. * The highlight layer Helps adding a glow effect around a mesh.
  119059. *
  119060. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  119061. * glowy meshes to your scene.
  119062. *
  119063. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  119064. */
  119065. export class HighlightLayer extends EffectLayer {
  119066. name: string;
  119067. /**
  119068. * Effect Name of the highlight layer.
  119069. */
  119070. static readonly EffectName: string;
  119071. /**
  119072. * The neutral color used during the preparation of the glow effect.
  119073. * This is black by default as the blend operation is a blend operation.
  119074. */
  119075. static NeutralColor: Color4;
  119076. /**
  119077. * Stencil value used for glowing meshes.
  119078. */
  119079. static GlowingMeshStencilReference: number;
  119080. /**
  119081. * Stencil value used for the other meshes in the scene.
  119082. */
  119083. static NormalMeshStencilReference: number;
  119084. /**
  119085. * Specifies whether or not the inner glow is ACTIVE in the layer.
  119086. */
  119087. innerGlow: boolean;
  119088. /**
  119089. * Specifies whether or not the outer glow is ACTIVE in the layer.
  119090. */
  119091. outerGlow: boolean;
  119092. /**
  119093. * Specifies the horizontal size of the blur.
  119094. */
  119095. /**
  119096. * Gets the horizontal size of the blur.
  119097. */
  119098. blurHorizontalSize: number;
  119099. /**
  119100. * Specifies the vertical size of the blur.
  119101. */
  119102. /**
  119103. * Gets the vertical size of the blur.
  119104. */
  119105. blurVerticalSize: number;
  119106. /**
  119107. * An event triggered when the highlight layer is being blurred.
  119108. */
  119109. onBeforeBlurObservable: Observable<HighlightLayer>;
  119110. /**
  119111. * An event triggered when the highlight layer has been blurred.
  119112. */
  119113. onAfterBlurObservable: Observable<HighlightLayer>;
  119114. private _instanceGlowingMeshStencilReference;
  119115. private _options;
  119116. private _downSamplePostprocess;
  119117. private _horizontalBlurPostprocess;
  119118. private _verticalBlurPostprocess;
  119119. private _blurTexture;
  119120. private _meshes;
  119121. private _excludedMeshes;
  119122. /**
  119123. * Instantiates a new highlight Layer and references it to the scene..
  119124. * @param name The name of the layer
  119125. * @param scene The scene to use the layer in
  119126. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  119127. */
  119128. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  119129. /**
  119130. * Get the effect name of the layer.
  119131. * @return The effect name
  119132. */
  119133. getEffectName(): string;
  119134. /**
  119135. * Create the merge effect. This is the shader use to blit the information back
  119136. * to the main canvas at the end of the scene rendering.
  119137. */
  119138. protected _createMergeEffect(): Effect;
  119139. /**
  119140. * Creates the render target textures and post processes used in the highlight layer.
  119141. */
  119142. protected _createTextureAndPostProcesses(): void;
  119143. /**
  119144. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  119145. */
  119146. needStencil(): boolean;
  119147. /**
  119148. * Checks for the readiness of the element composing the layer.
  119149. * @param subMesh the mesh to check for
  119150. * @param useInstances specify wether or not to use instances to render the mesh
  119151. * @param emissiveTexture the associated emissive texture used to generate the glow
  119152. * @return true if ready otherwise, false
  119153. */
  119154. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  119155. /**
  119156. * Implementation specific of rendering the generating effect on the main canvas.
  119157. * @param effect The effect used to render through
  119158. */
  119159. protected _internalRender(effect: Effect): void;
  119160. /**
  119161. * Returns true if the layer contains information to display, otherwise false.
  119162. */
  119163. shouldRender(): boolean;
  119164. /**
  119165. * Returns true if the mesh should render, otherwise false.
  119166. * @param mesh The mesh to render
  119167. * @returns true if it should render otherwise false
  119168. */
  119169. protected _shouldRenderMesh(mesh: Mesh): boolean;
  119170. /**
  119171. * Sets the required values for both the emissive texture and and the main color.
  119172. */
  119173. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  119174. /**
  119175. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  119176. * @param mesh The mesh to exclude from the highlight layer
  119177. */
  119178. addExcludedMesh(mesh: Mesh): void;
  119179. /**
  119180. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  119181. * @param mesh The mesh to highlight
  119182. */
  119183. removeExcludedMesh(mesh: Mesh): void;
  119184. /**
  119185. * Determine if a given mesh will be highlighted by the current HighlightLayer
  119186. * @param mesh mesh to test
  119187. * @returns true if the mesh will be highlighted by the current HighlightLayer
  119188. */
  119189. hasMesh(mesh: AbstractMesh): boolean;
  119190. /**
  119191. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  119192. * @param mesh The mesh to highlight
  119193. * @param color The color of the highlight
  119194. * @param glowEmissiveOnly Extract the glow from the emissive texture
  119195. */
  119196. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  119197. /**
  119198. * Remove a mesh from the highlight layer in order to make it stop glowing.
  119199. * @param mesh The mesh to highlight
  119200. */
  119201. removeMesh(mesh: Mesh): void;
  119202. /**
  119203. * Force the stencil to the normal expected value for none glowing parts
  119204. */
  119205. private _defaultStencilReference;
  119206. /**
  119207. * Free any resources and references associated to a mesh.
  119208. * Internal use
  119209. * @param mesh The mesh to free.
  119210. * @hidden
  119211. */
  119212. _disposeMesh(mesh: Mesh): void;
  119213. /**
  119214. * Dispose the highlight layer and free resources.
  119215. */
  119216. dispose(): void;
  119217. /**
  119218. * Gets the class name of the effect layer
  119219. * @returns the string with the class name of the effect layer
  119220. */
  119221. getClassName(): string;
  119222. /**
  119223. * Serializes this Highlight layer
  119224. * @returns a serialized Highlight layer object
  119225. */
  119226. serialize(): any;
  119227. /**
  119228. * Creates a Highlight layer from parsed Highlight layer data
  119229. * @param parsedHightlightLayer defines the Highlight layer data
  119230. * @param scene defines the current scene
  119231. * @param rootUrl defines the root URL containing the Highlight layer information
  119232. * @returns a parsed Highlight layer
  119233. */
  119234. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  119235. }
  119236. }
  119237. declare module BABYLON {
  119238. interface AbstractScene {
  119239. /**
  119240. * The list of layers (background and foreground) of the scene
  119241. */
  119242. layers: Array<Layer>;
  119243. }
  119244. /**
  119245. * Defines the layer scene component responsible to manage any layers
  119246. * in a given scene.
  119247. */
  119248. export class LayerSceneComponent implements ISceneComponent {
  119249. /**
  119250. * The component name helpfull to identify the component in the list of scene components.
  119251. */
  119252. readonly name: string;
  119253. /**
  119254. * The scene the component belongs to.
  119255. */
  119256. scene: Scene;
  119257. private _engine;
  119258. /**
  119259. * Creates a new instance of the component for the given scene
  119260. * @param scene Defines the scene to register the component in
  119261. */
  119262. constructor(scene: Scene);
  119263. /**
  119264. * Registers the component in a given scene
  119265. */
  119266. register(): void;
  119267. /**
  119268. * Rebuilds the elements related to this component in case of
  119269. * context lost for instance.
  119270. */
  119271. rebuild(): void;
  119272. /**
  119273. * Disposes the component and the associated ressources.
  119274. */
  119275. dispose(): void;
  119276. private _draw;
  119277. private _drawCameraPredicate;
  119278. private _drawCameraBackground;
  119279. private _drawCameraForeground;
  119280. private _drawRenderTargetPredicate;
  119281. private _drawRenderTargetBackground;
  119282. private _drawRenderTargetForeground;
  119283. /**
  119284. * Adds all the elements from the container to the scene
  119285. * @param container the container holding the elements
  119286. */
  119287. addFromContainer(container: AbstractScene): void;
  119288. /**
  119289. * Removes all the elements in the container from the scene
  119290. * @param container contains the elements to remove
  119291. * @param dispose if the removed element should be disposed (default: false)
  119292. */
  119293. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119294. }
  119295. }
  119296. declare module BABYLON {
  119297. /** @hidden */
  119298. export var layerPixelShader: {
  119299. name: string;
  119300. shader: string;
  119301. };
  119302. }
  119303. declare module BABYLON {
  119304. /** @hidden */
  119305. export var layerVertexShader: {
  119306. name: string;
  119307. shader: string;
  119308. };
  119309. }
  119310. declare module BABYLON {
  119311. /**
  119312. * This represents a full screen 2d layer.
  119313. * This can be useful to display a picture in the background of your scene for instance.
  119314. * @see https://www.babylonjs-playground.com/#08A2BS#1
  119315. */
  119316. export class Layer {
  119317. /**
  119318. * Define the name of the layer.
  119319. */
  119320. name: string;
  119321. /**
  119322. * Define the texture the layer should display.
  119323. */
  119324. texture: Nullable<Texture>;
  119325. /**
  119326. * Is the layer in background or foreground.
  119327. */
  119328. isBackground: boolean;
  119329. /**
  119330. * Define the color of the layer (instead of texture).
  119331. */
  119332. color: Color4;
  119333. /**
  119334. * Define the scale of the layer in order to zoom in out of the texture.
  119335. */
  119336. scale: Vector2;
  119337. /**
  119338. * Define an offset for the layer in order to shift the texture.
  119339. */
  119340. offset: Vector2;
  119341. /**
  119342. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  119343. */
  119344. alphaBlendingMode: number;
  119345. /**
  119346. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  119347. * Alpha test will not mix with the background color in case of transparency.
  119348. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  119349. */
  119350. alphaTest: boolean;
  119351. /**
  119352. * Define a mask to restrict the layer to only some of the scene cameras.
  119353. */
  119354. layerMask: number;
  119355. /**
  119356. * Define the list of render target the layer is visible into.
  119357. */
  119358. renderTargetTextures: RenderTargetTexture[];
  119359. /**
  119360. * Define if the layer is only used in renderTarget or if it also
  119361. * renders in the main frame buffer of the canvas.
  119362. */
  119363. renderOnlyInRenderTargetTextures: boolean;
  119364. private _scene;
  119365. private _vertexBuffers;
  119366. private _indexBuffer;
  119367. private _effect;
  119368. private _alphaTestEffect;
  119369. /**
  119370. * An event triggered when the layer is disposed.
  119371. */
  119372. onDisposeObservable: Observable<Layer>;
  119373. private _onDisposeObserver;
  119374. /**
  119375. * Back compatibility with callback before the onDisposeObservable existed.
  119376. * The set callback will be triggered when the layer has been disposed.
  119377. */
  119378. onDispose: () => void;
  119379. /**
  119380. * An event triggered before rendering the scene
  119381. */
  119382. onBeforeRenderObservable: Observable<Layer>;
  119383. private _onBeforeRenderObserver;
  119384. /**
  119385. * Back compatibility with callback before the onBeforeRenderObservable existed.
  119386. * The set callback will be triggered just before rendering the layer.
  119387. */
  119388. onBeforeRender: () => void;
  119389. /**
  119390. * An event triggered after rendering the scene
  119391. */
  119392. onAfterRenderObservable: Observable<Layer>;
  119393. private _onAfterRenderObserver;
  119394. /**
  119395. * Back compatibility with callback before the onAfterRenderObservable existed.
  119396. * The set callback will be triggered just after rendering the layer.
  119397. */
  119398. onAfterRender: () => void;
  119399. /**
  119400. * Instantiates a new layer.
  119401. * This represents a full screen 2d layer.
  119402. * This can be useful to display a picture in the background of your scene for instance.
  119403. * @see https://www.babylonjs-playground.com/#08A2BS#1
  119404. * @param name Define the name of the layer in the scene
  119405. * @param imgUrl Define the url of the texture to display in the layer
  119406. * @param scene Define the scene the layer belongs to
  119407. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  119408. * @param color Defines a color for the layer
  119409. */
  119410. constructor(
  119411. /**
  119412. * Define the name of the layer.
  119413. */
  119414. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  119415. private _createIndexBuffer;
  119416. /** @hidden */
  119417. _rebuild(): void;
  119418. /**
  119419. * Renders the layer in the scene.
  119420. */
  119421. render(): void;
  119422. /**
  119423. * Disposes and releases the associated ressources.
  119424. */
  119425. dispose(): void;
  119426. }
  119427. }
  119428. declare module BABYLON {
  119429. /** @hidden */
  119430. export var lensFlarePixelShader: {
  119431. name: string;
  119432. shader: string;
  119433. };
  119434. }
  119435. declare module BABYLON {
  119436. /** @hidden */
  119437. export var lensFlareVertexShader: {
  119438. name: string;
  119439. shader: string;
  119440. };
  119441. }
  119442. declare module BABYLON {
  119443. /**
  119444. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  119445. * It is usually composed of several `lensFlare`.
  119446. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119447. */
  119448. export class LensFlareSystem {
  119449. /**
  119450. * Define the name of the lens flare system
  119451. */
  119452. name: string;
  119453. /**
  119454. * List of lens flares used in this system.
  119455. */
  119456. lensFlares: LensFlare[];
  119457. /**
  119458. * Define a limit from the border the lens flare can be visible.
  119459. */
  119460. borderLimit: number;
  119461. /**
  119462. * Define a viewport border we do not want to see the lens flare in.
  119463. */
  119464. viewportBorder: number;
  119465. /**
  119466. * Define a predicate which could limit the list of meshes able to occlude the effect.
  119467. */
  119468. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  119469. /**
  119470. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  119471. */
  119472. layerMask: number;
  119473. /**
  119474. * Define the id of the lens flare system in the scene.
  119475. * (equal to name by default)
  119476. */
  119477. id: string;
  119478. private _scene;
  119479. private _emitter;
  119480. private _vertexBuffers;
  119481. private _indexBuffer;
  119482. private _effect;
  119483. private _positionX;
  119484. private _positionY;
  119485. private _isEnabled;
  119486. /** @hidden */
  119487. static _SceneComponentInitialization: (scene: Scene) => void;
  119488. /**
  119489. * Instantiates a lens flare system.
  119490. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  119491. * It is usually composed of several `lensFlare`.
  119492. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119493. * @param name Define the name of the lens flare system in the scene
  119494. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  119495. * @param scene Define the scene the lens flare system belongs to
  119496. */
  119497. constructor(
  119498. /**
  119499. * Define the name of the lens flare system
  119500. */
  119501. name: string, emitter: any, scene: Scene);
  119502. /**
  119503. * Define if the lens flare system is enabled.
  119504. */
  119505. isEnabled: boolean;
  119506. /**
  119507. * Get the scene the effects belongs to.
  119508. * @returns the scene holding the lens flare system
  119509. */
  119510. getScene(): Scene;
  119511. /**
  119512. * Get the emitter of the lens flare system.
  119513. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  119514. * @returns the emitter of the lens flare system
  119515. */
  119516. getEmitter(): any;
  119517. /**
  119518. * Set the emitter of the lens flare system.
  119519. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  119520. * @param newEmitter Define the new emitter of the system
  119521. */
  119522. setEmitter(newEmitter: any): void;
  119523. /**
  119524. * Get the lens flare system emitter position.
  119525. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  119526. * @returns the position
  119527. */
  119528. getEmitterPosition(): Vector3;
  119529. /**
  119530. * @hidden
  119531. */
  119532. computeEffectivePosition(globalViewport: Viewport): boolean;
  119533. /** @hidden */
  119534. _isVisible(): boolean;
  119535. /**
  119536. * @hidden
  119537. */
  119538. render(): boolean;
  119539. /**
  119540. * Dispose and release the lens flare with its associated resources.
  119541. */
  119542. dispose(): void;
  119543. /**
  119544. * Parse a lens flare system from a JSON repressentation
  119545. * @param parsedLensFlareSystem Define the JSON to parse
  119546. * @param scene Define the scene the parsed system should be instantiated in
  119547. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  119548. * @returns the parsed system
  119549. */
  119550. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  119551. /**
  119552. * Serialize the current Lens Flare System into a JSON representation.
  119553. * @returns the serialized JSON
  119554. */
  119555. serialize(): any;
  119556. }
  119557. }
  119558. declare module BABYLON {
  119559. /**
  119560. * This represents one of the lens effect in a `lensFlareSystem`.
  119561. * It controls one of the indiviual texture used in the effect.
  119562. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119563. */
  119564. export class LensFlare {
  119565. /**
  119566. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  119567. */
  119568. size: number;
  119569. /**
  119570. * 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.
  119571. */
  119572. position: number;
  119573. /**
  119574. * Define the lens color.
  119575. */
  119576. color: Color3;
  119577. /**
  119578. * Define the lens texture.
  119579. */
  119580. texture: Nullable<Texture>;
  119581. /**
  119582. * Define the alpha mode to render this particular lens.
  119583. */
  119584. alphaMode: number;
  119585. private _system;
  119586. /**
  119587. * Creates a new Lens Flare.
  119588. * This represents one of the lens effect in a `lensFlareSystem`.
  119589. * It controls one of the indiviual texture used in the effect.
  119590. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119591. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  119592. * @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.
  119593. * @param color Define the lens color
  119594. * @param imgUrl Define the lens texture url
  119595. * @param system Define the `lensFlareSystem` this flare is part of
  119596. * @returns The newly created Lens Flare
  119597. */
  119598. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  119599. /**
  119600. * Instantiates a new Lens Flare.
  119601. * This represents one of the lens effect in a `lensFlareSystem`.
  119602. * It controls one of the indiviual texture used in the effect.
  119603. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119604. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  119605. * @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.
  119606. * @param color Define the lens color
  119607. * @param imgUrl Define the lens texture url
  119608. * @param system Define the `lensFlareSystem` this flare is part of
  119609. */
  119610. constructor(
  119611. /**
  119612. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  119613. */
  119614. size: number,
  119615. /**
  119616. * 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.
  119617. */
  119618. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  119619. /**
  119620. * Dispose and release the lens flare with its associated resources.
  119621. */
  119622. dispose(): void;
  119623. }
  119624. }
  119625. declare module BABYLON {
  119626. interface AbstractScene {
  119627. /**
  119628. * The list of lens flare system added to the scene
  119629. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119630. */
  119631. lensFlareSystems: Array<LensFlareSystem>;
  119632. /**
  119633. * Removes the given lens flare system from this scene.
  119634. * @param toRemove The lens flare system to remove
  119635. * @returns The index of the removed lens flare system
  119636. */
  119637. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  119638. /**
  119639. * Adds the given lens flare system to this scene
  119640. * @param newLensFlareSystem The lens flare system to add
  119641. */
  119642. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  119643. /**
  119644. * Gets a lens flare system using its name
  119645. * @param name defines the name to look for
  119646. * @returns the lens flare system or null if not found
  119647. */
  119648. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  119649. /**
  119650. * Gets a lens flare system using its id
  119651. * @param id defines the id to look for
  119652. * @returns the lens flare system or null if not found
  119653. */
  119654. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  119655. }
  119656. /**
  119657. * Defines the lens flare scene component responsible to manage any lens flares
  119658. * in a given scene.
  119659. */
  119660. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  119661. /**
  119662. * The component name helpfull to identify the component in the list of scene components.
  119663. */
  119664. readonly name: string;
  119665. /**
  119666. * The scene the component belongs to.
  119667. */
  119668. scene: Scene;
  119669. /**
  119670. * Creates a new instance of the component for the given scene
  119671. * @param scene Defines the scene to register the component in
  119672. */
  119673. constructor(scene: Scene);
  119674. /**
  119675. * Registers the component in a given scene
  119676. */
  119677. register(): void;
  119678. /**
  119679. * Rebuilds the elements related to this component in case of
  119680. * context lost for instance.
  119681. */
  119682. rebuild(): void;
  119683. /**
  119684. * Adds all the elements from the container to the scene
  119685. * @param container the container holding the elements
  119686. */
  119687. addFromContainer(container: AbstractScene): void;
  119688. /**
  119689. * Removes all the elements in the container from the scene
  119690. * @param container contains the elements to remove
  119691. * @param dispose if the removed element should be disposed (default: false)
  119692. */
  119693. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119694. /**
  119695. * Serializes the component data to the specified json object
  119696. * @param serializationObject The object to serialize to
  119697. */
  119698. serialize(serializationObject: any): void;
  119699. /**
  119700. * Disposes the component and the associated ressources.
  119701. */
  119702. dispose(): void;
  119703. private _draw;
  119704. }
  119705. }
  119706. declare module BABYLON {
  119707. /**
  119708. * Defines the shadow generator component responsible to manage any shadow generators
  119709. * in a given scene.
  119710. */
  119711. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  119712. /**
  119713. * The component name helpfull to identify the component in the list of scene components.
  119714. */
  119715. readonly name: string;
  119716. /**
  119717. * The scene the component belongs to.
  119718. */
  119719. scene: Scene;
  119720. /**
  119721. * Creates a new instance of the component for the given scene
  119722. * @param scene Defines the scene to register the component in
  119723. */
  119724. constructor(scene: Scene);
  119725. /**
  119726. * Registers the component in a given scene
  119727. */
  119728. register(): void;
  119729. /**
  119730. * Rebuilds the elements related to this component in case of
  119731. * context lost for instance.
  119732. */
  119733. rebuild(): void;
  119734. /**
  119735. * Serializes the component data to the specified json object
  119736. * @param serializationObject The object to serialize to
  119737. */
  119738. serialize(serializationObject: any): void;
  119739. /**
  119740. * Adds all the elements from the container to the scene
  119741. * @param container the container holding the elements
  119742. */
  119743. addFromContainer(container: AbstractScene): void;
  119744. /**
  119745. * Removes all the elements in the container from the scene
  119746. * @param container contains the elements to remove
  119747. * @param dispose if the removed element should be disposed (default: false)
  119748. */
  119749. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119750. /**
  119751. * Rebuilds the elements related to this component in case of
  119752. * context lost for instance.
  119753. */
  119754. dispose(): void;
  119755. private _gatherRenderTargets;
  119756. }
  119757. }
  119758. declare module BABYLON {
  119759. /**
  119760. * A point light is a light defined by an unique point in world space.
  119761. * The light is emitted in every direction from this point.
  119762. * A good example of a point light is a standard light bulb.
  119763. * Documentation: https://doc.babylonjs.com/babylon101/lights
  119764. */
  119765. export class PointLight extends ShadowLight {
  119766. private _shadowAngle;
  119767. /**
  119768. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119769. * This specifies what angle the shadow will use to be created.
  119770. *
  119771. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  119772. */
  119773. /**
  119774. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119775. * This specifies what angle the shadow will use to be created.
  119776. *
  119777. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  119778. */
  119779. shadowAngle: number;
  119780. /**
  119781. * Gets the direction if it has been set.
  119782. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119783. */
  119784. /**
  119785. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119786. */
  119787. direction: Vector3;
  119788. /**
  119789. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  119790. * A PointLight emits the light in every direction.
  119791. * It can cast shadows.
  119792. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  119793. * ```javascript
  119794. * var pointLight = new PointLight("pl", camera.position, scene);
  119795. * ```
  119796. * Documentation : https://doc.babylonjs.com/babylon101/lights
  119797. * @param name The light friendly name
  119798. * @param position The position of the point light in the scene
  119799. * @param scene The scene the lights belongs to
  119800. */
  119801. constructor(name: string, position: Vector3, scene: Scene);
  119802. /**
  119803. * Returns the string "PointLight"
  119804. * @returns the class name
  119805. */
  119806. getClassName(): string;
  119807. /**
  119808. * Returns the integer 0.
  119809. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  119810. */
  119811. getTypeID(): number;
  119812. /**
  119813. * Specifies wether or not the shadowmap should be a cube texture.
  119814. * @returns true if the shadowmap needs to be a cube texture.
  119815. */
  119816. needCube(): boolean;
  119817. /**
  119818. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  119819. * @param faceIndex The index of the face we are computed the direction to generate shadow
  119820. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  119821. */
  119822. getShadowDirection(faceIndex?: number): Vector3;
  119823. /**
  119824. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  119825. * - fov = PI / 2
  119826. * - aspect ratio : 1.0
  119827. * - z-near and far equal to the active camera minZ and maxZ.
  119828. * Returns the PointLight.
  119829. */
  119830. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  119831. protected _buildUniformLayout(): void;
  119832. /**
  119833. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  119834. * @param effect The effect to update
  119835. * @param lightIndex The index of the light in the effect to update
  119836. * @returns The point light
  119837. */
  119838. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  119839. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  119840. /**
  119841. * Prepares the list of defines specific to the light type.
  119842. * @param defines the list of defines
  119843. * @param lightIndex defines the index of the light for the effect
  119844. */
  119845. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  119846. }
  119847. }
  119848. declare module BABYLON {
  119849. /**
  119850. * Header information of HDR texture files.
  119851. */
  119852. export interface HDRInfo {
  119853. /**
  119854. * The height of the texture in pixels.
  119855. */
  119856. height: number;
  119857. /**
  119858. * The width of the texture in pixels.
  119859. */
  119860. width: number;
  119861. /**
  119862. * The index of the beginning of the data in the binary file.
  119863. */
  119864. dataPosition: number;
  119865. }
  119866. /**
  119867. * This groups tools to convert HDR texture to native colors array.
  119868. */
  119869. export class HDRTools {
  119870. private static Ldexp;
  119871. private static Rgbe2float;
  119872. private static readStringLine;
  119873. /**
  119874. * Reads header information from an RGBE texture stored in a native array.
  119875. * More information on this format are available here:
  119876. * https://en.wikipedia.org/wiki/RGBE_image_format
  119877. *
  119878. * @param uint8array The binary file stored in native array.
  119879. * @return The header information.
  119880. */
  119881. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  119882. /**
  119883. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  119884. * This RGBE texture needs to store the information as a panorama.
  119885. *
  119886. * More information on this format are available here:
  119887. * https://en.wikipedia.org/wiki/RGBE_image_format
  119888. *
  119889. * @param buffer The binary file stored in an array buffer.
  119890. * @param size The expected size of the extracted cubemap.
  119891. * @return The Cube Map information.
  119892. */
  119893. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  119894. /**
  119895. * Returns the pixels data extracted from an RGBE texture.
  119896. * This pixels will be stored left to right up to down in the R G B order in one array.
  119897. *
  119898. * More information on this format are available here:
  119899. * https://en.wikipedia.org/wiki/RGBE_image_format
  119900. *
  119901. * @param uint8array The binary file stored in an array buffer.
  119902. * @param hdrInfo The header information of the file.
  119903. * @return The pixels data in RGB right to left up to down order.
  119904. */
  119905. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  119906. private static RGBE_ReadPixels_RLE;
  119907. }
  119908. }
  119909. declare module BABYLON {
  119910. /**
  119911. * This represents a texture coming from an HDR input.
  119912. *
  119913. * The only supported format is currently panorama picture stored in RGBE format.
  119914. * Example of such files can be found on HDRLib: http://hdrlib.com/
  119915. */
  119916. export class HDRCubeTexture extends BaseTexture {
  119917. private static _facesMapping;
  119918. private _generateHarmonics;
  119919. private _noMipmap;
  119920. private _textureMatrix;
  119921. private _size;
  119922. private _onLoad;
  119923. private _onError;
  119924. /**
  119925. * The texture URL.
  119926. */
  119927. url: string;
  119928. /**
  119929. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  119930. */
  119931. coordinatesMode: number;
  119932. protected _isBlocking: boolean;
  119933. /**
  119934. * Sets wether or not the texture is blocking during loading.
  119935. */
  119936. /**
  119937. * Gets wether or not the texture is blocking during loading.
  119938. */
  119939. isBlocking: boolean;
  119940. protected _rotationY: number;
  119941. /**
  119942. * Sets texture matrix rotation angle around Y axis in radians.
  119943. */
  119944. /**
  119945. * Gets texture matrix rotation angle around Y axis radians.
  119946. */
  119947. rotationY: number;
  119948. /**
  119949. * Gets or sets the center of the bounding box associated with the cube texture
  119950. * It must define where the camera used to render the texture was set
  119951. */
  119952. boundingBoxPosition: Vector3;
  119953. private _boundingBoxSize;
  119954. /**
  119955. * Gets or sets the size of the bounding box associated with the cube texture
  119956. * When defined, the cubemap will switch to local mode
  119957. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  119958. * @example https://www.babylonjs-playground.com/#RNASML
  119959. */
  119960. boundingBoxSize: Vector3;
  119961. /**
  119962. * Instantiates an HDRTexture from the following parameters.
  119963. *
  119964. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  119965. * @param scene The scene the texture will be used in
  119966. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  119967. * @param noMipmap Forces to not generate the mipmap if true
  119968. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  119969. * @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)
  119970. * @param reserved Reserved flag for internal use.
  119971. */
  119972. 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>);
  119973. /**
  119974. * Get the current class name of the texture useful for serialization or dynamic coding.
  119975. * @returns "HDRCubeTexture"
  119976. */
  119977. getClassName(): string;
  119978. /**
  119979. * Occurs when the file is raw .hdr file.
  119980. */
  119981. private loadTexture;
  119982. clone(): HDRCubeTexture;
  119983. delayLoad(): void;
  119984. /**
  119985. * Get the texture reflection matrix used to rotate/transform the reflection.
  119986. * @returns the reflection matrix
  119987. */
  119988. getReflectionTextureMatrix(): Matrix;
  119989. /**
  119990. * Set the texture reflection matrix used to rotate/transform the reflection.
  119991. * @param value Define the reflection matrix to set
  119992. */
  119993. setReflectionTextureMatrix(value: Matrix): void;
  119994. /**
  119995. * Parses a JSON representation of an HDR Texture in order to create the texture
  119996. * @param parsedTexture Define the JSON representation
  119997. * @param scene Define the scene the texture should be created in
  119998. * @param rootUrl Define the root url in case we need to load relative dependencies
  119999. * @returns the newly created texture after parsing
  120000. */
  120001. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  120002. serialize(): any;
  120003. }
  120004. }
  120005. declare module BABYLON {
  120006. /**
  120007. * Class used to control physics engine
  120008. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  120009. */
  120010. export class PhysicsEngine implements IPhysicsEngine {
  120011. private _physicsPlugin;
  120012. /**
  120013. * Global value used to control the smallest number supported by the simulation
  120014. */
  120015. static Epsilon: number;
  120016. private _impostors;
  120017. private _joints;
  120018. /**
  120019. * Gets the gravity vector used by the simulation
  120020. */
  120021. gravity: Vector3;
  120022. /**
  120023. * Factory used to create the default physics plugin.
  120024. * @returns The default physics plugin
  120025. */
  120026. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  120027. /**
  120028. * Creates a new Physics Engine
  120029. * @param gravity defines the gravity vector used by the simulation
  120030. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  120031. */
  120032. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  120033. /**
  120034. * Sets the gravity vector used by the simulation
  120035. * @param gravity defines the gravity vector to use
  120036. */
  120037. setGravity(gravity: Vector3): void;
  120038. /**
  120039. * Set the time step of the physics engine.
  120040. * Default is 1/60.
  120041. * To slow it down, enter 1/600 for example.
  120042. * To speed it up, 1/30
  120043. * @param newTimeStep defines the new timestep to apply to this world.
  120044. */
  120045. setTimeStep(newTimeStep?: number): void;
  120046. /**
  120047. * Get the time step of the physics engine.
  120048. * @returns the current time step
  120049. */
  120050. getTimeStep(): number;
  120051. /**
  120052. * Release all resources
  120053. */
  120054. dispose(): void;
  120055. /**
  120056. * Gets the name of the current physics plugin
  120057. * @returns the name of the plugin
  120058. */
  120059. getPhysicsPluginName(): string;
  120060. /**
  120061. * Adding a new impostor for the impostor tracking.
  120062. * This will be done by the impostor itself.
  120063. * @param impostor the impostor to add
  120064. */
  120065. addImpostor(impostor: PhysicsImpostor): void;
  120066. /**
  120067. * Remove an impostor from the engine.
  120068. * This impostor and its mesh will not longer be updated by the physics engine.
  120069. * @param impostor the impostor to remove
  120070. */
  120071. removeImpostor(impostor: PhysicsImpostor): void;
  120072. /**
  120073. * Add a joint to the physics engine
  120074. * @param mainImpostor defines the main impostor to which the joint is added.
  120075. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  120076. * @param joint defines the joint that will connect both impostors.
  120077. */
  120078. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  120079. /**
  120080. * Removes a joint from the simulation
  120081. * @param mainImpostor defines the impostor used with the joint
  120082. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  120083. * @param joint defines the joint to remove
  120084. */
  120085. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  120086. /**
  120087. * Called by the scene. No need to call it.
  120088. * @param delta defines the timespam between frames
  120089. */
  120090. _step(delta: number): void;
  120091. /**
  120092. * Gets the current plugin used to run the simulation
  120093. * @returns current plugin
  120094. */
  120095. getPhysicsPlugin(): IPhysicsEnginePlugin;
  120096. /**
  120097. * Gets the list of physic impostors
  120098. * @returns an array of PhysicsImpostor
  120099. */
  120100. getImpostors(): Array<PhysicsImpostor>;
  120101. /**
  120102. * Gets the impostor for a physics enabled object
  120103. * @param object defines the object impersonated by the impostor
  120104. * @returns the PhysicsImpostor or null if not found
  120105. */
  120106. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  120107. /**
  120108. * Gets the impostor for a physics body object
  120109. * @param body defines physics body used by the impostor
  120110. * @returns the PhysicsImpostor or null if not found
  120111. */
  120112. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  120113. /**
  120114. * Does a raycast in the physics world
  120115. * @param from when should the ray start?
  120116. * @param to when should the ray end?
  120117. * @returns PhysicsRaycastResult
  120118. */
  120119. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120120. }
  120121. }
  120122. declare module BABYLON {
  120123. /** @hidden */
  120124. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  120125. private _useDeltaForWorldStep;
  120126. world: any;
  120127. name: string;
  120128. private _physicsMaterials;
  120129. private _fixedTimeStep;
  120130. private _cannonRaycastResult;
  120131. private _raycastResult;
  120132. private _physicsBodysToRemoveAfterStep;
  120133. BJSCANNON: any;
  120134. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  120135. setGravity(gravity: Vector3): void;
  120136. setTimeStep(timeStep: number): void;
  120137. getTimeStep(): number;
  120138. executeStep(delta: number): void;
  120139. private _removeMarkedPhysicsBodiesFromWorld;
  120140. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120141. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120142. generatePhysicsBody(impostor: PhysicsImpostor): void;
  120143. private _processChildMeshes;
  120144. removePhysicsBody(impostor: PhysicsImpostor): void;
  120145. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  120146. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  120147. private _addMaterial;
  120148. private _checkWithEpsilon;
  120149. private _createShape;
  120150. private _createHeightmap;
  120151. private _minus90X;
  120152. private _plus90X;
  120153. private _tmpPosition;
  120154. private _tmpDeltaPosition;
  120155. private _tmpUnityRotation;
  120156. private _updatePhysicsBodyTransformation;
  120157. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120158. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120159. isSupported(): boolean;
  120160. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120161. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120162. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120163. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120164. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120165. getBodyMass(impostor: PhysicsImpostor): number;
  120166. getBodyFriction(impostor: PhysicsImpostor): number;
  120167. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120168. getBodyRestitution(impostor: PhysicsImpostor): number;
  120169. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120170. sleepBody(impostor: PhysicsImpostor): void;
  120171. wakeUpBody(impostor: PhysicsImpostor): void;
  120172. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  120173. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  120174. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  120175. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120176. getRadius(impostor: PhysicsImpostor): number;
  120177. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120178. dispose(): void;
  120179. private _extendNamespace;
  120180. /**
  120181. * Does a raycast in the physics world
  120182. * @param from when should the ray start?
  120183. * @param to when should the ray end?
  120184. * @returns PhysicsRaycastResult
  120185. */
  120186. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120187. }
  120188. }
  120189. declare module BABYLON {
  120190. /** @hidden */
  120191. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  120192. world: any;
  120193. name: string;
  120194. BJSOIMO: any;
  120195. private _raycastResult;
  120196. constructor(iterations?: number, oimoInjection?: any);
  120197. setGravity(gravity: Vector3): void;
  120198. setTimeStep(timeStep: number): void;
  120199. getTimeStep(): number;
  120200. private _tmpImpostorsArray;
  120201. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  120202. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120203. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120204. generatePhysicsBody(impostor: PhysicsImpostor): void;
  120205. private _tmpPositionVector;
  120206. removePhysicsBody(impostor: PhysicsImpostor): void;
  120207. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  120208. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  120209. isSupported(): boolean;
  120210. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120211. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120212. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120213. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120214. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120215. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120216. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120217. getBodyMass(impostor: PhysicsImpostor): number;
  120218. getBodyFriction(impostor: PhysicsImpostor): number;
  120219. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120220. getBodyRestitution(impostor: PhysicsImpostor): number;
  120221. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120222. sleepBody(impostor: PhysicsImpostor): void;
  120223. wakeUpBody(impostor: PhysicsImpostor): void;
  120224. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  120225. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  120226. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  120227. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120228. getRadius(impostor: PhysicsImpostor): number;
  120229. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120230. dispose(): void;
  120231. /**
  120232. * Does a raycast in the physics world
  120233. * @param from when should the ray start?
  120234. * @param to when should the ray end?
  120235. * @returns PhysicsRaycastResult
  120236. */
  120237. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120238. }
  120239. }
  120240. declare module BABYLON {
  120241. /**
  120242. * Class containing static functions to help procedurally build meshes
  120243. */
  120244. export class RibbonBuilder {
  120245. /**
  120246. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  120247. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  120248. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  120249. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  120250. * * 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
  120251. * * 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
  120252. * * 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
  120253. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120254. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120255. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  120256. * * 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
  120257. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  120258. * * 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
  120259. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  120260. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120261. * @param name defines the name of the mesh
  120262. * @param options defines the options used to create the mesh
  120263. * @param scene defines the hosting scene
  120264. * @returns the ribbon mesh
  120265. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  120266. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120267. */
  120268. static CreateRibbon(name: string, options: {
  120269. pathArray: Vector3[][];
  120270. closeArray?: boolean;
  120271. closePath?: boolean;
  120272. offset?: number;
  120273. updatable?: boolean;
  120274. sideOrientation?: number;
  120275. frontUVs?: Vector4;
  120276. backUVs?: Vector4;
  120277. instance?: Mesh;
  120278. invertUV?: boolean;
  120279. uvs?: Vector2[];
  120280. colors?: Color4[];
  120281. }, scene?: Nullable<Scene>): Mesh;
  120282. }
  120283. }
  120284. declare module BABYLON {
  120285. /**
  120286. * Class containing static functions to help procedurally build meshes
  120287. */
  120288. export class ShapeBuilder {
  120289. /**
  120290. * 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.
  120291. * * 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.
  120292. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  120293. * * 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.
  120294. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  120295. * * 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
  120296. * * 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
  120297. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  120298. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120299. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120300. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  120301. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  120302. * @param name defines the name of the mesh
  120303. * @param options defines the options used to create the mesh
  120304. * @param scene defines the hosting scene
  120305. * @returns the extruded shape mesh
  120306. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120307. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  120308. */
  120309. static ExtrudeShape(name: string, options: {
  120310. shape: Vector3[];
  120311. path: Vector3[];
  120312. scale?: number;
  120313. rotation?: number;
  120314. cap?: number;
  120315. updatable?: boolean;
  120316. sideOrientation?: number;
  120317. frontUVs?: Vector4;
  120318. backUVs?: Vector4;
  120319. instance?: Mesh;
  120320. invertUV?: boolean;
  120321. }, scene?: Nullable<Scene>): Mesh;
  120322. /**
  120323. * Creates an custom extruded shape mesh.
  120324. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  120325. * * 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.
  120326. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  120327. * * 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
  120328. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  120329. * * 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
  120330. * * It must returns a float value that will be the scale value applied to the shape on each path point
  120331. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  120332. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  120333. * * 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
  120334. * * 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
  120335. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  120336. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120337. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120338. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  120339. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120340. * @param name defines the name of the mesh
  120341. * @param options defines the options used to create the mesh
  120342. * @param scene defines the hosting scene
  120343. * @returns the custom extruded shape mesh
  120344. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  120345. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120346. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  120347. */
  120348. static ExtrudeShapeCustom(name: string, options: {
  120349. shape: Vector3[];
  120350. path: Vector3[];
  120351. scaleFunction?: any;
  120352. rotationFunction?: any;
  120353. ribbonCloseArray?: boolean;
  120354. ribbonClosePath?: boolean;
  120355. cap?: number;
  120356. updatable?: boolean;
  120357. sideOrientation?: number;
  120358. frontUVs?: Vector4;
  120359. backUVs?: Vector4;
  120360. instance?: Mesh;
  120361. invertUV?: boolean;
  120362. }, scene?: Nullable<Scene>): Mesh;
  120363. private static _ExtrudeShapeGeneric;
  120364. }
  120365. }
  120366. declare module BABYLON {
  120367. /**
  120368. * AmmoJS Physics plugin
  120369. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  120370. * @see https://github.com/kripken/ammo.js/
  120371. */
  120372. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  120373. private _useDeltaForWorldStep;
  120374. /**
  120375. * Reference to the Ammo library
  120376. */
  120377. bjsAMMO: any;
  120378. /**
  120379. * Created ammoJS world which physics bodies are added to
  120380. */
  120381. world: any;
  120382. /**
  120383. * Name of the plugin
  120384. */
  120385. name: string;
  120386. private _timeStep;
  120387. private _fixedTimeStep;
  120388. private _maxSteps;
  120389. private _tmpQuaternion;
  120390. private _tmpAmmoTransform;
  120391. private _tmpAmmoQuaternion;
  120392. private _tmpAmmoConcreteContactResultCallback;
  120393. private _collisionConfiguration;
  120394. private _dispatcher;
  120395. private _overlappingPairCache;
  120396. private _solver;
  120397. private _softBodySolver;
  120398. private _tmpAmmoVectorA;
  120399. private _tmpAmmoVectorB;
  120400. private _tmpAmmoVectorC;
  120401. private _tmpAmmoVectorD;
  120402. private _tmpContactCallbackResult;
  120403. private _tmpAmmoVectorRCA;
  120404. private _tmpAmmoVectorRCB;
  120405. private _raycastResult;
  120406. private static readonly DISABLE_COLLISION_FLAG;
  120407. private static readonly KINEMATIC_FLAG;
  120408. private static readonly DISABLE_DEACTIVATION_FLAG;
  120409. /**
  120410. * Initializes the ammoJS plugin
  120411. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  120412. * @param ammoInjection can be used to inject your own ammo reference
  120413. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  120414. */
  120415. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  120416. /**
  120417. * Sets the gravity of the physics world (m/(s^2))
  120418. * @param gravity Gravity to set
  120419. */
  120420. setGravity(gravity: Vector3): void;
  120421. /**
  120422. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  120423. * @param timeStep timestep to use in seconds
  120424. */
  120425. setTimeStep(timeStep: number): void;
  120426. /**
  120427. * 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)
  120428. * @param fixedTimeStep fixedTimeStep to use in seconds
  120429. */
  120430. setFixedTimeStep(fixedTimeStep: number): void;
  120431. /**
  120432. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  120433. * @param maxSteps the maximum number of steps by the physics engine per frame
  120434. */
  120435. setMaxSteps(maxSteps: number): void;
  120436. /**
  120437. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  120438. * @returns the current timestep in seconds
  120439. */
  120440. getTimeStep(): number;
  120441. private _isImpostorInContact;
  120442. private _isImpostorPairInContact;
  120443. private _stepSimulation;
  120444. /**
  120445. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  120446. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  120447. * After the step the babylon meshes are set to the position of the physics imposters
  120448. * @param delta amount of time to step forward
  120449. * @param impostors array of imposters to update before/after the step
  120450. */
  120451. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  120452. /**
  120453. * Update babylon mesh to match physics world object
  120454. * @param impostor imposter to match
  120455. */
  120456. private _afterSoftStep;
  120457. /**
  120458. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  120459. * @param impostor imposter to match
  120460. */
  120461. private _ropeStep;
  120462. /**
  120463. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  120464. * @param impostor imposter to match
  120465. */
  120466. private _softbodyOrClothStep;
  120467. private _tmpVector;
  120468. private _tmpMatrix;
  120469. /**
  120470. * Applies an impulse on the imposter
  120471. * @param impostor imposter to apply impulse to
  120472. * @param force amount of force to be applied to the imposter
  120473. * @param contactPoint the location to apply the impulse on the imposter
  120474. */
  120475. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120476. /**
  120477. * Applies a force on the imposter
  120478. * @param impostor imposter to apply force
  120479. * @param force amount of force to be applied to the imposter
  120480. * @param contactPoint the location to apply the force on the imposter
  120481. */
  120482. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120483. /**
  120484. * Creates a physics body using the plugin
  120485. * @param impostor the imposter to create the physics body on
  120486. */
  120487. generatePhysicsBody(impostor: PhysicsImpostor): void;
  120488. /**
  120489. * Removes the physics body from the imposter and disposes of the body's memory
  120490. * @param impostor imposter to remove the physics body from
  120491. */
  120492. removePhysicsBody(impostor: PhysicsImpostor): void;
  120493. /**
  120494. * Generates a joint
  120495. * @param impostorJoint the imposter joint to create the joint with
  120496. */
  120497. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  120498. /**
  120499. * Removes a joint
  120500. * @param impostorJoint the imposter joint to remove the joint from
  120501. */
  120502. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  120503. private _addMeshVerts;
  120504. /**
  120505. * Initialise the soft body vertices to match its object's (mesh) vertices
  120506. * Softbody vertices (nodes) are in world space and to match this
  120507. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  120508. * @param impostor to create the softbody for
  120509. */
  120510. private _softVertexData;
  120511. /**
  120512. * Create an impostor's soft body
  120513. * @param impostor to create the softbody for
  120514. */
  120515. private _createSoftbody;
  120516. /**
  120517. * Create cloth for an impostor
  120518. * @param impostor to create the softbody for
  120519. */
  120520. private _createCloth;
  120521. /**
  120522. * Create rope for an impostor
  120523. * @param impostor to create the softbody for
  120524. */
  120525. private _createRope;
  120526. private _addHullVerts;
  120527. private _createShape;
  120528. /**
  120529. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  120530. * @param impostor imposter containing the physics body and babylon object
  120531. */
  120532. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120533. /**
  120534. * Sets the babylon object's position/rotation from the physics body's position/rotation
  120535. * @param impostor imposter containing the physics body and babylon object
  120536. * @param newPosition new position
  120537. * @param newRotation new rotation
  120538. */
  120539. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120540. /**
  120541. * If this plugin is supported
  120542. * @returns true if its supported
  120543. */
  120544. isSupported(): boolean;
  120545. /**
  120546. * Sets the linear velocity of the physics body
  120547. * @param impostor imposter to set the velocity on
  120548. * @param velocity velocity to set
  120549. */
  120550. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120551. /**
  120552. * Sets the angular velocity of the physics body
  120553. * @param impostor imposter to set the velocity on
  120554. * @param velocity velocity to set
  120555. */
  120556. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120557. /**
  120558. * gets the linear velocity
  120559. * @param impostor imposter to get linear velocity from
  120560. * @returns linear velocity
  120561. */
  120562. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120563. /**
  120564. * gets the angular velocity
  120565. * @param impostor imposter to get angular velocity from
  120566. * @returns angular velocity
  120567. */
  120568. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120569. /**
  120570. * Sets the mass of physics body
  120571. * @param impostor imposter to set the mass on
  120572. * @param mass mass to set
  120573. */
  120574. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120575. /**
  120576. * Gets the mass of the physics body
  120577. * @param impostor imposter to get the mass from
  120578. * @returns mass
  120579. */
  120580. getBodyMass(impostor: PhysicsImpostor): number;
  120581. /**
  120582. * Gets friction of the impostor
  120583. * @param impostor impostor to get friction from
  120584. * @returns friction value
  120585. */
  120586. getBodyFriction(impostor: PhysicsImpostor): number;
  120587. /**
  120588. * Sets friction of the impostor
  120589. * @param impostor impostor to set friction on
  120590. * @param friction friction value
  120591. */
  120592. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120593. /**
  120594. * Gets restitution of the impostor
  120595. * @param impostor impostor to get restitution from
  120596. * @returns restitution value
  120597. */
  120598. getBodyRestitution(impostor: PhysicsImpostor): number;
  120599. /**
  120600. * Sets resitution of the impostor
  120601. * @param impostor impostor to set resitution on
  120602. * @param restitution resitution value
  120603. */
  120604. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120605. /**
  120606. * Gets pressure inside the impostor
  120607. * @param impostor impostor to get pressure from
  120608. * @returns pressure value
  120609. */
  120610. getBodyPressure(impostor: PhysicsImpostor): number;
  120611. /**
  120612. * Sets pressure inside a soft body impostor
  120613. * Cloth and rope must remain 0 pressure
  120614. * @param impostor impostor to set pressure on
  120615. * @param pressure pressure value
  120616. */
  120617. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  120618. /**
  120619. * Gets stiffness of the impostor
  120620. * @param impostor impostor to get stiffness from
  120621. * @returns pressure value
  120622. */
  120623. getBodyStiffness(impostor: PhysicsImpostor): number;
  120624. /**
  120625. * Sets stiffness of the impostor
  120626. * @param impostor impostor to set stiffness on
  120627. * @param stiffness stiffness value from 0 to 1
  120628. */
  120629. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  120630. /**
  120631. * Gets velocityIterations of the impostor
  120632. * @param impostor impostor to get velocity iterations from
  120633. * @returns velocityIterations value
  120634. */
  120635. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  120636. /**
  120637. * Sets velocityIterations of the impostor
  120638. * @param impostor impostor to set velocity iterations on
  120639. * @param velocityIterations velocityIterations value
  120640. */
  120641. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  120642. /**
  120643. * Gets positionIterations of the impostor
  120644. * @param impostor impostor to get position iterations from
  120645. * @returns positionIterations value
  120646. */
  120647. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  120648. /**
  120649. * Sets positionIterations of the impostor
  120650. * @param impostor impostor to set position on
  120651. * @param positionIterations positionIterations value
  120652. */
  120653. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  120654. /**
  120655. * Append an anchor to a cloth object
  120656. * @param impostor is the cloth impostor to add anchor to
  120657. * @param otherImpostor is the rigid impostor to anchor to
  120658. * @param width ratio across width from 0 to 1
  120659. * @param height ratio up height from 0 to 1
  120660. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  120661. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  120662. */
  120663. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  120664. /**
  120665. * Append an hook to a rope object
  120666. * @param impostor is the rope impostor to add hook to
  120667. * @param otherImpostor is the rigid impostor to hook to
  120668. * @param length ratio along the rope from 0 to 1
  120669. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  120670. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  120671. */
  120672. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  120673. /**
  120674. * Sleeps the physics body and stops it from being active
  120675. * @param impostor impostor to sleep
  120676. */
  120677. sleepBody(impostor: PhysicsImpostor): void;
  120678. /**
  120679. * Activates the physics body
  120680. * @param impostor impostor to activate
  120681. */
  120682. wakeUpBody(impostor: PhysicsImpostor): void;
  120683. /**
  120684. * Updates the distance parameters of the joint
  120685. * @param joint joint to update
  120686. * @param maxDistance maximum distance of the joint
  120687. * @param minDistance minimum distance of the joint
  120688. */
  120689. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  120690. /**
  120691. * Sets a motor on the joint
  120692. * @param joint joint to set motor on
  120693. * @param speed speed of the motor
  120694. * @param maxForce maximum force of the motor
  120695. * @param motorIndex index of the motor
  120696. */
  120697. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  120698. /**
  120699. * Sets the motors limit
  120700. * @param joint joint to set limit on
  120701. * @param upperLimit upper limit
  120702. * @param lowerLimit lower limit
  120703. */
  120704. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  120705. /**
  120706. * Syncs the position and rotation of a mesh with the impostor
  120707. * @param mesh mesh to sync
  120708. * @param impostor impostor to update the mesh with
  120709. */
  120710. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120711. /**
  120712. * Gets the radius of the impostor
  120713. * @param impostor impostor to get radius from
  120714. * @returns the radius
  120715. */
  120716. getRadius(impostor: PhysicsImpostor): number;
  120717. /**
  120718. * Gets the box size of the impostor
  120719. * @param impostor impostor to get box size from
  120720. * @param result the resulting box size
  120721. */
  120722. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120723. /**
  120724. * Disposes of the impostor
  120725. */
  120726. dispose(): void;
  120727. /**
  120728. * Does a raycast in the physics world
  120729. * @param from when should the ray start?
  120730. * @param to when should the ray end?
  120731. * @returns PhysicsRaycastResult
  120732. */
  120733. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120734. }
  120735. }
  120736. declare module BABYLON {
  120737. interface AbstractScene {
  120738. /**
  120739. * The list of reflection probes added to the scene
  120740. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  120741. */
  120742. reflectionProbes: Array<ReflectionProbe>;
  120743. /**
  120744. * Removes the given reflection probe from this scene.
  120745. * @param toRemove The reflection probe to remove
  120746. * @returns The index of the removed reflection probe
  120747. */
  120748. removeReflectionProbe(toRemove: ReflectionProbe): number;
  120749. /**
  120750. * Adds the given reflection probe to this scene.
  120751. * @param newReflectionProbe The reflection probe to add
  120752. */
  120753. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  120754. }
  120755. /**
  120756. * Class used to generate realtime reflection / refraction cube textures
  120757. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  120758. */
  120759. export class ReflectionProbe {
  120760. /** defines the name of the probe */
  120761. name: string;
  120762. private _scene;
  120763. private _renderTargetTexture;
  120764. private _projectionMatrix;
  120765. private _viewMatrix;
  120766. private _target;
  120767. private _add;
  120768. private _attachedMesh;
  120769. private _invertYAxis;
  120770. /** Gets or sets probe position (center of the cube map) */
  120771. position: Vector3;
  120772. /**
  120773. * Creates a new reflection probe
  120774. * @param name defines the name of the probe
  120775. * @param size defines the texture resolution (for each face)
  120776. * @param scene defines the hosting scene
  120777. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  120778. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  120779. */
  120780. constructor(
  120781. /** defines the name of the probe */
  120782. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  120783. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  120784. samples: number;
  120785. /** Gets or sets the refresh rate to use (on every frame by default) */
  120786. refreshRate: number;
  120787. /**
  120788. * Gets the hosting scene
  120789. * @returns a Scene
  120790. */
  120791. getScene(): Scene;
  120792. /** Gets the internal CubeTexture used to render to */
  120793. readonly cubeTexture: RenderTargetTexture;
  120794. /** Gets the list of meshes to render */
  120795. readonly renderList: Nullable<AbstractMesh[]>;
  120796. /**
  120797. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  120798. * @param mesh defines the mesh to attach to
  120799. */
  120800. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  120801. /**
  120802. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  120803. * @param renderingGroupId The rendering group id corresponding to its index
  120804. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120805. */
  120806. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  120807. /**
  120808. * Clean all associated resources
  120809. */
  120810. dispose(): void;
  120811. /**
  120812. * Converts the reflection probe information to a readable string for debug purpose.
  120813. * @param fullDetails Supports for multiple levels of logging within scene loading
  120814. * @returns the human readable reflection probe info
  120815. */
  120816. toString(fullDetails?: boolean): string;
  120817. /**
  120818. * Get the class name of the relfection probe.
  120819. * @returns "ReflectionProbe"
  120820. */
  120821. getClassName(): string;
  120822. /**
  120823. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  120824. * @returns The JSON representation of the texture
  120825. */
  120826. serialize(): any;
  120827. /**
  120828. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  120829. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  120830. * @param scene Define the scene the parsed reflection probe should be instantiated in
  120831. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  120832. * @returns The parsed reflection probe if successful
  120833. */
  120834. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  120835. }
  120836. }
  120837. declare module BABYLON {
  120838. /** @hidden */
  120839. export var _BabylonLoaderRegistered: boolean;
  120840. /**
  120841. * Helps setting up some configuration for the babylon file loader.
  120842. */
  120843. export class BabylonFileLoaderConfiguration {
  120844. /**
  120845. * The loader does not allow injecting custom physix engine into the plugins.
  120846. * Unfortunately in ES6, we need to manually inject them into the plugin.
  120847. * So you could set this variable to your engine import to make it work.
  120848. */
  120849. static LoaderInjectedPhysicsEngine: any;
  120850. }
  120851. }
  120852. declare module BABYLON {
  120853. /**
  120854. * The Physically based simple base material of BJS.
  120855. *
  120856. * This enables better naming and convention enforcements on top of the pbrMaterial.
  120857. * It is used as the base class for both the specGloss and metalRough conventions.
  120858. */
  120859. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  120860. /**
  120861. * Number of Simultaneous lights allowed on the material.
  120862. */
  120863. maxSimultaneousLights: number;
  120864. /**
  120865. * If sets to true, disables all the lights affecting the material.
  120866. */
  120867. disableLighting: boolean;
  120868. /**
  120869. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  120870. */
  120871. environmentTexture: BaseTexture;
  120872. /**
  120873. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  120874. */
  120875. invertNormalMapX: boolean;
  120876. /**
  120877. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  120878. */
  120879. invertNormalMapY: boolean;
  120880. /**
  120881. * Normal map used in the model.
  120882. */
  120883. normalTexture: BaseTexture;
  120884. /**
  120885. * Emissivie color used to self-illuminate the model.
  120886. */
  120887. emissiveColor: Color3;
  120888. /**
  120889. * Emissivie texture used to self-illuminate the model.
  120890. */
  120891. emissiveTexture: BaseTexture;
  120892. /**
  120893. * Occlusion Channel Strenght.
  120894. */
  120895. occlusionStrength: number;
  120896. /**
  120897. * Occlusion Texture of the material (adding extra occlusion effects).
  120898. */
  120899. occlusionTexture: BaseTexture;
  120900. /**
  120901. * Defines the alpha limits in alpha test mode.
  120902. */
  120903. alphaCutOff: number;
  120904. /**
  120905. * Gets the current double sided mode.
  120906. */
  120907. /**
  120908. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  120909. */
  120910. doubleSided: boolean;
  120911. /**
  120912. * Stores the pre-calculated light information of a mesh in a texture.
  120913. */
  120914. lightmapTexture: BaseTexture;
  120915. /**
  120916. * If true, the light map contains occlusion information instead of lighting info.
  120917. */
  120918. useLightmapAsShadowmap: boolean;
  120919. /**
  120920. * Instantiates a new PBRMaterial instance.
  120921. *
  120922. * @param name The material name
  120923. * @param scene The scene the material will be use in.
  120924. */
  120925. constructor(name: string, scene: Scene);
  120926. getClassName(): string;
  120927. }
  120928. }
  120929. declare module BABYLON {
  120930. /**
  120931. * The PBR material of BJS following the metal roughness convention.
  120932. *
  120933. * This fits to the PBR convention in the GLTF definition:
  120934. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  120935. */
  120936. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  120937. /**
  120938. * The base color has two different interpretations depending on the value of metalness.
  120939. * When the material is a metal, the base color is the specific measured reflectance value
  120940. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  120941. * of the material.
  120942. */
  120943. baseColor: Color3;
  120944. /**
  120945. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  120946. * well as opacity information in the alpha channel.
  120947. */
  120948. baseTexture: BaseTexture;
  120949. /**
  120950. * Specifies the metallic scalar value of the material.
  120951. * Can also be used to scale the metalness values of the metallic texture.
  120952. */
  120953. metallic: number;
  120954. /**
  120955. * Specifies the roughness scalar value of the material.
  120956. * Can also be used to scale the roughness values of the metallic texture.
  120957. */
  120958. roughness: number;
  120959. /**
  120960. * Texture containing both the metallic value in the B channel and the
  120961. * roughness value in the G channel to keep better precision.
  120962. */
  120963. metallicRoughnessTexture: BaseTexture;
  120964. /**
  120965. * Instantiates a new PBRMetalRoughnessMaterial instance.
  120966. *
  120967. * @param name The material name
  120968. * @param scene The scene the material will be use in.
  120969. */
  120970. constructor(name: string, scene: Scene);
  120971. /**
  120972. * Return the currrent class name of the material.
  120973. */
  120974. getClassName(): string;
  120975. /**
  120976. * Makes a duplicate of the current material.
  120977. * @param name - name to use for the new material.
  120978. */
  120979. clone(name: string): PBRMetallicRoughnessMaterial;
  120980. /**
  120981. * Serialize the material to a parsable JSON object.
  120982. */
  120983. serialize(): any;
  120984. /**
  120985. * Parses a JSON object correponding to the serialize function.
  120986. */
  120987. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  120988. }
  120989. }
  120990. declare module BABYLON {
  120991. /**
  120992. * The PBR material of BJS following the specular glossiness convention.
  120993. *
  120994. * This fits to the PBR convention in the GLTF definition:
  120995. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  120996. */
  120997. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  120998. /**
  120999. * Specifies the diffuse color of the material.
  121000. */
  121001. diffuseColor: Color3;
  121002. /**
  121003. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  121004. * channel.
  121005. */
  121006. diffuseTexture: BaseTexture;
  121007. /**
  121008. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  121009. */
  121010. specularColor: Color3;
  121011. /**
  121012. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  121013. */
  121014. glossiness: number;
  121015. /**
  121016. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  121017. */
  121018. specularGlossinessTexture: BaseTexture;
  121019. /**
  121020. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  121021. *
  121022. * @param name The material name
  121023. * @param scene The scene the material will be use in.
  121024. */
  121025. constructor(name: string, scene: Scene);
  121026. /**
  121027. * Return the currrent class name of the material.
  121028. */
  121029. getClassName(): string;
  121030. /**
  121031. * Makes a duplicate of the current material.
  121032. * @param name - name to use for the new material.
  121033. */
  121034. clone(name: string): PBRSpecularGlossinessMaterial;
  121035. /**
  121036. * Serialize the material to a parsable JSON object.
  121037. */
  121038. serialize(): any;
  121039. /**
  121040. * Parses a JSON object correponding to the serialize function.
  121041. */
  121042. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  121043. }
  121044. }
  121045. declare module BABYLON {
  121046. /**
  121047. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  121048. * It can help converting any input color in a desired output one. This can then be used to create effects
  121049. * from sepia, black and white to sixties or futuristic rendering...
  121050. *
  121051. * The only supported format is currently 3dl.
  121052. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  121053. */
  121054. export class ColorGradingTexture extends BaseTexture {
  121055. /**
  121056. * The current texture matrix. (will always be identity in color grading texture)
  121057. */
  121058. private _textureMatrix;
  121059. /**
  121060. * The texture URL.
  121061. */
  121062. url: string;
  121063. /**
  121064. * Empty line regex stored for GC.
  121065. */
  121066. private static _noneEmptyLineRegex;
  121067. private _engine;
  121068. /**
  121069. * Instantiates a ColorGradingTexture from the following parameters.
  121070. *
  121071. * @param url The location of the color gradind data (currently only supporting 3dl)
  121072. * @param scene The scene the texture will be used in
  121073. */
  121074. constructor(url: string, scene: Scene);
  121075. /**
  121076. * Returns the texture matrix used in most of the material.
  121077. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  121078. */
  121079. getTextureMatrix(): Matrix;
  121080. /**
  121081. * Occurs when the file being loaded is a .3dl LUT file.
  121082. */
  121083. private load3dlTexture;
  121084. /**
  121085. * Starts the loading process of the texture.
  121086. */
  121087. private loadTexture;
  121088. /**
  121089. * Clones the color gradind texture.
  121090. */
  121091. clone(): ColorGradingTexture;
  121092. /**
  121093. * Called during delayed load for textures.
  121094. */
  121095. delayLoad(): void;
  121096. /**
  121097. * Parses a color grading texture serialized by Babylon.
  121098. * @param parsedTexture The texture information being parsedTexture
  121099. * @param scene The scene to load the texture in
  121100. * @param rootUrl The root url of the data assets to load
  121101. * @return A color gradind texture
  121102. */
  121103. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  121104. /**
  121105. * Serializes the LUT texture to json format.
  121106. */
  121107. serialize(): any;
  121108. }
  121109. }
  121110. declare module BABYLON {
  121111. /**
  121112. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  121113. */
  121114. export class EquiRectangularCubeTexture extends BaseTexture {
  121115. /** The six faces of the cube. */
  121116. private static _FacesMapping;
  121117. private _noMipmap;
  121118. private _onLoad;
  121119. private _onError;
  121120. /** The size of the cubemap. */
  121121. private _size;
  121122. /** The buffer of the image. */
  121123. private _buffer;
  121124. /** The width of the input image. */
  121125. private _width;
  121126. /** The height of the input image. */
  121127. private _height;
  121128. /** The URL to the image. */
  121129. url: string;
  121130. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  121131. coordinatesMode: number;
  121132. /**
  121133. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  121134. * @param url The location of the image
  121135. * @param scene The scene the texture will be used in
  121136. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  121137. * @param noMipmap Forces to not generate the mipmap if true
  121138. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  121139. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  121140. * @param onLoad — defines a callback called when texture is loaded
  121141. * @param onError — defines a callback called if there is an error
  121142. */
  121143. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  121144. /**
  121145. * Load the image data, by putting the image on a canvas and extracting its buffer.
  121146. */
  121147. private loadImage;
  121148. /**
  121149. * Convert the image buffer into a cubemap and create a CubeTexture.
  121150. */
  121151. private loadTexture;
  121152. /**
  121153. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  121154. * @param buffer The ArrayBuffer that should be converted.
  121155. * @returns The buffer as Float32Array.
  121156. */
  121157. private getFloat32ArrayFromArrayBuffer;
  121158. /**
  121159. * Get the current class name of the texture useful for serialization or dynamic coding.
  121160. * @returns "EquiRectangularCubeTexture"
  121161. */
  121162. getClassName(): string;
  121163. /**
  121164. * Create a clone of the current EquiRectangularCubeTexture and return it.
  121165. * @returns A clone of the current EquiRectangularCubeTexture.
  121166. */
  121167. clone(): EquiRectangularCubeTexture;
  121168. }
  121169. }
  121170. declare module BABYLON {
  121171. /**
  121172. * Based on jsTGALoader - Javascript loader for TGA file
  121173. * By Vincent Thibault
  121174. * @see http://blog.robrowser.com/javascript-tga-loader.html
  121175. */
  121176. export class TGATools {
  121177. private static _TYPE_INDEXED;
  121178. private static _TYPE_RGB;
  121179. private static _TYPE_GREY;
  121180. private static _TYPE_RLE_INDEXED;
  121181. private static _TYPE_RLE_RGB;
  121182. private static _TYPE_RLE_GREY;
  121183. private static _ORIGIN_MASK;
  121184. private static _ORIGIN_SHIFT;
  121185. private static _ORIGIN_BL;
  121186. private static _ORIGIN_BR;
  121187. private static _ORIGIN_UL;
  121188. private static _ORIGIN_UR;
  121189. /**
  121190. * Gets the header of a TGA file
  121191. * @param data defines the TGA data
  121192. * @returns the header
  121193. */
  121194. static GetTGAHeader(data: Uint8Array): any;
  121195. /**
  121196. * Uploads TGA content to a Babylon Texture
  121197. * @hidden
  121198. */
  121199. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  121200. /** @hidden */
  121201. 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;
  121202. /** @hidden */
  121203. 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;
  121204. /** @hidden */
  121205. 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;
  121206. /** @hidden */
  121207. 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;
  121208. /** @hidden */
  121209. 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;
  121210. /** @hidden */
  121211. 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;
  121212. }
  121213. }
  121214. declare module BABYLON {
  121215. /**
  121216. * Implementation of the TGA Texture Loader.
  121217. * @hidden
  121218. */
  121219. export class _TGATextureLoader implements IInternalTextureLoader {
  121220. /**
  121221. * Defines wether the loader supports cascade loading the different faces.
  121222. */
  121223. readonly supportCascades: boolean;
  121224. /**
  121225. * This returns if the loader support the current file information.
  121226. * @param extension defines the file extension of the file being loaded
  121227. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121228. * @param fallback defines the fallback internal texture if any
  121229. * @param isBase64 defines whether the texture is encoded as a base64
  121230. * @param isBuffer defines whether the texture data are stored as a buffer
  121231. * @returns true if the loader can load the specified file
  121232. */
  121233. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  121234. /**
  121235. * Transform the url before loading if required.
  121236. * @param rootUrl the url of the texture
  121237. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121238. * @returns the transformed texture
  121239. */
  121240. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  121241. /**
  121242. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  121243. * @param rootUrl the url of the texture
  121244. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121245. * @returns the fallback texture
  121246. */
  121247. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  121248. /**
  121249. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  121250. * @param data contains the texture data
  121251. * @param texture defines the BabylonJS internal texture
  121252. * @param createPolynomials will be true if polynomials have been requested
  121253. * @param onLoad defines the callback to trigger once the texture is ready
  121254. * @param onError defines the callback to trigger in case of error
  121255. */
  121256. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  121257. /**
  121258. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  121259. * @param data contains the texture data
  121260. * @param texture defines the BabylonJS internal texture
  121261. * @param callback defines the method to call once ready to upload
  121262. */
  121263. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  121264. }
  121265. }
  121266. declare module BABYLON {
  121267. /**
  121268. * Info about the .basis files
  121269. */
  121270. class BasisFileInfo {
  121271. /**
  121272. * If the file has alpha
  121273. */
  121274. hasAlpha: boolean;
  121275. /**
  121276. * Info about each image of the basis file
  121277. */
  121278. images: Array<{
  121279. levels: Array<{
  121280. width: number;
  121281. height: number;
  121282. transcodedPixels: ArrayBufferView;
  121283. }>;
  121284. }>;
  121285. }
  121286. /**
  121287. * Result of transcoding a basis file
  121288. */
  121289. class TranscodeResult {
  121290. /**
  121291. * Info about the .basis file
  121292. */
  121293. fileInfo: BasisFileInfo;
  121294. /**
  121295. * Format to use when loading the file
  121296. */
  121297. format: number;
  121298. }
  121299. /**
  121300. * Configuration options for the Basis transcoder
  121301. */
  121302. export class BasisTranscodeConfiguration {
  121303. /**
  121304. * Supported compression formats used to determine the supported output format of the transcoder
  121305. */
  121306. supportedCompressionFormats?: {
  121307. /**
  121308. * etc1 compression format
  121309. */
  121310. etc1?: boolean;
  121311. /**
  121312. * s3tc compression format
  121313. */
  121314. s3tc?: boolean;
  121315. /**
  121316. * pvrtc compression format
  121317. */
  121318. pvrtc?: boolean;
  121319. /**
  121320. * etc2 compression format
  121321. */
  121322. etc2?: boolean;
  121323. };
  121324. /**
  121325. * If mipmap levels should be loaded for transcoded images (Default: true)
  121326. */
  121327. loadMipmapLevels?: boolean;
  121328. /**
  121329. * Index of a single image to load (Default: all images)
  121330. */
  121331. loadSingleImage?: number;
  121332. }
  121333. /**
  121334. * Used to load .Basis files
  121335. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  121336. */
  121337. export class BasisTools {
  121338. private static _IgnoreSupportedFormats;
  121339. /**
  121340. * URL to use when loading the basis transcoder
  121341. */
  121342. static JSModuleURL: string;
  121343. /**
  121344. * URL to use when loading the wasm module for the transcoder
  121345. */
  121346. static WasmModuleURL: string;
  121347. /**
  121348. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  121349. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  121350. * @returns internal format corresponding to the Basis format
  121351. */
  121352. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  121353. private static _WorkerPromise;
  121354. private static _Worker;
  121355. private static _actionId;
  121356. private static _CreateWorkerAsync;
  121357. /**
  121358. * Transcodes a loaded image file to compressed pixel data
  121359. * @param imageData image data to transcode
  121360. * @param config configuration options for the transcoding
  121361. * @returns a promise resulting in the transcoded image
  121362. */
  121363. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  121364. /**
  121365. * Loads a texture from the transcode result
  121366. * @param texture texture load to
  121367. * @param transcodeResult the result of transcoding the basis file to load from
  121368. */
  121369. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  121370. }
  121371. }
  121372. declare module BABYLON {
  121373. /**
  121374. * Loader for .basis file format
  121375. */
  121376. export class _BasisTextureLoader implements IInternalTextureLoader {
  121377. /**
  121378. * Defines whether the loader supports cascade loading the different faces.
  121379. */
  121380. readonly supportCascades: boolean;
  121381. /**
  121382. * This returns if the loader support the current file information.
  121383. * @param extension defines the file extension of the file being loaded
  121384. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121385. * @param fallback defines the fallback internal texture if any
  121386. * @param isBase64 defines whether the texture is encoded as a base64
  121387. * @param isBuffer defines whether the texture data are stored as a buffer
  121388. * @returns true if the loader can load the specified file
  121389. */
  121390. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  121391. /**
  121392. * Transform the url before loading if required.
  121393. * @param rootUrl the url of the texture
  121394. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121395. * @returns the transformed texture
  121396. */
  121397. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  121398. /**
  121399. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  121400. * @param rootUrl the url of the texture
  121401. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121402. * @returns the fallback texture
  121403. */
  121404. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  121405. /**
  121406. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  121407. * @param data contains the texture data
  121408. * @param texture defines the BabylonJS internal texture
  121409. * @param createPolynomials will be true if polynomials have been requested
  121410. * @param onLoad defines the callback to trigger once the texture is ready
  121411. * @param onError defines the callback to trigger in case of error
  121412. */
  121413. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  121414. /**
  121415. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  121416. * @param data contains the texture data
  121417. * @param texture defines the BabylonJS internal texture
  121418. * @param callback defines the method to call once ready to upload
  121419. */
  121420. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  121421. }
  121422. }
  121423. declare module BABYLON {
  121424. /**
  121425. * 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.
  121426. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  121427. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  121428. */
  121429. export class CustomProceduralTexture extends ProceduralTexture {
  121430. private _animate;
  121431. private _time;
  121432. private _config;
  121433. private _texturePath;
  121434. /**
  121435. * Instantiates a new Custom Procedural Texture.
  121436. * 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.
  121437. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  121438. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  121439. * @param name Define the name of the texture
  121440. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  121441. * @param size Define the size of the texture to create
  121442. * @param scene Define the scene the texture belongs to
  121443. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  121444. * @param generateMipMaps Define if the texture should creates mip maps or not
  121445. */
  121446. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  121447. private _loadJson;
  121448. /**
  121449. * Is the texture ready to be used ? (rendered at least once)
  121450. * @returns true if ready, otherwise, false.
  121451. */
  121452. isReady(): boolean;
  121453. /**
  121454. * Render the texture to its associated render target.
  121455. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  121456. */
  121457. render(useCameraPostProcess?: boolean): void;
  121458. /**
  121459. * Update the list of dependant textures samplers in the shader.
  121460. */
  121461. updateTextures(): void;
  121462. /**
  121463. * Update the uniform values of the procedural texture in the shader.
  121464. */
  121465. updateShaderUniforms(): void;
  121466. /**
  121467. * Define if the texture animates or not.
  121468. */
  121469. animate: boolean;
  121470. }
  121471. }
  121472. declare module BABYLON {
  121473. /** @hidden */
  121474. export var noisePixelShader: {
  121475. name: string;
  121476. shader: string;
  121477. };
  121478. }
  121479. declare module BABYLON {
  121480. /**
  121481. * Class used to generate noise procedural textures
  121482. */
  121483. export class NoiseProceduralTexture extends ProceduralTexture {
  121484. private _time;
  121485. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  121486. brightness: number;
  121487. /** Defines the number of octaves to process */
  121488. octaves: number;
  121489. /** Defines the level of persistence (0.8 by default) */
  121490. persistence: number;
  121491. /** Gets or sets animation speed factor (default is 1) */
  121492. animationSpeedFactor: number;
  121493. /**
  121494. * Creates a new NoiseProceduralTexture
  121495. * @param name defines the name fo the texture
  121496. * @param size defines the size of the texture (default is 256)
  121497. * @param scene defines the hosting scene
  121498. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  121499. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  121500. */
  121501. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  121502. private _updateShaderUniforms;
  121503. protected _getDefines(): string;
  121504. /** Generate the current state of the procedural texture */
  121505. render(useCameraPostProcess?: boolean): void;
  121506. /**
  121507. * Serializes this noise procedural texture
  121508. * @returns a serialized noise procedural texture object
  121509. */
  121510. serialize(): any;
  121511. /**
  121512. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  121513. * @param parsedTexture defines parsed texture data
  121514. * @param scene defines the current scene
  121515. * @param rootUrl defines the root URL containing noise procedural texture information
  121516. * @returns a parsed NoiseProceduralTexture
  121517. */
  121518. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  121519. }
  121520. }
  121521. declare module BABYLON {
  121522. /**
  121523. * Raw cube texture where the raw buffers are passed in
  121524. */
  121525. export class RawCubeTexture extends CubeTexture {
  121526. /**
  121527. * Creates a cube texture where the raw buffers are passed in.
  121528. * @param scene defines the scene the texture is attached to
  121529. * @param data defines the array of data to use to create each face
  121530. * @param size defines the size of the textures
  121531. * @param format defines the format of the data
  121532. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  121533. * @param generateMipMaps defines if the engine should generate the mip levels
  121534. * @param invertY defines if data must be stored with Y axis inverted
  121535. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  121536. * @param compression defines the compression used (null by default)
  121537. */
  121538. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  121539. /**
  121540. * Updates the raw cube texture.
  121541. * @param data defines the data to store
  121542. * @param format defines the data format
  121543. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  121544. * @param invertY defines if data must be stored with Y axis inverted
  121545. * @param compression defines the compression used (null by default)
  121546. * @param level defines which level of the texture to update
  121547. */
  121548. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  121549. /**
  121550. * Updates a raw cube texture with RGBD encoded data.
  121551. * @param data defines the array of data [mipmap][face] to use to create each face
  121552. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  121553. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  121554. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  121555. * @returns a promsie that resolves when the operation is complete
  121556. */
  121557. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  121558. /**
  121559. * Clones the raw cube texture.
  121560. * @return a new cube texture
  121561. */
  121562. clone(): CubeTexture;
  121563. /** @hidden */
  121564. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  121565. }
  121566. }
  121567. declare module BABYLON {
  121568. /**
  121569. * Class used to store 3D textures containing user data
  121570. */
  121571. export class RawTexture3D extends Texture {
  121572. /** Gets or sets the texture format to use */
  121573. format: number;
  121574. private _engine;
  121575. /**
  121576. * Create a new RawTexture3D
  121577. * @param data defines the data of the texture
  121578. * @param width defines the width of the texture
  121579. * @param height defines the height of the texture
  121580. * @param depth defines the depth of the texture
  121581. * @param format defines the texture format to use
  121582. * @param scene defines the hosting scene
  121583. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  121584. * @param invertY defines if texture must be stored with Y axis inverted
  121585. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  121586. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  121587. */
  121588. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  121589. /** Gets or sets the texture format to use */
  121590. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  121591. /**
  121592. * Update the texture with new data
  121593. * @param data defines the data to store in the texture
  121594. */
  121595. update(data: ArrayBufferView): void;
  121596. }
  121597. }
  121598. declare module BABYLON {
  121599. /**
  121600. * Class used to store 2D array textures containing user data
  121601. */
  121602. export class RawTexture2DArray extends Texture {
  121603. /** Gets or sets the texture format to use */
  121604. format: number;
  121605. private _engine;
  121606. /**
  121607. * Create a new RawTexture2DArray
  121608. * @param data defines the data of the texture
  121609. * @param width defines the width of the texture
  121610. * @param height defines the height of the texture
  121611. * @param depth defines the number of layers of the texture
  121612. * @param format defines the texture format to use
  121613. * @param scene defines the hosting scene
  121614. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  121615. * @param invertY defines if texture must be stored with Y axis inverted
  121616. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  121617. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  121618. */
  121619. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  121620. /** Gets or sets the texture format to use */
  121621. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  121622. /**
  121623. * Update the texture with new data
  121624. * @param data defines the data to store in the texture
  121625. */
  121626. update(data: ArrayBufferView): void;
  121627. }
  121628. }
  121629. declare module BABYLON {
  121630. /**
  121631. * Creates a refraction texture used by refraction channel of the standard material.
  121632. * It is like a mirror but to see through a material.
  121633. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121634. */
  121635. export class RefractionTexture extends RenderTargetTexture {
  121636. /**
  121637. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  121638. * 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.
  121639. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121640. */
  121641. refractionPlane: Plane;
  121642. /**
  121643. * Define how deep under the surface we should see.
  121644. */
  121645. depth: number;
  121646. /**
  121647. * Creates a refraction texture used by refraction channel of the standard material.
  121648. * It is like a mirror but to see through a material.
  121649. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121650. * @param name Define the texture name
  121651. * @param size Define the size of the underlying texture
  121652. * @param scene Define the scene the refraction belongs to
  121653. * @param generateMipMaps Define if we need to generate mips level for the refraction
  121654. */
  121655. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  121656. /**
  121657. * Clone the refraction texture.
  121658. * @returns the cloned texture
  121659. */
  121660. clone(): RefractionTexture;
  121661. /**
  121662. * Serialize the texture to a JSON representation you could use in Parse later on
  121663. * @returns the serialized JSON representation
  121664. */
  121665. serialize(): any;
  121666. }
  121667. }
  121668. declare module BABYLON {
  121669. /**
  121670. * Defines the options related to the creation of an HtmlElementTexture
  121671. */
  121672. export interface IHtmlElementTextureOptions {
  121673. /**
  121674. * Defines wether mip maps should be created or not.
  121675. */
  121676. generateMipMaps?: boolean;
  121677. /**
  121678. * Defines the sampling mode of the texture.
  121679. */
  121680. samplingMode?: number;
  121681. /**
  121682. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  121683. */
  121684. engine: Nullable<ThinEngine>;
  121685. /**
  121686. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  121687. */
  121688. scene: Nullable<Scene>;
  121689. }
  121690. /**
  121691. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  121692. * To be as efficient as possible depending on your constraints nothing aside the first upload
  121693. * is automatically managed.
  121694. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  121695. * in your application.
  121696. *
  121697. * As the update is not automatic, you need to call them manually.
  121698. */
  121699. export class HtmlElementTexture extends BaseTexture {
  121700. /**
  121701. * The texture URL.
  121702. */
  121703. element: HTMLVideoElement | HTMLCanvasElement;
  121704. private static readonly DefaultOptions;
  121705. private _textureMatrix;
  121706. private _engine;
  121707. private _isVideo;
  121708. private _generateMipMaps;
  121709. private _samplingMode;
  121710. /**
  121711. * Instantiates a HtmlElementTexture from the following parameters.
  121712. *
  121713. * @param name Defines the name of the texture
  121714. * @param element Defines the video or canvas the texture is filled with
  121715. * @param options Defines the other none mandatory texture creation options
  121716. */
  121717. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  121718. private _createInternalTexture;
  121719. /**
  121720. * Returns the texture matrix used in most of the material.
  121721. */
  121722. getTextureMatrix(): Matrix;
  121723. /**
  121724. * Updates the content of the texture.
  121725. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  121726. */
  121727. update(invertY?: Nullable<boolean>): void;
  121728. }
  121729. }
  121730. declare module BABYLON {
  121731. /**
  121732. * Enum used to define the target of a block
  121733. */
  121734. export enum NodeMaterialBlockTargets {
  121735. /** Vertex shader */
  121736. Vertex = 1,
  121737. /** Fragment shader */
  121738. Fragment = 2,
  121739. /** Neutral */
  121740. Neutral = 4,
  121741. /** Vertex and Fragment */
  121742. VertexAndFragment = 3
  121743. }
  121744. }
  121745. declare module BABYLON {
  121746. /**
  121747. * Defines the kind of connection point for node based material
  121748. */
  121749. export enum NodeMaterialBlockConnectionPointTypes {
  121750. /** Float */
  121751. Float = 1,
  121752. /** Int */
  121753. Int = 2,
  121754. /** Vector2 */
  121755. Vector2 = 4,
  121756. /** Vector3 */
  121757. Vector3 = 8,
  121758. /** Vector4 */
  121759. Vector4 = 16,
  121760. /** Color3 */
  121761. Color3 = 32,
  121762. /** Color4 */
  121763. Color4 = 64,
  121764. /** Matrix */
  121765. Matrix = 128,
  121766. /** Detect type based on connection */
  121767. AutoDetect = 1024,
  121768. /** Output type that will be defined by input type */
  121769. BasedOnInput = 2048
  121770. }
  121771. }
  121772. declare module BABYLON {
  121773. /**
  121774. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  121775. */
  121776. export enum NodeMaterialBlockConnectionPointMode {
  121777. /** Value is an uniform */
  121778. Uniform = 0,
  121779. /** Value is a mesh attribute */
  121780. Attribute = 1,
  121781. /** Value is a varying between vertex and fragment shaders */
  121782. Varying = 2,
  121783. /** Mode is undefined */
  121784. Undefined = 3
  121785. }
  121786. }
  121787. declare module BABYLON {
  121788. /**
  121789. * Enum used to define system values e.g. values automatically provided by the system
  121790. */
  121791. export enum NodeMaterialSystemValues {
  121792. /** World */
  121793. World = 1,
  121794. /** View */
  121795. View = 2,
  121796. /** Projection */
  121797. Projection = 3,
  121798. /** ViewProjection */
  121799. ViewProjection = 4,
  121800. /** WorldView */
  121801. WorldView = 5,
  121802. /** WorldViewProjection */
  121803. WorldViewProjection = 6,
  121804. /** CameraPosition */
  121805. CameraPosition = 7,
  121806. /** Fog Color */
  121807. FogColor = 8,
  121808. /** Delta time */
  121809. DeltaTime = 9
  121810. }
  121811. }
  121812. declare module BABYLON {
  121813. /**
  121814. * Root class for all node material optimizers
  121815. */
  121816. export class NodeMaterialOptimizer {
  121817. /**
  121818. * Function used to optimize a NodeMaterial graph
  121819. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  121820. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  121821. */
  121822. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  121823. }
  121824. }
  121825. declare module BABYLON {
  121826. /**
  121827. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  121828. */
  121829. export class TransformBlock extends NodeMaterialBlock {
  121830. /**
  121831. * Defines the value to use to complement W value to transform it to a Vector4
  121832. */
  121833. complementW: number;
  121834. /**
  121835. * Defines the value to use to complement z value to transform it to a Vector4
  121836. */
  121837. complementZ: number;
  121838. /**
  121839. * Creates a new TransformBlock
  121840. * @param name defines the block name
  121841. */
  121842. constructor(name: string);
  121843. /**
  121844. * Gets the current class name
  121845. * @returns the class name
  121846. */
  121847. getClassName(): string;
  121848. /**
  121849. * Gets the vector input
  121850. */
  121851. readonly vector: NodeMaterialConnectionPoint;
  121852. /**
  121853. * Gets the output component
  121854. */
  121855. readonly output: NodeMaterialConnectionPoint;
  121856. /**
  121857. * Gets the matrix transform input
  121858. */
  121859. readonly transform: NodeMaterialConnectionPoint;
  121860. protected _buildBlock(state: NodeMaterialBuildState): this;
  121861. serialize(): any;
  121862. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121863. protected _dumpPropertiesCode(): string;
  121864. }
  121865. }
  121866. declare module BABYLON {
  121867. /**
  121868. * Block used to output the vertex position
  121869. */
  121870. export class VertexOutputBlock extends NodeMaterialBlock {
  121871. /**
  121872. * Creates a new VertexOutputBlock
  121873. * @param name defines the block name
  121874. */
  121875. constructor(name: string);
  121876. /**
  121877. * Gets the current class name
  121878. * @returns the class name
  121879. */
  121880. getClassName(): string;
  121881. /**
  121882. * Gets the vector input component
  121883. */
  121884. readonly vector: NodeMaterialConnectionPoint;
  121885. protected _buildBlock(state: NodeMaterialBuildState): this;
  121886. }
  121887. }
  121888. declare module BABYLON {
  121889. /**
  121890. * Block used to output the final color
  121891. */
  121892. export class FragmentOutputBlock extends NodeMaterialBlock {
  121893. /**
  121894. * Create a new FragmentOutputBlock
  121895. * @param name defines the block name
  121896. */
  121897. constructor(name: string);
  121898. /**
  121899. * Gets the current class name
  121900. * @returns the class name
  121901. */
  121902. getClassName(): string;
  121903. /**
  121904. * Gets the rgba input component
  121905. */
  121906. readonly rgba: NodeMaterialConnectionPoint;
  121907. /**
  121908. * Gets the rgb input component
  121909. */
  121910. readonly rgb: NodeMaterialConnectionPoint;
  121911. /**
  121912. * Gets the a input component
  121913. */
  121914. readonly a: NodeMaterialConnectionPoint;
  121915. protected _buildBlock(state: NodeMaterialBuildState): this;
  121916. }
  121917. }
  121918. declare module BABYLON {
  121919. /**
  121920. * Block used to read a reflection texture from a sampler
  121921. */
  121922. export class ReflectionTextureBlock extends NodeMaterialBlock {
  121923. private _define3DName;
  121924. private _defineCubicName;
  121925. private _defineExplicitName;
  121926. private _defineProjectionName;
  121927. private _defineLocalCubicName;
  121928. private _defineSphericalName;
  121929. private _definePlanarName;
  121930. private _defineEquirectangularName;
  121931. private _defineMirroredEquirectangularFixedName;
  121932. private _defineEquirectangularFixedName;
  121933. private _defineSkyboxName;
  121934. private _cubeSamplerName;
  121935. private _2DSamplerName;
  121936. private _positionUVWName;
  121937. private _directionWName;
  121938. private _reflectionCoordsName;
  121939. private _reflection2DCoordsName;
  121940. private _reflectionColorName;
  121941. private _reflectionMatrixName;
  121942. /**
  121943. * Gets or sets the texture associated with the node
  121944. */
  121945. texture: Nullable<BaseTexture>;
  121946. /**
  121947. * Create a new TextureBlock
  121948. * @param name defines the block name
  121949. */
  121950. constructor(name: string);
  121951. /**
  121952. * Gets the current class name
  121953. * @returns the class name
  121954. */
  121955. getClassName(): string;
  121956. /**
  121957. * Gets the world position input component
  121958. */
  121959. readonly position: NodeMaterialConnectionPoint;
  121960. /**
  121961. * Gets the world position input component
  121962. */
  121963. readonly worldPosition: NodeMaterialConnectionPoint;
  121964. /**
  121965. * Gets the world normal input component
  121966. */
  121967. readonly worldNormal: NodeMaterialConnectionPoint;
  121968. /**
  121969. * Gets the world input component
  121970. */
  121971. readonly world: NodeMaterialConnectionPoint;
  121972. /**
  121973. * Gets the camera (or eye) position component
  121974. */
  121975. readonly cameraPosition: NodeMaterialConnectionPoint;
  121976. /**
  121977. * Gets the view input component
  121978. */
  121979. readonly view: NodeMaterialConnectionPoint;
  121980. /**
  121981. * Gets the rgb output component
  121982. */
  121983. readonly rgb: NodeMaterialConnectionPoint;
  121984. /**
  121985. * Gets the r output component
  121986. */
  121987. readonly r: NodeMaterialConnectionPoint;
  121988. /**
  121989. * Gets the g output component
  121990. */
  121991. readonly g: NodeMaterialConnectionPoint;
  121992. /**
  121993. * Gets the b output component
  121994. */
  121995. readonly b: NodeMaterialConnectionPoint;
  121996. autoConfigure(material: NodeMaterial): void;
  121997. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121998. isReady(): boolean;
  121999. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122000. private _injectVertexCode;
  122001. private _writeOutput;
  122002. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122003. protected _dumpPropertiesCode(): string;
  122004. serialize(): any;
  122005. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122006. }
  122007. }
  122008. declare module BABYLON {
  122009. /**
  122010. * Interface used to configure the node material editor
  122011. */
  122012. export interface INodeMaterialEditorOptions {
  122013. /** Define the URl to load node editor script */
  122014. editorURL?: string;
  122015. }
  122016. /** @hidden */
  122017. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  122018. /** BONES */
  122019. NUM_BONE_INFLUENCERS: number;
  122020. BonesPerMesh: number;
  122021. BONETEXTURE: boolean;
  122022. /** MORPH TARGETS */
  122023. MORPHTARGETS: boolean;
  122024. MORPHTARGETS_NORMAL: boolean;
  122025. MORPHTARGETS_TANGENT: boolean;
  122026. MORPHTARGETS_UV: boolean;
  122027. NUM_MORPH_INFLUENCERS: number;
  122028. /** IMAGE PROCESSING */
  122029. IMAGEPROCESSING: boolean;
  122030. VIGNETTE: boolean;
  122031. VIGNETTEBLENDMODEMULTIPLY: boolean;
  122032. VIGNETTEBLENDMODEOPAQUE: boolean;
  122033. TONEMAPPING: boolean;
  122034. TONEMAPPING_ACES: boolean;
  122035. CONTRAST: boolean;
  122036. EXPOSURE: boolean;
  122037. COLORCURVES: boolean;
  122038. COLORGRADING: boolean;
  122039. COLORGRADING3D: boolean;
  122040. SAMPLER3DGREENDEPTH: boolean;
  122041. SAMPLER3DBGRMAP: boolean;
  122042. IMAGEPROCESSINGPOSTPROCESS: boolean;
  122043. /** MISC. */
  122044. BUMPDIRECTUV: number;
  122045. constructor();
  122046. setValue(name: string, value: boolean): void;
  122047. }
  122048. /**
  122049. * Class used to configure NodeMaterial
  122050. */
  122051. export interface INodeMaterialOptions {
  122052. /**
  122053. * Defines if blocks should emit comments
  122054. */
  122055. emitComments: boolean;
  122056. }
  122057. /**
  122058. * Class used to create a node based material built by assembling shader blocks
  122059. */
  122060. export class NodeMaterial extends PushMaterial {
  122061. private static _BuildIdGenerator;
  122062. private _options;
  122063. private _vertexCompilationState;
  122064. private _fragmentCompilationState;
  122065. private _sharedData;
  122066. private _buildId;
  122067. private _buildWasSuccessful;
  122068. private _cachedWorldViewMatrix;
  122069. private _cachedWorldViewProjectionMatrix;
  122070. private _optimizers;
  122071. private _animationFrame;
  122072. /** Define the URl to load node editor script */
  122073. static EditorURL: string;
  122074. private BJSNODEMATERIALEDITOR;
  122075. /** Get the inspector from bundle or global */
  122076. private _getGlobalNodeMaterialEditor;
  122077. /**
  122078. * Gets or sets data used by visual editor
  122079. * @see https://nme.babylonjs.com
  122080. */
  122081. editorData: any;
  122082. /**
  122083. * 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)
  122084. */
  122085. ignoreAlpha: boolean;
  122086. /**
  122087. * Defines the maximum number of lights that can be used in the material
  122088. */
  122089. maxSimultaneousLights: number;
  122090. /**
  122091. * Observable raised when the material is built
  122092. */
  122093. onBuildObservable: Observable<NodeMaterial>;
  122094. /**
  122095. * Gets or sets the root nodes of the material vertex shader
  122096. */
  122097. _vertexOutputNodes: NodeMaterialBlock[];
  122098. /**
  122099. * Gets or sets the root nodes of the material fragment (pixel) shader
  122100. */
  122101. _fragmentOutputNodes: NodeMaterialBlock[];
  122102. /** Gets or sets options to control the node material overall behavior */
  122103. options: INodeMaterialOptions;
  122104. /**
  122105. * Default configuration related to image processing available in the standard Material.
  122106. */
  122107. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  122108. /**
  122109. * Gets the image processing configuration used either in this material.
  122110. */
  122111. /**
  122112. * Sets the Default image processing configuration used either in the this material.
  122113. *
  122114. * If sets to null, the scene one is in use.
  122115. */
  122116. imageProcessingConfiguration: ImageProcessingConfiguration;
  122117. /**
  122118. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  122119. */
  122120. attachedBlocks: NodeMaterialBlock[];
  122121. /**
  122122. * Create a new node based material
  122123. * @param name defines the material name
  122124. * @param scene defines the hosting scene
  122125. * @param options defines creation option
  122126. */
  122127. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  122128. /**
  122129. * Gets the current class name of the material e.g. "NodeMaterial"
  122130. * @returns the class name
  122131. */
  122132. getClassName(): string;
  122133. /**
  122134. * Keep track of the image processing observer to allow dispose and replace.
  122135. */
  122136. private _imageProcessingObserver;
  122137. /**
  122138. * Attaches a new image processing configuration to the Standard Material.
  122139. * @param configuration
  122140. */
  122141. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  122142. /**
  122143. * Get a block by its name
  122144. * @param name defines the name of the block to retrieve
  122145. * @returns the required block or null if not found
  122146. */
  122147. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  122148. /**
  122149. * Get a block by its name
  122150. * @param predicate defines the predicate used to find the good candidate
  122151. * @returns the required block or null if not found
  122152. */
  122153. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  122154. /**
  122155. * Get an input block by its name
  122156. * @param predicate defines the predicate used to find the good candidate
  122157. * @returns the required input block or null if not found
  122158. */
  122159. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  122160. /**
  122161. * Gets the list of input blocks attached to this material
  122162. * @returns an array of InputBlocks
  122163. */
  122164. getInputBlocks(): InputBlock[];
  122165. /**
  122166. * Adds a new optimizer to the list of optimizers
  122167. * @param optimizer defines the optimizers to add
  122168. * @returns the current material
  122169. */
  122170. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  122171. /**
  122172. * Remove an optimizer from the list of optimizers
  122173. * @param optimizer defines the optimizers to remove
  122174. * @returns the current material
  122175. */
  122176. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  122177. /**
  122178. * Add a new block to the list of output nodes
  122179. * @param node defines the node to add
  122180. * @returns the current material
  122181. */
  122182. addOutputNode(node: NodeMaterialBlock): this;
  122183. /**
  122184. * Remove a block from the list of root nodes
  122185. * @param node defines the node to remove
  122186. * @returns the current material
  122187. */
  122188. removeOutputNode(node: NodeMaterialBlock): this;
  122189. private _addVertexOutputNode;
  122190. private _removeVertexOutputNode;
  122191. private _addFragmentOutputNode;
  122192. private _removeFragmentOutputNode;
  122193. /**
  122194. * Specifies if the material will require alpha blending
  122195. * @returns a boolean specifying if alpha blending is needed
  122196. */
  122197. needAlphaBlending(): boolean;
  122198. /**
  122199. * Specifies if this material should be rendered in alpha test mode
  122200. * @returns a boolean specifying if an alpha test is needed.
  122201. */
  122202. needAlphaTesting(): boolean;
  122203. private _initializeBlock;
  122204. private _resetDualBlocks;
  122205. /**
  122206. * Build the material and generates the inner effect
  122207. * @param verbose defines if the build should log activity
  122208. */
  122209. build(verbose?: boolean): void;
  122210. /**
  122211. * Runs an otpimization phase to try to improve the shader code
  122212. */
  122213. optimize(): void;
  122214. private _prepareDefinesForAttributes;
  122215. /**
  122216. * Get if the submesh is ready to be used and all its information available.
  122217. * Child classes can use it to update shaders
  122218. * @param mesh defines the mesh to check
  122219. * @param subMesh defines which submesh to check
  122220. * @param useInstances specifies that instances should be used
  122221. * @returns a boolean indicating that the submesh is ready or not
  122222. */
  122223. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  122224. /**
  122225. * Get a string representing the shaders built by the current node graph
  122226. */
  122227. readonly compiledShaders: string;
  122228. /**
  122229. * Binds the world matrix to the material
  122230. * @param world defines the world transformation matrix
  122231. */
  122232. bindOnlyWorldMatrix(world: Matrix): void;
  122233. /**
  122234. * Binds the submesh to this material by preparing the effect and shader to draw
  122235. * @param world defines the world transformation matrix
  122236. * @param mesh defines the mesh containing the submesh
  122237. * @param subMesh defines the submesh to bind the material to
  122238. */
  122239. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  122240. /**
  122241. * Gets the active textures from the material
  122242. * @returns an array of textures
  122243. */
  122244. getActiveTextures(): BaseTexture[];
  122245. /**
  122246. * Gets the list of texture blocks
  122247. * @returns an array of texture blocks
  122248. */
  122249. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  122250. /**
  122251. * Specifies if the material uses a texture
  122252. * @param texture defines the texture to check against the material
  122253. * @returns a boolean specifying if the material uses the texture
  122254. */
  122255. hasTexture(texture: BaseTexture): boolean;
  122256. /**
  122257. * Disposes the material
  122258. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  122259. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  122260. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  122261. */
  122262. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  122263. /** Creates the node editor window. */
  122264. private _createNodeEditor;
  122265. /**
  122266. * Launch the node material editor
  122267. * @param config Define the configuration of the editor
  122268. * @return a promise fulfilled when the node editor is visible
  122269. */
  122270. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  122271. /**
  122272. * Clear the current material
  122273. */
  122274. clear(): void;
  122275. /**
  122276. * Clear the current material and set it to a default state
  122277. */
  122278. setToDefault(): void;
  122279. /**
  122280. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  122281. * @param url defines the url to load from
  122282. * @returns a promise that will fullfil when the material is fully loaded
  122283. */
  122284. loadAsync(url: string): Promise<void>;
  122285. private _gatherBlocks;
  122286. /**
  122287. * Generate a string containing the code declaration required to create an equivalent of this material
  122288. * @returns a string
  122289. */
  122290. generateCode(): string;
  122291. /**
  122292. * Serializes this material in a JSON representation
  122293. * @returns the serialized material object
  122294. */
  122295. serialize(): any;
  122296. private _restoreConnections;
  122297. /**
  122298. * Clear the current graph and load a new one from a serialization object
  122299. * @param source defines the JSON representation of the material
  122300. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122301. */
  122302. loadFromSerialization(source: any, rootUrl?: string): void;
  122303. /**
  122304. * Creates a node material from parsed material data
  122305. * @param source defines the JSON representation of the material
  122306. * @param scene defines the hosting scene
  122307. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122308. * @returns a new node material
  122309. */
  122310. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  122311. /**
  122312. * Creates a new node material set to default basic configuration
  122313. * @param name defines the name of the material
  122314. * @param scene defines the hosting scene
  122315. * @returns a new NodeMaterial
  122316. */
  122317. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  122318. }
  122319. }
  122320. declare module BABYLON {
  122321. /**
  122322. * Block used to read a texture from a sampler
  122323. */
  122324. export class TextureBlock extends NodeMaterialBlock {
  122325. private _defineName;
  122326. private _linearDefineName;
  122327. private _tempTextureRead;
  122328. private _samplerName;
  122329. private _transformedUVName;
  122330. private _textureTransformName;
  122331. private _textureInfoName;
  122332. private _mainUVName;
  122333. private _mainUVDefineName;
  122334. /**
  122335. * Gets or sets the texture associated with the node
  122336. */
  122337. texture: Nullable<Texture>;
  122338. /**
  122339. * Create a new TextureBlock
  122340. * @param name defines the block name
  122341. */
  122342. constructor(name: string);
  122343. /**
  122344. * Gets the current class name
  122345. * @returns the class name
  122346. */
  122347. getClassName(): string;
  122348. /**
  122349. * Gets the uv input component
  122350. */
  122351. readonly uv: NodeMaterialConnectionPoint;
  122352. /**
  122353. * Gets the rgba output component
  122354. */
  122355. readonly rgba: NodeMaterialConnectionPoint;
  122356. /**
  122357. * Gets the rgb output component
  122358. */
  122359. readonly rgb: NodeMaterialConnectionPoint;
  122360. /**
  122361. * Gets the r output component
  122362. */
  122363. readonly r: NodeMaterialConnectionPoint;
  122364. /**
  122365. * Gets the g output component
  122366. */
  122367. readonly g: NodeMaterialConnectionPoint;
  122368. /**
  122369. * Gets the b output component
  122370. */
  122371. readonly b: NodeMaterialConnectionPoint;
  122372. /**
  122373. * Gets the a output component
  122374. */
  122375. readonly a: NodeMaterialConnectionPoint;
  122376. readonly target: NodeMaterialBlockTargets;
  122377. autoConfigure(material: NodeMaterial): void;
  122378. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122379. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122380. isReady(): boolean;
  122381. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122382. private readonly _isMixed;
  122383. private _injectVertexCode;
  122384. private _writeTextureRead;
  122385. private _writeOutput;
  122386. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122387. protected _dumpPropertiesCode(): string;
  122388. serialize(): any;
  122389. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122390. }
  122391. }
  122392. declare module BABYLON {
  122393. /**
  122394. * Class used to store shared data between 2 NodeMaterialBuildState
  122395. */
  122396. export class NodeMaterialBuildStateSharedData {
  122397. /**
  122398. * Gets the list of emitted varyings
  122399. */
  122400. temps: string[];
  122401. /**
  122402. * Gets the list of emitted varyings
  122403. */
  122404. varyings: string[];
  122405. /**
  122406. * Gets the varying declaration string
  122407. */
  122408. varyingDeclaration: string;
  122409. /**
  122410. * Input blocks
  122411. */
  122412. inputBlocks: InputBlock[];
  122413. /**
  122414. * Input blocks
  122415. */
  122416. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  122417. /**
  122418. * Bindable blocks (Blocks that need to set data to the effect)
  122419. */
  122420. bindableBlocks: NodeMaterialBlock[];
  122421. /**
  122422. * List of blocks that can provide a compilation fallback
  122423. */
  122424. blocksWithFallbacks: NodeMaterialBlock[];
  122425. /**
  122426. * List of blocks that can provide a define update
  122427. */
  122428. blocksWithDefines: NodeMaterialBlock[];
  122429. /**
  122430. * List of blocks that can provide a repeatable content
  122431. */
  122432. repeatableContentBlocks: NodeMaterialBlock[];
  122433. /**
  122434. * List of blocks that can provide a dynamic list of uniforms
  122435. */
  122436. dynamicUniformBlocks: NodeMaterialBlock[];
  122437. /**
  122438. * List of blocks that can block the isReady function for the material
  122439. */
  122440. blockingBlocks: NodeMaterialBlock[];
  122441. /**
  122442. * Gets the list of animated inputs
  122443. */
  122444. animatedInputs: InputBlock[];
  122445. /**
  122446. * Build Id used to avoid multiple recompilations
  122447. */
  122448. buildId: number;
  122449. /** List of emitted variables */
  122450. variableNames: {
  122451. [key: string]: number;
  122452. };
  122453. /** List of emitted defines */
  122454. defineNames: {
  122455. [key: string]: number;
  122456. };
  122457. /** Should emit comments? */
  122458. emitComments: boolean;
  122459. /** Emit build activity */
  122460. verbose: boolean;
  122461. /** Gets or sets the hosting scene */
  122462. scene: Scene;
  122463. /**
  122464. * Gets the compilation hints emitted at compilation time
  122465. */
  122466. hints: {
  122467. needWorldViewMatrix: boolean;
  122468. needWorldViewProjectionMatrix: boolean;
  122469. needAlphaBlending: boolean;
  122470. needAlphaTesting: boolean;
  122471. };
  122472. /**
  122473. * List of compilation checks
  122474. */
  122475. checks: {
  122476. emitVertex: boolean;
  122477. emitFragment: boolean;
  122478. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  122479. };
  122480. /** Creates a new shared data */
  122481. constructor();
  122482. /**
  122483. * Emits console errors and exceptions if there is a failing check
  122484. */
  122485. emitErrors(): void;
  122486. }
  122487. }
  122488. declare module BABYLON {
  122489. /**
  122490. * Class used to store node based material build state
  122491. */
  122492. export class NodeMaterialBuildState {
  122493. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  122494. supportUniformBuffers: boolean;
  122495. /**
  122496. * Gets the list of emitted attributes
  122497. */
  122498. attributes: string[];
  122499. /**
  122500. * Gets the list of emitted uniforms
  122501. */
  122502. uniforms: string[];
  122503. /**
  122504. * Gets the list of emitted constants
  122505. */
  122506. constants: string[];
  122507. /**
  122508. * Gets the list of emitted samplers
  122509. */
  122510. samplers: string[];
  122511. /**
  122512. * Gets the list of emitted functions
  122513. */
  122514. functions: {
  122515. [key: string]: string;
  122516. };
  122517. /**
  122518. * Gets the list of emitted extensions
  122519. */
  122520. extensions: {
  122521. [key: string]: string;
  122522. };
  122523. /**
  122524. * Gets the target of the compilation state
  122525. */
  122526. target: NodeMaterialBlockTargets;
  122527. /**
  122528. * Gets the list of emitted counters
  122529. */
  122530. counters: {
  122531. [key: string]: number;
  122532. };
  122533. /**
  122534. * Shared data between multiple NodeMaterialBuildState instances
  122535. */
  122536. sharedData: NodeMaterialBuildStateSharedData;
  122537. /** @hidden */
  122538. _vertexState: NodeMaterialBuildState;
  122539. /** @hidden */
  122540. _attributeDeclaration: string;
  122541. /** @hidden */
  122542. _uniformDeclaration: string;
  122543. /** @hidden */
  122544. _constantDeclaration: string;
  122545. /** @hidden */
  122546. _samplerDeclaration: string;
  122547. /** @hidden */
  122548. _varyingTransfer: string;
  122549. private _repeatableContentAnchorIndex;
  122550. /** @hidden */
  122551. _builtCompilationString: string;
  122552. /**
  122553. * Gets the emitted compilation strings
  122554. */
  122555. compilationString: string;
  122556. /**
  122557. * Finalize the compilation strings
  122558. * @param state defines the current compilation state
  122559. */
  122560. finalize(state: NodeMaterialBuildState): void;
  122561. /** @hidden */
  122562. readonly _repeatableContentAnchor: string;
  122563. /** @hidden */
  122564. _getFreeVariableName(prefix: string): string;
  122565. /** @hidden */
  122566. _getFreeDefineName(prefix: string): string;
  122567. /** @hidden */
  122568. _excludeVariableName(name: string): void;
  122569. /** @hidden */
  122570. _emit2DSampler(name: string): void;
  122571. /** @hidden */
  122572. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  122573. /** @hidden */
  122574. _emitExtension(name: string, extension: string): void;
  122575. /** @hidden */
  122576. _emitFunction(name: string, code: string, comments: string): void;
  122577. /** @hidden */
  122578. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  122579. replaceStrings?: {
  122580. search: RegExp;
  122581. replace: string;
  122582. }[];
  122583. repeatKey?: string;
  122584. }): string;
  122585. /** @hidden */
  122586. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  122587. repeatKey?: string;
  122588. removeAttributes?: boolean;
  122589. removeUniforms?: boolean;
  122590. removeVaryings?: boolean;
  122591. removeIfDef?: boolean;
  122592. replaceStrings?: {
  122593. search: RegExp;
  122594. replace: string;
  122595. }[];
  122596. }, storeKey?: string): void;
  122597. /** @hidden */
  122598. _registerTempVariable(name: string): boolean;
  122599. /** @hidden */
  122600. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  122601. /** @hidden */
  122602. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  122603. /** @hidden */
  122604. _emitFloat(value: number): string;
  122605. }
  122606. }
  122607. declare module BABYLON {
  122608. /**
  122609. * Defines a block that can be used inside a node based material
  122610. */
  122611. export class NodeMaterialBlock {
  122612. private _buildId;
  122613. private _buildTarget;
  122614. private _target;
  122615. private _isFinalMerger;
  122616. private _isInput;
  122617. protected _isUnique: boolean;
  122618. /** @hidden */
  122619. _codeVariableName: string;
  122620. /** @hidden */
  122621. _inputs: NodeMaterialConnectionPoint[];
  122622. /** @hidden */
  122623. _outputs: NodeMaterialConnectionPoint[];
  122624. /** @hidden */
  122625. _preparationId: number;
  122626. /**
  122627. * Gets or sets the name of the block
  122628. */
  122629. name: string;
  122630. /**
  122631. * Gets or sets the unique id of the node
  122632. */
  122633. uniqueId: number;
  122634. /**
  122635. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  122636. */
  122637. readonly isUnique: boolean;
  122638. /**
  122639. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  122640. */
  122641. readonly isFinalMerger: boolean;
  122642. /**
  122643. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  122644. */
  122645. readonly isInput: boolean;
  122646. /**
  122647. * Gets or sets the build Id
  122648. */
  122649. buildId: number;
  122650. /**
  122651. * Gets or sets the target of the block
  122652. */
  122653. target: NodeMaterialBlockTargets;
  122654. /**
  122655. * Gets the list of input points
  122656. */
  122657. readonly inputs: NodeMaterialConnectionPoint[];
  122658. /** Gets the list of output points */
  122659. readonly outputs: NodeMaterialConnectionPoint[];
  122660. /**
  122661. * Find an input by its name
  122662. * @param name defines the name of the input to look for
  122663. * @returns the input or null if not found
  122664. */
  122665. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  122666. /**
  122667. * Find an output by its name
  122668. * @param name defines the name of the outputto look for
  122669. * @returns the output or null if not found
  122670. */
  122671. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  122672. /**
  122673. * Creates a new NodeMaterialBlock
  122674. * @param name defines the block name
  122675. * @param target defines the target of that block (Vertex by default)
  122676. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  122677. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  122678. */
  122679. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  122680. /**
  122681. * Initialize the block and prepare the context for build
  122682. * @param state defines the state that will be used for the build
  122683. */
  122684. initialize(state: NodeMaterialBuildState): void;
  122685. /**
  122686. * Bind data to effect. Will only be called for blocks with isBindable === true
  122687. * @param effect defines the effect to bind data to
  122688. * @param nodeMaterial defines the hosting NodeMaterial
  122689. * @param mesh defines the mesh that will be rendered
  122690. */
  122691. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122692. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  122693. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  122694. protected _writeFloat(value: number): string;
  122695. /**
  122696. * Gets the current class name e.g. "NodeMaterialBlock"
  122697. * @returns the class name
  122698. */
  122699. getClassName(): string;
  122700. /**
  122701. * Register a new input. Must be called inside a block constructor
  122702. * @param name defines the connection point name
  122703. * @param type defines the connection point type
  122704. * @param isOptional defines a boolean indicating that this input can be omitted
  122705. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  122706. * @returns the current block
  122707. */
  122708. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  122709. /**
  122710. * Register a new output. Must be called inside a block constructor
  122711. * @param name defines the connection point name
  122712. * @param type defines the connection point type
  122713. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  122714. * @returns the current block
  122715. */
  122716. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  122717. /**
  122718. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  122719. * @param forOutput defines an optional connection point to check compatibility with
  122720. * @returns the first available input or null
  122721. */
  122722. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  122723. /**
  122724. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  122725. * @param forBlock defines an optional block to check compatibility with
  122726. * @returns the first available input or null
  122727. */
  122728. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  122729. /**
  122730. * Gets the sibling of the given output
  122731. * @param current defines the current output
  122732. * @returns the next output in the list or null
  122733. */
  122734. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  122735. /**
  122736. * Connect current block with another block
  122737. * @param other defines the block to connect with
  122738. * @param options define the various options to help pick the right connections
  122739. * @returns the current block
  122740. */
  122741. connectTo(other: NodeMaterialBlock, options?: {
  122742. input?: string;
  122743. output?: string;
  122744. outputSwizzle?: string;
  122745. }): this | undefined;
  122746. protected _buildBlock(state: NodeMaterialBuildState): void;
  122747. /**
  122748. * Add uniforms, samplers and uniform buffers at compilation time
  122749. * @param state defines the state to update
  122750. * @param nodeMaterial defines the node material requesting the update
  122751. * @param defines defines the material defines to update
  122752. * @param uniformBuffers defines the list of uniform buffer names
  122753. */
  122754. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  122755. /**
  122756. * Add potential fallbacks if shader compilation fails
  122757. * @param mesh defines the mesh to be rendered
  122758. * @param fallbacks defines the current prioritized list of fallbacks
  122759. */
  122760. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  122761. /**
  122762. * Initialize defines for shader compilation
  122763. * @param mesh defines the mesh to be rendered
  122764. * @param nodeMaterial defines the node material requesting the update
  122765. * @param defines defines the material defines to update
  122766. * @param useInstances specifies that instances should be used
  122767. */
  122768. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122769. /**
  122770. * Update defines for shader compilation
  122771. * @param mesh defines the mesh to be rendered
  122772. * @param nodeMaterial defines the node material requesting the update
  122773. * @param defines defines the material defines to update
  122774. * @param useInstances specifies that instances should be used
  122775. */
  122776. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122777. /**
  122778. * Lets the block try to connect some inputs automatically
  122779. * @param material defines the hosting NodeMaterial
  122780. */
  122781. autoConfigure(material: NodeMaterial): void;
  122782. /**
  122783. * Function called when a block is declared as repeatable content generator
  122784. * @param vertexShaderState defines the current compilation state for the vertex shader
  122785. * @param fragmentShaderState defines the current compilation state for the fragment shader
  122786. * @param mesh defines the mesh to be rendered
  122787. * @param defines defines the material defines to update
  122788. */
  122789. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  122790. /**
  122791. * Checks if the block is ready
  122792. * @param mesh defines the mesh to be rendered
  122793. * @param nodeMaterial defines the node material requesting the update
  122794. * @param defines defines the material defines to update
  122795. * @param useInstances specifies that instances should be used
  122796. * @returns true if the block is ready
  122797. */
  122798. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  122799. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  122800. private _processBuild;
  122801. /**
  122802. * Compile the current node and generate the shader code
  122803. * @param state defines the current compilation state (uniforms, samplers, current string)
  122804. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  122805. * @returns true if already built
  122806. */
  122807. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  122808. protected _inputRename(name: string): string;
  122809. protected _outputRename(name: string): string;
  122810. protected _dumpPropertiesCode(): string;
  122811. /** @hidden */
  122812. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  122813. /** @hidden */
  122814. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  122815. /**
  122816. * Clone the current block to a new identical block
  122817. * @param scene defines the hosting scene
  122818. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122819. * @returns a copy of the current block
  122820. */
  122821. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  122822. /**
  122823. * Serializes this block in a JSON representation
  122824. * @returns the serialized block object
  122825. */
  122826. serialize(): any;
  122827. /** @hidden */
  122828. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122829. /**
  122830. * Release resources
  122831. */
  122832. dispose(): void;
  122833. }
  122834. }
  122835. declare module BABYLON {
  122836. /**
  122837. * Enum defining the type of animations supported by InputBlock
  122838. */
  122839. export enum AnimatedInputBlockTypes {
  122840. /** No animation */
  122841. None = 0,
  122842. /** Time based animation. Will only work for floats */
  122843. Time = 1
  122844. }
  122845. }
  122846. declare module BABYLON {
  122847. /**
  122848. * Block used to expose an input value
  122849. */
  122850. export class InputBlock extends NodeMaterialBlock {
  122851. private _mode;
  122852. private _associatedVariableName;
  122853. private _storedValue;
  122854. private _valueCallback;
  122855. private _type;
  122856. private _animationType;
  122857. /** Gets or set a value used to limit the range of float values */
  122858. min: number;
  122859. /** Gets or set a value used to limit the range of float values */
  122860. max: number;
  122861. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  122862. matrixMode: number;
  122863. /** @hidden */
  122864. _systemValue: Nullable<NodeMaterialSystemValues>;
  122865. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  122866. visibleInInspector: boolean;
  122867. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  122868. isConstant: boolean;
  122869. /**
  122870. * Gets or sets the connection point type (default is float)
  122871. */
  122872. readonly type: NodeMaterialBlockConnectionPointTypes;
  122873. /**
  122874. * Creates a new InputBlock
  122875. * @param name defines the block name
  122876. * @param target defines the target of that block (Vertex by default)
  122877. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  122878. */
  122879. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  122880. /**
  122881. * Gets the output component
  122882. */
  122883. readonly output: NodeMaterialConnectionPoint;
  122884. /**
  122885. * Set the source of this connection point to a vertex attribute
  122886. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  122887. * @returns the current connection point
  122888. */
  122889. setAsAttribute(attributeName?: string): InputBlock;
  122890. /**
  122891. * Set the source of this connection point to a system value
  122892. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  122893. * @returns the current connection point
  122894. */
  122895. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  122896. /**
  122897. * Gets or sets the value of that point.
  122898. * Please note that this value will be ignored if valueCallback is defined
  122899. */
  122900. value: any;
  122901. /**
  122902. * Gets or sets a callback used to get the value of that point.
  122903. * Please note that setting this value will force the connection point to ignore the value property
  122904. */
  122905. valueCallback: () => any;
  122906. /**
  122907. * Gets or sets the associated variable name in the shader
  122908. */
  122909. associatedVariableName: string;
  122910. /** Gets or sets the type of animation applied to the input */
  122911. animationType: AnimatedInputBlockTypes;
  122912. /**
  122913. * Gets a boolean indicating that this connection point not defined yet
  122914. */
  122915. readonly isUndefined: boolean;
  122916. /**
  122917. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  122918. * In this case the connection point name must be the name of the uniform to use.
  122919. * Can only be set on inputs
  122920. */
  122921. isUniform: boolean;
  122922. /**
  122923. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  122924. * In this case the connection point name must be the name of the attribute to use
  122925. * Can only be set on inputs
  122926. */
  122927. isAttribute: boolean;
  122928. /**
  122929. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  122930. * Can only be set on exit points
  122931. */
  122932. isVarying: boolean;
  122933. /**
  122934. * Gets a boolean indicating that the current connection point is a system value
  122935. */
  122936. readonly isSystemValue: boolean;
  122937. /**
  122938. * Gets or sets the current well known value or null if not defined as a system value
  122939. */
  122940. systemValue: Nullable<NodeMaterialSystemValues>;
  122941. /**
  122942. * Gets the current class name
  122943. * @returns the class name
  122944. */
  122945. getClassName(): string;
  122946. /**
  122947. * Animate the input if animationType !== None
  122948. * @param scene defines the rendering scene
  122949. */
  122950. animate(scene: Scene): void;
  122951. private _emitDefine;
  122952. initialize(state: NodeMaterialBuildState): void;
  122953. /**
  122954. * Set the input block to its default value (based on its type)
  122955. */
  122956. setDefaultValue(): void;
  122957. private _emitConstant;
  122958. private _emit;
  122959. /** @hidden */
  122960. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  122961. /** @hidden */
  122962. _transmit(effect: Effect, scene: Scene): void;
  122963. protected _buildBlock(state: NodeMaterialBuildState): void;
  122964. protected _dumpPropertiesCode(): string;
  122965. serialize(): any;
  122966. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122967. }
  122968. }
  122969. declare module BABYLON {
  122970. /**
  122971. * Enum used to define the compatibility state between two connection points
  122972. */
  122973. export enum NodeMaterialConnectionPointCompatibilityStates {
  122974. /** Points are compatibles */
  122975. Compatible = 0,
  122976. /** Points are incompatible because of their types */
  122977. TypeIncompatible = 1,
  122978. /** Points are incompatible because of their targets (vertex vs fragment) */
  122979. TargetIncompatible = 2
  122980. }
  122981. /**
  122982. * Defines a connection point for a block
  122983. */
  122984. export class NodeMaterialConnectionPoint {
  122985. /** @hidden */
  122986. _ownerBlock: NodeMaterialBlock;
  122987. /** @hidden */
  122988. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  122989. private _endpoints;
  122990. private _associatedVariableName;
  122991. /** @hidden */
  122992. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  122993. /** @hidden */
  122994. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  122995. private _type;
  122996. /** @hidden */
  122997. _enforceAssociatedVariableName: boolean;
  122998. /**
  122999. * Gets or sets the additional types supported by this connection point
  123000. */
  123001. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  123002. /**
  123003. * Gets or sets the additional types excluded by this connection point
  123004. */
  123005. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  123006. /**
  123007. * Observable triggered when this point is connected
  123008. */
  123009. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  123010. /**
  123011. * Gets or sets the associated variable name in the shader
  123012. */
  123013. associatedVariableName: string;
  123014. /**
  123015. * Gets or sets the connection point type (default is float)
  123016. */
  123017. type: NodeMaterialBlockConnectionPointTypes;
  123018. /**
  123019. * Gets or sets the connection point name
  123020. */
  123021. name: string;
  123022. /**
  123023. * Gets or sets a boolean indicating that this connection point can be omitted
  123024. */
  123025. isOptional: boolean;
  123026. /**
  123027. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  123028. */
  123029. define: string;
  123030. /** @hidden */
  123031. _prioritizeVertex: boolean;
  123032. private _target;
  123033. /** Gets or sets the target of that connection point */
  123034. target: NodeMaterialBlockTargets;
  123035. /**
  123036. * Gets a boolean indicating that the current point is connected
  123037. */
  123038. readonly isConnected: boolean;
  123039. /**
  123040. * Gets a boolean indicating that the current point is connected to an input block
  123041. */
  123042. readonly isConnectedToInputBlock: boolean;
  123043. /**
  123044. * Gets a the connected input block (if any)
  123045. */
  123046. readonly connectInputBlock: Nullable<InputBlock>;
  123047. /** Get the other side of the connection (if any) */
  123048. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  123049. /** Get the block that owns this connection point */
  123050. readonly ownerBlock: NodeMaterialBlock;
  123051. /** Get the block connected on the other side of this connection (if any) */
  123052. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  123053. /** Get the block connected on the endpoints of this connection (if any) */
  123054. readonly connectedBlocks: Array<NodeMaterialBlock>;
  123055. /** Gets the list of connected endpoints */
  123056. readonly endpoints: NodeMaterialConnectionPoint[];
  123057. /** Gets a boolean indicating if that output point is connected to at least one input */
  123058. readonly hasEndpoints: boolean;
  123059. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  123060. readonly isConnectedInVertexShader: boolean;
  123061. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  123062. readonly isConnectedInFragmentShader: boolean;
  123063. /**
  123064. * Creates a new connection point
  123065. * @param name defines the connection point name
  123066. * @param ownerBlock defines the block hosting this connection point
  123067. */
  123068. constructor(name: string, ownerBlock: NodeMaterialBlock);
  123069. /**
  123070. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  123071. * @returns the class name
  123072. */
  123073. getClassName(): string;
  123074. /**
  123075. * Gets a boolean indicating if the current point can be connected to another point
  123076. * @param connectionPoint defines the other connection point
  123077. * @returns a boolean
  123078. */
  123079. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  123080. /**
  123081. * Gets a number indicating if the current point can be connected to another point
  123082. * @param connectionPoint defines the other connection point
  123083. * @returns a number defining the compatibility state
  123084. */
  123085. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  123086. /**
  123087. * Connect this point to another connection point
  123088. * @param connectionPoint defines the other connection point
  123089. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  123090. * @returns the current connection point
  123091. */
  123092. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  123093. /**
  123094. * Disconnect this point from one of his endpoint
  123095. * @param endpoint defines the other connection point
  123096. * @returns the current connection point
  123097. */
  123098. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  123099. /**
  123100. * Serializes this point in a JSON representation
  123101. * @returns the serialized point object
  123102. */
  123103. serialize(): any;
  123104. /**
  123105. * Release resources
  123106. */
  123107. dispose(): void;
  123108. }
  123109. }
  123110. declare module BABYLON {
  123111. /**
  123112. * Block used to add support for vertex skinning (bones)
  123113. */
  123114. export class BonesBlock extends NodeMaterialBlock {
  123115. /**
  123116. * Creates a new BonesBlock
  123117. * @param name defines the block name
  123118. */
  123119. constructor(name: string);
  123120. /**
  123121. * Initialize the block and prepare the context for build
  123122. * @param state defines the state that will be used for the build
  123123. */
  123124. initialize(state: NodeMaterialBuildState): void;
  123125. /**
  123126. * Gets the current class name
  123127. * @returns the class name
  123128. */
  123129. getClassName(): string;
  123130. /**
  123131. * Gets the matrix indices input component
  123132. */
  123133. readonly matricesIndices: NodeMaterialConnectionPoint;
  123134. /**
  123135. * Gets the matrix weights input component
  123136. */
  123137. readonly matricesWeights: NodeMaterialConnectionPoint;
  123138. /**
  123139. * Gets the extra matrix indices input component
  123140. */
  123141. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  123142. /**
  123143. * Gets the extra matrix weights input component
  123144. */
  123145. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  123146. /**
  123147. * Gets the world input component
  123148. */
  123149. readonly world: NodeMaterialConnectionPoint;
  123150. /**
  123151. * Gets the output component
  123152. */
  123153. readonly output: NodeMaterialConnectionPoint;
  123154. autoConfigure(material: NodeMaterial): void;
  123155. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  123156. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123157. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123158. protected _buildBlock(state: NodeMaterialBuildState): this;
  123159. }
  123160. }
  123161. declare module BABYLON {
  123162. /**
  123163. * Block used to add support for instances
  123164. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  123165. */
  123166. export class InstancesBlock extends NodeMaterialBlock {
  123167. /**
  123168. * Creates a new InstancesBlock
  123169. * @param name defines the block name
  123170. */
  123171. constructor(name: string);
  123172. /**
  123173. * Gets the current class name
  123174. * @returns the class name
  123175. */
  123176. getClassName(): string;
  123177. /**
  123178. * Gets the first world row input component
  123179. */
  123180. readonly world0: NodeMaterialConnectionPoint;
  123181. /**
  123182. * Gets the second world row input component
  123183. */
  123184. readonly world1: NodeMaterialConnectionPoint;
  123185. /**
  123186. * Gets the third world row input component
  123187. */
  123188. readonly world2: NodeMaterialConnectionPoint;
  123189. /**
  123190. * Gets the forth world row input component
  123191. */
  123192. readonly world3: NodeMaterialConnectionPoint;
  123193. /**
  123194. * Gets the world input component
  123195. */
  123196. readonly world: NodeMaterialConnectionPoint;
  123197. /**
  123198. * Gets the output component
  123199. */
  123200. readonly output: NodeMaterialConnectionPoint;
  123201. autoConfigure(material: NodeMaterial): void;
  123202. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  123203. protected _buildBlock(state: NodeMaterialBuildState): this;
  123204. }
  123205. }
  123206. declare module BABYLON {
  123207. /**
  123208. * Block used to add morph targets support to vertex shader
  123209. */
  123210. export class MorphTargetsBlock extends NodeMaterialBlock {
  123211. private _repeatableContentAnchor;
  123212. private _repeatebleContentGenerated;
  123213. /**
  123214. * Create a new MorphTargetsBlock
  123215. * @param name defines the block name
  123216. */
  123217. constructor(name: string);
  123218. /**
  123219. * Gets the current class name
  123220. * @returns the class name
  123221. */
  123222. getClassName(): string;
  123223. /**
  123224. * Gets the position input component
  123225. */
  123226. readonly position: NodeMaterialConnectionPoint;
  123227. /**
  123228. * Gets the normal input component
  123229. */
  123230. readonly normal: NodeMaterialConnectionPoint;
  123231. /**
  123232. * Gets the tangent input component
  123233. */
  123234. readonly tangent: NodeMaterialConnectionPoint;
  123235. /**
  123236. * Gets the tangent input component
  123237. */
  123238. readonly uv: NodeMaterialConnectionPoint;
  123239. /**
  123240. * Gets the position output component
  123241. */
  123242. readonly positionOutput: NodeMaterialConnectionPoint;
  123243. /**
  123244. * Gets the normal output component
  123245. */
  123246. readonly normalOutput: NodeMaterialConnectionPoint;
  123247. /**
  123248. * Gets the tangent output component
  123249. */
  123250. readonly tangentOutput: NodeMaterialConnectionPoint;
  123251. /**
  123252. * Gets the tangent output component
  123253. */
  123254. readonly uvOutput: NodeMaterialConnectionPoint;
  123255. initialize(state: NodeMaterialBuildState): void;
  123256. autoConfigure(material: NodeMaterial): void;
  123257. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123258. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123259. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  123260. protected _buildBlock(state: NodeMaterialBuildState): this;
  123261. }
  123262. }
  123263. declare module BABYLON {
  123264. /**
  123265. * Block used to get data information from a light
  123266. */
  123267. export class LightInformationBlock extends NodeMaterialBlock {
  123268. private _lightDataUniformName;
  123269. private _lightColorUniformName;
  123270. private _lightTypeDefineName;
  123271. /**
  123272. * Gets or sets the light associated with this block
  123273. */
  123274. light: Nullable<Light>;
  123275. /**
  123276. * Creates a new LightInformationBlock
  123277. * @param name defines the block name
  123278. */
  123279. constructor(name: string);
  123280. /**
  123281. * Gets the current class name
  123282. * @returns the class name
  123283. */
  123284. getClassName(): string;
  123285. /**
  123286. * Gets the world position input component
  123287. */
  123288. readonly worldPosition: NodeMaterialConnectionPoint;
  123289. /**
  123290. * Gets the direction output component
  123291. */
  123292. readonly direction: NodeMaterialConnectionPoint;
  123293. /**
  123294. * Gets the direction output component
  123295. */
  123296. readonly color: NodeMaterialConnectionPoint;
  123297. /**
  123298. * Gets the direction output component
  123299. */
  123300. readonly intensity: NodeMaterialConnectionPoint;
  123301. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123302. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123303. protected _buildBlock(state: NodeMaterialBuildState): this;
  123304. serialize(): any;
  123305. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123306. }
  123307. }
  123308. declare module BABYLON {
  123309. /**
  123310. * Block used to add image processing support to fragment shader
  123311. */
  123312. export class ImageProcessingBlock extends NodeMaterialBlock {
  123313. /**
  123314. * Create a new ImageProcessingBlock
  123315. * @param name defines the block name
  123316. */
  123317. constructor(name: string);
  123318. /**
  123319. * Gets the current class name
  123320. * @returns the class name
  123321. */
  123322. getClassName(): string;
  123323. /**
  123324. * Gets the color input component
  123325. */
  123326. readonly color: NodeMaterialConnectionPoint;
  123327. /**
  123328. * Gets the output component
  123329. */
  123330. readonly output: NodeMaterialConnectionPoint;
  123331. /**
  123332. * Initialize the block and prepare the context for build
  123333. * @param state defines the state that will be used for the build
  123334. */
  123335. initialize(state: NodeMaterialBuildState): void;
  123336. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  123337. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123338. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123339. protected _buildBlock(state: NodeMaterialBuildState): this;
  123340. }
  123341. }
  123342. declare module BABYLON {
  123343. /**
  123344. * Block used to pertub normals based on a normal map
  123345. */
  123346. export class PerturbNormalBlock extends NodeMaterialBlock {
  123347. private _tangentSpaceParameterName;
  123348. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  123349. invertX: boolean;
  123350. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  123351. invertY: boolean;
  123352. /**
  123353. * Create a new PerturbNormalBlock
  123354. * @param name defines the block name
  123355. */
  123356. constructor(name: string);
  123357. /**
  123358. * Gets the current class name
  123359. * @returns the class name
  123360. */
  123361. getClassName(): string;
  123362. /**
  123363. * Gets the world position input component
  123364. */
  123365. readonly worldPosition: NodeMaterialConnectionPoint;
  123366. /**
  123367. * Gets the world normal input component
  123368. */
  123369. readonly worldNormal: NodeMaterialConnectionPoint;
  123370. /**
  123371. * Gets the uv input component
  123372. */
  123373. readonly uv: NodeMaterialConnectionPoint;
  123374. /**
  123375. * Gets the normal map color input component
  123376. */
  123377. readonly normalMapColor: NodeMaterialConnectionPoint;
  123378. /**
  123379. * Gets the strength input component
  123380. */
  123381. readonly strength: NodeMaterialConnectionPoint;
  123382. /**
  123383. * Gets the output component
  123384. */
  123385. readonly output: NodeMaterialConnectionPoint;
  123386. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123387. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123388. autoConfigure(material: NodeMaterial): void;
  123389. protected _buildBlock(state: NodeMaterialBuildState): this;
  123390. protected _dumpPropertiesCode(): string;
  123391. serialize(): any;
  123392. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123393. }
  123394. }
  123395. declare module BABYLON {
  123396. /**
  123397. * Block used to discard a pixel if a value is smaller than a cutoff
  123398. */
  123399. export class DiscardBlock extends NodeMaterialBlock {
  123400. /**
  123401. * Create a new DiscardBlock
  123402. * @param name defines the block name
  123403. */
  123404. constructor(name: string);
  123405. /**
  123406. * Gets the current class name
  123407. * @returns the class name
  123408. */
  123409. getClassName(): string;
  123410. /**
  123411. * Gets the color input component
  123412. */
  123413. readonly value: NodeMaterialConnectionPoint;
  123414. /**
  123415. * Gets the cutoff input component
  123416. */
  123417. readonly cutoff: NodeMaterialConnectionPoint;
  123418. protected _buildBlock(state: NodeMaterialBuildState): this;
  123419. }
  123420. }
  123421. declare module BABYLON {
  123422. /**
  123423. * Block used to test if the fragment shader is front facing
  123424. */
  123425. export class FrontFacingBlock extends NodeMaterialBlock {
  123426. /**
  123427. * Creates a new FrontFacingBlock
  123428. * @param name defines the block name
  123429. */
  123430. constructor(name: string);
  123431. /**
  123432. * Gets the current class name
  123433. * @returns the class name
  123434. */
  123435. getClassName(): string;
  123436. /**
  123437. * Gets the output component
  123438. */
  123439. readonly output: NodeMaterialConnectionPoint;
  123440. protected _buildBlock(state: NodeMaterialBuildState): this;
  123441. }
  123442. }
  123443. declare module BABYLON {
  123444. /**
  123445. * Block used to add support for scene fog
  123446. */
  123447. export class FogBlock extends NodeMaterialBlock {
  123448. private _fogDistanceName;
  123449. private _fogParameters;
  123450. /**
  123451. * Create a new FogBlock
  123452. * @param name defines the block name
  123453. */
  123454. constructor(name: string);
  123455. /**
  123456. * Gets the current class name
  123457. * @returns the class name
  123458. */
  123459. getClassName(): string;
  123460. /**
  123461. * Gets the world position input component
  123462. */
  123463. readonly worldPosition: NodeMaterialConnectionPoint;
  123464. /**
  123465. * Gets the view input component
  123466. */
  123467. readonly view: NodeMaterialConnectionPoint;
  123468. /**
  123469. * Gets the color input component
  123470. */
  123471. readonly input: NodeMaterialConnectionPoint;
  123472. /**
  123473. * Gets the fog color input component
  123474. */
  123475. readonly fogColor: NodeMaterialConnectionPoint;
  123476. /**
  123477. * Gets the output component
  123478. */
  123479. readonly output: NodeMaterialConnectionPoint;
  123480. autoConfigure(material: NodeMaterial): void;
  123481. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123482. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123483. protected _buildBlock(state: NodeMaterialBuildState): this;
  123484. }
  123485. }
  123486. declare module BABYLON {
  123487. /**
  123488. * Block used to add light in the fragment shader
  123489. */
  123490. export class LightBlock extends NodeMaterialBlock {
  123491. private _lightId;
  123492. /**
  123493. * Gets or sets the light associated with this block
  123494. */
  123495. light: Nullable<Light>;
  123496. /**
  123497. * Create a new LightBlock
  123498. * @param name defines the block name
  123499. */
  123500. constructor(name: string);
  123501. /**
  123502. * Gets the current class name
  123503. * @returns the class name
  123504. */
  123505. getClassName(): string;
  123506. /**
  123507. * Gets the world position input component
  123508. */
  123509. readonly worldPosition: NodeMaterialConnectionPoint;
  123510. /**
  123511. * Gets the world normal input component
  123512. */
  123513. readonly worldNormal: NodeMaterialConnectionPoint;
  123514. /**
  123515. * Gets the camera (or eye) position component
  123516. */
  123517. readonly cameraPosition: NodeMaterialConnectionPoint;
  123518. /**
  123519. * Gets the glossiness component
  123520. */
  123521. readonly glossiness: NodeMaterialConnectionPoint;
  123522. /**
  123523. * Gets the glossinness power component
  123524. */
  123525. readonly glossPower: NodeMaterialConnectionPoint;
  123526. /**
  123527. * Gets the diffuse color component
  123528. */
  123529. readonly diffuseColor: NodeMaterialConnectionPoint;
  123530. /**
  123531. * Gets the specular color component
  123532. */
  123533. readonly specularColor: NodeMaterialConnectionPoint;
  123534. /**
  123535. * Gets the diffuse output component
  123536. */
  123537. readonly diffuseOutput: NodeMaterialConnectionPoint;
  123538. /**
  123539. * Gets the specular output component
  123540. */
  123541. readonly specularOutput: NodeMaterialConnectionPoint;
  123542. autoConfigure(material: NodeMaterial): void;
  123543. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123544. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  123545. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123546. private _injectVertexCode;
  123547. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123548. serialize(): any;
  123549. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123550. }
  123551. }
  123552. declare module BABYLON {
  123553. /**
  123554. * Block used to multiply 2 values
  123555. */
  123556. export class MultiplyBlock extends NodeMaterialBlock {
  123557. /**
  123558. * Creates a new MultiplyBlock
  123559. * @param name defines the block name
  123560. */
  123561. constructor(name: string);
  123562. /**
  123563. * Gets the current class name
  123564. * @returns the class name
  123565. */
  123566. getClassName(): string;
  123567. /**
  123568. * Gets the left operand input component
  123569. */
  123570. readonly left: NodeMaterialConnectionPoint;
  123571. /**
  123572. * Gets the right operand input component
  123573. */
  123574. readonly right: NodeMaterialConnectionPoint;
  123575. /**
  123576. * Gets the output component
  123577. */
  123578. readonly output: NodeMaterialConnectionPoint;
  123579. protected _buildBlock(state: NodeMaterialBuildState): this;
  123580. }
  123581. }
  123582. declare module BABYLON {
  123583. /**
  123584. * Block used to add 2 vectors
  123585. */
  123586. export class AddBlock extends NodeMaterialBlock {
  123587. /**
  123588. * Creates a new AddBlock
  123589. * @param name defines the block name
  123590. */
  123591. constructor(name: string);
  123592. /**
  123593. * Gets the current class name
  123594. * @returns the class name
  123595. */
  123596. getClassName(): string;
  123597. /**
  123598. * Gets the left operand input component
  123599. */
  123600. readonly left: NodeMaterialConnectionPoint;
  123601. /**
  123602. * Gets the right operand input component
  123603. */
  123604. readonly right: NodeMaterialConnectionPoint;
  123605. /**
  123606. * Gets the output component
  123607. */
  123608. readonly output: NodeMaterialConnectionPoint;
  123609. protected _buildBlock(state: NodeMaterialBuildState): this;
  123610. }
  123611. }
  123612. declare module BABYLON {
  123613. /**
  123614. * Block used to scale a vector by a float
  123615. */
  123616. export class ScaleBlock extends NodeMaterialBlock {
  123617. /**
  123618. * Creates a new ScaleBlock
  123619. * @param name defines the block name
  123620. */
  123621. constructor(name: string);
  123622. /**
  123623. * Gets the current class name
  123624. * @returns the class name
  123625. */
  123626. getClassName(): string;
  123627. /**
  123628. * Gets the input component
  123629. */
  123630. readonly input: NodeMaterialConnectionPoint;
  123631. /**
  123632. * Gets the factor input component
  123633. */
  123634. readonly factor: NodeMaterialConnectionPoint;
  123635. /**
  123636. * Gets the output component
  123637. */
  123638. readonly output: NodeMaterialConnectionPoint;
  123639. protected _buildBlock(state: NodeMaterialBuildState): this;
  123640. }
  123641. }
  123642. declare module BABYLON {
  123643. /**
  123644. * Block used to clamp a float
  123645. */
  123646. export class ClampBlock extends NodeMaterialBlock {
  123647. /** Gets or sets the minimum range */
  123648. minimum: number;
  123649. /** Gets or sets the maximum range */
  123650. maximum: number;
  123651. /**
  123652. * Creates a new ClampBlock
  123653. * @param name defines the block name
  123654. */
  123655. constructor(name: string);
  123656. /**
  123657. * Gets the current class name
  123658. * @returns the class name
  123659. */
  123660. getClassName(): string;
  123661. /**
  123662. * Gets the value input component
  123663. */
  123664. readonly value: NodeMaterialConnectionPoint;
  123665. /**
  123666. * Gets the output component
  123667. */
  123668. readonly output: NodeMaterialConnectionPoint;
  123669. protected _buildBlock(state: NodeMaterialBuildState): this;
  123670. protected _dumpPropertiesCode(): string;
  123671. serialize(): any;
  123672. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123673. }
  123674. }
  123675. declare module BABYLON {
  123676. /**
  123677. * Block used to apply a cross product between 2 vectors
  123678. */
  123679. export class CrossBlock extends NodeMaterialBlock {
  123680. /**
  123681. * Creates a new CrossBlock
  123682. * @param name defines the block name
  123683. */
  123684. constructor(name: string);
  123685. /**
  123686. * Gets the current class name
  123687. * @returns the class name
  123688. */
  123689. getClassName(): string;
  123690. /**
  123691. * Gets the left operand input component
  123692. */
  123693. readonly left: NodeMaterialConnectionPoint;
  123694. /**
  123695. * Gets the right operand input component
  123696. */
  123697. readonly right: NodeMaterialConnectionPoint;
  123698. /**
  123699. * Gets the output component
  123700. */
  123701. readonly output: NodeMaterialConnectionPoint;
  123702. protected _buildBlock(state: NodeMaterialBuildState): this;
  123703. }
  123704. }
  123705. declare module BABYLON {
  123706. /**
  123707. * Block used to apply a dot product between 2 vectors
  123708. */
  123709. export class DotBlock extends NodeMaterialBlock {
  123710. /**
  123711. * Creates a new DotBlock
  123712. * @param name defines the block name
  123713. */
  123714. constructor(name: string);
  123715. /**
  123716. * Gets the current class name
  123717. * @returns the class name
  123718. */
  123719. getClassName(): string;
  123720. /**
  123721. * Gets the left operand input component
  123722. */
  123723. readonly left: NodeMaterialConnectionPoint;
  123724. /**
  123725. * Gets the right operand input component
  123726. */
  123727. readonly right: NodeMaterialConnectionPoint;
  123728. /**
  123729. * Gets the output component
  123730. */
  123731. readonly output: NodeMaterialConnectionPoint;
  123732. protected _buildBlock(state: NodeMaterialBuildState): this;
  123733. }
  123734. }
  123735. declare module BABYLON {
  123736. /**
  123737. * Block used to remap a float from a range to a new one
  123738. */
  123739. export class RemapBlock extends NodeMaterialBlock {
  123740. /**
  123741. * Gets or sets the source range
  123742. */
  123743. sourceRange: Vector2;
  123744. /**
  123745. * Gets or sets the target range
  123746. */
  123747. targetRange: Vector2;
  123748. /**
  123749. * Creates a new RemapBlock
  123750. * @param name defines the block name
  123751. */
  123752. constructor(name: string);
  123753. /**
  123754. * Gets the current class name
  123755. * @returns the class name
  123756. */
  123757. getClassName(): string;
  123758. /**
  123759. * Gets the input component
  123760. */
  123761. readonly input: NodeMaterialConnectionPoint;
  123762. /**
  123763. * Gets the source min input component
  123764. */
  123765. readonly sourceMin: NodeMaterialConnectionPoint;
  123766. /**
  123767. * Gets the source max input component
  123768. */
  123769. readonly sourceMax: NodeMaterialConnectionPoint;
  123770. /**
  123771. * Gets the target min input component
  123772. */
  123773. readonly targetMin: NodeMaterialConnectionPoint;
  123774. /**
  123775. * Gets the target max input component
  123776. */
  123777. readonly targetMax: NodeMaterialConnectionPoint;
  123778. /**
  123779. * Gets the output component
  123780. */
  123781. readonly output: NodeMaterialConnectionPoint;
  123782. protected _buildBlock(state: NodeMaterialBuildState): this;
  123783. protected _dumpPropertiesCode(): string;
  123784. serialize(): any;
  123785. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123786. }
  123787. }
  123788. declare module BABYLON {
  123789. /**
  123790. * Block used to normalize a vector
  123791. */
  123792. export class NormalizeBlock extends NodeMaterialBlock {
  123793. /**
  123794. * Creates a new NormalizeBlock
  123795. * @param name defines the block name
  123796. */
  123797. constructor(name: string);
  123798. /**
  123799. * Gets the current class name
  123800. * @returns the class name
  123801. */
  123802. getClassName(): string;
  123803. /**
  123804. * Gets the input component
  123805. */
  123806. readonly input: NodeMaterialConnectionPoint;
  123807. /**
  123808. * Gets the output component
  123809. */
  123810. readonly output: NodeMaterialConnectionPoint;
  123811. protected _buildBlock(state: NodeMaterialBuildState): this;
  123812. }
  123813. }
  123814. declare module BABYLON {
  123815. /**
  123816. * Operations supported by the Trigonometry block
  123817. */
  123818. export enum TrigonometryBlockOperations {
  123819. /** Cos */
  123820. Cos = 0,
  123821. /** Sin */
  123822. Sin = 1,
  123823. /** Abs */
  123824. Abs = 2,
  123825. /** Exp */
  123826. Exp = 3,
  123827. /** Exp2 */
  123828. Exp2 = 4,
  123829. /** Round */
  123830. Round = 5,
  123831. /** Floor */
  123832. Floor = 6,
  123833. /** Ceiling */
  123834. Ceiling = 7,
  123835. /** Square root */
  123836. Sqrt = 8,
  123837. /** Log */
  123838. Log = 9,
  123839. /** Tangent */
  123840. Tan = 10,
  123841. /** Arc tangent */
  123842. ArcTan = 11,
  123843. /** Arc cosinus */
  123844. ArcCos = 12,
  123845. /** Arc sinus */
  123846. ArcSin = 13,
  123847. /** Fraction */
  123848. Fract = 14,
  123849. /** Sign */
  123850. Sign = 15,
  123851. /** To radians (from degrees) */
  123852. Radians = 16,
  123853. /** To degrees (from radians) */
  123854. Degrees = 17
  123855. }
  123856. /**
  123857. * Block used to apply trigonometry operation to floats
  123858. */
  123859. export class TrigonometryBlock extends NodeMaterialBlock {
  123860. /**
  123861. * Gets or sets the operation applied by the block
  123862. */
  123863. operation: TrigonometryBlockOperations;
  123864. /**
  123865. * Creates a new TrigonometryBlock
  123866. * @param name defines the block name
  123867. */
  123868. constructor(name: string);
  123869. /**
  123870. * Gets the current class name
  123871. * @returns the class name
  123872. */
  123873. getClassName(): string;
  123874. /**
  123875. * Gets the input component
  123876. */
  123877. readonly input: NodeMaterialConnectionPoint;
  123878. /**
  123879. * Gets the output component
  123880. */
  123881. readonly output: NodeMaterialConnectionPoint;
  123882. protected _buildBlock(state: NodeMaterialBuildState): this;
  123883. serialize(): any;
  123884. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123885. protected _dumpPropertiesCode(): string;
  123886. }
  123887. }
  123888. declare module BABYLON {
  123889. /**
  123890. * Block used to create a Color3/4 out of individual inputs (one for each component)
  123891. */
  123892. export class ColorMergerBlock extends NodeMaterialBlock {
  123893. /**
  123894. * Create a new ColorMergerBlock
  123895. * @param name defines the block name
  123896. */
  123897. constructor(name: string);
  123898. /**
  123899. * Gets the current class name
  123900. * @returns the class name
  123901. */
  123902. getClassName(): string;
  123903. /**
  123904. * Gets the r component (input)
  123905. */
  123906. readonly r: NodeMaterialConnectionPoint;
  123907. /**
  123908. * Gets the g component (input)
  123909. */
  123910. readonly g: NodeMaterialConnectionPoint;
  123911. /**
  123912. * Gets the b component (input)
  123913. */
  123914. readonly b: NodeMaterialConnectionPoint;
  123915. /**
  123916. * Gets the a component (input)
  123917. */
  123918. readonly a: NodeMaterialConnectionPoint;
  123919. /**
  123920. * Gets the rgba component (output)
  123921. */
  123922. readonly rgba: NodeMaterialConnectionPoint;
  123923. /**
  123924. * Gets the rgb component (output)
  123925. */
  123926. readonly rgb: NodeMaterialConnectionPoint;
  123927. protected _buildBlock(state: NodeMaterialBuildState): this;
  123928. }
  123929. }
  123930. declare module BABYLON {
  123931. /**
  123932. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  123933. */
  123934. export class VectorMergerBlock extends NodeMaterialBlock {
  123935. /**
  123936. * Create a new VectorMergerBlock
  123937. * @param name defines the block name
  123938. */
  123939. constructor(name: string);
  123940. /**
  123941. * Gets the current class name
  123942. * @returns the class name
  123943. */
  123944. getClassName(): string;
  123945. /**
  123946. * Gets the x component (input)
  123947. */
  123948. readonly x: NodeMaterialConnectionPoint;
  123949. /**
  123950. * Gets the y component (input)
  123951. */
  123952. readonly y: NodeMaterialConnectionPoint;
  123953. /**
  123954. * Gets the z component (input)
  123955. */
  123956. readonly z: NodeMaterialConnectionPoint;
  123957. /**
  123958. * Gets the w component (input)
  123959. */
  123960. readonly w: NodeMaterialConnectionPoint;
  123961. /**
  123962. * Gets the xyzw component (output)
  123963. */
  123964. readonly xyzw: NodeMaterialConnectionPoint;
  123965. /**
  123966. * Gets the xyz component (output)
  123967. */
  123968. readonly xyz: NodeMaterialConnectionPoint;
  123969. /**
  123970. * Gets the xy component (output)
  123971. */
  123972. readonly xy: NodeMaterialConnectionPoint;
  123973. protected _buildBlock(state: NodeMaterialBuildState): this;
  123974. }
  123975. }
  123976. declare module BABYLON {
  123977. /**
  123978. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  123979. */
  123980. export class ColorSplitterBlock extends NodeMaterialBlock {
  123981. /**
  123982. * Create a new ColorSplitterBlock
  123983. * @param name defines the block name
  123984. */
  123985. constructor(name: string);
  123986. /**
  123987. * Gets the current class name
  123988. * @returns the class name
  123989. */
  123990. getClassName(): string;
  123991. /**
  123992. * Gets the rgba component (input)
  123993. */
  123994. readonly rgba: NodeMaterialConnectionPoint;
  123995. /**
  123996. * Gets the rgb component (input)
  123997. */
  123998. readonly rgbIn: NodeMaterialConnectionPoint;
  123999. /**
  124000. * Gets the rgb component (output)
  124001. */
  124002. readonly rgbOut: NodeMaterialConnectionPoint;
  124003. /**
  124004. * Gets the r component (output)
  124005. */
  124006. readonly r: NodeMaterialConnectionPoint;
  124007. /**
  124008. * Gets the g component (output)
  124009. */
  124010. readonly g: NodeMaterialConnectionPoint;
  124011. /**
  124012. * Gets the b component (output)
  124013. */
  124014. readonly b: NodeMaterialConnectionPoint;
  124015. /**
  124016. * Gets the a component (output)
  124017. */
  124018. readonly a: NodeMaterialConnectionPoint;
  124019. protected _inputRename(name: string): string;
  124020. protected _outputRename(name: string): string;
  124021. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124022. }
  124023. }
  124024. declare module BABYLON {
  124025. /**
  124026. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  124027. */
  124028. export class VectorSplitterBlock extends NodeMaterialBlock {
  124029. /**
  124030. * Create a new VectorSplitterBlock
  124031. * @param name defines the block name
  124032. */
  124033. constructor(name: string);
  124034. /**
  124035. * Gets the current class name
  124036. * @returns the class name
  124037. */
  124038. getClassName(): string;
  124039. /**
  124040. * Gets the xyzw component (input)
  124041. */
  124042. readonly xyzw: NodeMaterialConnectionPoint;
  124043. /**
  124044. * Gets the xyz component (input)
  124045. */
  124046. readonly xyzIn: NodeMaterialConnectionPoint;
  124047. /**
  124048. * Gets the xy component (input)
  124049. */
  124050. readonly xyIn: NodeMaterialConnectionPoint;
  124051. /**
  124052. * Gets the xyz component (output)
  124053. */
  124054. readonly xyzOut: NodeMaterialConnectionPoint;
  124055. /**
  124056. * Gets the xy component (output)
  124057. */
  124058. readonly xyOut: NodeMaterialConnectionPoint;
  124059. /**
  124060. * Gets the x component (output)
  124061. */
  124062. readonly x: NodeMaterialConnectionPoint;
  124063. /**
  124064. * Gets the y component (output)
  124065. */
  124066. readonly y: NodeMaterialConnectionPoint;
  124067. /**
  124068. * Gets the z component (output)
  124069. */
  124070. readonly z: NodeMaterialConnectionPoint;
  124071. /**
  124072. * Gets the w component (output)
  124073. */
  124074. readonly w: NodeMaterialConnectionPoint;
  124075. protected _inputRename(name: string): string;
  124076. protected _outputRename(name: string): string;
  124077. protected _buildBlock(state: NodeMaterialBuildState): this;
  124078. }
  124079. }
  124080. declare module BABYLON {
  124081. /**
  124082. * Block used to lerp between 2 values
  124083. */
  124084. export class LerpBlock extends NodeMaterialBlock {
  124085. /**
  124086. * Creates a new LerpBlock
  124087. * @param name defines the block name
  124088. */
  124089. constructor(name: string);
  124090. /**
  124091. * Gets the current class name
  124092. * @returns the class name
  124093. */
  124094. getClassName(): string;
  124095. /**
  124096. * Gets the left operand input component
  124097. */
  124098. readonly left: NodeMaterialConnectionPoint;
  124099. /**
  124100. * Gets the right operand input component
  124101. */
  124102. readonly right: NodeMaterialConnectionPoint;
  124103. /**
  124104. * Gets the gradient operand input component
  124105. */
  124106. readonly gradient: NodeMaterialConnectionPoint;
  124107. /**
  124108. * Gets the output component
  124109. */
  124110. readonly output: NodeMaterialConnectionPoint;
  124111. protected _buildBlock(state: NodeMaterialBuildState): this;
  124112. }
  124113. }
  124114. declare module BABYLON {
  124115. /**
  124116. * Block used to divide 2 vectors
  124117. */
  124118. export class DivideBlock extends NodeMaterialBlock {
  124119. /**
  124120. * Creates a new DivideBlock
  124121. * @param name defines the block name
  124122. */
  124123. constructor(name: string);
  124124. /**
  124125. * Gets the current class name
  124126. * @returns the class name
  124127. */
  124128. getClassName(): string;
  124129. /**
  124130. * Gets the left operand input component
  124131. */
  124132. readonly left: NodeMaterialConnectionPoint;
  124133. /**
  124134. * Gets the right operand input component
  124135. */
  124136. readonly right: NodeMaterialConnectionPoint;
  124137. /**
  124138. * Gets the output component
  124139. */
  124140. readonly output: NodeMaterialConnectionPoint;
  124141. protected _buildBlock(state: NodeMaterialBuildState): this;
  124142. }
  124143. }
  124144. declare module BABYLON {
  124145. /**
  124146. * Block used to subtract 2 vectors
  124147. */
  124148. export class SubtractBlock extends NodeMaterialBlock {
  124149. /**
  124150. * Creates a new SubtractBlock
  124151. * @param name defines the block name
  124152. */
  124153. constructor(name: string);
  124154. /**
  124155. * Gets the current class name
  124156. * @returns the class name
  124157. */
  124158. getClassName(): string;
  124159. /**
  124160. * Gets the left operand input component
  124161. */
  124162. readonly left: NodeMaterialConnectionPoint;
  124163. /**
  124164. * Gets the right operand input component
  124165. */
  124166. readonly right: NodeMaterialConnectionPoint;
  124167. /**
  124168. * Gets the output component
  124169. */
  124170. readonly output: NodeMaterialConnectionPoint;
  124171. protected _buildBlock(state: NodeMaterialBuildState): this;
  124172. }
  124173. }
  124174. declare module BABYLON {
  124175. /**
  124176. * Block used to step a value
  124177. */
  124178. export class StepBlock extends NodeMaterialBlock {
  124179. /**
  124180. * Creates a new StepBlock
  124181. * @param name defines the block name
  124182. */
  124183. constructor(name: string);
  124184. /**
  124185. * Gets the current class name
  124186. * @returns the class name
  124187. */
  124188. getClassName(): string;
  124189. /**
  124190. * Gets the value operand input component
  124191. */
  124192. readonly value: NodeMaterialConnectionPoint;
  124193. /**
  124194. * Gets the edge operand input component
  124195. */
  124196. readonly edge: NodeMaterialConnectionPoint;
  124197. /**
  124198. * Gets the output component
  124199. */
  124200. readonly output: NodeMaterialConnectionPoint;
  124201. protected _buildBlock(state: NodeMaterialBuildState): this;
  124202. }
  124203. }
  124204. declare module BABYLON {
  124205. /**
  124206. * Block used to get the opposite (1 - x) of a value
  124207. */
  124208. export class OneMinusBlock extends NodeMaterialBlock {
  124209. /**
  124210. * Creates a new OneMinusBlock
  124211. * @param name defines the block name
  124212. */
  124213. constructor(name: string);
  124214. /**
  124215. * Gets the current class name
  124216. * @returns the class name
  124217. */
  124218. getClassName(): string;
  124219. /**
  124220. * Gets the input component
  124221. */
  124222. readonly input: NodeMaterialConnectionPoint;
  124223. /**
  124224. * Gets the output component
  124225. */
  124226. readonly output: NodeMaterialConnectionPoint;
  124227. protected _buildBlock(state: NodeMaterialBuildState): this;
  124228. }
  124229. }
  124230. declare module BABYLON {
  124231. /**
  124232. * Block used to get the view direction
  124233. */
  124234. export class ViewDirectionBlock extends NodeMaterialBlock {
  124235. /**
  124236. * Creates a new ViewDirectionBlock
  124237. * @param name defines the block name
  124238. */
  124239. constructor(name: string);
  124240. /**
  124241. * Gets the current class name
  124242. * @returns the class name
  124243. */
  124244. getClassName(): string;
  124245. /**
  124246. * Gets the world position component
  124247. */
  124248. readonly worldPosition: NodeMaterialConnectionPoint;
  124249. /**
  124250. * Gets the camera position component
  124251. */
  124252. readonly cameraPosition: NodeMaterialConnectionPoint;
  124253. /**
  124254. * Gets the output component
  124255. */
  124256. readonly output: NodeMaterialConnectionPoint;
  124257. autoConfigure(material: NodeMaterial): void;
  124258. protected _buildBlock(state: NodeMaterialBuildState): this;
  124259. }
  124260. }
  124261. declare module BABYLON {
  124262. /**
  124263. * Block used to compute fresnel value
  124264. */
  124265. export class FresnelBlock extends NodeMaterialBlock {
  124266. /**
  124267. * Create a new FresnelBlock
  124268. * @param name defines the block name
  124269. */
  124270. constructor(name: string);
  124271. /**
  124272. * Gets the current class name
  124273. * @returns the class name
  124274. */
  124275. getClassName(): string;
  124276. /**
  124277. * Gets the world normal input component
  124278. */
  124279. readonly worldNormal: NodeMaterialConnectionPoint;
  124280. /**
  124281. * Gets the view direction input component
  124282. */
  124283. readonly viewDirection: NodeMaterialConnectionPoint;
  124284. /**
  124285. * Gets the bias input component
  124286. */
  124287. readonly bias: NodeMaterialConnectionPoint;
  124288. /**
  124289. * Gets the camera (or eye) position component
  124290. */
  124291. readonly power: NodeMaterialConnectionPoint;
  124292. /**
  124293. * Gets the fresnel output component
  124294. */
  124295. readonly fresnel: NodeMaterialConnectionPoint;
  124296. autoConfigure(material: NodeMaterial): void;
  124297. protected _buildBlock(state: NodeMaterialBuildState): this;
  124298. }
  124299. }
  124300. declare module BABYLON {
  124301. /**
  124302. * Block used to get the max of 2 values
  124303. */
  124304. export class MaxBlock extends NodeMaterialBlock {
  124305. /**
  124306. * Creates a new MaxBlock
  124307. * @param name defines the block name
  124308. */
  124309. constructor(name: string);
  124310. /**
  124311. * Gets the current class name
  124312. * @returns the class name
  124313. */
  124314. getClassName(): string;
  124315. /**
  124316. * Gets the left operand input component
  124317. */
  124318. readonly left: NodeMaterialConnectionPoint;
  124319. /**
  124320. * Gets the right operand input component
  124321. */
  124322. readonly right: NodeMaterialConnectionPoint;
  124323. /**
  124324. * Gets the output component
  124325. */
  124326. readonly output: NodeMaterialConnectionPoint;
  124327. protected _buildBlock(state: NodeMaterialBuildState): this;
  124328. }
  124329. }
  124330. declare module BABYLON {
  124331. /**
  124332. * Block used to get the min of 2 values
  124333. */
  124334. export class MinBlock extends NodeMaterialBlock {
  124335. /**
  124336. * Creates a new MinBlock
  124337. * @param name defines the block name
  124338. */
  124339. constructor(name: string);
  124340. /**
  124341. * Gets the current class name
  124342. * @returns the class name
  124343. */
  124344. getClassName(): string;
  124345. /**
  124346. * Gets the left operand input component
  124347. */
  124348. readonly left: NodeMaterialConnectionPoint;
  124349. /**
  124350. * Gets the right operand input component
  124351. */
  124352. readonly right: NodeMaterialConnectionPoint;
  124353. /**
  124354. * Gets the output component
  124355. */
  124356. readonly output: NodeMaterialConnectionPoint;
  124357. protected _buildBlock(state: NodeMaterialBuildState): this;
  124358. }
  124359. }
  124360. declare module BABYLON {
  124361. /**
  124362. * Block used to get the distance between 2 values
  124363. */
  124364. export class DistanceBlock extends NodeMaterialBlock {
  124365. /**
  124366. * Creates a new DistanceBlock
  124367. * @param name defines the block name
  124368. */
  124369. constructor(name: string);
  124370. /**
  124371. * Gets the current class name
  124372. * @returns the class name
  124373. */
  124374. getClassName(): string;
  124375. /**
  124376. * Gets the left operand input component
  124377. */
  124378. readonly left: NodeMaterialConnectionPoint;
  124379. /**
  124380. * Gets the right operand input component
  124381. */
  124382. readonly right: NodeMaterialConnectionPoint;
  124383. /**
  124384. * Gets the output component
  124385. */
  124386. readonly output: NodeMaterialConnectionPoint;
  124387. protected _buildBlock(state: NodeMaterialBuildState): this;
  124388. }
  124389. }
  124390. declare module BABYLON {
  124391. /**
  124392. * Block used to get the length of a vector
  124393. */
  124394. export class LengthBlock extends NodeMaterialBlock {
  124395. /**
  124396. * Creates a new LengthBlock
  124397. * @param name defines the block name
  124398. */
  124399. constructor(name: string);
  124400. /**
  124401. * Gets the current class name
  124402. * @returns the class name
  124403. */
  124404. getClassName(): string;
  124405. /**
  124406. * Gets the value input component
  124407. */
  124408. readonly value: NodeMaterialConnectionPoint;
  124409. /**
  124410. * Gets the output component
  124411. */
  124412. readonly output: NodeMaterialConnectionPoint;
  124413. protected _buildBlock(state: NodeMaterialBuildState): this;
  124414. }
  124415. }
  124416. declare module BABYLON {
  124417. /**
  124418. * Block used to get negative version of a value (i.e. x * -1)
  124419. */
  124420. export class NegateBlock extends NodeMaterialBlock {
  124421. /**
  124422. * Creates a new NegateBlock
  124423. * @param name defines the block name
  124424. */
  124425. constructor(name: string);
  124426. /**
  124427. * Gets the current class name
  124428. * @returns the class name
  124429. */
  124430. getClassName(): string;
  124431. /**
  124432. * Gets the value input component
  124433. */
  124434. readonly value: NodeMaterialConnectionPoint;
  124435. /**
  124436. * Gets the output component
  124437. */
  124438. readonly output: NodeMaterialConnectionPoint;
  124439. protected _buildBlock(state: NodeMaterialBuildState): this;
  124440. }
  124441. }
  124442. declare module BABYLON {
  124443. /**
  124444. * Block used to get the value of the first parameter raised to the power of the second
  124445. */
  124446. export class PowBlock extends NodeMaterialBlock {
  124447. /**
  124448. * Creates a new PowBlock
  124449. * @param name defines the block name
  124450. */
  124451. constructor(name: string);
  124452. /**
  124453. * Gets the current class name
  124454. * @returns the class name
  124455. */
  124456. getClassName(): string;
  124457. /**
  124458. * Gets the value operand input component
  124459. */
  124460. readonly value: NodeMaterialConnectionPoint;
  124461. /**
  124462. * Gets the power operand input component
  124463. */
  124464. readonly power: NodeMaterialConnectionPoint;
  124465. /**
  124466. * Gets the output component
  124467. */
  124468. readonly output: NodeMaterialConnectionPoint;
  124469. protected _buildBlock(state: NodeMaterialBuildState): this;
  124470. }
  124471. }
  124472. declare module BABYLON {
  124473. /**
  124474. * Block used to get a random number
  124475. */
  124476. export class RandomNumberBlock extends NodeMaterialBlock {
  124477. /**
  124478. * Creates a new RandomNumberBlock
  124479. * @param name defines the block name
  124480. */
  124481. constructor(name: string);
  124482. /**
  124483. * Gets the current class name
  124484. * @returns the class name
  124485. */
  124486. getClassName(): string;
  124487. /**
  124488. * Gets the seed input component
  124489. */
  124490. readonly seed: NodeMaterialConnectionPoint;
  124491. /**
  124492. * Gets the output component
  124493. */
  124494. readonly output: NodeMaterialConnectionPoint;
  124495. protected _buildBlock(state: NodeMaterialBuildState): this;
  124496. }
  124497. }
  124498. declare module BABYLON {
  124499. /**
  124500. * Block used to compute arc tangent of 2 values
  124501. */
  124502. export class ArcTan2Block extends NodeMaterialBlock {
  124503. /**
  124504. * Creates a new ArcTan2Block
  124505. * @param name defines the block name
  124506. */
  124507. constructor(name: string);
  124508. /**
  124509. * Gets the current class name
  124510. * @returns the class name
  124511. */
  124512. getClassName(): string;
  124513. /**
  124514. * Gets the x operand input component
  124515. */
  124516. readonly x: NodeMaterialConnectionPoint;
  124517. /**
  124518. * Gets the y operand input component
  124519. */
  124520. readonly y: NodeMaterialConnectionPoint;
  124521. /**
  124522. * Gets the output component
  124523. */
  124524. readonly output: NodeMaterialConnectionPoint;
  124525. protected _buildBlock(state: NodeMaterialBuildState): this;
  124526. }
  124527. }
  124528. declare module BABYLON {
  124529. /**
  124530. * Block used to smooth step a value
  124531. */
  124532. export class SmoothStepBlock extends NodeMaterialBlock {
  124533. /**
  124534. * Creates a new SmoothStepBlock
  124535. * @param name defines the block name
  124536. */
  124537. constructor(name: string);
  124538. /**
  124539. * Gets the current class name
  124540. * @returns the class name
  124541. */
  124542. getClassName(): string;
  124543. /**
  124544. * Gets the value operand input component
  124545. */
  124546. readonly value: NodeMaterialConnectionPoint;
  124547. /**
  124548. * Gets the first edge operand input component
  124549. */
  124550. readonly edge0: NodeMaterialConnectionPoint;
  124551. /**
  124552. * Gets the second edge operand input component
  124553. */
  124554. readonly edge1: NodeMaterialConnectionPoint;
  124555. /**
  124556. * Gets the output component
  124557. */
  124558. readonly output: NodeMaterialConnectionPoint;
  124559. protected _buildBlock(state: NodeMaterialBuildState): this;
  124560. }
  124561. }
  124562. declare module BABYLON {
  124563. /**
  124564. * Block used to get the reciprocal (1 / x) of a value
  124565. */
  124566. export class ReciprocalBlock extends NodeMaterialBlock {
  124567. /**
  124568. * Creates a new ReciprocalBlock
  124569. * @param name defines the block name
  124570. */
  124571. constructor(name: string);
  124572. /**
  124573. * Gets the current class name
  124574. * @returns the class name
  124575. */
  124576. getClassName(): string;
  124577. /**
  124578. * Gets the input component
  124579. */
  124580. readonly input: NodeMaterialConnectionPoint;
  124581. /**
  124582. * Gets the output component
  124583. */
  124584. readonly output: NodeMaterialConnectionPoint;
  124585. protected _buildBlock(state: NodeMaterialBuildState): this;
  124586. }
  124587. }
  124588. declare module BABYLON {
  124589. /**
  124590. * Block used to replace a color by another one
  124591. */
  124592. export class ReplaceColorBlock extends NodeMaterialBlock {
  124593. /**
  124594. * Creates a new ReplaceColorBlock
  124595. * @param name defines the block name
  124596. */
  124597. constructor(name: string);
  124598. /**
  124599. * Gets the current class name
  124600. * @returns the class name
  124601. */
  124602. getClassName(): string;
  124603. /**
  124604. * Gets the value input component
  124605. */
  124606. readonly value: NodeMaterialConnectionPoint;
  124607. /**
  124608. * Gets the reference input component
  124609. */
  124610. readonly reference: NodeMaterialConnectionPoint;
  124611. /**
  124612. * Gets the distance input component
  124613. */
  124614. readonly distance: NodeMaterialConnectionPoint;
  124615. /**
  124616. * Gets the replacement input component
  124617. */
  124618. readonly replacement: NodeMaterialConnectionPoint;
  124619. /**
  124620. * Gets the output component
  124621. */
  124622. readonly output: NodeMaterialConnectionPoint;
  124623. protected _buildBlock(state: NodeMaterialBuildState): this;
  124624. }
  124625. }
  124626. declare module BABYLON {
  124627. /**
  124628. * Block used to posterize a value
  124629. * @see https://en.wikipedia.org/wiki/Posterization
  124630. */
  124631. export class PosterizeBlock extends NodeMaterialBlock {
  124632. /**
  124633. * Creates a new PosterizeBlock
  124634. * @param name defines the block name
  124635. */
  124636. constructor(name: string);
  124637. /**
  124638. * Gets the current class name
  124639. * @returns the class name
  124640. */
  124641. getClassName(): string;
  124642. /**
  124643. * Gets the value input component
  124644. */
  124645. readonly value: NodeMaterialConnectionPoint;
  124646. /**
  124647. * Gets the steps input component
  124648. */
  124649. readonly steps: NodeMaterialConnectionPoint;
  124650. /**
  124651. * Gets the output component
  124652. */
  124653. readonly output: NodeMaterialConnectionPoint;
  124654. protected _buildBlock(state: NodeMaterialBuildState): this;
  124655. }
  124656. }
  124657. declare module BABYLON {
  124658. /**
  124659. * Operations supported by the Wave block
  124660. */
  124661. export enum WaveBlockKind {
  124662. /** SawTooth */
  124663. SawTooth = 0,
  124664. /** Square */
  124665. Square = 1,
  124666. /** Triangle */
  124667. Triangle = 2
  124668. }
  124669. /**
  124670. * Block used to apply wave operation to floats
  124671. */
  124672. export class WaveBlock extends NodeMaterialBlock {
  124673. /**
  124674. * Gets or sets the kibnd of wave to be applied by the block
  124675. */
  124676. kind: WaveBlockKind;
  124677. /**
  124678. * Creates a new WaveBlock
  124679. * @param name defines the block name
  124680. */
  124681. constructor(name: string);
  124682. /**
  124683. * Gets the current class name
  124684. * @returns the class name
  124685. */
  124686. getClassName(): string;
  124687. /**
  124688. * Gets the input component
  124689. */
  124690. readonly input: NodeMaterialConnectionPoint;
  124691. /**
  124692. * Gets the output component
  124693. */
  124694. readonly output: NodeMaterialConnectionPoint;
  124695. protected _buildBlock(state: NodeMaterialBuildState): this;
  124696. serialize(): any;
  124697. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124698. }
  124699. }
  124700. declare module BABYLON {
  124701. /**
  124702. * Class used to store a color step for the GradientBlock
  124703. */
  124704. export class GradientBlockColorStep {
  124705. /**
  124706. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  124707. */
  124708. step: number;
  124709. /**
  124710. * Gets or sets the color associated with this step
  124711. */
  124712. color: Color3;
  124713. /**
  124714. * Creates a new GradientBlockColorStep
  124715. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  124716. * @param color defines the color associated with this step
  124717. */
  124718. constructor(
  124719. /**
  124720. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  124721. */
  124722. step: number,
  124723. /**
  124724. * Gets or sets the color associated with this step
  124725. */
  124726. color: Color3);
  124727. }
  124728. /**
  124729. * Block used to return a color from a gradient based on an input value between 0 and 1
  124730. */
  124731. export class GradientBlock extends NodeMaterialBlock {
  124732. /**
  124733. * Gets or sets the list of color steps
  124734. */
  124735. colorSteps: GradientBlockColorStep[];
  124736. /**
  124737. * Creates a new GradientBlock
  124738. * @param name defines the block name
  124739. */
  124740. constructor(name: string);
  124741. /**
  124742. * Gets the current class name
  124743. * @returns the class name
  124744. */
  124745. getClassName(): string;
  124746. /**
  124747. * Gets the gradient input component
  124748. */
  124749. readonly gradient: NodeMaterialConnectionPoint;
  124750. /**
  124751. * Gets the output component
  124752. */
  124753. readonly output: NodeMaterialConnectionPoint;
  124754. private _writeColorConstant;
  124755. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124756. serialize(): any;
  124757. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124758. protected _dumpPropertiesCode(): string;
  124759. }
  124760. }
  124761. declare module BABYLON {
  124762. /**
  124763. * Block used to normalize lerp between 2 values
  124764. */
  124765. export class NLerpBlock extends NodeMaterialBlock {
  124766. /**
  124767. * Creates a new NLerpBlock
  124768. * @param name defines the block name
  124769. */
  124770. constructor(name: string);
  124771. /**
  124772. * Gets the current class name
  124773. * @returns the class name
  124774. */
  124775. getClassName(): string;
  124776. /**
  124777. * Gets the left operand input component
  124778. */
  124779. readonly left: NodeMaterialConnectionPoint;
  124780. /**
  124781. * Gets the right operand input component
  124782. */
  124783. readonly right: NodeMaterialConnectionPoint;
  124784. /**
  124785. * Gets the gradient operand input component
  124786. */
  124787. readonly gradient: NodeMaterialConnectionPoint;
  124788. /**
  124789. * Gets the output component
  124790. */
  124791. readonly output: NodeMaterialConnectionPoint;
  124792. protected _buildBlock(state: NodeMaterialBuildState): this;
  124793. }
  124794. }
  124795. declare module BABYLON {
  124796. /**
  124797. * block used to Generate a Worley Noise 3D Noise Pattern
  124798. */
  124799. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  124800. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  124801. manhattanDistance: boolean;
  124802. /**
  124803. * Creates a new WorleyNoise3DBlock
  124804. * @param name defines the block name
  124805. */
  124806. constructor(name: string);
  124807. /**
  124808. * Gets the current class name
  124809. * @returns the class name
  124810. */
  124811. getClassName(): string;
  124812. /**
  124813. * Gets the position input component
  124814. */
  124815. readonly position: NodeMaterialConnectionPoint;
  124816. /**
  124817. * Gets the jitter input component
  124818. */
  124819. readonly jitter: NodeMaterialConnectionPoint;
  124820. /**
  124821. * Gets the output component
  124822. */
  124823. readonly output: NodeMaterialConnectionPoint;
  124824. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124825. /**
  124826. * Exposes the properties to the UI?
  124827. */
  124828. protected _dumpPropertiesCode(): string;
  124829. /**
  124830. * Exposes the properties to the Seralize?
  124831. */
  124832. serialize(): any;
  124833. /**
  124834. * Exposes the properties to the deseralize?
  124835. */
  124836. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124837. }
  124838. }
  124839. declare module BABYLON {
  124840. /**
  124841. * block used to Generate a Simplex Perlin 3d Noise Pattern
  124842. */
  124843. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  124844. /**
  124845. * Creates a new SimplexPerlin3DBlock
  124846. * @param name defines the block name
  124847. */
  124848. constructor(name: string);
  124849. /**
  124850. * Gets the current class name
  124851. * @returns the class name
  124852. */
  124853. getClassName(): string;
  124854. /**
  124855. * Gets the position operand input component
  124856. */
  124857. readonly position: NodeMaterialConnectionPoint;
  124858. /**
  124859. * Gets the output component
  124860. */
  124861. readonly output: NodeMaterialConnectionPoint;
  124862. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124863. }
  124864. }
  124865. declare module BABYLON {
  124866. /**
  124867. * Block used to blend normals
  124868. */
  124869. export class NormalBlendBlock extends NodeMaterialBlock {
  124870. /**
  124871. * Creates a new NormalBlendBlock
  124872. * @param name defines the block name
  124873. */
  124874. constructor(name: string);
  124875. /**
  124876. * Gets the current class name
  124877. * @returns the class name
  124878. */
  124879. getClassName(): string;
  124880. /**
  124881. * Gets the first input component
  124882. */
  124883. readonly input0: NodeMaterialConnectionPoint;
  124884. /**
  124885. * Gets the second input component
  124886. */
  124887. readonly input1: NodeMaterialConnectionPoint;
  124888. /**
  124889. * Gets the output component
  124890. */
  124891. readonly output: NodeMaterialConnectionPoint;
  124892. protected _buildBlock(state: NodeMaterialBuildState): this;
  124893. }
  124894. }
  124895. declare module BABYLON {
  124896. /**
  124897. * Block used to rotate a 2d vector by a given angle
  124898. */
  124899. export class Rotate2dBlock extends NodeMaterialBlock {
  124900. /**
  124901. * Creates a new Rotate2dBlock
  124902. * @param name defines the block name
  124903. */
  124904. constructor(name: string);
  124905. /**
  124906. * Gets the current class name
  124907. * @returns the class name
  124908. */
  124909. getClassName(): string;
  124910. /**
  124911. * Gets the input vector
  124912. */
  124913. readonly input: NodeMaterialConnectionPoint;
  124914. /**
  124915. * Gets the input angle
  124916. */
  124917. readonly angle: NodeMaterialConnectionPoint;
  124918. /**
  124919. * Gets the output component
  124920. */
  124921. readonly output: NodeMaterialConnectionPoint;
  124922. autoConfigure(material: NodeMaterial): void;
  124923. protected _buildBlock(state: NodeMaterialBuildState): this;
  124924. }
  124925. }
  124926. declare module BABYLON {
  124927. /**
  124928. * Effect Render Options
  124929. */
  124930. export interface IEffectRendererOptions {
  124931. /**
  124932. * Defines the vertices positions.
  124933. */
  124934. positions?: number[];
  124935. /**
  124936. * Defines the indices.
  124937. */
  124938. indices?: number[];
  124939. }
  124940. /**
  124941. * Helper class to render one or more effects
  124942. */
  124943. export class EffectRenderer {
  124944. private engine;
  124945. private static _DefaultOptions;
  124946. private _vertexBuffers;
  124947. private _indexBuffer;
  124948. private _ringBufferIndex;
  124949. private _ringScreenBuffer;
  124950. private _fullscreenViewport;
  124951. private _getNextFrameBuffer;
  124952. /**
  124953. * Creates an effect renderer
  124954. * @param engine the engine to use for rendering
  124955. * @param options defines the options of the effect renderer
  124956. */
  124957. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  124958. /**
  124959. * Sets the current viewport in normalized coordinates 0-1
  124960. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  124961. */
  124962. setViewport(viewport?: Viewport): void;
  124963. /**
  124964. * Binds the embedded attributes buffer to the effect.
  124965. * @param effect Defines the effect to bind the attributes for
  124966. */
  124967. bindBuffers(effect: Effect): void;
  124968. /**
  124969. * Sets the current effect wrapper to use during draw.
  124970. * The effect needs to be ready before calling this api.
  124971. * This also sets the default full screen position attribute.
  124972. * @param effectWrapper Defines the effect to draw with
  124973. */
  124974. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  124975. /**
  124976. * Draws a full screen quad.
  124977. */
  124978. draw(): void;
  124979. /**
  124980. * renders one or more effects to a specified texture
  124981. * @param effectWrappers list of effects to renderer
  124982. * @param outputTexture texture to draw to, if null it will render to the screen
  124983. */
  124984. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  124985. /**
  124986. * Disposes of the effect renderer
  124987. */
  124988. dispose(): void;
  124989. }
  124990. /**
  124991. * Options to create an EffectWrapper
  124992. */
  124993. interface EffectWrapperCreationOptions {
  124994. /**
  124995. * Engine to use to create the effect
  124996. */
  124997. engine: ThinEngine;
  124998. /**
  124999. * Fragment shader for the effect
  125000. */
  125001. fragmentShader: string;
  125002. /**
  125003. * Vertex shader for the effect
  125004. */
  125005. vertexShader?: string;
  125006. /**
  125007. * Attributes to use in the shader
  125008. */
  125009. attributeNames?: Array<string>;
  125010. /**
  125011. * Uniforms to use in the shader
  125012. */
  125013. uniformNames?: Array<string>;
  125014. /**
  125015. * Texture sampler names to use in the shader
  125016. */
  125017. samplerNames?: Array<string>;
  125018. /**
  125019. * The friendly name of the effect displayed in Spector.
  125020. */
  125021. name?: string;
  125022. }
  125023. /**
  125024. * Wraps an effect to be used for rendering
  125025. */
  125026. export class EffectWrapper {
  125027. /**
  125028. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  125029. */
  125030. onApplyObservable: Observable<{}>;
  125031. /**
  125032. * The underlying effect
  125033. */
  125034. effect: Effect;
  125035. /**
  125036. * Creates an effect to be renderer
  125037. * @param creationOptions options to create the effect
  125038. */
  125039. constructor(creationOptions: EffectWrapperCreationOptions);
  125040. /**
  125041. * Disposes of the effect wrapper
  125042. */
  125043. dispose(): void;
  125044. }
  125045. }
  125046. declare module BABYLON {
  125047. /**
  125048. * Helper class to push actions to a pool of workers.
  125049. */
  125050. export class WorkerPool implements IDisposable {
  125051. private _workerInfos;
  125052. private _pendingActions;
  125053. /**
  125054. * Constructor
  125055. * @param workers Array of workers to use for actions
  125056. */
  125057. constructor(workers: Array<Worker>);
  125058. /**
  125059. * Terminates all workers and clears any pending actions.
  125060. */
  125061. dispose(): void;
  125062. /**
  125063. * Pushes an action to the worker pool. If all the workers are active, the action will be
  125064. * pended until a worker has completed its action.
  125065. * @param action The action to perform. Call onComplete when the action is complete.
  125066. */
  125067. push(action: (worker: Worker, onComplete: () => void) => void): void;
  125068. private _execute;
  125069. }
  125070. }
  125071. declare module BABYLON {
  125072. /**
  125073. * Configuration for Draco compression
  125074. */
  125075. export interface IDracoCompressionConfiguration {
  125076. /**
  125077. * Configuration for the decoder.
  125078. */
  125079. decoder: {
  125080. /**
  125081. * The url to the WebAssembly module.
  125082. */
  125083. wasmUrl?: string;
  125084. /**
  125085. * The url to the WebAssembly binary.
  125086. */
  125087. wasmBinaryUrl?: string;
  125088. /**
  125089. * The url to the fallback JavaScript module.
  125090. */
  125091. fallbackUrl?: string;
  125092. };
  125093. }
  125094. /**
  125095. * Draco compression (https://google.github.io/draco/)
  125096. *
  125097. * This class wraps the Draco module.
  125098. *
  125099. * **Encoder**
  125100. *
  125101. * The encoder is not currently implemented.
  125102. *
  125103. * **Decoder**
  125104. *
  125105. * 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.
  125106. *
  125107. * To update the configuration, use the following code:
  125108. * ```javascript
  125109. * DracoCompression.Configuration = {
  125110. * decoder: {
  125111. * wasmUrl: "<url to the WebAssembly library>",
  125112. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  125113. * fallbackUrl: "<url to the fallback JavaScript library>",
  125114. * }
  125115. * };
  125116. * ```
  125117. *
  125118. * 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.
  125119. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  125120. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  125121. *
  125122. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  125123. * ```javascript
  125124. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  125125. * ```
  125126. *
  125127. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  125128. */
  125129. export class DracoCompression implements IDisposable {
  125130. private _workerPoolPromise?;
  125131. private _decoderModulePromise?;
  125132. /**
  125133. * The configuration. Defaults to the following urls:
  125134. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  125135. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  125136. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  125137. */
  125138. static Configuration: IDracoCompressionConfiguration;
  125139. /**
  125140. * Returns true if the decoder configuration is available.
  125141. */
  125142. static readonly DecoderAvailable: boolean;
  125143. /**
  125144. * Default number of workers to create when creating the draco compression object.
  125145. */
  125146. static DefaultNumWorkers: number;
  125147. private static GetDefaultNumWorkers;
  125148. private static _Default;
  125149. /**
  125150. * Default instance for the draco compression object.
  125151. */
  125152. static readonly Default: DracoCompression;
  125153. /**
  125154. * Constructor
  125155. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  125156. */
  125157. constructor(numWorkers?: number);
  125158. /**
  125159. * Stop all async operations and release resources.
  125160. */
  125161. dispose(): void;
  125162. /**
  125163. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  125164. * @returns a promise that resolves when ready
  125165. */
  125166. whenReadyAsync(): Promise<void>;
  125167. /**
  125168. * Decode Draco compressed mesh data to vertex data.
  125169. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  125170. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  125171. * @returns A promise that resolves with the decoded vertex data
  125172. */
  125173. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  125174. [kind: string]: number;
  125175. }): Promise<VertexData>;
  125176. }
  125177. }
  125178. declare module BABYLON {
  125179. /**
  125180. * Class for building Constructive Solid Geometry
  125181. */
  125182. export class CSG {
  125183. private polygons;
  125184. /**
  125185. * The world matrix
  125186. */
  125187. matrix: Matrix;
  125188. /**
  125189. * Stores the position
  125190. */
  125191. position: Vector3;
  125192. /**
  125193. * Stores the rotation
  125194. */
  125195. rotation: Vector3;
  125196. /**
  125197. * Stores the rotation quaternion
  125198. */
  125199. rotationQuaternion: Nullable<Quaternion>;
  125200. /**
  125201. * Stores the scaling vector
  125202. */
  125203. scaling: Vector3;
  125204. /**
  125205. * Convert the Mesh to CSG
  125206. * @param mesh The Mesh to convert to CSG
  125207. * @returns A new CSG from the Mesh
  125208. */
  125209. static FromMesh(mesh: Mesh): CSG;
  125210. /**
  125211. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  125212. * @param polygons Polygons used to construct a CSG solid
  125213. */
  125214. private static FromPolygons;
  125215. /**
  125216. * Clones, or makes a deep copy, of the CSG
  125217. * @returns A new CSG
  125218. */
  125219. clone(): CSG;
  125220. /**
  125221. * Unions this CSG with another CSG
  125222. * @param csg The CSG to union against this CSG
  125223. * @returns The unioned CSG
  125224. */
  125225. union(csg: CSG): CSG;
  125226. /**
  125227. * Unions this CSG with another CSG in place
  125228. * @param csg The CSG to union against this CSG
  125229. */
  125230. unionInPlace(csg: CSG): void;
  125231. /**
  125232. * Subtracts this CSG with another CSG
  125233. * @param csg The CSG to subtract against this CSG
  125234. * @returns A new CSG
  125235. */
  125236. subtract(csg: CSG): CSG;
  125237. /**
  125238. * Subtracts this CSG with another CSG in place
  125239. * @param csg The CSG to subtact against this CSG
  125240. */
  125241. subtractInPlace(csg: CSG): void;
  125242. /**
  125243. * Intersect this CSG with another CSG
  125244. * @param csg The CSG to intersect against this CSG
  125245. * @returns A new CSG
  125246. */
  125247. intersect(csg: CSG): CSG;
  125248. /**
  125249. * Intersects this CSG with another CSG in place
  125250. * @param csg The CSG to intersect against this CSG
  125251. */
  125252. intersectInPlace(csg: CSG): void;
  125253. /**
  125254. * Return a new CSG solid with solid and empty space switched. This solid is
  125255. * not modified.
  125256. * @returns A new CSG solid with solid and empty space switched
  125257. */
  125258. inverse(): CSG;
  125259. /**
  125260. * Inverses the CSG in place
  125261. */
  125262. inverseInPlace(): void;
  125263. /**
  125264. * This is used to keep meshes transformations so they can be restored
  125265. * when we build back a Babylon Mesh
  125266. * NB : All CSG operations are performed in world coordinates
  125267. * @param csg The CSG to copy the transform attributes from
  125268. * @returns This CSG
  125269. */
  125270. copyTransformAttributes(csg: CSG): CSG;
  125271. /**
  125272. * Build Raw mesh from CSG
  125273. * Coordinates here are in world space
  125274. * @param name The name of the mesh geometry
  125275. * @param scene The Scene
  125276. * @param keepSubMeshes Specifies if the submeshes should be kept
  125277. * @returns A new Mesh
  125278. */
  125279. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  125280. /**
  125281. * Build Mesh from CSG taking material and transforms into account
  125282. * @param name The name of the Mesh
  125283. * @param material The material of the Mesh
  125284. * @param scene The Scene
  125285. * @param keepSubMeshes Specifies if submeshes should be kept
  125286. * @returns The new Mesh
  125287. */
  125288. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  125289. }
  125290. }
  125291. declare module BABYLON {
  125292. /**
  125293. * Class used to create a trail following a mesh
  125294. */
  125295. export class TrailMesh extends Mesh {
  125296. private _generator;
  125297. private _autoStart;
  125298. private _running;
  125299. private _diameter;
  125300. private _length;
  125301. private _sectionPolygonPointsCount;
  125302. private _sectionVectors;
  125303. private _sectionNormalVectors;
  125304. private _beforeRenderObserver;
  125305. /**
  125306. * @constructor
  125307. * @param name The value used by scene.getMeshByName() to do a lookup.
  125308. * @param generator The mesh to generate a trail.
  125309. * @param scene The scene to add this mesh to.
  125310. * @param diameter Diameter of trailing mesh. Default is 1.
  125311. * @param length Length of trailing mesh. Default is 60.
  125312. * @param autoStart Automatically start trailing mesh. Default true.
  125313. */
  125314. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  125315. /**
  125316. * "TrailMesh"
  125317. * @returns "TrailMesh"
  125318. */
  125319. getClassName(): string;
  125320. private _createMesh;
  125321. /**
  125322. * Start trailing mesh.
  125323. */
  125324. start(): void;
  125325. /**
  125326. * Stop trailing mesh.
  125327. */
  125328. stop(): void;
  125329. /**
  125330. * Update trailing mesh geometry.
  125331. */
  125332. update(): void;
  125333. /**
  125334. * Returns a new TrailMesh object.
  125335. * @param name is a string, the name given to the new mesh
  125336. * @param newGenerator use new generator object for cloned trail mesh
  125337. * @returns a new mesh
  125338. */
  125339. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  125340. /**
  125341. * Serializes this trail mesh
  125342. * @param serializationObject object to write serialization to
  125343. */
  125344. serialize(serializationObject: any): void;
  125345. /**
  125346. * Parses a serialized trail mesh
  125347. * @param parsedMesh the serialized mesh
  125348. * @param scene the scene to create the trail mesh in
  125349. * @returns the created trail mesh
  125350. */
  125351. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  125352. }
  125353. }
  125354. declare module BABYLON {
  125355. /**
  125356. * Class containing static functions to help procedurally build meshes
  125357. */
  125358. export class TiledBoxBuilder {
  125359. /**
  125360. * Creates a box mesh
  125361. * 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)
  125362. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125363. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125364. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125365. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125366. * @param name defines the name of the mesh
  125367. * @param options defines the options used to create the mesh
  125368. * @param scene defines the hosting scene
  125369. * @returns the box mesh
  125370. */
  125371. static CreateTiledBox(name: string, options: {
  125372. pattern?: number;
  125373. width?: number;
  125374. height?: number;
  125375. depth?: number;
  125376. tileSize?: number;
  125377. tileWidth?: number;
  125378. tileHeight?: number;
  125379. alignHorizontal?: number;
  125380. alignVertical?: number;
  125381. faceUV?: Vector4[];
  125382. faceColors?: Color4[];
  125383. sideOrientation?: number;
  125384. updatable?: boolean;
  125385. }, scene?: Nullable<Scene>): Mesh;
  125386. }
  125387. }
  125388. declare module BABYLON {
  125389. /**
  125390. * Class containing static functions to help procedurally build meshes
  125391. */
  125392. export class TorusKnotBuilder {
  125393. /**
  125394. * Creates a torus knot mesh
  125395. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  125396. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  125397. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  125398. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  125399. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125400. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125401. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125402. * @param name defines the name of the mesh
  125403. * @param options defines the options used to create the mesh
  125404. * @param scene defines the hosting scene
  125405. * @returns the torus knot mesh
  125406. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  125407. */
  125408. static CreateTorusKnot(name: string, options: {
  125409. radius?: number;
  125410. tube?: number;
  125411. radialSegments?: number;
  125412. tubularSegments?: number;
  125413. p?: number;
  125414. q?: number;
  125415. updatable?: boolean;
  125416. sideOrientation?: number;
  125417. frontUVs?: Vector4;
  125418. backUVs?: Vector4;
  125419. }, scene: any): Mesh;
  125420. }
  125421. }
  125422. declare module BABYLON {
  125423. /**
  125424. * Polygon
  125425. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  125426. */
  125427. export class Polygon {
  125428. /**
  125429. * Creates a rectangle
  125430. * @param xmin bottom X coord
  125431. * @param ymin bottom Y coord
  125432. * @param xmax top X coord
  125433. * @param ymax top Y coord
  125434. * @returns points that make the resulting rectation
  125435. */
  125436. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  125437. /**
  125438. * Creates a circle
  125439. * @param radius radius of circle
  125440. * @param cx scale in x
  125441. * @param cy scale in y
  125442. * @param numberOfSides number of sides that make up the circle
  125443. * @returns points that make the resulting circle
  125444. */
  125445. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  125446. /**
  125447. * Creates a polygon from input string
  125448. * @param input Input polygon data
  125449. * @returns the parsed points
  125450. */
  125451. static Parse(input: string): Vector2[];
  125452. /**
  125453. * Starts building a polygon from x and y coordinates
  125454. * @param x x coordinate
  125455. * @param y y coordinate
  125456. * @returns the started path2
  125457. */
  125458. static StartingAt(x: number, y: number): Path2;
  125459. }
  125460. /**
  125461. * Builds a polygon
  125462. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  125463. */
  125464. export class PolygonMeshBuilder {
  125465. private _points;
  125466. private _outlinepoints;
  125467. private _holes;
  125468. private _name;
  125469. private _scene;
  125470. private _epoints;
  125471. private _eholes;
  125472. private _addToepoint;
  125473. /**
  125474. * Babylon reference to the earcut plugin.
  125475. */
  125476. bjsEarcut: any;
  125477. /**
  125478. * Creates a PolygonMeshBuilder
  125479. * @param name name of the builder
  125480. * @param contours Path of the polygon
  125481. * @param scene scene to add to when creating the mesh
  125482. * @param earcutInjection can be used to inject your own earcut reference
  125483. */
  125484. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  125485. /**
  125486. * Adds a whole within the polygon
  125487. * @param hole Array of points defining the hole
  125488. * @returns this
  125489. */
  125490. addHole(hole: Vector2[]): PolygonMeshBuilder;
  125491. /**
  125492. * Creates the polygon
  125493. * @param updatable If the mesh should be updatable
  125494. * @param depth The depth of the mesh created
  125495. * @returns the created mesh
  125496. */
  125497. build(updatable?: boolean, depth?: number): Mesh;
  125498. /**
  125499. * Creates the polygon
  125500. * @param depth The depth of the mesh created
  125501. * @returns the created VertexData
  125502. */
  125503. buildVertexData(depth?: number): VertexData;
  125504. /**
  125505. * Adds a side to the polygon
  125506. * @param positions points that make the polygon
  125507. * @param normals normals of the polygon
  125508. * @param uvs uvs of the polygon
  125509. * @param indices indices of the polygon
  125510. * @param bounds bounds of the polygon
  125511. * @param points points of the polygon
  125512. * @param depth depth of the polygon
  125513. * @param flip flip of the polygon
  125514. */
  125515. private addSide;
  125516. }
  125517. }
  125518. declare module BABYLON {
  125519. /**
  125520. * Class containing static functions to help procedurally build meshes
  125521. */
  125522. export class PolygonBuilder {
  125523. /**
  125524. * Creates a polygon mesh
  125525. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  125526. * * 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
  125527. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125528. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125529. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  125530. * * Remember you can only change the shape positions, not their number when updating a polygon
  125531. * @param name defines the name of the mesh
  125532. * @param options defines the options used to create the mesh
  125533. * @param scene defines the hosting scene
  125534. * @param earcutInjection can be used to inject your own earcut reference
  125535. * @returns the polygon mesh
  125536. */
  125537. static CreatePolygon(name: string, options: {
  125538. shape: Vector3[];
  125539. holes?: Vector3[][];
  125540. depth?: number;
  125541. faceUV?: Vector4[];
  125542. faceColors?: Color4[];
  125543. updatable?: boolean;
  125544. sideOrientation?: number;
  125545. frontUVs?: Vector4;
  125546. backUVs?: Vector4;
  125547. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125548. /**
  125549. * Creates an extruded polygon mesh, with depth in the Y direction.
  125550. * * 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)
  125551. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125552. * @param name defines the name of the mesh
  125553. * @param options defines the options used to create the mesh
  125554. * @param scene defines the hosting scene
  125555. * @param earcutInjection can be used to inject your own earcut reference
  125556. * @returns the polygon mesh
  125557. */
  125558. static ExtrudePolygon(name: string, options: {
  125559. shape: Vector3[];
  125560. holes?: Vector3[][];
  125561. depth?: number;
  125562. faceUV?: Vector4[];
  125563. faceColors?: Color4[];
  125564. updatable?: boolean;
  125565. sideOrientation?: number;
  125566. frontUVs?: Vector4;
  125567. backUVs?: Vector4;
  125568. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125569. }
  125570. }
  125571. declare module BABYLON {
  125572. /**
  125573. * Class containing static functions to help procedurally build meshes
  125574. */
  125575. export class LatheBuilder {
  125576. /**
  125577. * Creates lathe mesh.
  125578. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  125579. * * 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
  125580. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  125581. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  125582. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  125583. * * 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
  125584. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  125585. * * 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
  125586. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125587. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125588. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125589. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125590. * @param name defines the name of the mesh
  125591. * @param options defines the options used to create the mesh
  125592. * @param scene defines the hosting scene
  125593. * @returns the lathe mesh
  125594. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  125595. */
  125596. static CreateLathe(name: string, options: {
  125597. shape: Vector3[];
  125598. radius?: number;
  125599. tessellation?: number;
  125600. clip?: number;
  125601. arc?: number;
  125602. closed?: boolean;
  125603. updatable?: boolean;
  125604. sideOrientation?: number;
  125605. frontUVs?: Vector4;
  125606. backUVs?: Vector4;
  125607. cap?: number;
  125608. invertUV?: boolean;
  125609. }, scene?: Nullable<Scene>): Mesh;
  125610. }
  125611. }
  125612. declare module BABYLON {
  125613. /**
  125614. * Class containing static functions to help procedurally build meshes
  125615. */
  125616. export class TiledPlaneBuilder {
  125617. /**
  125618. * Creates a tiled plane mesh
  125619. * * The parameter `pattern` will, depending on value, do nothing or
  125620. * * * flip (reflect about central vertical) alternate tiles across and up
  125621. * * * flip every tile on alternate rows
  125622. * * * rotate (180 degs) alternate tiles across and up
  125623. * * * rotate every tile on alternate rows
  125624. * * * flip and rotate alternate tiles across and up
  125625. * * * flip and rotate every tile on alternate rows
  125626. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  125627. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  125628. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125629. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125630. * * 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)
  125631. * * 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)
  125632. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  125633. * @param name defines the name of the mesh
  125634. * @param options defines the options used to create the mesh
  125635. * @param scene defines the hosting scene
  125636. * @returns the box mesh
  125637. */
  125638. static CreateTiledPlane(name: string, options: {
  125639. pattern?: number;
  125640. tileSize?: number;
  125641. tileWidth?: number;
  125642. tileHeight?: number;
  125643. size?: number;
  125644. width?: number;
  125645. height?: number;
  125646. alignHorizontal?: number;
  125647. alignVertical?: number;
  125648. sideOrientation?: number;
  125649. frontUVs?: Vector4;
  125650. backUVs?: Vector4;
  125651. updatable?: boolean;
  125652. }, scene?: Nullable<Scene>): Mesh;
  125653. }
  125654. }
  125655. declare module BABYLON {
  125656. /**
  125657. * Class containing static functions to help procedurally build meshes
  125658. */
  125659. export class TubeBuilder {
  125660. /**
  125661. * Creates a tube mesh.
  125662. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125663. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  125664. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  125665. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  125666. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  125667. * * 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)
  125668. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  125669. * * 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
  125670. * * 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
  125671. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125672. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125673. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125674. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125675. * @param name defines the name of the mesh
  125676. * @param options defines the options used to create the mesh
  125677. * @param scene defines the hosting scene
  125678. * @returns the tube mesh
  125679. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125680. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  125681. */
  125682. static CreateTube(name: string, options: {
  125683. path: Vector3[];
  125684. radius?: number;
  125685. tessellation?: number;
  125686. radiusFunction?: {
  125687. (i: number, distance: number): number;
  125688. };
  125689. cap?: number;
  125690. arc?: number;
  125691. updatable?: boolean;
  125692. sideOrientation?: number;
  125693. frontUVs?: Vector4;
  125694. backUVs?: Vector4;
  125695. instance?: Mesh;
  125696. invertUV?: boolean;
  125697. }, scene?: Nullable<Scene>): Mesh;
  125698. }
  125699. }
  125700. declare module BABYLON {
  125701. /**
  125702. * Class containing static functions to help procedurally build meshes
  125703. */
  125704. export class IcoSphereBuilder {
  125705. /**
  125706. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  125707. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  125708. * * 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`)
  125709. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  125710. * * 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
  125711. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125712. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125713. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125714. * @param name defines the name of the mesh
  125715. * @param options defines the options used to create the mesh
  125716. * @param scene defines the hosting scene
  125717. * @returns the icosahedron mesh
  125718. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  125719. */
  125720. static CreateIcoSphere(name: string, options: {
  125721. radius?: number;
  125722. radiusX?: number;
  125723. radiusY?: number;
  125724. radiusZ?: number;
  125725. flat?: boolean;
  125726. subdivisions?: number;
  125727. sideOrientation?: number;
  125728. frontUVs?: Vector4;
  125729. backUVs?: Vector4;
  125730. updatable?: boolean;
  125731. }, scene?: Nullable<Scene>): Mesh;
  125732. }
  125733. }
  125734. declare module BABYLON {
  125735. /**
  125736. * Class containing static functions to help procedurally build meshes
  125737. */
  125738. export class DecalBuilder {
  125739. /**
  125740. * Creates a decal mesh.
  125741. * 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
  125742. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  125743. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  125744. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  125745. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  125746. * @param name defines the name of the mesh
  125747. * @param sourceMesh defines the mesh where the decal must be applied
  125748. * @param options defines the options used to create the mesh
  125749. * @param scene defines the hosting scene
  125750. * @returns the decal mesh
  125751. * @see https://doc.babylonjs.com/how_to/decals
  125752. */
  125753. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  125754. position?: Vector3;
  125755. normal?: Vector3;
  125756. size?: Vector3;
  125757. angle?: number;
  125758. }): Mesh;
  125759. }
  125760. }
  125761. declare module BABYLON {
  125762. /**
  125763. * Class containing static functions to help procedurally build meshes
  125764. */
  125765. export class MeshBuilder {
  125766. /**
  125767. * Creates a box mesh
  125768. * * The parameter `size` sets the size (float) of each box side (default 1)
  125769. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  125770. * * 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)
  125771. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125772. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125773. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125774. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125775. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  125776. * @param name defines the name of the mesh
  125777. * @param options defines the options used to create the mesh
  125778. * @param scene defines the hosting scene
  125779. * @returns the box mesh
  125780. */
  125781. static CreateBox(name: string, options: {
  125782. size?: number;
  125783. width?: number;
  125784. height?: number;
  125785. depth?: number;
  125786. faceUV?: Vector4[];
  125787. faceColors?: Color4[];
  125788. sideOrientation?: number;
  125789. frontUVs?: Vector4;
  125790. backUVs?: Vector4;
  125791. updatable?: boolean;
  125792. }, scene?: Nullable<Scene>): Mesh;
  125793. /**
  125794. * Creates a tiled box mesh
  125795. * * faceTiles sets the pattern, tile size and number of tiles for a face
  125796. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125797. * @param name defines the name of the mesh
  125798. * @param options defines the options used to create the mesh
  125799. * @param scene defines the hosting scene
  125800. * @returns the tiled box mesh
  125801. */
  125802. static CreateTiledBox(name: string, options: {
  125803. pattern?: number;
  125804. size?: number;
  125805. width?: number;
  125806. height?: number;
  125807. depth: number;
  125808. tileSize?: number;
  125809. tileWidth?: number;
  125810. tileHeight?: number;
  125811. faceUV?: Vector4[];
  125812. faceColors?: Color4[];
  125813. alignHorizontal?: number;
  125814. alignVertical?: number;
  125815. sideOrientation?: number;
  125816. updatable?: boolean;
  125817. }, scene?: Nullable<Scene>): Mesh;
  125818. /**
  125819. * Creates a sphere mesh
  125820. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  125821. * * 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`)
  125822. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  125823. * * 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
  125824. * * 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)
  125825. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125826. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125827. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125828. * @param name defines the name of the mesh
  125829. * @param options defines the options used to create the mesh
  125830. * @param scene defines the hosting scene
  125831. * @returns the sphere mesh
  125832. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  125833. */
  125834. static CreateSphere(name: string, options: {
  125835. segments?: number;
  125836. diameter?: number;
  125837. diameterX?: number;
  125838. diameterY?: number;
  125839. diameterZ?: number;
  125840. arc?: number;
  125841. slice?: number;
  125842. sideOrientation?: number;
  125843. frontUVs?: Vector4;
  125844. backUVs?: Vector4;
  125845. updatable?: boolean;
  125846. }, scene?: Nullable<Scene>): Mesh;
  125847. /**
  125848. * Creates a plane polygonal mesh. By default, this is a disc
  125849. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  125850. * * 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
  125851. * * 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
  125852. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125853. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125854. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125855. * @param name defines the name of the mesh
  125856. * @param options defines the options used to create the mesh
  125857. * @param scene defines the hosting scene
  125858. * @returns the plane polygonal mesh
  125859. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  125860. */
  125861. static CreateDisc(name: string, options: {
  125862. radius?: number;
  125863. tessellation?: number;
  125864. arc?: number;
  125865. updatable?: boolean;
  125866. sideOrientation?: number;
  125867. frontUVs?: Vector4;
  125868. backUVs?: Vector4;
  125869. }, scene?: Nullable<Scene>): Mesh;
  125870. /**
  125871. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  125872. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  125873. * * 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`)
  125874. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  125875. * * 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
  125876. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125877. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125878. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125879. * @param name defines the name of the mesh
  125880. * @param options defines the options used to create the mesh
  125881. * @param scene defines the hosting scene
  125882. * @returns the icosahedron mesh
  125883. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  125884. */
  125885. static CreateIcoSphere(name: string, options: {
  125886. radius?: number;
  125887. radiusX?: number;
  125888. radiusY?: number;
  125889. radiusZ?: number;
  125890. flat?: boolean;
  125891. subdivisions?: number;
  125892. sideOrientation?: number;
  125893. frontUVs?: Vector4;
  125894. backUVs?: Vector4;
  125895. updatable?: boolean;
  125896. }, scene?: Nullable<Scene>): Mesh;
  125897. /**
  125898. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125899. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  125900. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  125901. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  125902. * * 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
  125903. * * 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
  125904. * * 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
  125905. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125906. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125907. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125908. * * 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
  125909. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  125910. * * 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
  125911. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  125912. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125913. * @param name defines the name of the mesh
  125914. * @param options defines the options used to create the mesh
  125915. * @param scene defines the hosting scene
  125916. * @returns the ribbon mesh
  125917. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  125918. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125919. */
  125920. static CreateRibbon(name: string, options: {
  125921. pathArray: Vector3[][];
  125922. closeArray?: boolean;
  125923. closePath?: boolean;
  125924. offset?: number;
  125925. updatable?: boolean;
  125926. sideOrientation?: number;
  125927. frontUVs?: Vector4;
  125928. backUVs?: Vector4;
  125929. instance?: Mesh;
  125930. invertUV?: boolean;
  125931. uvs?: Vector2[];
  125932. colors?: Color4[];
  125933. }, scene?: Nullable<Scene>): Mesh;
  125934. /**
  125935. * Creates a cylinder or a cone mesh
  125936. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  125937. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  125938. * * 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.
  125939. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  125940. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  125941. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  125942. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  125943. * * 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).
  125944. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  125945. * * 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).
  125946. * * 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
  125947. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  125948. * * 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
  125949. * * 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.
  125950. * * If `enclose` is false, a ring surface is one element.
  125951. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  125952. * * 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
  125953. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125954. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125955. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125956. * @param name defines the name of the mesh
  125957. * @param options defines the options used to create the mesh
  125958. * @param scene defines the hosting scene
  125959. * @returns the cylinder mesh
  125960. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  125961. */
  125962. static CreateCylinder(name: string, options: {
  125963. height?: number;
  125964. diameterTop?: number;
  125965. diameterBottom?: number;
  125966. diameter?: number;
  125967. tessellation?: number;
  125968. subdivisions?: number;
  125969. arc?: number;
  125970. faceColors?: Color4[];
  125971. faceUV?: Vector4[];
  125972. updatable?: boolean;
  125973. hasRings?: boolean;
  125974. enclose?: boolean;
  125975. cap?: number;
  125976. sideOrientation?: number;
  125977. frontUVs?: Vector4;
  125978. backUVs?: Vector4;
  125979. }, scene?: Nullable<Scene>): Mesh;
  125980. /**
  125981. * Creates a torus mesh
  125982. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  125983. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  125984. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  125985. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125986. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125987. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125988. * @param name defines the name of the mesh
  125989. * @param options defines the options used to create the mesh
  125990. * @param scene defines the hosting scene
  125991. * @returns the torus mesh
  125992. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  125993. */
  125994. static CreateTorus(name: string, options: {
  125995. diameter?: number;
  125996. thickness?: number;
  125997. tessellation?: number;
  125998. updatable?: boolean;
  125999. sideOrientation?: number;
  126000. frontUVs?: Vector4;
  126001. backUVs?: Vector4;
  126002. }, scene?: Nullable<Scene>): Mesh;
  126003. /**
  126004. * Creates a torus knot mesh
  126005. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  126006. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  126007. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  126008. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  126009. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126010. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126011. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126012. * @param name defines the name of the mesh
  126013. * @param options defines the options used to create the mesh
  126014. * @param scene defines the hosting scene
  126015. * @returns the torus knot mesh
  126016. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  126017. */
  126018. static CreateTorusKnot(name: string, options: {
  126019. radius?: number;
  126020. tube?: number;
  126021. radialSegments?: number;
  126022. tubularSegments?: number;
  126023. p?: number;
  126024. q?: number;
  126025. updatable?: boolean;
  126026. sideOrientation?: number;
  126027. frontUVs?: Vector4;
  126028. backUVs?: Vector4;
  126029. }, scene?: Nullable<Scene>): Mesh;
  126030. /**
  126031. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  126032. * * 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
  126033. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  126034. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  126035. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  126036. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  126037. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  126038. * * 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
  126039. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  126040. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126041. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  126042. * @param name defines the name of the new line system
  126043. * @param options defines the options used to create the line system
  126044. * @param scene defines the hosting scene
  126045. * @returns a new line system mesh
  126046. */
  126047. static CreateLineSystem(name: string, options: {
  126048. lines: Vector3[][];
  126049. updatable?: boolean;
  126050. instance?: Nullable<LinesMesh>;
  126051. colors?: Nullable<Color4[][]>;
  126052. useVertexAlpha?: boolean;
  126053. }, scene: Nullable<Scene>): LinesMesh;
  126054. /**
  126055. * Creates a line mesh
  126056. * 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
  126057. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  126058. * * The parameter `points` is an array successive Vector3
  126059. * * 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
  126060. * * The optional parameter `colors` is an array of successive Color4, one per line point
  126061. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  126062. * * When updating an instance, remember that only point positions can change, not the number of points
  126063. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126064. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  126065. * @param name defines the name of the new line system
  126066. * @param options defines the options used to create the line system
  126067. * @param scene defines the hosting scene
  126068. * @returns a new line mesh
  126069. */
  126070. static CreateLines(name: string, options: {
  126071. points: Vector3[];
  126072. updatable?: boolean;
  126073. instance?: Nullable<LinesMesh>;
  126074. colors?: Color4[];
  126075. useVertexAlpha?: boolean;
  126076. }, scene?: Nullable<Scene>): LinesMesh;
  126077. /**
  126078. * Creates a dashed line mesh
  126079. * * 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
  126080. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  126081. * * The parameter `points` is an array successive Vector3
  126082. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  126083. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  126084. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  126085. * * 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
  126086. * * When updating an instance, remember that only point positions can change, not the number of points
  126087. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126088. * @param name defines the name of the mesh
  126089. * @param options defines the options used to create the mesh
  126090. * @param scene defines the hosting scene
  126091. * @returns the dashed line mesh
  126092. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  126093. */
  126094. static CreateDashedLines(name: string, options: {
  126095. points: Vector3[];
  126096. dashSize?: number;
  126097. gapSize?: number;
  126098. dashNb?: number;
  126099. updatable?: boolean;
  126100. instance?: LinesMesh;
  126101. }, scene?: Nullable<Scene>): LinesMesh;
  126102. /**
  126103. * 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.
  126104. * * 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.
  126105. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  126106. * * 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.
  126107. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  126108. * * 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
  126109. * * 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
  126110. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  126111. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126112. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126113. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  126114. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126115. * @param name defines the name of the mesh
  126116. * @param options defines the options used to create the mesh
  126117. * @param scene defines the hosting scene
  126118. * @returns the extruded shape mesh
  126119. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  126120. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  126121. */
  126122. static ExtrudeShape(name: string, options: {
  126123. shape: Vector3[];
  126124. path: Vector3[];
  126125. scale?: number;
  126126. rotation?: number;
  126127. cap?: number;
  126128. updatable?: boolean;
  126129. sideOrientation?: number;
  126130. frontUVs?: Vector4;
  126131. backUVs?: Vector4;
  126132. instance?: Mesh;
  126133. invertUV?: boolean;
  126134. }, scene?: Nullable<Scene>): Mesh;
  126135. /**
  126136. * Creates an custom extruded shape mesh.
  126137. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  126138. * * 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.
  126139. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  126140. * * 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
  126141. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  126142. * * 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
  126143. * * It must returns a float value that will be the scale value applied to the shape on each path point
  126144. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  126145. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  126146. * * 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
  126147. * * 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
  126148. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  126149. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126150. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126151. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  126152. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126153. * @param name defines the name of the mesh
  126154. * @param options defines the options used to create the mesh
  126155. * @param scene defines the hosting scene
  126156. * @returns the custom extruded shape mesh
  126157. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  126158. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  126159. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  126160. */
  126161. static ExtrudeShapeCustom(name: string, options: {
  126162. shape: Vector3[];
  126163. path: Vector3[];
  126164. scaleFunction?: any;
  126165. rotationFunction?: any;
  126166. ribbonCloseArray?: boolean;
  126167. ribbonClosePath?: boolean;
  126168. cap?: number;
  126169. updatable?: boolean;
  126170. sideOrientation?: number;
  126171. frontUVs?: Vector4;
  126172. backUVs?: Vector4;
  126173. instance?: Mesh;
  126174. invertUV?: boolean;
  126175. }, scene?: Nullable<Scene>): Mesh;
  126176. /**
  126177. * Creates lathe mesh.
  126178. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  126179. * * 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
  126180. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  126181. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  126182. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  126183. * * 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
  126184. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  126185. * * 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
  126186. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126187. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126188. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  126189. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126190. * @param name defines the name of the mesh
  126191. * @param options defines the options used to create the mesh
  126192. * @param scene defines the hosting scene
  126193. * @returns the lathe mesh
  126194. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  126195. */
  126196. static CreateLathe(name: string, options: {
  126197. shape: Vector3[];
  126198. radius?: number;
  126199. tessellation?: number;
  126200. clip?: number;
  126201. arc?: number;
  126202. closed?: boolean;
  126203. updatable?: boolean;
  126204. sideOrientation?: number;
  126205. frontUVs?: Vector4;
  126206. backUVs?: Vector4;
  126207. cap?: number;
  126208. invertUV?: boolean;
  126209. }, scene?: Nullable<Scene>): Mesh;
  126210. /**
  126211. * Creates a tiled plane mesh
  126212. * * You can set a limited pattern arrangement with the tiles
  126213. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126214. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126215. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126216. * @param name defines the name of the mesh
  126217. * @param options defines the options used to create the mesh
  126218. * @param scene defines the hosting scene
  126219. * @returns the plane mesh
  126220. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  126221. */
  126222. static CreateTiledPlane(name: string, options: {
  126223. pattern?: number;
  126224. tileSize?: number;
  126225. tileWidth?: number;
  126226. tileHeight?: number;
  126227. size?: number;
  126228. width?: number;
  126229. height?: number;
  126230. alignHorizontal?: number;
  126231. alignVertical?: number;
  126232. sideOrientation?: number;
  126233. frontUVs?: Vector4;
  126234. backUVs?: Vector4;
  126235. updatable?: boolean;
  126236. }, scene?: Nullable<Scene>): Mesh;
  126237. /**
  126238. * Creates a plane mesh
  126239. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  126240. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  126241. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  126242. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126243. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126244. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126245. * @param name defines the name of the mesh
  126246. * @param options defines the options used to create the mesh
  126247. * @param scene defines the hosting scene
  126248. * @returns the plane mesh
  126249. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  126250. */
  126251. static CreatePlane(name: string, options: {
  126252. size?: number;
  126253. width?: number;
  126254. height?: number;
  126255. sideOrientation?: number;
  126256. frontUVs?: Vector4;
  126257. backUVs?: Vector4;
  126258. updatable?: boolean;
  126259. sourcePlane?: Plane;
  126260. }, scene?: Nullable<Scene>): Mesh;
  126261. /**
  126262. * Creates a ground mesh
  126263. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126264. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126265. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126266. * @param name defines the name of the mesh
  126267. * @param options defines the options used to create the mesh
  126268. * @param scene defines the hosting scene
  126269. * @returns the ground mesh
  126270. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126271. */
  126272. static CreateGround(name: string, options: {
  126273. width?: number;
  126274. height?: number;
  126275. subdivisions?: number;
  126276. subdivisionsX?: number;
  126277. subdivisionsY?: number;
  126278. updatable?: boolean;
  126279. }, scene?: Nullable<Scene>): Mesh;
  126280. /**
  126281. * Creates a tiled ground mesh
  126282. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126283. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126284. * * 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
  126285. * * 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
  126286. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126287. * @param name defines the name of the mesh
  126288. * @param options defines the options used to create the mesh
  126289. * @param scene defines the hosting scene
  126290. * @returns the tiled ground mesh
  126291. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126292. */
  126293. static CreateTiledGround(name: string, options: {
  126294. xmin: number;
  126295. zmin: number;
  126296. xmax: number;
  126297. zmax: number;
  126298. subdivisions?: {
  126299. w: number;
  126300. h: number;
  126301. };
  126302. precision?: {
  126303. w: number;
  126304. h: number;
  126305. };
  126306. updatable?: boolean;
  126307. }, scene?: Nullable<Scene>): Mesh;
  126308. /**
  126309. * Creates a ground mesh from a height map
  126310. * * The parameter `url` sets the URL of the height map image resource.
  126311. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126312. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126313. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126314. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126315. * * 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.
  126316. * * 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).
  126317. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126318. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126319. * @param name defines the name of the mesh
  126320. * @param url defines the url to the height map
  126321. * @param options defines the options used to create the mesh
  126322. * @param scene defines the hosting scene
  126323. * @returns the ground mesh
  126324. * @see https://doc.babylonjs.com/babylon101/height_map
  126325. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126326. */
  126327. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126328. width?: number;
  126329. height?: number;
  126330. subdivisions?: number;
  126331. minHeight?: number;
  126332. maxHeight?: number;
  126333. colorFilter?: Color3;
  126334. alphaFilter?: number;
  126335. updatable?: boolean;
  126336. onReady?: (mesh: GroundMesh) => void;
  126337. }, scene?: Nullable<Scene>): GroundMesh;
  126338. /**
  126339. * Creates a polygon mesh
  126340. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  126341. * * 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
  126342. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  126343. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126344. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  126345. * * Remember you can only change the shape positions, not their number when updating a polygon
  126346. * @param name defines the name of the mesh
  126347. * @param options defines the options used to create the mesh
  126348. * @param scene defines the hosting scene
  126349. * @param earcutInjection can be used to inject your own earcut reference
  126350. * @returns the polygon mesh
  126351. */
  126352. static CreatePolygon(name: string, options: {
  126353. shape: Vector3[];
  126354. holes?: Vector3[][];
  126355. depth?: number;
  126356. faceUV?: Vector4[];
  126357. faceColors?: Color4[];
  126358. updatable?: boolean;
  126359. sideOrientation?: number;
  126360. frontUVs?: Vector4;
  126361. backUVs?: Vector4;
  126362. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  126363. /**
  126364. * Creates an extruded polygon mesh, with depth in the Y direction.
  126365. * * 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)
  126366. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  126367. * @param name defines the name of the mesh
  126368. * @param options defines the options used to create the mesh
  126369. * @param scene defines the hosting scene
  126370. * @param earcutInjection can be used to inject your own earcut reference
  126371. * @returns the polygon mesh
  126372. */
  126373. static ExtrudePolygon(name: string, options: {
  126374. shape: Vector3[];
  126375. holes?: Vector3[][];
  126376. depth?: number;
  126377. faceUV?: Vector4[];
  126378. faceColors?: Color4[];
  126379. updatable?: boolean;
  126380. sideOrientation?: number;
  126381. frontUVs?: Vector4;
  126382. backUVs?: Vector4;
  126383. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  126384. /**
  126385. * Creates a tube mesh.
  126386. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  126387. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  126388. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  126389. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  126390. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  126391. * * 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)
  126392. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  126393. * * 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
  126394. * * 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
  126395. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126396. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126397. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  126398. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126399. * @param name defines the name of the mesh
  126400. * @param options defines the options used to create the mesh
  126401. * @param scene defines the hosting scene
  126402. * @returns the tube mesh
  126403. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  126404. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  126405. */
  126406. static CreateTube(name: string, options: {
  126407. path: Vector3[];
  126408. radius?: number;
  126409. tessellation?: number;
  126410. radiusFunction?: {
  126411. (i: number, distance: number): number;
  126412. };
  126413. cap?: number;
  126414. arc?: number;
  126415. updatable?: boolean;
  126416. sideOrientation?: number;
  126417. frontUVs?: Vector4;
  126418. backUVs?: Vector4;
  126419. instance?: Mesh;
  126420. invertUV?: boolean;
  126421. }, scene?: Nullable<Scene>): Mesh;
  126422. /**
  126423. * Creates a polyhedron mesh
  126424. * * 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
  126425. * * The parameter `size` (positive float, default 1) sets the polygon size
  126426. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  126427. * * 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`
  126428. * * 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
  126429. * * 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)`)
  126430. * * 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
  126431. * * 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
  126432. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126433. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126434. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126435. * @param name defines the name of the mesh
  126436. * @param options defines the options used to create the mesh
  126437. * @param scene defines the hosting scene
  126438. * @returns the polyhedron mesh
  126439. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  126440. */
  126441. static CreatePolyhedron(name: string, options: {
  126442. type?: number;
  126443. size?: number;
  126444. sizeX?: number;
  126445. sizeY?: number;
  126446. sizeZ?: number;
  126447. custom?: any;
  126448. faceUV?: Vector4[];
  126449. faceColors?: Color4[];
  126450. flat?: boolean;
  126451. updatable?: boolean;
  126452. sideOrientation?: number;
  126453. frontUVs?: Vector4;
  126454. backUVs?: Vector4;
  126455. }, scene?: Nullable<Scene>): Mesh;
  126456. /**
  126457. * Creates a decal mesh.
  126458. * 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
  126459. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  126460. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  126461. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  126462. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  126463. * @param name defines the name of the mesh
  126464. * @param sourceMesh defines the mesh where the decal must be applied
  126465. * @param options defines the options used to create the mesh
  126466. * @param scene defines the hosting scene
  126467. * @returns the decal mesh
  126468. * @see https://doc.babylonjs.com/how_to/decals
  126469. */
  126470. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  126471. position?: Vector3;
  126472. normal?: Vector3;
  126473. size?: Vector3;
  126474. angle?: number;
  126475. }): Mesh;
  126476. }
  126477. }
  126478. declare module BABYLON {
  126479. /**
  126480. * A simplifier interface for future simplification implementations
  126481. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126482. */
  126483. export interface ISimplifier {
  126484. /**
  126485. * Simplification of a given mesh according to the given settings.
  126486. * Since this requires computation, it is assumed that the function runs async.
  126487. * @param settings The settings of the simplification, including quality and distance
  126488. * @param successCallback A callback that will be called after the mesh was simplified.
  126489. * @param errorCallback in case of an error, this callback will be called. optional.
  126490. */
  126491. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  126492. }
  126493. /**
  126494. * Expected simplification settings.
  126495. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  126496. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126497. */
  126498. export interface ISimplificationSettings {
  126499. /**
  126500. * Gets or sets the expected quality
  126501. */
  126502. quality: number;
  126503. /**
  126504. * Gets or sets the distance when this optimized version should be used
  126505. */
  126506. distance: number;
  126507. /**
  126508. * Gets an already optimized mesh
  126509. */
  126510. optimizeMesh?: boolean;
  126511. }
  126512. /**
  126513. * Class used to specify simplification options
  126514. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126515. */
  126516. export class SimplificationSettings implements ISimplificationSettings {
  126517. /** expected quality */
  126518. quality: number;
  126519. /** distance when this optimized version should be used */
  126520. distance: number;
  126521. /** already optimized mesh */
  126522. optimizeMesh?: boolean | undefined;
  126523. /**
  126524. * Creates a SimplificationSettings
  126525. * @param quality expected quality
  126526. * @param distance distance when this optimized version should be used
  126527. * @param optimizeMesh already optimized mesh
  126528. */
  126529. constructor(
  126530. /** expected quality */
  126531. quality: number,
  126532. /** distance when this optimized version should be used */
  126533. distance: number,
  126534. /** already optimized mesh */
  126535. optimizeMesh?: boolean | undefined);
  126536. }
  126537. /**
  126538. * Interface used to define a simplification task
  126539. */
  126540. export interface ISimplificationTask {
  126541. /**
  126542. * Array of settings
  126543. */
  126544. settings: Array<ISimplificationSettings>;
  126545. /**
  126546. * Simplification type
  126547. */
  126548. simplificationType: SimplificationType;
  126549. /**
  126550. * Mesh to simplify
  126551. */
  126552. mesh: Mesh;
  126553. /**
  126554. * Callback called on success
  126555. */
  126556. successCallback?: () => void;
  126557. /**
  126558. * Defines if parallel processing can be used
  126559. */
  126560. parallelProcessing: boolean;
  126561. }
  126562. /**
  126563. * Queue used to order the simplification tasks
  126564. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126565. */
  126566. export class SimplificationQueue {
  126567. private _simplificationArray;
  126568. /**
  126569. * Gets a boolean indicating that the process is still running
  126570. */
  126571. running: boolean;
  126572. /**
  126573. * Creates a new queue
  126574. */
  126575. constructor();
  126576. /**
  126577. * Adds a new simplification task
  126578. * @param task defines a task to add
  126579. */
  126580. addTask(task: ISimplificationTask): void;
  126581. /**
  126582. * Execute next task
  126583. */
  126584. executeNext(): void;
  126585. /**
  126586. * Execute a simplification task
  126587. * @param task defines the task to run
  126588. */
  126589. runSimplification(task: ISimplificationTask): void;
  126590. private getSimplifier;
  126591. }
  126592. /**
  126593. * The implemented types of simplification
  126594. * At the moment only Quadratic Error Decimation is implemented
  126595. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126596. */
  126597. export enum SimplificationType {
  126598. /** Quadratic error decimation */
  126599. QUADRATIC = 0
  126600. }
  126601. }
  126602. declare module BABYLON {
  126603. interface Scene {
  126604. /** @hidden (Backing field) */
  126605. _simplificationQueue: SimplificationQueue;
  126606. /**
  126607. * Gets or sets the simplification queue attached to the scene
  126608. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126609. */
  126610. simplificationQueue: SimplificationQueue;
  126611. }
  126612. interface Mesh {
  126613. /**
  126614. * Simplify the mesh according to the given array of settings.
  126615. * Function will return immediately and will simplify async
  126616. * @param settings a collection of simplification settings
  126617. * @param parallelProcessing should all levels calculate parallel or one after the other
  126618. * @param simplificationType the type of simplification to run
  126619. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  126620. * @returns the current mesh
  126621. */
  126622. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  126623. }
  126624. /**
  126625. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  126626. * created in a scene
  126627. */
  126628. export class SimplicationQueueSceneComponent implements ISceneComponent {
  126629. /**
  126630. * The component name helpfull to identify the component in the list of scene components.
  126631. */
  126632. readonly name: string;
  126633. /**
  126634. * The scene the component belongs to.
  126635. */
  126636. scene: Scene;
  126637. /**
  126638. * Creates a new instance of the component for the given scene
  126639. * @param scene Defines the scene to register the component in
  126640. */
  126641. constructor(scene: Scene);
  126642. /**
  126643. * Registers the component in a given scene
  126644. */
  126645. register(): void;
  126646. /**
  126647. * Rebuilds the elements related to this component in case of
  126648. * context lost for instance.
  126649. */
  126650. rebuild(): void;
  126651. /**
  126652. * Disposes the component and the associated ressources
  126653. */
  126654. dispose(): void;
  126655. private _beforeCameraUpdate;
  126656. }
  126657. }
  126658. declare module BABYLON {
  126659. /**
  126660. * Navigation plugin interface to add navigation constrained by a navigation mesh
  126661. */
  126662. export interface INavigationEnginePlugin {
  126663. /**
  126664. * plugin name
  126665. */
  126666. name: string;
  126667. /**
  126668. * Creates a navigation mesh
  126669. * @param meshes array of all the geometry used to compute the navigatio mesh
  126670. * @param parameters bunch of parameters used to filter geometry
  126671. */
  126672. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  126673. /**
  126674. * Create a navigation mesh debug mesh
  126675. * @param scene is where the mesh will be added
  126676. * @returns debug display mesh
  126677. */
  126678. createDebugNavMesh(scene: Scene): Mesh;
  126679. /**
  126680. * Get a navigation mesh constrained position, closest to the parameter position
  126681. * @param position world position
  126682. * @returns the closest point to position constrained by the navigation mesh
  126683. */
  126684. getClosestPoint(position: Vector3): Vector3;
  126685. /**
  126686. * Get a navigation mesh constrained position, within a particular radius
  126687. * @param position world position
  126688. * @param maxRadius the maximum distance to the constrained world position
  126689. * @returns the closest point to position constrained by the navigation mesh
  126690. */
  126691. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  126692. /**
  126693. * Compute the final position from a segment made of destination-position
  126694. * @param position world position
  126695. * @param destination world position
  126696. * @returns the resulting point along the navmesh
  126697. */
  126698. moveAlong(position: Vector3, destination: Vector3): Vector3;
  126699. /**
  126700. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  126701. * @param start world position
  126702. * @param end world position
  126703. * @returns array containing world position composing the path
  126704. */
  126705. computePath(start: Vector3, end: Vector3): Vector3[];
  126706. /**
  126707. * If this plugin is supported
  126708. * @returns true if plugin is supported
  126709. */
  126710. isSupported(): boolean;
  126711. /**
  126712. * Create a new Crowd so you can add agents
  126713. * @param maxAgents the maximum agent count in the crowd
  126714. * @param maxAgentRadius the maximum radius an agent can have
  126715. * @param scene to attach the crowd to
  126716. * @returns the crowd you can add agents to
  126717. */
  126718. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  126719. /**
  126720. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126721. * The queries will try to find a solution within those bounds
  126722. * default is (1,1,1)
  126723. * @param extent x,y,z value that define the extent around the queries point of reference
  126724. */
  126725. setDefaultQueryExtent(extent: Vector3): void;
  126726. /**
  126727. * Get the Bounding box extent specified by setDefaultQueryExtent
  126728. * @returns the box extent values
  126729. */
  126730. getDefaultQueryExtent(): Vector3;
  126731. /**
  126732. * Release all resources
  126733. */
  126734. dispose(): void;
  126735. }
  126736. /**
  126737. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  126738. */
  126739. export interface ICrowd {
  126740. /**
  126741. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  126742. * You can attach anything to that node. The node position is updated in the scene update tick.
  126743. * @param pos world position that will be constrained by the navigation mesh
  126744. * @param parameters agent parameters
  126745. * @param transform hooked to the agent that will be update by the scene
  126746. * @returns agent index
  126747. */
  126748. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  126749. /**
  126750. * Returns the agent position in world space
  126751. * @param index agent index returned by addAgent
  126752. * @returns world space position
  126753. */
  126754. getAgentPosition(index: number): Vector3;
  126755. /**
  126756. * Gets the agent velocity in world space
  126757. * @param index agent index returned by addAgent
  126758. * @returns world space velocity
  126759. */
  126760. getAgentVelocity(index: number): Vector3;
  126761. /**
  126762. * remove a particular agent previously created
  126763. * @param index agent index returned by addAgent
  126764. */
  126765. removeAgent(index: number): void;
  126766. /**
  126767. * get the list of all agents attached to this crowd
  126768. * @returns list of agent indices
  126769. */
  126770. getAgents(): number[];
  126771. /**
  126772. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  126773. * @param deltaTime in seconds
  126774. */
  126775. update(deltaTime: number): void;
  126776. /**
  126777. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  126778. * @param index agent index returned by addAgent
  126779. * @param destination targeted world position
  126780. */
  126781. agentGoto(index: number, destination: Vector3): void;
  126782. /**
  126783. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126784. * The queries will try to find a solution within those bounds
  126785. * default is (1,1,1)
  126786. * @param extent x,y,z value that define the extent around the queries point of reference
  126787. */
  126788. setDefaultQueryExtent(extent: Vector3): void;
  126789. /**
  126790. * Get the Bounding box extent specified by setDefaultQueryExtent
  126791. * @returns the box extent values
  126792. */
  126793. getDefaultQueryExtent(): Vector3;
  126794. /**
  126795. * Release all resources
  126796. */
  126797. dispose(): void;
  126798. }
  126799. /**
  126800. * Configures an agent
  126801. */
  126802. export interface IAgentParameters {
  126803. /**
  126804. * Agent radius. [Limit: >= 0]
  126805. */
  126806. radius: number;
  126807. /**
  126808. * Agent height. [Limit: > 0]
  126809. */
  126810. height: number;
  126811. /**
  126812. * Maximum allowed acceleration. [Limit: >= 0]
  126813. */
  126814. maxAcceleration: number;
  126815. /**
  126816. * Maximum allowed speed. [Limit: >= 0]
  126817. */
  126818. maxSpeed: number;
  126819. /**
  126820. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  126821. */
  126822. collisionQueryRange: number;
  126823. /**
  126824. * The path visibility optimization range. [Limit: > 0]
  126825. */
  126826. pathOptimizationRange: number;
  126827. /**
  126828. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  126829. */
  126830. separationWeight: number;
  126831. }
  126832. /**
  126833. * Configures the navigation mesh creation
  126834. */
  126835. export interface INavMeshParameters {
  126836. /**
  126837. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  126838. */
  126839. cs: number;
  126840. /**
  126841. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  126842. */
  126843. ch: number;
  126844. /**
  126845. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  126846. */
  126847. walkableSlopeAngle: number;
  126848. /**
  126849. * Minimum floor to 'ceiling' height that will still allow the floor area to
  126850. * be considered walkable. [Limit: >= 3] [Units: vx]
  126851. */
  126852. walkableHeight: number;
  126853. /**
  126854. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  126855. */
  126856. walkableClimb: number;
  126857. /**
  126858. * The distance to erode/shrink the walkable area of the heightfield away from
  126859. * obstructions. [Limit: >=0] [Units: vx]
  126860. */
  126861. walkableRadius: number;
  126862. /**
  126863. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  126864. */
  126865. maxEdgeLen: number;
  126866. /**
  126867. * The maximum distance a simplfied contour's border edges should deviate
  126868. * the original raw contour. [Limit: >=0] [Units: vx]
  126869. */
  126870. maxSimplificationError: number;
  126871. /**
  126872. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  126873. */
  126874. minRegionArea: number;
  126875. /**
  126876. * Any regions with a span count smaller than this value will, if possible,
  126877. * be merged with larger regions. [Limit: >=0] [Units: vx]
  126878. */
  126879. mergeRegionArea: number;
  126880. /**
  126881. * The maximum number of vertices allowed for polygons generated during the
  126882. * contour to polygon conversion process. [Limit: >= 3]
  126883. */
  126884. maxVertsPerPoly: number;
  126885. /**
  126886. * Sets the sampling distance to use when generating the detail mesh.
  126887. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  126888. */
  126889. detailSampleDist: number;
  126890. /**
  126891. * The maximum distance the detail mesh surface should deviate from heightfield
  126892. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  126893. */
  126894. detailSampleMaxError: number;
  126895. }
  126896. }
  126897. declare module BABYLON {
  126898. /**
  126899. * RecastJS navigation plugin
  126900. */
  126901. export class RecastJSPlugin implements INavigationEnginePlugin {
  126902. /**
  126903. * Reference to the Recast library
  126904. */
  126905. bjsRECAST: any;
  126906. /**
  126907. * plugin name
  126908. */
  126909. name: string;
  126910. /**
  126911. * the first navmesh created. We might extend this to support multiple navmeshes
  126912. */
  126913. navMesh: any;
  126914. /**
  126915. * Initializes the recastJS plugin
  126916. * @param recastInjection can be used to inject your own recast reference
  126917. */
  126918. constructor(recastInjection?: any);
  126919. /**
  126920. * Creates a navigation mesh
  126921. * @param meshes array of all the geometry used to compute the navigatio mesh
  126922. * @param parameters bunch of parameters used to filter geometry
  126923. */
  126924. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  126925. /**
  126926. * Create a navigation mesh debug mesh
  126927. * @param scene is where the mesh will be added
  126928. * @returns debug display mesh
  126929. */
  126930. createDebugNavMesh(scene: Scene): Mesh;
  126931. /**
  126932. * Get a navigation mesh constrained position, closest to the parameter position
  126933. * @param position world position
  126934. * @returns the closest point to position constrained by the navigation mesh
  126935. */
  126936. getClosestPoint(position: Vector3): Vector3;
  126937. /**
  126938. * Get a navigation mesh constrained position, within a particular radius
  126939. * @param position world position
  126940. * @param maxRadius the maximum distance to the constrained world position
  126941. * @returns the closest point to position constrained by the navigation mesh
  126942. */
  126943. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  126944. /**
  126945. * Compute the final position from a segment made of destination-position
  126946. * @param position world position
  126947. * @param destination world position
  126948. * @returns the resulting point along the navmesh
  126949. */
  126950. moveAlong(position: Vector3, destination: Vector3): Vector3;
  126951. /**
  126952. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  126953. * @param start world position
  126954. * @param end world position
  126955. * @returns array containing world position composing the path
  126956. */
  126957. computePath(start: Vector3, end: Vector3): Vector3[];
  126958. /**
  126959. * Create a new Crowd so you can add agents
  126960. * @param maxAgents the maximum agent count in the crowd
  126961. * @param maxAgentRadius the maximum radius an agent can have
  126962. * @param scene to attach the crowd to
  126963. * @returns the crowd you can add agents to
  126964. */
  126965. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  126966. /**
  126967. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126968. * The queries will try to find a solution within those bounds
  126969. * default is (1,1,1)
  126970. * @param extent x,y,z value that define the extent around the queries point of reference
  126971. */
  126972. setDefaultQueryExtent(extent: Vector3): void;
  126973. /**
  126974. * Get the Bounding box extent specified by setDefaultQueryExtent
  126975. * @returns the box extent values
  126976. */
  126977. getDefaultQueryExtent(): Vector3;
  126978. /**
  126979. * Disposes
  126980. */
  126981. dispose(): void;
  126982. /**
  126983. * If this plugin is supported
  126984. * @returns true if plugin is supported
  126985. */
  126986. isSupported(): boolean;
  126987. }
  126988. /**
  126989. * Recast detour crowd implementation
  126990. */
  126991. export class RecastJSCrowd implements ICrowd {
  126992. /**
  126993. * Recast/detour plugin
  126994. */
  126995. bjsRECASTPlugin: RecastJSPlugin;
  126996. /**
  126997. * Link to the detour crowd
  126998. */
  126999. recastCrowd: any;
  127000. /**
  127001. * One transform per agent
  127002. */
  127003. transforms: TransformNode[];
  127004. /**
  127005. * All agents created
  127006. */
  127007. agents: number[];
  127008. /**
  127009. * Link to the scene is kept to unregister the crowd from the scene
  127010. */
  127011. private _scene;
  127012. /**
  127013. * Observer for crowd updates
  127014. */
  127015. private _onBeforeAnimationsObserver;
  127016. /**
  127017. * Constructor
  127018. * @param plugin recastJS plugin
  127019. * @param maxAgents the maximum agent count in the crowd
  127020. * @param maxAgentRadius the maximum radius an agent can have
  127021. * @param scene to attach the crowd to
  127022. * @returns the crowd you can add agents to
  127023. */
  127024. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  127025. /**
  127026. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  127027. * You can attach anything to that node. The node position is updated in the scene update tick.
  127028. * @param pos world position that will be constrained by the navigation mesh
  127029. * @param parameters agent parameters
  127030. * @param transform hooked to the agent that will be update by the scene
  127031. * @returns agent index
  127032. */
  127033. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  127034. /**
  127035. * Returns the agent position in world space
  127036. * @param index agent index returned by addAgent
  127037. * @returns world space position
  127038. */
  127039. getAgentPosition(index: number): Vector3;
  127040. /**
  127041. * Returns the agent velocity in world space
  127042. * @param index agent index returned by addAgent
  127043. * @returns world space velocity
  127044. */
  127045. getAgentVelocity(index: number): Vector3;
  127046. /**
  127047. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  127048. * @param index agent index returned by addAgent
  127049. * @param destination targeted world position
  127050. */
  127051. agentGoto(index: number, destination: Vector3): void;
  127052. /**
  127053. * remove a particular agent previously created
  127054. * @param index agent index returned by addAgent
  127055. */
  127056. removeAgent(index: number): void;
  127057. /**
  127058. * get the list of all agents attached to this crowd
  127059. * @returns list of agent indices
  127060. */
  127061. getAgents(): number[];
  127062. /**
  127063. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  127064. * @param deltaTime in seconds
  127065. */
  127066. update(deltaTime: number): void;
  127067. /**
  127068. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  127069. * The queries will try to find a solution within those bounds
  127070. * default is (1,1,1)
  127071. * @param extent x,y,z value that define the extent around the queries point of reference
  127072. */
  127073. setDefaultQueryExtent(extent: Vector3): void;
  127074. /**
  127075. * Get the Bounding box extent specified by setDefaultQueryExtent
  127076. * @returns the box extent values
  127077. */
  127078. getDefaultQueryExtent(): Vector3;
  127079. /**
  127080. * Release all resources
  127081. */
  127082. dispose(): void;
  127083. }
  127084. }
  127085. declare module BABYLON {
  127086. /**
  127087. * Class used to enable access to IndexedDB
  127088. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  127089. */
  127090. export class Database implements IOfflineProvider {
  127091. private _callbackManifestChecked;
  127092. private _currentSceneUrl;
  127093. private _db;
  127094. private _enableSceneOffline;
  127095. private _enableTexturesOffline;
  127096. private _manifestVersionFound;
  127097. private _mustUpdateRessources;
  127098. private _hasReachedQuota;
  127099. private _isSupported;
  127100. private _idbFactory;
  127101. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  127102. private static IsUASupportingBlobStorage;
  127103. /**
  127104. * Gets a boolean indicating if Database storate is enabled (off by default)
  127105. */
  127106. static IDBStorageEnabled: boolean;
  127107. /**
  127108. * Gets a boolean indicating if scene must be saved in the database
  127109. */
  127110. readonly enableSceneOffline: boolean;
  127111. /**
  127112. * Gets a boolean indicating if textures must be saved in the database
  127113. */
  127114. readonly enableTexturesOffline: boolean;
  127115. /**
  127116. * Creates a new Database
  127117. * @param urlToScene defines the url to load the scene
  127118. * @param callbackManifestChecked defines the callback to use when manifest is checked
  127119. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  127120. */
  127121. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  127122. private static _ParseURL;
  127123. private static _ReturnFullUrlLocation;
  127124. private _checkManifestFile;
  127125. /**
  127126. * Open the database and make it available
  127127. * @param successCallback defines the callback to call on success
  127128. * @param errorCallback defines the callback to call on error
  127129. */
  127130. open(successCallback: () => void, errorCallback: () => void): void;
  127131. /**
  127132. * Loads an image from the database
  127133. * @param url defines the url to load from
  127134. * @param image defines the target DOM image
  127135. */
  127136. loadImage(url: string, image: HTMLImageElement): void;
  127137. private _loadImageFromDBAsync;
  127138. private _saveImageIntoDBAsync;
  127139. private _checkVersionFromDB;
  127140. private _loadVersionFromDBAsync;
  127141. private _saveVersionIntoDBAsync;
  127142. /**
  127143. * Loads a file from database
  127144. * @param url defines the URL to load from
  127145. * @param sceneLoaded defines a callback to call on success
  127146. * @param progressCallBack defines a callback to call when progress changed
  127147. * @param errorCallback defines a callback to call on error
  127148. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  127149. */
  127150. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  127151. private _loadFileAsync;
  127152. private _saveFileAsync;
  127153. /**
  127154. * Validates if xhr data is correct
  127155. * @param xhr defines the request to validate
  127156. * @param dataType defines the expected data type
  127157. * @returns true if data is correct
  127158. */
  127159. private static _ValidateXHRData;
  127160. }
  127161. }
  127162. declare module BABYLON {
  127163. /** @hidden */
  127164. export var gpuUpdateParticlesPixelShader: {
  127165. name: string;
  127166. shader: string;
  127167. };
  127168. }
  127169. declare module BABYLON {
  127170. /** @hidden */
  127171. export var gpuUpdateParticlesVertexShader: {
  127172. name: string;
  127173. shader: string;
  127174. };
  127175. }
  127176. declare module BABYLON {
  127177. /** @hidden */
  127178. export var clipPlaneFragmentDeclaration2: {
  127179. name: string;
  127180. shader: string;
  127181. };
  127182. }
  127183. declare module BABYLON {
  127184. /** @hidden */
  127185. export var gpuRenderParticlesPixelShader: {
  127186. name: string;
  127187. shader: string;
  127188. };
  127189. }
  127190. declare module BABYLON {
  127191. /** @hidden */
  127192. export var clipPlaneVertexDeclaration2: {
  127193. name: string;
  127194. shader: string;
  127195. };
  127196. }
  127197. declare module BABYLON {
  127198. /** @hidden */
  127199. export var gpuRenderParticlesVertexShader: {
  127200. name: string;
  127201. shader: string;
  127202. };
  127203. }
  127204. declare module BABYLON {
  127205. /**
  127206. * This represents a GPU particle system in Babylon
  127207. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  127208. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  127209. */
  127210. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  127211. /**
  127212. * The layer mask we are rendering the particles through.
  127213. */
  127214. layerMask: number;
  127215. private _capacity;
  127216. private _activeCount;
  127217. private _currentActiveCount;
  127218. private _accumulatedCount;
  127219. private _renderEffect;
  127220. private _updateEffect;
  127221. private _buffer0;
  127222. private _buffer1;
  127223. private _spriteBuffer;
  127224. private _updateVAO;
  127225. private _renderVAO;
  127226. private _targetIndex;
  127227. private _sourceBuffer;
  127228. private _targetBuffer;
  127229. private _engine;
  127230. private _currentRenderId;
  127231. private _started;
  127232. private _stopped;
  127233. private _timeDelta;
  127234. private _randomTexture;
  127235. private _randomTexture2;
  127236. private _attributesStrideSize;
  127237. private _updateEffectOptions;
  127238. private _randomTextureSize;
  127239. private _actualFrame;
  127240. private readonly _rawTextureWidth;
  127241. /**
  127242. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  127243. */
  127244. static readonly IsSupported: boolean;
  127245. /**
  127246. * An event triggered when the system is disposed.
  127247. */
  127248. onDisposeObservable: Observable<GPUParticleSystem>;
  127249. /**
  127250. * Gets the maximum number of particles active at the same time.
  127251. * @returns The max number of active particles.
  127252. */
  127253. getCapacity(): number;
  127254. /**
  127255. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  127256. * to override the particles.
  127257. */
  127258. forceDepthWrite: boolean;
  127259. /**
  127260. * Gets or set the number of active particles
  127261. */
  127262. activeParticleCount: number;
  127263. private _preWarmDone;
  127264. /**
  127265. * Is this system ready to be used/rendered
  127266. * @return true if the system is ready
  127267. */
  127268. isReady(): boolean;
  127269. /**
  127270. * Gets if the system has been started. (Note: this will still be true after stop is called)
  127271. * @returns True if it has been started, otherwise false.
  127272. */
  127273. isStarted(): boolean;
  127274. /**
  127275. * Starts the particle system and begins to emit
  127276. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  127277. */
  127278. start(delay?: number): void;
  127279. /**
  127280. * Stops the particle system.
  127281. */
  127282. stop(): void;
  127283. /**
  127284. * Remove all active particles
  127285. */
  127286. reset(): void;
  127287. /**
  127288. * Returns the string "GPUParticleSystem"
  127289. * @returns a string containing the class name
  127290. */
  127291. getClassName(): string;
  127292. private _colorGradientsTexture;
  127293. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  127294. /**
  127295. * Adds a new color gradient
  127296. * @param gradient defines the gradient to use (between 0 and 1)
  127297. * @param color1 defines the color to affect to the specified gradient
  127298. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  127299. * @returns the current particle system
  127300. */
  127301. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  127302. /**
  127303. * Remove a specific color gradient
  127304. * @param gradient defines the gradient to remove
  127305. * @returns the current particle system
  127306. */
  127307. removeColorGradient(gradient: number): GPUParticleSystem;
  127308. private _angularSpeedGradientsTexture;
  127309. private _sizeGradientsTexture;
  127310. private _velocityGradientsTexture;
  127311. private _limitVelocityGradientsTexture;
  127312. private _dragGradientsTexture;
  127313. private _addFactorGradient;
  127314. /**
  127315. * Adds a new size gradient
  127316. * @param gradient defines the gradient to use (between 0 and 1)
  127317. * @param factor defines the size factor to affect to the specified gradient
  127318. * @returns the current particle system
  127319. */
  127320. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  127321. /**
  127322. * Remove a specific size gradient
  127323. * @param gradient defines the gradient to remove
  127324. * @returns the current particle system
  127325. */
  127326. removeSizeGradient(gradient: number): GPUParticleSystem;
  127327. /**
  127328. * Adds a new angular speed gradient
  127329. * @param gradient defines the gradient to use (between 0 and 1)
  127330. * @param factor defines the angular speed to affect to the specified gradient
  127331. * @returns the current particle system
  127332. */
  127333. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  127334. /**
  127335. * Remove a specific angular speed gradient
  127336. * @param gradient defines the gradient to remove
  127337. * @returns the current particle system
  127338. */
  127339. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  127340. /**
  127341. * Adds a new velocity gradient
  127342. * @param gradient defines the gradient to use (between 0 and 1)
  127343. * @param factor defines the velocity to affect to the specified gradient
  127344. * @returns the current particle system
  127345. */
  127346. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  127347. /**
  127348. * Remove a specific velocity gradient
  127349. * @param gradient defines the gradient to remove
  127350. * @returns the current particle system
  127351. */
  127352. removeVelocityGradient(gradient: number): GPUParticleSystem;
  127353. /**
  127354. * Adds a new limit velocity gradient
  127355. * @param gradient defines the gradient to use (between 0 and 1)
  127356. * @param factor defines the limit velocity value to affect to the specified gradient
  127357. * @returns the current particle system
  127358. */
  127359. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  127360. /**
  127361. * Remove a specific limit velocity gradient
  127362. * @param gradient defines the gradient to remove
  127363. * @returns the current particle system
  127364. */
  127365. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  127366. /**
  127367. * Adds a new drag gradient
  127368. * @param gradient defines the gradient to use (between 0 and 1)
  127369. * @param factor defines the drag value to affect to the specified gradient
  127370. * @returns the current particle system
  127371. */
  127372. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  127373. /**
  127374. * Remove a specific drag gradient
  127375. * @param gradient defines the gradient to remove
  127376. * @returns the current particle system
  127377. */
  127378. removeDragGradient(gradient: number): GPUParticleSystem;
  127379. /**
  127380. * Not supported by GPUParticleSystem
  127381. * @param gradient defines the gradient to use (between 0 and 1)
  127382. * @param factor defines the emit rate value to affect to the specified gradient
  127383. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  127384. * @returns the current particle system
  127385. */
  127386. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  127387. /**
  127388. * Not supported by GPUParticleSystem
  127389. * @param gradient defines the gradient to remove
  127390. * @returns the current particle system
  127391. */
  127392. removeEmitRateGradient(gradient: number): IParticleSystem;
  127393. /**
  127394. * Not supported by GPUParticleSystem
  127395. * @param gradient defines the gradient to use (between 0 and 1)
  127396. * @param factor defines the start size value to affect to the specified gradient
  127397. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  127398. * @returns the current particle system
  127399. */
  127400. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  127401. /**
  127402. * Not supported by GPUParticleSystem
  127403. * @param gradient defines the gradient to remove
  127404. * @returns the current particle system
  127405. */
  127406. removeStartSizeGradient(gradient: number): IParticleSystem;
  127407. /**
  127408. * Not supported by GPUParticleSystem
  127409. * @param gradient defines the gradient to use (between 0 and 1)
  127410. * @param min defines the color remap minimal range
  127411. * @param max defines the color remap maximal range
  127412. * @returns the current particle system
  127413. */
  127414. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  127415. /**
  127416. * Not supported by GPUParticleSystem
  127417. * @param gradient defines the gradient to remove
  127418. * @returns the current particle system
  127419. */
  127420. removeColorRemapGradient(): IParticleSystem;
  127421. /**
  127422. * Not supported by GPUParticleSystem
  127423. * @param gradient defines the gradient to use (between 0 and 1)
  127424. * @param min defines the alpha remap minimal range
  127425. * @param max defines the alpha remap maximal range
  127426. * @returns the current particle system
  127427. */
  127428. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  127429. /**
  127430. * Not supported by GPUParticleSystem
  127431. * @param gradient defines the gradient to remove
  127432. * @returns the current particle system
  127433. */
  127434. removeAlphaRemapGradient(): IParticleSystem;
  127435. /**
  127436. * Not supported by GPUParticleSystem
  127437. * @param gradient defines the gradient to use (between 0 and 1)
  127438. * @param color defines the color to affect to the specified gradient
  127439. * @returns the current particle system
  127440. */
  127441. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  127442. /**
  127443. * Not supported by GPUParticleSystem
  127444. * @param gradient defines the gradient to remove
  127445. * @returns the current particle system
  127446. */
  127447. removeRampGradient(): IParticleSystem;
  127448. /**
  127449. * Not supported by GPUParticleSystem
  127450. * @returns the list of ramp gradients
  127451. */
  127452. getRampGradients(): Nullable<Array<Color3Gradient>>;
  127453. /**
  127454. * Not supported by GPUParticleSystem
  127455. * Gets or sets a boolean indicating that ramp gradients must be used
  127456. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  127457. */
  127458. useRampGradients: boolean;
  127459. /**
  127460. * Not supported by GPUParticleSystem
  127461. * @param gradient defines the gradient to use (between 0 and 1)
  127462. * @param factor defines the life time factor to affect to the specified gradient
  127463. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  127464. * @returns the current particle system
  127465. */
  127466. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  127467. /**
  127468. * Not supported by GPUParticleSystem
  127469. * @param gradient defines the gradient to remove
  127470. * @returns the current particle system
  127471. */
  127472. removeLifeTimeGradient(gradient: number): IParticleSystem;
  127473. /**
  127474. * Instantiates a GPU particle system.
  127475. * 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.
  127476. * @param name The name of the particle system
  127477. * @param options The options used to create the system
  127478. * @param scene The scene the particle system belongs to
  127479. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  127480. */
  127481. constructor(name: string, options: Partial<{
  127482. capacity: number;
  127483. randomTextureSize: number;
  127484. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  127485. protected _reset(): void;
  127486. private _createUpdateVAO;
  127487. private _createRenderVAO;
  127488. private _initialize;
  127489. /** @hidden */
  127490. _recreateUpdateEffect(): void;
  127491. /** @hidden */
  127492. _recreateRenderEffect(): void;
  127493. /**
  127494. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  127495. * @param preWarm defines if we are in the pre-warmimg phase
  127496. */
  127497. animate(preWarm?: boolean): void;
  127498. private _createFactorGradientTexture;
  127499. private _createSizeGradientTexture;
  127500. private _createAngularSpeedGradientTexture;
  127501. private _createVelocityGradientTexture;
  127502. private _createLimitVelocityGradientTexture;
  127503. private _createDragGradientTexture;
  127504. private _createColorGradientTexture;
  127505. /**
  127506. * Renders the particle system in its current state
  127507. * @param preWarm defines if the system should only update the particles but not render them
  127508. * @returns the current number of particles
  127509. */
  127510. render(preWarm?: boolean): number;
  127511. /**
  127512. * Rebuilds the particle system
  127513. */
  127514. rebuild(): void;
  127515. private _releaseBuffers;
  127516. private _releaseVAOs;
  127517. /**
  127518. * Disposes the particle system and free the associated resources
  127519. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  127520. */
  127521. dispose(disposeTexture?: boolean): void;
  127522. /**
  127523. * Clones the particle system.
  127524. * @param name The name of the cloned object
  127525. * @param newEmitter The new emitter to use
  127526. * @returns the cloned particle system
  127527. */
  127528. clone(name: string, newEmitter: any): GPUParticleSystem;
  127529. /**
  127530. * Serializes the particle system to a JSON object.
  127531. * @returns the JSON object
  127532. */
  127533. serialize(): any;
  127534. /**
  127535. * Parses a JSON object to create a GPU particle system.
  127536. * @param parsedParticleSystem The JSON object to parse
  127537. * @param scene The scene to create the particle system in
  127538. * @param rootUrl The root url to use to load external dependencies like texture
  127539. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  127540. * @returns the parsed GPU particle system
  127541. */
  127542. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  127543. }
  127544. }
  127545. declare module BABYLON {
  127546. /**
  127547. * Represents a set of particle systems working together to create a specific effect
  127548. */
  127549. export class ParticleSystemSet implements IDisposable {
  127550. /**
  127551. * Gets or sets base Assets URL
  127552. */
  127553. static BaseAssetsUrl: string;
  127554. private _emitterCreationOptions;
  127555. private _emitterNode;
  127556. /**
  127557. * Gets the particle system list
  127558. */
  127559. systems: IParticleSystem[];
  127560. /**
  127561. * Gets the emitter node used with this set
  127562. */
  127563. readonly emitterNode: Nullable<TransformNode>;
  127564. /**
  127565. * Creates a new emitter mesh as a sphere
  127566. * @param options defines the options used to create the sphere
  127567. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  127568. * @param scene defines the hosting scene
  127569. */
  127570. setEmitterAsSphere(options: {
  127571. diameter: number;
  127572. segments: number;
  127573. color: Color3;
  127574. }, renderingGroupId: number, scene: Scene): void;
  127575. /**
  127576. * Starts all particle systems of the set
  127577. * @param emitter defines an optional mesh to use as emitter for the particle systems
  127578. */
  127579. start(emitter?: AbstractMesh): void;
  127580. /**
  127581. * Release all associated resources
  127582. */
  127583. dispose(): void;
  127584. /**
  127585. * Serialize the set into a JSON compatible object
  127586. * @returns a JSON compatible representation of the set
  127587. */
  127588. serialize(): any;
  127589. /**
  127590. * Parse a new ParticleSystemSet from a serialized source
  127591. * @param data defines a JSON compatible representation of the set
  127592. * @param scene defines the hosting scene
  127593. * @param gpu defines if we want GPU particles or CPU particles
  127594. * @returns a new ParticleSystemSet
  127595. */
  127596. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  127597. }
  127598. }
  127599. declare module BABYLON {
  127600. /**
  127601. * This class is made for on one-liner static method to help creating particle system set.
  127602. */
  127603. export class ParticleHelper {
  127604. /**
  127605. * Gets or sets base Assets URL
  127606. */
  127607. static BaseAssetsUrl: string;
  127608. /**
  127609. * Create a default particle system that you can tweak
  127610. * @param emitter defines the emitter to use
  127611. * @param capacity defines the system capacity (default is 500 particles)
  127612. * @param scene defines the hosting scene
  127613. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  127614. * @returns the new Particle system
  127615. */
  127616. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  127617. /**
  127618. * This is the main static method (one-liner) of this helper to create different particle systems
  127619. * @param type This string represents the type to the particle system to create
  127620. * @param scene The scene where the particle system should live
  127621. * @param gpu If the system will use gpu
  127622. * @returns the ParticleSystemSet created
  127623. */
  127624. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  127625. /**
  127626. * Static function used to export a particle system to a ParticleSystemSet variable.
  127627. * Please note that the emitter shape is not exported
  127628. * @param systems defines the particle systems to export
  127629. * @returns the created particle system set
  127630. */
  127631. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  127632. }
  127633. }
  127634. declare module BABYLON {
  127635. interface Engine {
  127636. /**
  127637. * Create an effect to use with particle systems.
  127638. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  127639. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  127640. * @param uniformsNames defines a list of attribute names
  127641. * @param samplers defines an array of string used to represent textures
  127642. * @param defines defines the string containing the defines to use to compile the shaders
  127643. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  127644. * @param onCompiled defines a function to call when the effect creation is successful
  127645. * @param onError defines a function to call when the effect creation has failed
  127646. * @returns the new Effect
  127647. */
  127648. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  127649. }
  127650. interface Mesh {
  127651. /**
  127652. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  127653. * @returns an array of IParticleSystem
  127654. */
  127655. getEmittedParticleSystems(): IParticleSystem[];
  127656. /**
  127657. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  127658. * @returns an array of IParticleSystem
  127659. */
  127660. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  127661. }
  127662. /**
  127663. * @hidden
  127664. */
  127665. export var _IDoNeedToBeInTheBuild: number;
  127666. }
  127667. declare module BABYLON {
  127668. /** Defines the 4 color options */
  127669. export enum PointColor {
  127670. /** color value */
  127671. Color = 2,
  127672. /** uv value */
  127673. UV = 1,
  127674. /** random value */
  127675. Random = 0,
  127676. /** stated value */
  127677. Stated = 3
  127678. }
  127679. /**
  127680. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  127681. * As it is just a mesh, the PointCloudSystem has all the same properties as any other BJS mesh : not more, not less. It can be scaled, rotated, translated, enlighted, textured, moved, etc.
  127682. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  127683. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  127684. *
  127685. * Full documentation here : TO BE ENTERED
  127686. */
  127687. export class PointsCloudSystem implements IDisposable {
  127688. /**
  127689. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  127690. * Example : var p = SPS.particles[i];
  127691. */
  127692. particles: CloudPoint[];
  127693. /**
  127694. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  127695. */
  127696. nbParticles: number;
  127697. /**
  127698. * This a counter for your own usage. It's not set by any SPS functions.
  127699. */
  127700. counter: number;
  127701. /**
  127702. * The PCS name. This name is also given to the underlying mesh.
  127703. */
  127704. name: string;
  127705. /**
  127706. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  127707. */
  127708. mesh: Mesh;
  127709. /**
  127710. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  127711. * Please read :
  127712. */
  127713. vars: any;
  127714. /**
  127715. * @hidden
  127716. */
  127717. _size: number;
  127718. private _scene;
  127719. private _promises;
  127720. private _positions;
  127721. private _indices;
  127722. private _normals;
  127723. private _colors;
  127724. private _uvs;
  127725. private _indices32;
  127726. private _positions32;
  127727. private _colors32;
  127728. private _uvs32;
  127729. private _updatable;
  127730. private _isVisibilityBoxLocked;
  127731. private _alwaysVisible;
  127732. private _groups;
  127733. private _groupCounter;
  127734. private _computeParticleColor;
  127735. private _computeParticleTexture;
  127736. private _computeParticleRotation;
  127737. private _computeBoundingBox;
  127738. private _isReady;
  127739. /**
  127740. * Creates a PCS (Points Cloud System) object
  127741. * @param name (String) is the PCS name, this will be the underlying mesh name
  127742. * @param pointSize (number) is the size for each point
  127743. * @param scene (Scene) is the scene in which the PCS is added
  127744. * @param options defines the options of the PCS e.g.
  127745. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  127746. */
  127747. constructor(name: string, pointSize: number, scene: Scene, options?: {
  127748. updatable?: boolean;
  127749. });
  127750. /**
  127751. * Builds the PCS underlying mesh. Returns a standard Mesh.
  127752. * If no points were added to the PCS, the returned mesh is just a single point.
  127753. * @returns a promise for the created mesh
  127754. */
  127755. buildMeshAsync(): Promise<Mesh>;
  127756. /**
  127757. * @hidden
  127758. */
  127759. private _buildMesh;
  127760. private _addParticle;
  127761. private _randomUnitVector;
  127762. private _getColorIndicesForCoord;
  127763. private _setPointsColorOrUV;
  127764. private _colorFromTexture;
  127765. private _calculateDensity;
  127766. /**
  127767. * Adds points to the PCS in random positions within a unit sphere
  127768. * @param nb (positive integer) the number of particles to be created from this model
  127769. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  127770. * @returns the number of groups in the system
  127771. */
  127772. addPoints(nb: number, pointFunction?: any): number;
  127773. /**
  127774. * Adds points to the PCS from the surface of the model shape
  127775. * @param mesh is any Mesh object that will be used as a surface model for the points
  127776. * @param nb (positive integer) the number of particles to be created from this model
  127777. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  127778. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  127779. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  127780. * @returns the number of groups in the system
  127781. */
  127782. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  127783. /**
  127784. * Adds points to the PCS inside the model shape
  127785. * @param mesh is any Mesh object that will be used as a surface model for the points
  127786. * @param nb (positive integer) the number of particles to be created from this model
  127787. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  127788. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  127789. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  127790. * @returns the number of groups in the system
  127791. */
  127792. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  127793. /**
  127794. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  127795. * This method calls `updateParticle()` for each particle of the SPS.
  127796. * For an animated SPS, it is usually called within the render loop.
  127797. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  127798. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  127799. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  127800. * @returns the PCS.
  127801. */
  127802. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  127803. /**
  127804. * Disposes the PCS.
  127805. */
  127806. dispose(): void;
  127807. /**
  127808. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  127809. * doc :
  127810. * @returns the PCS.
  127811. */
  127812. refreshVisibleSize(): PointsCloudSystem;
  127813. /**
  127814. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  127815. * @param size the size (float) of the visibility box
  127816. * note : this doesn't lock the PCS mesh bounding box.
  127817. * doc :
  127818. */
  127819. setVisibilityBox(size: number): void;
  127820. /**
  127821. * Gets whether the PCS is always visible or not
  127822. * doc :
  127823. */
  127824. /**
  127825. * Sets the PCS as always visible or not
  127826. * doc :
  127827. */
  127828. isAlwaysVisible: boolean;
  127829. /**
  127830. * Tells to `setParticles()` to compute the particle rotations or not
  127831. * Default value : false. The PCS is faster when it's set to false
  127832. * Note : particle rotations are only applied to parent particles
  127833. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  127834. */
  127835. computeParticleRotation: boolean;
  127836. /**
  127837. * Tells to `setParticles()` to compute the particle colors or not.
  127838. * Default value : true. The PCS is faster when it's set to false.
  127839. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  127840. */
  127841. /**
  127842. * Gets if `setParticles()` computes the particle colors or not.
  127843. * Default value : false. The PCS is faster when it's set to false.
  127844. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  127845. */
  127846. computeParticleColor: boolean;
  127847. /**
  127848. * Gets if `setParticles()` computes the particle textures or not.
  127849. * Default value : false. The PCS is faster when it's set to false.
  127850. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  127851. */
  127852. computeParticleTexture: boolean;
  127853. /**
  127854. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  127855. */
  127856. /**
  127857. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  127858. */
  127859. computeBoundingBox: boolean;
  127860. /**
  127861. * This function does nothing. It may be overwritten to set all the particle first values.
  127862. * The PCS doesn't call this function, you may have to call it by your own.
  127863. * doc :
  127864. */
  127865. initParticles(): void;
  127866. /**
  127867. * This function does nothing. It may be overwritten to recycle a particle
  127868. * The PCS doesn't call this function, you can to call it
  127869. * doc :
  127870. * @param particle The particle to recycle
  127871. * @returns the recycled particle
  127872. */
  127873. recycleParticle(particle: CloudPoint): CloudPoint;
  127874. /**
  127875. * Updates a particle : this function should be overwritten by the user.
  127876. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  127877. * doc :
  127878. * @example : just set a particle position or velocity and recycle conditions
  127879. * @param particle The particle to update
  127880. * @returns the updated particle
  127881. */
  127882. updateParticle(particle: CloudPoint): CloudPoint;
  127883. /**
  127884. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  127885. * This does nothing and may be overwritten by the user.
  127886. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  127887. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  127888. * @param update the boolean update value actually passed to setParticles()
  127889. */
  127890. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  127891. /**
  127892. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  127893. * This will be passed three parameters.
  127894. * This does nothing and may be overwritten by the user.
  127895. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  127896. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  127897. * @param update the boolean update value actually passed to setParticles()
  127898. */
  127899. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  127900. }
  127901. }
  127902. declare module BABYLON {
  127903. /**
  127904. * Represents one particle of a points cloud system.
  127905. */
  127906. export class CloudPoint {
  127907. /**
  127908. * particle global index
  127909. */
  127910. idx: number;
  127911. /**
  127912. * The color of the particle
  127913. */
  127914. color: Nullable<Color4>;
  127915. /**
  127916. * The world space position of the particle.
  127917. */
  127918. position: Vector3;
  127919. /**
  127920. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  127921. */
  127922. rotation: Vector3;
  127923. /**
  127924. * The world space rotation quaternion of the particle.
  127925. */
  127926. rotationQuaternion: Nullable<Quaternion>;
  127927. /**
  127928. * The uv of the particle.
  127929. */
  127930. uv: Nullable<Vector2>;
  127931. /**
  127932. * The current speed of the particle.
  127933. */
  127934. velocity: Vector3;
  127935. /**
  127936. * The pivot point in the particle local space.
  127937. */
  127938. pivot: Vector3;
  127939. /**
  127940. * Must the particle be translated from its pivot point in its local space ?
  127941. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  127942. * Default : false
  127943. */
  127944. translateFromPivot: boolean;
  127945. /**
  127946. * Index of this particle in the global "positions" array (Internal use)
  127947. * @hidden
  127948. */
  127949. _pos: number;
  127950. /**
  127951. * @hidden Index of this particle in the global "indices" array (Internal use)
  127952. */
  127953. _ind: number;
  127954. /**
  127955. * Group this particle belongs to
  127956. */
  127957. _group: PointsGroup;
  127958. /**
  127959. * Group id of this particle
  127960. */
  127961. groupId: number;
  127962. /**
  127963. * Index of the particle in its group id (Internal use)
  127964. */
  127965. idxInGroup: number;
  127966. /**
  127967. * @hidden Particle BoundingInfo object (Internal use)
  127968. */
  127969. _boundingInfo: BoundingInfo;
  127970. /**
  127971. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  127972. */
  127973. _pcs: PointsCloudSystem;
  127974. /**
  127975. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  127976. */
  127977. _stillInvisible: boolean;
  127978. /**
  127979. * @hidden Last computed particle rotation matrix
  127980. */
  127981. _rotationMatrix: number[];
  127982. /**
  127983. * Parent particle Id, if any.
  127984. * Default null.
  127985. */
  127986. parentId: Nullable<number>;
  127987. /**
  127988. * @hidden Internal global position in the PCS.
  127989. */
  127990. _globalPosition: Vector3;
  127991. /**
  127992. * Creates a Point Cloud object.
  127993. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  127994. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  127995. * @param group (PointsGroup) is the group the particle belongs to
  127996. * @param groupId (integer) is the group identifier in the PCS.
  127997. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  127998. * @param pcs defines the PCS it is associated to
  127999. */
  128000. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  128001. /**
  128002. * get point size
  128003. */
  128004. /**
  128005. * Set point size
  128006. */
  128007. size: Vector3;
  128008. /**
  128009. * Legacy support, changed quaternion to rotationQuaternion
  128010. */
  128011. /**
  128012. * Legacy support, changed quaternion to rotationQuaternion
  128013. */
  128014. quaternion: Nullable<Quaternion>;
  128015. /**
  128016. * Returns a boolean. True if the particle intersects a mesh, else false
  128017. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  128018. * @param target is the object (point or mesh) what the intersection is computed against
  128019. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  128020. * @returns true if it intersects
  128021. */
  128022. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  128023. /**
  128024. * get the rotation matrix of the particle
  128025. * @hidden
  128026. */
  128027. getRotationMatrix(m: Matrix): void;
  128028. }
  128029. /**
  128030. * Represents a group of points in a points cloud system
  128031. * * PCS internal tool, don't use it manually.
  128032. */
  128033. export class PointsGroup {
  128034. /**
  128035. * The group id
  128036. * @hidden
  128037. */
  128038. groupID: number;
  128039. /**
  128040. * image data for group (internal use)
  128041. * @hidden
  128042. */
  128043. _groupImageData: Nullable<ArrayBufferView>;
  128044. /**
  128045. * Image Width (internal use)
  128046. * @hidden
  128047. */
  128048. _groupImgWidth: number;
  128049. /**
  128050. * Image Height (internal use)
  128051. * @hidden
  128052. */
  128053. _groupImgHeight: number;
  128054. /**
  128055. * Custom position function (internal use)
  128056. * @hidden
  128057. */
  128058. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  128059. /**
  128060. * density per facet for surface points
  128061. * @hidden
  128062. */
  128063. _groupDensity: number[];
  128064. /**
  128065. * Only when points are colored by texture carries pointer to texture list array
  128066. * @hidden
  128067. */
  128068. _textureNb: number;
  128069. /**
  128070. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  128071. * PCS internal tool, don't use it manually.
  128072. * @hidden
  128073. */
  128074. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  128075. }
  128076. }
  128077. declare module BABYLON {
  128078. interface Scene {
  128079. /** @hidden (Backing field) */
  128080. _physicsEngine: Nullable<IPhysicsEngine>;
  128081. /**
  128082. * Gets the current physics engine
  128083. * @returns a IPhysicsEngine or null if none attached
  128084. */
  128085. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  128086. /**
  128087. * Enables physics to the current scene
  128088. * @param gravity defines the scene's gravity for the physics engine
  128089. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  128090. * @return a boolean indicating if the physics engine was initialized
  128091. */
  128092. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  128093. /**
  128094. * Disables and disposes the physics engine associated with the scene
  128095. */
  128096. disablePhysicsEngine(): void;
  128097. /**
  128098. * Gets a boolean indicating if there is an active physics engine
  128099. * @returns a boolean indicating if there is an active physics engine
  128100. */
  128101. isPhysicsEnabled(): boolean;
  128102. /**
  128103. * Deletes a physics compound impostor
  128104. * @param compound defines the compound to delete
  128105. */
  128106. deleteCompoundImpostor(compound: any): void;
  128107. /**
  128108. * An event triggered when physic simulation is about to be run
  128109. */
  128110. onBeforePhysicsObservable: Observable<Scene>;
  128111. /**
  128112. * An event triggered when physic simulation has been done
  128113. */
  128114. onAfterPhysicsObservable: Observable<Scene>;
  128115. }
  128116. interface AbstractMesh {
  128117. /** @hidden */
  128118. _physicsImpostor: Nullable<PhysicsImpostor>;
  128119. /**
  128120. * Gets or sets impostor used for physic simulation
  128121. * @see http://doc.babylonjs.com/features/physics_engine
  128122. */
  128123. physicsImpostor: Nullable<PhysicsImpostor>;
  128124. /**
  128125. * Gets the current physics impostor
  128126. * @see http://doc.babylonjs.com/features/physics_engine
  128127. * @returns a physics impostor or null
  128128. */
  128129. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  128130. /** Apply a physic impulse to the mesh
  128131. * @param force defines the force to apply
  128132. * @param contactPoint defines where to apply the force
  128133. * @returns the current mesh
  128134. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  128135. */
  128136. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  128137. /**
  128138. * Creates a physic joint between two meshes
  128139. * @param otherMesh defines the other mesh to use
  128140. * @param pivot1 defines the pivot to use on this mesh
  128141. * @param pivot2 defines the pivot to use on the other mesh
  128142. * @param options defines additional options (can be plugin dependent)
  128143. * @returns the current mesh
  128144. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  128145. */
  128146. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  128147. /** @hidden */
  128148. _disposePhysicsObserver: Nullable<Observer<Node>>;
  128149. }
  128150. /**
  128151. * Defines the physics engine scene component responsible to manage a physics engine
  128152. */
  128153. export class PhysicsEngineSceneComponent implements ISceneComponent {
  128154. /**
  128155. * The component name helpful to identify the component in the list of scene components.
  128156. */
  128157. readonly name: string;
  128158. /**
  128159. * The scene the component belongs to.
  128160. */
  128161. scene: Scene;
  128162. /**
  128163. * Creates a new instance of the component for the given scene
  128164. * @param scene Defines the scene to register the component in
  128165. */
  128166. constructor(scene: Scene);
  128167. /**
  128168. * Registers the component in a given scene
  128169. */
  128170. register(): void;
  128171. /**
  128172. * Rebuilds the elements related to this component in case of
  128173. * context lost for instance.
  128174. */
  128175. rebuild(): void;
  128176. /**
  128177. * Disposes the component and the associated ressources
  128178. */
  128179. dispose(): void;
  128180. }
  128181. }
  128182. declare module BABYLON {
  128183. /**
  128184. * A helper for physics simulations
  128185. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128186. */
  128187. export class PhysicsHelper {
  128188. private _scene;
  128189. private _physicsEngine;
  128190. /**
  128191. * Initializes the Physics helper
  128192. * @param scene Babylon.js scene
  128193. */
  128194. constructor(scene: Scene);
  128195. /**
  128196. * Applies a radial explosion impulse
  128197. * @param origin the origin of the explosion
  128198. * @param radiusOrEventOptions the radius or the options of radial explosion
  128199. * @param strength the explosion strength
  128200. * @param falloff possible options: Constant & Linear. Defaults to Constant
  128201. * @returns A physics radial explosion event, or null
  128202. */
  128203. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  128204. /**
  128205. * Applies a radial explosion force
  128206. * @param origin the origin of the explosion
  128207. * @param radiusOrEventOptions the radius or the options of radial explosion
  128208. * @param strength the explosion strength
  128209. * @param falloff possible options: Constant & Linear. Defaults to Constant
  128210. * @returns A physics radial explosion event, or null
  128211. */
  128212. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  128213. /**
  128214. * Creates a gravitational field
  128215. * @param origin the origin of the explosion
  128216. * @param radiusOrEventOptions the radius or the options of radial explosion
  128217. * @param strength the explosion strength
  128218. * @param falloff possible options: Constant & Linear. Defaults to Constant
  128219. * @returns A physics gravitational field event, or null
  128220. */
  128221. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  128222. /**
  128223. * Creates a physics updraft event
  128224. * @param origin the origin of the updraft
  128225. * @param radiusOrEventOptions the radius or the options of the updraft
  128226. * @param strength the strength of the updraft
  128227. * @param height the height of the updraft
  128228. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  128229. * @returns A physics updraft event, or null
  128230. */
  128231. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  128232. /**
  128233. * Creates a physics vortex event
  128234. * @param origin the of the vortex
  128235. * @param radiusOrEventOptions the radius or the options of the vortex
  128236. * @param strength the strength of the vortex
  128237. * @param height the height of the vortex
  128238. * @returns a Physics vortex event, or null
  128239. * A physics vortex event or null
  128240. */
  128241. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  128242. }
  128243. /**
  128244. * Represents a physics radial explosion event
  128245. */
  128246. class PhysicsRadialExplosionEvent {
  128247. private _scene;
  128248. private _options;
  128249. private _sphere;
  128250. private _dataFetched;
  128251. /**
  128252. * Initializes a radial explosioin event
  128253. * @param _scene BabylonJS scene
  128254. * @param _options The options for the vortex event
  128255. */
  128256. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  128257. /**
  128258. * Returns the data related to the radial explosion event (sphere).
  128259. * @returns The radial explosion event data
  128260. */
  128261. getData(): PhysicsRadialExplosionEventData;
  128262. /**
  128263. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  128264. * @param impostor A physics imposter
  128265. * @param origin the origin of the explosion
  128266. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  128267. */
  128268. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  128269. /**
  128270. * Triggers affecterd impostors callbacks
  128271. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  128272. */
  128273. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  128274. /**
  128275. * Disposes the sphere.
  128276. * @param force Specifies if the sphere should be disposed by force
  128277. */
  128278. dispose(force?: boolean): void;
  128279. /*** Helpers ***/
  128280. private _prepareSphere;
  128281. private _intersectsWithSphere;
  128282. }
  128283. /**
  128284. * Represents a gravitational field event
  128285. */
  128286. class PhysicsGravitationalFieldEvent {
  128287. private _physicsHelper;
  128288. private _scene;
  128289. private _origin;
  128290. private _options;
  128291. private _tickCallback;
  128292. private _sphere;
  128293. private _dataFetched;
  128294. /**
  128295. * Initializes the physics gravitational field event
  128296. * @param _physicsHelper A physics helper
  128297. * @param _scene BabylonJS scene
  128298. * @param _origin The origin position of the gravitational field event
  128299. * @param _options The options for the vortex event
  128300. */
  128301. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  128302. /**
  128303. * Returns the data related to the gravitational field event (sphere).
  128304. * @returns A gravitational field event
  128305. */
  128306. getData(): PhysicsGravitationalFieldEventData;
  128307. /**
  128308. * Enables the gravitational field.
  128309. */
  128310. enable(): void;
  128311. /**
  128312. * Disables the gravitational field.
  128313. */
  128314. disable(): void;
  128315. /**
  128316. * Disposes the sphere.
  128317. * @param force The force to dispose from the gravitational field event
  128318. */
  128319. dispose(force?: boolean): void;
  128320. private _tick;
  128321. }
  128322. /**
  128323. * Represents a physics updraft event
  128324. */
  128325. class PhysicsUpdraftEvent {
  128326. private _scene;
  128327. private _origin;
  128328. private _options;
  128329. private _physicsEngine;
  128330. private _originTop;
  128331. private _originDirection;
  128332. private _tickCallback;
  128333. private _cylinder;
  128334. private _cylinderPosition;
  128335. private _dataFetched;
  128336. /**
  128337. * Initializes the physics updraft event
  128338. * @param _scene BabylonJS scene
  128339. * @param _origin The origin position of the updraft
  128340. * @param _options The options for the updraft event
  128341. */
  128342. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  128343. /**
  128344. * Returns the data related to the updraft event (cylinder).
  128345. * @returns A physics updraft event
  128346. */
  128347. getData(): PhysicsUpdraftEventData;
  128348. /**
  128349. * Enables the updraft.
  128350. */
  128351. enable(): void;
  128352. /**
  128353. * Disables the updraft.
  128354. */
  128355. disable(): void;
  128356. /**
  128357. * Disposes the cylinder.
  128358. * @param force Specifies if the updraft should be disposed by force
  128359. */
  128360. dispose(force?: boolean): void;
  128361. private getImpostorHitData;
  128362. private _tick;
  128363. /*** Helpers ***/
  128364. private _prepareCylinder;
  128365. private _intersectsWithCylinder;
  128366. }
  128367. /**
  128368. * Represents a physics vortex event
  128369. */
  128370. class PhysicsVortexEvent {
  128371. private _scene;
  128372. private _origin;
  128373. private _options;
  128374. private _physicsEngine;
  128375. private _originTop;
  128376. private _tickCallback;
  128377. private _cylinder;
  128378. private _cylinderPosition;
  128379. private _dataFetched;
  128380. /**
  128381. * Initializes the physics vortex event
  128382. * @param _scene The BabylonJS scene
  128383. * @param _origin The origin position of the vortex
  128384. * @param _options The options for the vortex event
  128385. */
  128386. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  128387. /**
  128388. * Returns the data related to the vortex event (cylinder).
  128389. * @returns The physics vortex event data
  128390. */
  128391. getData(): PhysicsVortexEventData;
  128392. /**
  128393. * Enables the vortex.
  128394. */
  128395. enable(): void;
  128396. /**
  128397. * Disables the cortex.
  128398. */
  128399. disable(): void;
  128400. /**
  128401. * Disposes the sphere.
  128402. * @param force
  128403. */
  128404. dispose(force?: boolean): void;
  128405. private getImpostorHitData;
  128406. private _tick;
  128407. /*** Helpers ***/
  128408. private _prepareCylinder;
  128409. private _intersectsWithCylinder;
  128410. }
  128411. /**
  128412. * Options fot the radial explosion event
  128413. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128414. */
  128415. export class PhysicsRadialExplosionEventOptions {
  128416. /**
  128417. * The radius of the sphere for the radial explosion.
  128418. */
  128419. radius: number;
  128420. /**
  128421. * The strenth of the explosion.
  128422. */
  128423. strength: number;
  128424. /**
  128425. * The strenght of the force in correspondence to the distance of the affected object
  128426. */
  128427. falloff: PhysicsRadialImpulseFalloff;
  128428. /**
  128429. * Sphere options for the radial explosion.
  128430. */
  128431. sphere: {
  128432. segments: number;
  128433. diameter: number;
  128434. };
  128435. /**
  128436. * Sphere options for the radial explosion.
  128437. */
  128438. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  128439. }
  128440. /**
  128441. * Options fot the updraft event
  128442. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128443. */
  128444. export class PhysicsUpdraftEventOptions {
  128445. /**
  128446. * The radius of the cylinder for the vortex
  128447. */
  128448. radius: number;
  128449. /**
  128450. * The strenth of the updraft.
  128451. */
  128452. strength: number;
  128453. /**
  128454. * The height of the cylinder for the updraft.
  128455. */
  128456. height: number;
  128457. /**
  128458. * The mode for the the updraft.
  128459. */
  128460. updraftMode: PhysicsUpdraftMode;
  128461. }
  128462. /**
  128463. * Options fot the vortex event
  128464. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128465. */
  128466. export class PhysicsVortexEventOptions {
  128467. /**
  128468. * The radius of the cylinder for the vortex
  128469. */
  128470. radius: number;
  128471. /**
  128472. * The strenth of the vortex.
  128473. */
  128474. strength: number;
  128475. /**
  128476. * The height of the cylinder for the vortex.
  128477. */
  128478. height: number;
  128479. /**
  128480. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  128481. */
  128482. centripetalForceThreshold: number;
  128483. /**
  128484. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  128485. */
  128486. centripetalForceMultiplier: number;
  128487. /**
  128488. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  128489. */
  128490. centrifugalForceMultiplier: number;
  128491. /**
  128492. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  128493. */
  128494. updraftForceMultiplier: number;
  128495. }
  128496. /**
  128497. * The strenght of the force in correspondence to the distance of the affected object
  128498. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128499. */
  128500. export enum PhysicsRadialImpulseFalloff {
  128501. /** Defines that impulse is constant in strength across it's whole radius */
  128502. Constant = 0,
  128503. /** Defines that impulse gets weaker if it's further from the origin */
  128504. Linear = 1
  128505. }
  128506. /**
  128507. * The strength of the force in correspondence to the distance of the affected object
  128508. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128509. */
  128510. export enum PhysicsUpdraftMode {
  128511. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  128512. Center = 0,
  128513. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  128514. Perpendicular = 1
  128515. }
  128516. /**
  128517. * Interface for a physics hit data
  128518. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128519. */
  128520. export interface PhysicsHitData {
  128521. /**
  128522. * The force applied at the contact point
  128523. */
  128524. force: Vector3;
  128525. /**
  128526. * The contact point
  128527. */
  128528. contactPoint: Vector3;
  128529. /**
  128530. * The distance from the origin to the contact point
  128531. */
  128532. distanceFromOrigin: number;
  128533. }
  128534. /**
  128535. * Interface for radial explosion event data
  128536. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128537. */
  128538. export interface PhysicsRadialExplosionEventData {
  128539. /**
  128540. * A sphere used for the radial explosion event
  128541. */
  128542. sphere: Mesh;
  128543. }
  128544. /**
  128545. * Interface for gravitational field event data
  128546. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128547. */
  128548. export interface PhysicsGravitationalFieldEventData {
  128549. /**
  128550. * A sphere mesh used for the gravitational field event
  128551. */
  128552. sphere: Mesh;
  128553. }
  128554. /**
  128555. * Interface for updraft event data
  128556. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128557. */
  128558. export interface PhysicsUpdraftEventData {
  128559. /**
  128560. * A cylinder used for the updraft event
  128561. */
  128562. cylinder: Mesh;
  128563. }
  128564. /**
  128565. * Interface for vortex event data
  128566. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128567. */
  128568. export interface PhysicsVortexEventData {
  128569. /**
  128570. * A cylinder used for the vortex event
  128571. */
  128572. cylinder: Mesh;
  128573. }
  128574. /**
  128575. * Interface for an affected physics impostor
  128576. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128577. */
  128578. export interface PhysicsAffectedImpostorWithData {
  128579. /**
  128580. * The impostor affected by the effect
  128581. */
  128582. impostor: PhysicsImpostor;
  128583. /**
  128584. * The data about the hit/horce from the explosion
  128585. */
  128586. hitData: PhysicsHitData;
  128587. }
  128588. }
  128589. declare module BABYLON {
  128590. /** @hidden */
  128591. export var blackAndWhitePixelShader: {
  128592. name: string;
  128593. shader: string;
  128594. };
  128595. }
  128596. declare module BABYLON {
  128597. /**
  128598. * Post process used to render in black and white
  128599. */
  128600. export class BlackAndWhitePostProcess extends PostProcess {
  128601. /**
  128602. * Linear about to convert he result to black and white (default: 1)
  128603. */
  128604. degree: number;
  128605. /**
  128606. * Creates a black and white post process
  128607. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  128608. * @param name The name of the effect.
  128609. * @param options The required width/height ratio to downsize to before computing the render pass.
  128610. * @param camera The camera to apply the render pass to.
  128611. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128612. * @param engine The engine which the post process will be applied. (default: current engine)
  128613. * @param reusable If the post process can be reused on the same frame. (default: false)
  128614. */
  128615. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128616. }
  128617. }
  128618. declare module BABYLON {
  128619. /**
  128620. * This represents a set of one or more post processes in Babylon.
  128621. * A post process can be used to apply a shader to a texture after it is rendered.
  128622. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128623. */
  128624. export class PostProcessRenderEffect {
  128625. private _postProcesses;
  128626. private _getPostProcesses;
  128627. private _singleInstance;
  128628. private _cameras;
  128629. private _indicesForCamera;
  128630. /**
  128631. * Name of the effect
  128632. * @hidden
  128633. */
  128634. _name: string;
  128635. /**
  128636. * Instantiates a post process render effect.
  128637. * A post process can be used to apply a shader to a texture after it is rendered.
  128638. * @param engine The engine the effect is tied to
  128639. * @param name The name of the effect
  128640. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  128641. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  128642. */
  128643. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  128644. /**
  128645. * Checks if all the post processes in the effect are supported.
  128646. */
  128647. readonly isSupported: boolean;
  128648. /**
  128649. * Updates the current state of the effect
  128650. * @hidden
  128651. */
  128652. _update(): void;
  128653. /**
  128654. * Attaches the effect on cameras
  128655. * @param cameras The camera to attach to.
  128656. * @hidden
  128657. */
  128658. _attachCameras(cameras: Camera): void;
  128659. /**
  128660. * Attaches the effect on cameras
  128661. * @param cameras The camera to attach to.
  128662. * @hidden
  128663. */
  128664. _attachCameras(cameras: Camera[]): void;
  128665. /**
  128666. * Detaches the effect on cameras
  128667. * @param cameras The camera to detatch from.
  128668. * @hidden
  128669. */
  128670. _detachCameras(cameras: Camera): void;
  128671. /**
  128672. * Detatches the effect on cameras
  128673. * @param cameras The camera to detatch from.
  128674. * @hidden
  128675. */
  128676. _detachCameras(cameras: Camera[]): void;
  128677. /**
  128678. * Enables the effect on given cameras
  128679. * @param cameras The camera to enable.
  128680. * @hidden
  128681. */
  128682. _enable(cameras: Camera): void;
  128683. /**
  128684. * Enables the effect on given cameras
  128685. * @param cameras The camera to enable.
  128686. * @hidden
  128687. */
  128688. _enable(cameras: Nullable<Camera[]>): void;
  128689. /**
  128690. * Disables the effect on the given cameras
  128691. * @param cameras The camera to disable.
  128692. * @hidden
  128693. */
  128694. _disable(cameras: Camera): void;
  128695. /**
  128696. * Disables the effect on the given cameras
  128697. * @param cameras The camera to disable.
  128698. * @hidden
  128699. */
  128700. _disable(cameras: Nullable<Camera[]>): void;
  128701. /**
  128702. * Gets a list of the post processes contained in the effect.
  128703. * @param camera The camera to get the post processes on.
  128704. * @returns The list of the post processes in the effect.
  128705. */
  128706. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  128707. }
  128708. }
  128709. declare module BABYLON {
  128710. /** @hidden */
  128711. export var extractHighlightsPixelShader: {
  128712. name: string;
  128713. shader: string;
  128714. };
  128715. }
  128716. declare module BABYLON {
  128717. /**
  128718. * 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.
  128719. */
  128720. export class ExtractHighlightsPostProcess extends PostProcess {
  128721. /**
  128722. * The luminance threshold, pixels below this value will be set to black.
  128723. */
  128724. threshold: number;
  128725. /** @hidden */
  128726. _exposure: number;
  128727. /**
  128728. * Post process which has the input texture to be used when performing highlight extraction
  128729. * @hidden
  128730. */
  128731. _inputPostProcess: Nullable<PostProcess>;
  128732. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128733. }
  128734. }
  128735. declare module BABYLON {
  128736. /** @hidden */
  128737. export var bloomMergePixelShader: {
  128738. name: string;
  128739. shader: string;
  128740. };
  128741. }
  128742. declare module BABYLON {
  128743. /**
  128744. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  128745. */
  128746. export class BloomMergePostProcess extends PostProcess {
  128747. /** Weight of the bloom to be added to the original input. */
  128748. weight: number;
  128749. /**
  128750. * Creates a new instance of @see BloomMergePostProcess
  128751. * @param name The name of the effect.
  128752. * @param originalFromInput Post process which's input will be used for the merge.
  128753. * @param blurred Blurred highlights post process which's output will be used.
  128754. * @param weight Weight of the bloom to be added to the original input.
  128755. * @param options The required width/height ratio to downsize to before computing the render pass.
  128756. * @param camera The camera to apply the render pass to.
  128757. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128758. * @param engine The engine which the post process will be applied. (default: current engine)
  128759. * @param reusable If the post process can be reused on the same frame. (default: false)
  128760. * @param textureType Type of textures used when performing the post process. (default: 0)
  128761. * @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)
  128762. */
  128763. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  128764. /** Weight of the bloom to be added to the original input. */
  128765. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128766. }
  128767. }
  128768. declare module BABYLON {
  128769. /**
  128770. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  128771. */
  128772. export class BloomEffect extends PostProcessRenderEffect {
  128773. private bloomScale;
  128774. /**
  128775. * @hidden Internal
  128776. */
  128777. _effects: Array<PostProcess>;
  128778. /**
  128779. * @hidden Internal
  128780. */
  128781. _downscale: ExtractHighlightsPostProcess;
  128782. private _blurX;
  128783. private _blurY;
  128784. private _merge;
  128785. /**
  128786. * The luminance threshold to find bright areas of the image to bloom.
  128787. */
  128788. threshold: number;
  128789. /**
  128790. * The strength of the bloom.
  128791. */
  128792. weight: number;
  128793. /**
  128794. * Specifies the size of the bloom blur kernel, relative to the final output size
  128795. */
  128796. kernel: number;
  128797. /**
  128798. * Creates a new instance of @see BloomEffect
  128799. * @param scene The scene the effect belongs to.
  128800. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  128801. * @param bloomKernel The size of the kernel to be used when applying the blur.
  128802. * @param bloomWeight The the strength of bloom.
  128803. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  128804. * @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)
  128805. */
  128806. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  128807. /**
  128808. * Disposes each of the internal effects for a given camera.
  128809. * @param camera The camera to dispose the effect on.
  128810. */
  128811. disposeEffects(camera: Camera): void;
  128812. /**
  128813. * @hidden Internal
  128814. */
  128815. _updateEffects(): void;
  128816. /**
  128817. * Internal
  128818. * @returns if all the contained post processes are ready.
  128819. * @hidden
  128820. */
  128821. _isReady(): boolean;
  128822. }
  128823. }
  128824. declare module BABYLON {
  128825. /** @hidden */
  128826. export var chromaticAberrationPixelShader: {
  128827. name: string;
  128828. shader: string;
  128829. };
  128830. }
  128831. declare module BABYLON {
  128832. /**
  128833. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  128834. */
  128835. export class ChromaticAberrationPostProcess extends PostProcess {
  128836. /**
  128837. * The amount of seperation of rgb channels (default: 30)
  128838. */
  128839. aberrationAmount: number;
  128840. /**
  128841. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  128842. */
  128843. radialIntensity: number;
  128844. /**
  128845. * 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))
  128846. */
  128847. direction: Vector2;
  128848. /**
  128849. * 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))
  128850. */
  128851. centerPosition: Vector2;
  128852. /**
  128853. * Creates a new instance ChromaticAberrationPostProcess
  128854. * @param name The name of the effect.
  128855. * @param screenWidth The width of the screen to apply the effect on.
  128856. * @param screenHeight The height of the screen to apply the effect on.
  128857. * @param options The required width/height ratio to downsize to before computing the render pass.
  128858. * @param camera The camera to apply the render pass to.
  128859. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128860. * @param engine The engine which the post process will be applied. (default: current engine)
  128861. * @param reusable If the post process can be reused on the same frame. (default: false)
  128862. * @param textureType Type of textures used when performing the post process. (default: 0)
  128863. * @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)
  128864. */
  128865. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128866. }
  128867. }
  128868. declare module BABYLON {
  128869. /** @hidden */
  128870. export var circleOfConfusionPixelShader: {
  128871. name: string;
  128872. shader: string;
  128873. };
  128874. }
  128875. declare module BABYLON {
  128876. /**
  128877. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  128878. */
  128879. export class CircleOfConfusionPostProcess extends PostProcess {
  128880. /**
  128881. * 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.
  128882. */
  128883. lensSize: number;
  128884. /**
  128885. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  128886. */
  128887. fStop: number;
  128888. /**
  128889. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  128890. */
  128891. focusDistance: number;
  128892. /**
  128893. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  128894. */
  128895. focalLength: number;
  128896. private _depthTexture;
  128897. /**
  128898. * Creates a new instance CircleOfConfusionPostProcess
  128899. * @param name The name of the effect.
  128900. * @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.
  128901. * @param options The required width/height ratio to downsize to before computing the render pass.
  128902. * @param camera The camera to apply the render pass to.
  128903. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128904. * @param engine The engine which the post process will be applied. (default: current engine)
  128905. * @param reusable If the post process can be reused on the same frame. (default: false)
  128906. * @param textureType Type of textures used when performing the post process. (default: 0)
  128907. * @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)
  128908. */
  128909. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128910. /**
  128911. * 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.
  128912. */
  128913. depthTexture: RenderTargetTexture;
  128914. }
  128915. }
  128916. declare module BABYLON {
  128917. /** @hidden */
  128918. export var colorCorrectionPixelShader: {
  128919. name: string;
  128920. shader: string;
  128921. };
  128922. }
  128923. declare module BABYLON {
  128924. /**
  128925. *
  128926. * This post-process allows the modification of rendered colors by using
  128927. * a 'look-up table' (LUT). This effect is also called Color Grading.
  128928. *
  128929. * The object needs to be provided an url to a texture containing the color
  128930. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  128931. * Use an image editing software to tweak the LUT to match your needs.
  128932. *
  128933. * For an example of a color LUT, see here:
  128934. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  128935. * For explanations on color grading, see here:
  128936. * @see http://udn.epicgames.com/Three/ColorGrading.html
  128937. *
  128938. */
  128939. export class ColorCorrectionPostProcess extends PostProcess {
  128940. private _colorTableTexture;
  128941. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128942. }
  128943. }
  128944. declare module BABYLON {
  128945. /** @hidden */
  128946. export var convolutionPixelShader: {
  128947. name: string;
  128948. shader: string;
  128949. };
  128950. }
  128951. declare module BABYLON {
  128952. /**
  128953. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  128954. * input texture to perform effects such as edge detection or sharpening
  128955. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  128956. */
  128957. export class ConvolutionPostProcess extends PostProcess {
  128958. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  128959. kernel: number[];
  128960. /**
  128961. * Creates a new instance ConvolutionPostProcess
  128962. * @param name The name of the effect.
  128963. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  128964. * @param options The required width/height ratio to downsize to before computing the render pass.
  128965. * @param camera The camera to apply the render pass to.
  128966. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128967. * @param engine The engine which the post process will be applied. (default: current engine)
  128968. * @param reusable If the post process can be reused on the same frame. (default: false)
  128969. * @param textureType Type of textures used when performing the post process. (default: 0)
  128970. */
  128971. constructor(name: string,
  128972. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  128973. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128974. /**
  128975. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128976. */
  128977. static EdgeDetect0Kernel: number[];
  128978. /**
  128979. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128980. */
  128981. static EdgeDetect1Kernel: number[];
  128982. /**
  128983. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128984. */
  128985. static EdgeDetect2Kernel: number[];
  128986. /**
  128987. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128988. */
  128989. static SharpenKernel: number[];
  128990. /**
  128991. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128992. */
  128993. static EmbossKernel: number[];
  128994. /**
  128995. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128996. */
  128997. static GaussianKernel: number[];
  128998. }
  128999. }
  129000. declare module BABYLON {
  129001. /**
  129002. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  129003. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  129004. * based on samples that have a large difference in distance than the center pixel.
  129005. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  129006. */
  129007. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  129008. direction: Vector2;
  129009. /**
  129010. * Creates a new instance CircleOfConfusionPostProcess
  129011. * @param name The name of the effect.
  129012. * @param scene The scene the effect belongs to.
  129013. * @param direction The direction the blur should be applied.
  129014. * @param kernel The size of the kernel used to blur.
  129015. * @param options The required width/height ratio to downsize to before computing the render pass.
  129016. * @param camera The camera to apply the render pass to.
  129017. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  129018. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  129019. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129020. * @param engine The engine which the post process will be applied. (default: current engine)
  129021. * @param reusable If the post process can be reused on the same frame. (default: false)
  129022. * @param textureType Type of textures used when performing the post process. (default: 0)
  129023. * @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)
  129024. */
  129025. 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);
  129026. }
  129027. }
  129028. declare module BABYLON {
  129029. /** @hidden */
  129030. export var depthOfFieldMergePixelShader: {
  129031. name: string;
  129032. shader: string;
  129033. };
  129034. }
  129035. declare module BABYLON {
  129036. /**
  129037. * Options to be set when merging outputs from the default pipeline.
  129038. */
  129039. export class DepthOfFieldMergePostProcessOptions {
  129040. /**
  129041. * The original image to merge on top of
  129042. */
  129043. originalFromInput: PostProcess;
  129044. /**
  129045. * Parameters to perform the merge of the depth of field effect
  129046. */
  129047. depthOfField?: {
  129048. circleOfConfusion: PostProcess;
  129049. blurSteps: Array<PostProcess>;
  129050. };
  129051. /**
  129052. * Parameters to perform the merge of bloom effect
  129053. */
  129054. bloom?: {
  129055. blurred: PostProcess;
  129056. weight: number;
  129057. };
  129058. }
  129059. /**
  129060. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  129061. */
  129062. export class DepthOfFieldMergePostProcess extends PostProcess {
  129063. private blurSteps;
  129064. /**
  129065. * Creates a new instance of DepthOfFieldMergePostProcess
  129066. * @param name The name of the effect.
  129067. * @param originalFromInput Post process which's input will be used for the merge.
  129068. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  129069. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  129070. * @param options The required width/height ratio to downsize to before computing the render pass.
  129071. * @param camera The camera to apply the render pass to.
  129072. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129073. * @param engine The engine which the post process will be applied. (default: current engine)
  129074. * @param reusable If the post process can be reused on the same frame. (default: false)
  129075. * @param textureType Type of textures used when performing the post process. (default: 0)
  129076. * @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)
  129077. */
  129078. 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);
  129079. /**
  129080. * Updates the effect with the current post process compile time values and recompiles the shader.
  129081. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  129082. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  129083. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  129084. * @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
  129085. * @param onCompiled Called when the shader has been compiled.
  129086. * @param onError Called if there is an error when compiling a shader.
  129087. */
  129088. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  129089. }
  129090. }
  129091. declare module BABYLON {
  129092. /**
  129093. * Specifies the level of max blur that should be applied when using the depth of field effect
  129094. */
  129095. export enum DepthOfFieldEffectBlurLevel {
  129096. /**
  129097. * Subtle blur
  129098. */
  129099. Low = 0,
  129100. /**
  129101. * Medium blur
  129102. */
  129103. Medium = 1,
  129104. /**
  129105. * Large blur
  129106. */
  129107. High = 2
  129108. }
  129109. /**
  129110. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  129111. */
  129112. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  129113. private _circleOfConfusion;
  129114. /**
  129115. * @hidden Internal, blurs from high to low
  129116. */
  129117. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  129118. private _depthOfFieldBlurY;
  129119. private _dofMerge;
  129120. /**
  129121. * @hidden Internal post processes in depth of field effect
  129122. */
  129123. _effects: Array<PostProcess>;
  129124. /**
  129125. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  129126. */
  129127. focalLength: number;
  129128. /**
  129129. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  129130. */
  129131. fStop: number;
  129132. /**
  129133. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  129134. */
  129135. focusDistance: number;
  129136. /**
  129137. * 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.
  129138. */
  129139. lensSize: number;
  129140. /**
  129141. * Creates a new instance DepthOfFieldEffect
  129142. * @param scene The scene the effect belongs to.
  129143. * @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.
  129144. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  129145. * @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)
  129146. */
  129147. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  129148. /**
  129149. * Get the current class name of the current effet
  129150. * @returns "DepthOfFieldEffect"
  129151. */
  129152. getClassName(): string;
  129153. /**
  129154. * 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.
  129155. */
  129156. depthTexture: RenderTargetTexture;
  129157. /**
  129158. * Disposes each of the internal effects for a given camera.
  129159. * @param camera The camera to dispose the effect on.
  129160. */
  129161. disposeEffects(camera: Camera): void;
  129162. /**
  129163. * @hidden Internal
  129164. */
  129165. _updateEffects(): void;
  129166. /**
  129167. * Internal
  129168. * @returns if all the contained post processes are ready.
  129169. * @hidden
  129170. */
  129171. _isReady(): boolean;
  129172. }
  129173. }
  129174. declare module BABYLON {
  129175. /** @hidden */
  129176. export var displayPassPixelShader: {
  129177. name: string;
  129178. shader: string;
  129179. };
  129180. }
  129181. declare module BABYLON {
  129182. /**
  129183. * DisplayPassPostProcess which produces an output the same as it's input
  129184. */
  129185. export class DisplayPassPostProcess extends PostProcess {
  129186. /**
  129187. * Creates the DisplayPassPostProcess
  129188. * @param name The name of the effect.
  129189. * @param options The required width/height ratio to downsize to before computing the render pass.
  129190. * @param camera The camera to apply the render pass to.
  129191. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129192. * @param engine The engine which the post process will be applied. (default: current engine)
  129193. * @param reusable If the post process can be reused on the same frame. (default: false)
  129194. */
  129195. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  129196. }
  129197. }
  129198. declare module BABYLON {
  129199. /** @hidden */
  129200. export var filterPixelShader: {
  129201. name: string;
  129202. shader: string;
  129203. };
  129204. }
  129205. declare module BABYLON {
  129206. /**
  129207. * Applies a kernel filter to the image
  129208. */
  129209. export class FilterPostProcess extends PostProcess {
  129210. /** The matrix to be applied to the image */
  129211. kernelMatrix: Matrix;
  129212. /**
  129213. *
  129214. * @param name The name of the effect.
  129215. * @param kernelMatrix The matrix to be applied to the image
  129216. * @param options The required width/height ratio to downsize to before computing the render pass.
  129217. * @param camera The camera to apply the render pass to.
  129218. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129219. * @param engine The engine which the post process will be applied. (default: current engine)
  129220. * @param reusable If the post process can be reused on the same frame. (default: false)
  129221. */
  129222. constructor(name: string,
  129223. /** The matrix to be applied to the image */
  129224. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  129225. }
  129226. }
  129227. declare module BABYLON {
  129228. /** @hidden */
  129229. export var fxaaPixelShader: {
  129230. name: string;
  129231. shader: string;
  129232. };
  129233. }
  129234. declare module BABYLON {
  129235. /** @hidden */
  129236. export var fxaaVertexShader: {
  129237. name: string;
  129238. shader: string;
  129239. };
  129240. }
  129241. declare module BABYLON {
  129242. /**
  129243. * Fxaa post process
  129244. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  129245. */
  129246. export class FxaaPostProcess extends PostProcess {
  129247. /** @hidden */
  129248. texelWidth: number;
  129249. /** @hidden */
  129250. texelHeight: number;
  129251. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  129252. private _getDefines;
  129253. }
  129254. }
  129255. declare module BABYLON {
  129256. /** @hidden */
  129257. export var grainPixelShader: {
  129258. name: string;
  129259. shader: string;
  129260. };
  129261. }
  129262. declare module BABYLON {
  129263. /**
  129264. * The GrainPostProcess adds noise to the image at mid luminance levels
  129265. */
  129266. export class GrainPostProcess extends PostProcess {
  129267. /**
  129268. * The intensity of the grain added (default: 30)
  129269. */
  129270. intensity: number;
  129271. /**
  129272. * If the grain should be randomized on every frame
  129273. */
  129274. animated: boolean;
  129275. /**
  129276. * Creates a new instance of @see GrainPostProcess
  129277. * @param name The name of the effect.
  129278. * @param options The required width/height ratio to downsize to before computing the render pass.
  129279. * @param camera The camera to apply the render pass to.
  129280. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129281. * @param engine The engine which the post process will be applied. (default: current engine)
  129282. * @param reusable If the post process can be reused on the same frame. (default: false)
  129283. * @param textureType Type of textures used when performing the post process. (default: 0)
  129284. * @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)
  129285. */
  129286. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129287. }
  129288. }
  129289. declare module BABYLON {
  129290. /** @hidden */
  129291. export var highlightsPixelShader: {
  129292. name: string;
  129293. shader: string;
  129294. };
  129295. }
  129296. declare module BABYLON {
  129297. /**
  129298. * Extracts highlights from the image
  129299. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  129300. */
  129301. export class HighlightsPostProcess extends PostProcess {
  129302. /**
  129303. * Extracts highlights from the image
  129304. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  129305. * @param name The name of the effect.
  129306. * @param options The required width/height ratio to downsize to before computing the render pass.
  129307. * @param camera The camera to apply the render pass to.
  129308. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129309. * @param engine The engine which the post process will be applied. (default: current engine)
  129310. * @param reusable If the post process can be reused on the same frame. (default: false)
  129311. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  129312. */
  129313. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  129314. }
  129315. }
  129316. declare module BABYLON {
  129317. /** @hidden */
  129318. export var mrtFragmentDeclaration: {
  129319. name: string;
  129320. shader: string;
  129321. };
  129322. }
  129323. declare module BABYLON {
  129324. /** @hidden */
  129325. export var geometryPixelShader: {
  129326. name: string;
  129327. shader: string;
  129328. };
  129329. }
  129330. declare module BABYLON {
  129331. /** @hidden */
  129332. export var geometryVertexShader: {
  129333. name: string;
  129334. shader: string;
  129335. };
  129336. }
  129337. declare module BABYLON {
  129338. /** @hidden */
  129339. interface ISavedTransformationMatrix {
  129340. world: Matrix;
  129341. viewProjection: Matrix;
  129342. }
  129343. /**
  129344. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  129345. */
  129346. export class GeometryBufferRenderer {
  129347. /**
  129348. * Constant used to retrieve the position texture index in the G-Buffer textures array
  129349. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  129350. */
  129351. static readonly POSITION_TEXTURE_TYPE: number;
  129352. /**
  129353. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  129354. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  129355. */
  129356. static readonly VELOCITY_TEXTURE_TYPE: number;
  129357. /**
  129358. * Dictionary used to store the previous transformation matrices of each rendered mesh
  129359. * in order to compute objects velocities when enableVelocity is set to "true"
  129360. * @hidden
  129361. */
  129362. _previousTransformationMatrices: {
  129363. [index: number]: ISavedTransformationMatrix;
  129364. };
  129365. /**
  129366. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  129367. * in order to compute objects velocities when enableVelocity is set to "true"
  129368. * @hidden
  129369. */
  129370. _previousBonesTransformationMatrices: {
  129371. [index: number]: Float32Array;
  129372. };
  129373. /**
  129374. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  129375. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  129376. */
  129377. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  129378. private _scene;
  129379. private _multiRenderTarget;
  129380. private _ratio;
  129381. private _enablePosition;
  129382. private _enableVelocity;
  129383. private _positionIndex;
  129384. private _velocityIndex;
  129385. protected _effect: Effect;
  129386. protected _cachedDefines: string;
  129387. /**
  129388. * Set the render list (meshes to be rendered) used in the G buffer.
  129389. */
  129390. renderList: Mesh[];
  129391. /**
  129392. * Gets wether or not G buffer are supported by the running hardware.
  129393. * This requires draw buffer supports
  129394. */
  129395. readonly isSupported: boolean;
  129396. /**
  129397. * Returns the index of the given texture type in the G-Buffer textures array
  129398. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  129399. * @returns the index of the given texture type in the G-Buffer textures array
  129400. */
  129401. getTextureIndex(textureType: number): number;
  129402. /**
  129403. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  129404. */
  129405. /**
  129406. * Sets whether or not objects positions are enabled for the G buffer.
  129407. */
  129408. enablePosition: boolean;
  129409. /**
  129410. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  129411. */
  129412. /**
  129413. * Sets wether or not objects velocities are enabled for the G buffer.
  129414. */
  129415. enableVelocity: boolean;
  129416. /**
  129417. * Gets the scene associated with the buffer.
  129418. */
  129419. readonly scene: Scene;
  129420. /**
  129421. * Gets the ratio used by the buffer during its creation.
  129422. * How big is the buffer related to the main canvas.
  129423. */
  129424. readonly ratio: number;
  129425. /** @hidden */
  129426. static _SceneComponentInitialization: (scene: Scene) => void;
  129427. /**
  129428. * Creates a new G Buffer for the scene
  129429. * @param scene The scene the buffer belongs to
  129430. * @param ratio How big is the buffer related to the main canvas.
  129431. */
  129432. constructor(scene: Scene, ratio?: number);
  129433. /**
  129434. * Checks wether everything is ready to render a submesh to the G buffer.
  129435. * @param subMesh the submesh to check readiness for
  129436. * @param useInstances is the mesh drawn using instance or not
  129437. * @returns true if ready otherwise false
  129438. */
  129439. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  129440. /**
  129441. * Gets the current underlying G Buffer.
  129442. * @returns the buffer
  129443. */
  129444. getGBuffer(): MultiRenderTarget;
  129445. /**
  129446. * Gets the number of samples used to render the buffer (anti aliasing).
  129447. */
  129448. /**
  129449. * Sets the number of samples used to render the buffer (anti aliasing).
  129450. */
  129451. samples: number;
  129452. /**
  129453. * Disposes the renderer and frees up associated resources.
  129454. */
  129455. dispose(): void;
  129456. protected _createRenderTargets(): void;
  129457. private _copyBonesTransformationMatrices;
  129458. }
  129459. }
  129460. declare module BABYLON {
  129461. interface Scene {
  129462. /** @hidden (Backing field) */
  129463. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  129464. /**
  129465. * Gets or Sets the current geometry buffer associated to the scene.
  129466. */
  129467. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  129468. /**
  129469. * Enables a GeometryBufferRender and associates it with the scene
  129470. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  129471. * @returns the GeometryBufferRenderer
  129472. */
  129473. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  129474. /**
  129475. * Disables the GeometryBufferRender associated with the scene
  129476. */
  129477. disableGeometryBufferRenderer(): void;
  129478. }
  129479. /**
  129480. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  129481. * in several rendering techniques.
  129482. */
  129483. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  129484. /**
  129485. * The component name helpful to identify the component in the list of scene components.
  129486. */
  129487. readonly name: string;
  129488. /**
  129489. * The scene the component belongs to.
  129490. */
  129491. scene: Scene;
  129492. /**
  129493. * Creates a new instance of the component for the given scene
  129494. * @param scene Defines the scene to register the component in
  129495. */
  129496. constructor(scene: Scene);
  129497. /**
  129498. * Registers the component in a given scene
  129499. */
  129500. register(): void;
  129501. /**
  129502. * Rebuilds the elements related to this component in case of
  129503. * context lost for instance.
  129504. */
  129505. rebuild(): void;
  129506. /**
  129507. * Disposes the component and the associated ressources
  129508. */
  129509. dispose(): void;
  129510. private _gatherRenderTargets;
  129511. }
  129512. }
  129513. declare module BABYLON {
  129514. /** @hidden */
  129515. export var motionBlurPixelShader: {
  129516. name: string;
  129517. shader: string;
  129518. };
  129519. }
  129520. declare module BABYLON {
  129521. /**
  129522. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  129523. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  129524. * As an example, all you have to do is to create the post-process:
  129525. * var mb = new BABYLON.MotionBlurPostProcess(
  129526. * 'mb', // The name of the effect.
  129527. * scene, // The scene containing the objects to blur according to their velocity.
  129528. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  129529. * camera // The camera to apply the render pass to.
  129530. * );
  129531. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  129532. */
  129533. export class MotionBlurPostProcess extends PostProcess {
  129534. /**
  129535. * Defines how much the image is blurred by the movement. Default value is equal to 1
  129536. */
  129537. motionStrength: number;
  129538. /**
  129539. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  129540. */
  129541. /**
  129542. * Sets the number of iterations to be used for motion blur quality
  129543. */
  129544. motionBlurSamples: number;
  129545. private _motionBlurSamples;
  129546. private _geometryBufferRenderer;
  129547. /**
  129548. * Creates a new instance MotionBlurPostProcess
  129549. * @param name The name of the effect.
  129550. * @param scene The scene containing the objects to blur according to their velocity.
  129551. * @param options The required width/height ratio to downsize to before computing the render pass.
  129552. * @param camera The camera to apply the render pass to.
  129553. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129554. * @param engine The engine which the post process will be applied. (default: current engine)
  129555. * @param reusable If the post process can be reused on the same frame. (default: false)
  129556. * @param textureType Type of textures used when performing the post process. (default: 0)
  129557. * @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)
  129558. */
  129559. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129560. /**
  129561. * Excludes the given skinned mesh from computing bones velocities.
  129562. * 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.
  129563. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  129564. */
  129565. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  129566. /**
  129567. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  129568. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  129569. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  129570. */
  129571. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  129572. /**
  129573. * Disposes the post process.
  129574. * @param camera The camera to dispose the post process on.
  129575. */
  129576. dispose(camera?: Camera): void;
  129577. }
  129578. }
  129579. declare module BABYLON {
  129580. /** @hidden */
  129581. export var refractionPixelShader: {
  129582. name: string;
  129583. shader: string;
  129584. };
  129585. }
  129586. declare module BABYLON {
  129587. /**
  129588. * Post process which applies a refractin texture
  129589. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  129590. */
  129591. export class RefractionPostProcess extends PostProcess {
  129592. /** the base color of the refraction (used to taint the rendering) */
  129593. color: Color3;
  129594. /** simulated refraction depth */
  129595. depth: number;
  129596. /** the coefficient of the base color (0 to remove base color tainting) */
  129597. colorLevel: number;
  129598. private _refTexture;
  129599. private _ownRefractionTexture;
  129600. /**
  129601. * Gets or sets the refraction texture
  129602. * Please note that you are responsible for disposing the texture if you set it manually
  129603. */
  129604. refractionTexture: Texture;
  129605. /**
  129606. * Initializes the RefractionPostProcess
  129607. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  129608. * @param name The name of the effect.
  129609. * @param refractionTextureUrl Url of the refraction texture to use
  129610. * @param color the base color of the refraction (used to taint the rendering)
  129611. * @param depth simulated refraction depth
  129612. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  129613. * @param camera The camera to apply the render pass to.
  129614. * @param options The required width/height ratio to downsize to before computing the render pass.
  129615. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129616. * @param engine The engine which the post process will be applied. (default: current engine)
  129617. * @param reusable If the post process can be reused on the same frame. (default: false)
  129618. */
  129619. constructor(name: string, refractionTextureUrl: string,
  129620. /** the base color of the refraction (used to taint the rendering) */
  129621. color: Color3,
  129622. /** simulated refraction depth */
  129623. depth: number,
  129624. /** the coefficient of the base color (0 to remove base color tainting) */
  129625. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  129626. /**
  129627. * Disposes of the post process
  129628. * @param camera Camera to dispose post process on
  129629. */
  129630. dispose(camera: Camera): void;
  129631. }
  129632. }
  129633. declare module BABYLON {
  129634. /** @hidden */
  129635. export var sharpenPixelShader: {
  129636. name: string;
  129637. shader: string;
  129638. };
  129639. }
  129640. declare module BABYLON {
  129641. /**
  129642. * The SharpenPostProcess applies a sharpen kernel to every pixel
  129643. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  129644. */
  129645. export class SharpenPostProcess extends PostProcess {
  129646. /**
  129647. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  129648. */
  129649. colorAmount: number;
  129650. /**
  129651. * How much sharpness should be applied (default: 0.3)
  129652. */
  129653. edgeAmount: number;
  129654. /**
  129655. * Creates a new instance ConvolutionPostProcess
  129656. * @param name The name of the effect.
  129657. * @param options The required width/height ratio to downsize to before computing the render pass.
  129658. * @param camera The camera to apply the render pass to.
  129659. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129660. * @param engine The engine which the post process will be applied. (default: current engine)
  129661. * @param reusable If the post process can be reused on the same frame. (default: false)
  129662. * @param textureType Type of textures used when performing the post process. (default: 0)
  129663. * @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)
  129664. */
  129665. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129666. }
  129667. }
  129668. declare module BABYLON {
  129669. /**
  129670. * PostProcessRenderPipeline
  129671. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129672. */
  129673. export class PostProcessRenderPipeline {
  129674. private engine;
  129675. private _renderEffects;
  129676. private _renderEffectsForIsolatedPass;
  129677. /**
  129678. * List of inspectable custom properties (used by the Inspector)
  129679. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  129680. */
  129681. inspectableCustomProperties: IInspectable[];
  129682. /**
  129683. * @hidden
  129684. */
  129685. protected _cameras: Camera[];
  129686. /** @hidden */
  129687. _name: string;
  129688. /**
  129689. * Gets pipeline name
  129690. */
  129691. readonly name: string;
  129692. /** Gets the list of attached cameras */
  129693. readonly cameras: Camera[];
  129694. /**
  129695. * Initializes a PostProcessRenderPipeline
  129696. * @param engine engine to add the pipeline to
  129697. * @param name name of the pipeline
  129698. */
  129699. constructor(engine: Engine, name: string);
  129700. /**
  129701. * Gets the class name
  129702. * @returns "PostProcessRenderPipeline"
  129703. */
  129704. getClassName(): string;
  129705. /**
  129706. * If all the render effects in the pipeline are supported
  129707. */
  129708. readonly isSupported: boolean;
  129709. /**
  129710. * Adds an effect to the pipeline
  129711. * @param renderEffect the effect to add
  129712. */
  129713. addEffect(renderEffect: PostProcessRenderEffect): void;
  129714. /** @hidden */
  129715. _rebuild(): void;
  129716. /** @hidden */
  129717. _enableEffect(renderEffectName: string, cameras: Camera): void;
  129718. /** @hidden */
  129719. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  129720. /** @hidden */
  129721. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  129722. /** @hidden */
  129723. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  129724. /** @hidden */
  129725. _attachCameras(cameras: Camera, unique: boolean): void;
  129726. /** @hidden */
  129727. _attachCameras(cameras: Camera[], unique: boolean): void;
  129728. /** @hidden */
  129729. _detachCameras(cameras: Camera): void;
  129730. /** @hidden */
  129731. _detachCameras(cameras: Nullable<Camera[]>): void;
  129732. /** @hidden */
  129733. _update(): void;
  129734. /** @hidden */
  129735. _reset(): void;
  129736. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  129737. /**
  129738. * Disposes of the pipeline
  129739. */
  129740. dispose(): void;
  129741. }
  129742. }
  129743. declare module BABYLON {
  129744. /**
  129745. * PostProcessRenderPipelineManager class
  129746. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129747. */
  129748. export class PostProcessRenderPipelineManager {
  129749. private _renderPipelines;
  129750. /**
  129751. * Initializes a PostProcessRenderPipelineManager
  129752. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129753. */
  129754. constructor();
  129755. /**
  129756. * Gets the list of supported render pipelines
  129757. */
  129758. readonly supportedPipelines: PostProcessRenderPipeline[];
  129759. /**
  129760. * Adds a pipeline to the manager
  129761. * @param renderPipeline The pipeline to add
  129762. */
  129763. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  129764. /**
  129765. * Attaches a camera to the pipeline
  129766. * @param renderPipelineName The name of the pipeline to attach to
  129767. * @param cameras the camera to attach
  129768. * @param unique if the camera can be attached multiple times to the pipeline
  129769. */
  129770. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  129771. /**
  129772. * Detaches a camera from the pipeline
  129773. * @param renderPipelineName The name of the pipeline to detach from
  129774. * @param cameras the camera to detach
  129775. */
  129776. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  129777. /**
  129778. * Enables an effect by name on a pipeline
  129779. * @param renderPipelineName the name of the pipeline to enable the effect in
  129780. * @param renderEffectName the name of the effect to enable
  129781. * @param cameras the cameras that the effect should be enabled on
  129782. */
  129783. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  129784. /**
  129785. * Disables an effect by name on a pipeline
  129786. * @param renderPipelineName the name of the pipeline to disable the effect in
  129787. * @param renderEffectName the name of the effect to disable
  129788. * @param cameras the cameras that the effect should be disabled on
  129789. */
  129790. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  129791. /**
  129792. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  129793. */
  129794. update(): void;
  129795. /** @hidden */
  129796. _rebuild(): void;
  129797. /**
  129798. * Disposes of the manager and pipelines
  129799. */
  129800. dispose(): void;
  129801. }
  129802. }
  129803. declare module BABYLON {
  129804. interface Scene {
  129805. /** @hidden (Backing field) */
  129806. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  129807. /**
  129808. * Gets the postprocess render pipeline manager
  129809. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129810. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  129811. */
  129812. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  129813. }
  129814. /**
  129815. * Defines the Render Pipeline scene component responsible to rendering pipelines
  129816. */
  129817. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  129818. /**
  129819. * The component name helpfull to identify the component in the list of scene components.
  129820. */
  129821. readonly name: string;
  129822. /**
  129823. * The scene the component belongs to.
  129824. */
  129825. scene: Scene;
  129826. /**
  129827. * Creates a new instance of the component for the given scene
  129828. * @param scene Defines the scene to register the component in
  129829. */
  129830. constructor(scene: Scene);
  129831. /**
  129832. * Registers the component in a given scene
  129833. */
  129834. register(): void;
  129835. /**
  129836. * Rebuilds the elements related to this component in case of
  129837. * context lost for instance.
  129838. */
  129839. rebuild(): void;
  129840. /**
  129841. * Disposes the component and the associated ressources
  129842. */
  129843. dispose(): void;
  129844. private _gatherRenderTargets;
  129845. }
  129846. }
  129847. declare module BABYLON {
  129848. /**
  129849. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  129850. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  129851. */
  129852. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  129853. private _scene;
  129854. private _camerasToBeAttached;
  129855. /**
  129856. * ID of the sharpen post process,
  129857. */
  129858. private readonly SharpenPostProcessId;
  129859. /**
  129860. * @ignore
  129861. * ID of the image processing post process;
  129862. */
  129863. readonly ImageProcessingPostProcessId: string;
  129864. /**
  129865. * @ignore
  129866. * ID of the Fast Approximate Anti-Aliasing post process;
  129867. */
  129868. readonly FxaaPostProcessId: string;
  129869. /**
  129870. * ID of the chromatic aberration post process,
  129871. */
  129872. private readonly ChromaticAberrationPostProcessId;
  129873. /**
  129874. * ID of the grain post process
  129875. */
  129876. private readonly GrainPostProcessId;
  129877. /**
  129878. * Sharpen post process which will apply a sharpen convolution to enhance edges
  129879. */
  129880. sharpen: SharpenPostProcess;
  129881. private _sharpenEffect;
  129882. private bloom;
  129883. /**
  129884. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  129885. */
  129886. depthOfField: DepthOfFieldEffect;
  129887. /**
  129888. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  129889. */
  129890. fxaa: FxaaPostProcess;
  129891. /**
  129892. * Image post processing pass used to perform operations such as tone mapping or color grading.
  129893. */
  129894. imageProcessing: ImageProcessingPostProcess;
  129895. /**
  129896. * Chromatic aberration post process which will shift rgb colors in the image
  129897. */
  129898. chromaticAberration: ChromaticAberrationPostProcess;
  129899. private _chromaticAberrationEffect;
  129900. /**
  129901. * Grain post process which add noise to the image
  129902. */
  129903. grain: GrainPostProcess;
  129904. private _grainEffect;
  129905. /**
  129906. * Glow post process which adds a glow to emissive areas of the image
  129907. */
  129908. private _glowLayer;
  129909. /**
  129910. * Animations which can be used to tweak settings over a period of time
  129911. */
  129912. animations: Animation[];
  129913. private _imageProcessingConfigurationObserver;
  129914. private _sharpenEnabled;
  129915. private _bloomEnabled;
  129916. private _depthOfFieldEnabled;
  129917. private _depthOfFieldBlurLevel;
  129918. private _fxaaEnabled;
  129919. private _imageProcessingEnabled;
  129920. private _defaultPipelineTextureType;
  129921. private _bloomScale;
  129922. private _chromaticAberrationEnabled;
  129923. private _grainEnabled;
  129924. private _buildAllowed;
  129925. /**
  129926. * Gets active scene
  129927. */
  129928. readonly scene: Scene;
  129929. /**
  129930. * Enable or disable the sharpen process from the pipeline
  129931. */
  129932. sharpenEnabled: boolean;
  129933. private _resizeObserver;
  129934. private _hardwareScaleLevel;
  129935. private _bloomKernel;
  129936. /**
  129937. * Specifies the size of the bloom blur kernel, relative to the final output size
  129938. */
  129939. bloomKernel: number;
  129940. /**
  129941. * Specifies the weight of the bloom in the final rendering
  129942. */
  129943. private _bloomWeight;
  129944. /**
  129945. * Specifies the luma threshold for the area that will be blurred by the bloom
  129946. */
  129947. private _bloomThreshold;
  129948. private _hdr;
  129949. /**
  129950. * The strength of the bloom.
  129951. */
  129952. bloomWeight: number;
  129953. /**
  129954. * The strength of the bloom.
  129955. */
  129956. bloomThreshold: number;
  129957. /**
  129958. * The scale of the bloom, lower value will provide better performance.
  129959. */
  129960. bloomScale: number;
  129961. /**
  129962. * Enable or disable the bloom from the pipeline
  129963. */
  129964. bloomEnabled: boolean;
  129965. private _rebuildBloom;
  129966. /**
  129967. * If the depth of field is enabled.
  129968. */
  129969. depthOfFieldEnabled: boolean;
  129970. /**
  129971. * Blur level of the depth of field effect. (Higher blur will effect performance)
  129972. */
  129973. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  129974. /**
  129975. * If the anti aliasing is enabled.
  129976. */
  129977. fxaaEnabled: boolean;
  129978. private _samples;
  129979. /**
  129980. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  129981. */
  129982. samples: number;
  129983. /**
  129984. * If image processing is enabled.
  129985. */
  129986. imageProcessingEnabled: boolean;
  129987. /**
  129988. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  129989. */
  129990. glowLayerEnabled: boolean;
  129991. /**
  129992. * Gets the glow layer (or null if not defined)
  129993. */
  129994. readonly glowLayer: Nullable<GlowLayer>;
  129995. /**
  129996. * Enable or disable the chromaticAberration process from the pipeline
  129997. */
  129998. chromaticAberrationEnabled: boolean;
  129999. /**
  130000. * Enable or disable the grain process from the pipeline
  130001. */
  130002. grainEnabled: boolean;
  130003. /**
  130004. * @constructor
  130005. * @param name - The rendering pipeline name (default: "")
  130006. * @param hdr - If high dynamic range textures should be used (default: true)
  130007. * @param scene - The scene linked to this pipeline (default: the last created scene)
  130008. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  130009. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  130010. */
  130011. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  130012. /**
  130013. * Get the class name
  130014. * @returns "DefaultRenderingPipeline"
  130015. */
  130016. getClassName(): string;
  130017. /**
  130018. * Force the compilation of the entire pipeline.
  130019. */
  130020. prepare(): void;
  130021. private _hasCleared;
  130022. private _prevPostProcess;
  130023. private _prevPrevPostProcess;
  130024. private _setAutoClearAndTextureSharing;
  130025. private _depthOfFieldSceneObserver;
  130026. private _buildPipeline;
  130027. private _disposePostProcesses;
  130028. /**
  130029. * Adds a camera to the pipeline
  130030. * @param camera the camera to be added
  130031. */
  130032. addCamera(camera: Camera): void;
  130033. /**
  130034. * Removes a camera from the pipeline
  130035. * @param camera the camera to remove
  130036. */
  130037. removeCamera(camera: Camera): void;
  130038. /**
  130039. * Dispose of the pipeline and stop all post processes
  130040. */
  130041. dispose(): void;
  130042. /**
  130043. * Serialize the rendering pipeline (Used when exporting)
  130044. * @returns the serialized object
  130045. */
  130046. serialize(): any;
  130047. /**
  130048. * Parse the serialized pipeline
  130049. * @param source Source pipeline.
  130050. * @param scene The scene to load the pipeline to.
  130051. * @param rootUrl The URL of the serialized pipeline.
  130052. * @returns An instantiated pipeline from the serialized object.
  130053. */
  130054. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  130055. }
  130056. }
  130057. declare module BABYLON {
  130058. /** @hidden */
  130059. export var lensHighlightsPixelShader: {
  130060. name: string;
  130061. shader: string;
  130062. };
  130063. }
  130064. declare module BABYLON {
  130065. /** @hidden */
  130066. export var depthOfFieldPixelShader: {
  130067. name: string;
  130068. shader: string;
  130069. };
  130070. }
  130071. declare module BABYLON {
  130072. /**
  130073. * BABYLON.JS Chromatic Aberration GLSL Shader
  130074. * Author: Olivier Guyot
  130075. * Separates very slightly R, G and B colors on the edges of the screen
  130076. * Inspired by Francois Tarlier & Martins Upitis
  130077. */
  130078. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  130079. /**
  130080. * @ignore
  130081. * The chromatic aberration PostProcess id in the pipeline
  130082. */
  130083. LensChromaticAberrationEffect: string;
  130084. /**
  130085. * @ignore
  130086. * The highlights enhancing PostProcess id in the pipeline
  130087. */
  130088. HighlightsEnhancingEffect: string;
  130089. /**
  130090. * @ignore
  130091. * The depth-of-field PostProcess id in the pipeline
  130092. */
  130093. LensDepthOfFieldEffect: string;
  130094. private _scene;
  130095. private _depthTexture;
  130096. private _grainTexture;
  130097. private _chromaticAberrationPostProcess;
  130098. private _highlightsPostProcess;
  130099. private _depthOfFieldPostProcess;
  130100. private _edgeBlur;
  130101. private _grainAmount;
  130102. private _chromaticAberration;
  130103. private _distortion;
  130104. private _highlightsGain;
  130105. private _highlightsThreshold;
  130106. private _dofDistance;
  130107. private _dofAperture;
  130108. private _dofDarken;
  130109. private _dofPentagon;
  130110. private _blurNoise;
  130111. /**
  130112. * @constructor
  130113. *
  130114. * Effect parameters are as follow:
  130115. * {
  130116. * chromatic_aberration: number; // from 0 to x (1 for realism)
  130117. * edge_blur: number; // from 0 to x (1 for realism)
  130118. * distortion: number; // from 0 to x (1 for realism)
  130119. * grain_amount: number; // from 0 to 1
  130120. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  130121. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  130122. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  130123. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  130124. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  130125. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  130126. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  130127. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  130128. * }
  130129. * Note: if an effect parameter is unset, effect is disabled
  130130. *
  130131. * @param name The rendering pipeline name
  130132. * @param parameters - An object containing all parameters (see above)
  130133. * @param scene The scene linked to this pipeline
  130134. * @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)
  130135. * @param cameras The array of cameras that the rendering pipeline will be attached to
  130136. */
  130137. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  130138. /**
  130139. * Get the class name
  130140. * @returns "LensRenderingPipeline"
  130141. */
  130142. getClassName(): string;
  130143. /**
  130144. * Gets associated scene
  130145. */
  130146. readonly scene: Scene;
  130147. /**
  130148. * Gets or sets the edge blur
  130149. */
  130150. edgeBlur: number;
  130151. /**
  130152. * Gets or sets the grain amount
  130153. */
  130154. grainAmount: number;
  130155. /**
  130156. * Gets or sets the chromatic aberration amount
  130157. */
  130158. chromaticAberration: number;
  130159. /**
  130160. * Gets or sets the depth of field aperture
  130161. */
  130162. dofAperture: number;
  130163. /**
  130164. * Gets or sets the edge distortion
  130165. */
  130166. edgeDistortion: number;
  130167. /**
  130168. * Gets or sets the depth of field distortion
  130169. */
  130170. dofDistortion: number;
  130171. /**
  130172. * Gets or sets the darken out of focus amount
  130173. */
  130174. darkenOutOfFocus: number;
  130175. /**
  130176. * Gets or sets a boolean indicating if blur noise is enabled
  130177. */
  130178. blurNoise: boolean;
  130179. /**
  130180. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  130181. */
  130182. pentagonBokeh: boolean;
  130183. /**
  130184. * Gets or sets the highlight grain amount
  130185. */
  130186. highlightsGain: number;
  130187. /**
  130188. * Gets or sets the highlight threshold
  130189. */
  130190. highlightsThreshold: number;
  130191. /**
  130192. * Sets the amount of blur at the edges
  130193. * @param amount blur amount
  130194. */
  130195. setEdgeBlur(amount: number): void;
  130196. /**
  130197. * Sets edge blur to 0
  130198. */
  130199. disableEdgeBlur(): void;
  130200. /**
  130201. * Sets the amout of grain
  130202. * @param amount Amount of grain
  130203. */
  130204. setGrainAmount(amount: number): void;
  130205. /**
  130206. * Set grain amount to 0
  130207. */
  130208. disableGrain(): void;
  130209. /**
  130210. * Sets the chromatic aberration amount
  130211. * @param amount amount of chromatic aberration
  130212. */
  130213. setChromaticAberration(amount: number): void;
  130214. /**
  130215. * Sets chromatic aberration amount to 0
  130216. */
  130217. disableChromaticAberration(): void;
  130218. /**
  130219. * Sets the EdgeDistortion amount
  130220. * @param amount amount of EdgeDistortion
  130221. */
  130222. setEdgeDistortion(amount: number): void;
  130223. /**
  130224. * Sets edge distortion to 0
  130225. */
  130226. disableEdgeDistortion(): void;
  130227. /**
  130228. * Sets the FocusDistance amount
  130229. * @param amount amount of FocusDistance
  130230. */
  130231. setFocusDistance(amount: number): void;
  130232. /**
  130233. * Disables depth of field
  130234. */
  130235. disableDepthOfField(): void;
  130236. /**
  130237. * Sets the Aperture amount
  130238. * @param amount amount of Aperture
  130239. */
  130240. setAperture(amount: number): void;
  130241. /**
  130242. * Sets the DarkenOutOfFocus amount
  130243. * @param amount amount of DarkenOutOfFocus
  130244. */
  130245. setDarkenOutOfFocus(amount: number): void;
  130246. private _pentagonBokehIsEnabled;
  130247. /**
  130248. * Creates a pentagon bokeh effect
  130249. */
  130250. enablePentagonBokeh(): void;
  130251. /**
  130252. * Disables the pentagon bokeh effect
  130253. */
  130254. disablePentagonBokeh(): void;
  130255. /**
  130256. * Enables noise blur
  130257. */
  130258. enableNoiseBlur(): void;
  130259. /**
  130260. * Disables noise blur
  130261. */
  130262. disableNoiseBlur(): void;
  130263. /**
  130264. * Sets the HighlightsGain amount
  130265. * @param amount amount of HighlightsGain
  130266. */
  130267. setHighlightsGain(amount: number): void;
  130268. /**
  130269. * Sets the HighlightsThreshold amount
  130270. * @param amount amount of HighlightsThreshold
  130271. */
  130272. setHighlightsThreshold(amount: number): void;
  130273. /**
  130274. * Disables highlights
  130275. */
  130276. disableHighlights(): void;
  130277. /**
  130278. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  130279. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  130280. */
  130281. dispose(disableDepthRender?: boolean): void;
  130282. private _createChromaticAberrationPostProcess;
  130283. private _createHighlightsPostProcess;
  130284. private _createDepthOfFieldPostProcess;
  130285. private _createGrainTexture;
  130286. }
  130287. }
  130288. declare module BABYLON {
  130289. /** @hidden */
  130290. export var ssao2PixelShader: {
  130291. name: string;
  130292. shader: string;
  130293. };
  130294. }
  130295. declare module BABYLON {
  130296. /** @hidden */
  130297. export var ssaoCombinePixelShader: {
  130298. name: string;
  130299. shader: string;
  130300. };
  130301. }
  130302. declare module BABYLON {
  130303. /**
  130304. * Render pipeline to produce ssao effect
  130305. */
  130306. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  130307. /**
  130308. * @ignore
  130309. * The PassPostProcess id in the pipeline that contains the original scene color
  130310. */
  130311. SSAOOriginalSceneColorEffect: string;
  130312. /**
  130313. * @ignore
  130314. * The SSAO PostProcess id in the pipeline
  130315. */
  130316. SSAORenderEffect: string;
  130317. /**
  130318. * @ignore
  130319. * The horizontal blur PostProcess id in the pipeline
  130320. */
  130321. SSAOBlurHRenderEffect: string;
  130322. /**
  130323. * @ignore
  130324. * The vertical blur PostProcess id in the pipeline
  130325. */
  130326. SSAOBlurVRenderEffect: string;
  130327. /**
  130328. * @ignore
  130329. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  130330. */
  130331. SSAOCombineRenderEffect: string;
  130332. /**
  130333. * The output strength of the SSAO post-process. Default value is 1.0.
  130334. */
  130335. totalStrength: number;
  130336. /**
  130337. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  130338. */
  130339. maxZ: number;
  130340. /**
  130341. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  130342. */
  130343. minZAspect: number;
  130344. private _samples;
  130345. /**
  130346. * Number of samples used for the SSAO calculations. Default value is 8
  130347. */
  130348. samples: number;
  130349. private _textureSamples;
  130350. /**
  130351. * Number of samples to use for antialiasing
  130352. */
  130353. textureSamples: number;
  130354. /**
  130355. * Ratio object used for SSAO ratio and blur ratio
  130356. */
  130357. private _ratio;
  130358. /**
  130359. * Dynamically generated sphere sampler.
  130360. */
  130361. private _sampleSphere;
  130362. /**
  130363. * Blur filter offsets
  130364. */
  130365. private _samplerOffsets;
  130366. private _expensiveBlur;
  130367. /**
  130368. * If bilateral blur should be used
  130369. */
  130370. expensiveBlur: boolean;
  130371. /**
  130372. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  130373. */
  130374. radius: number;
  130375. /**
  130376. * The base color of the SSAO post-process
  130377. * The final result is "base + ssao" between [0, 1]
  130378. */
  130379. base: number;
  130380. /**
  130381. * Support test.
  130382. */
  130383. static readonly IsSupported: boolean;
  130384. private _scene;
  130385. private _depthTexture;
  130386. private _normalTexture;
  130387. private _randomTexture;
  130388. private _originalColorPostProcess;
  130389. private _ssaoPostProcess;
  130390. private _blurHPostProcess;
  130391. private _blurVPostProcess;
  130392. private _ssaoCombinePostProcess;
  130393. /**
  130394. * Gets active scene
  130395. */
  130396. readonly scene: Scene;
  130397. /**
  130398. * @constructor
  130399. * @param name The rendering pipeline name
  130400. * @param scene The scene linked to this pipeline
  130401. * @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 }
  130402. * @param cameras The array of cameras that the rendering pipeline will be attached to
  130403. */
  130404. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  130405. /**
  130406. * Get the class name
  130407. * @returns "SSAO2RenderingPipeline"
  130408. */
  130409. getClassName(): string;
  130410. /**
  130411. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  130412. */
  130413. dispose(disableGeometryBufferRenderer?: boolean): void;
  130414. private _createBlurPostProcess;
  130415. /** @hidden */
  130416. _rebuild(): void;
  130417. private _bits;
  130418. private _radicalInverse_VdC;
  130419. private _hammersley;
  130420. private _hemisphereSample_uniform;
  130421. private _generateHemisphere;
  130422. private _createSSAOPostProcess;
  130423. private _createSSAOCombinePostProcess;
  130424. private _createRandomTexture;
  130425. /**
  130426. * Serialize the rendering pipeline (Used when exporting)
  130427. * @returns the serialized object
  130428. */
  130429. serialize(): any;
  130430. /**
  130431. * Parse the serialized pipeline
  130432. * @param source Source pipeline.
  130433. * @param scene The scene to load the pipeline to.
  130434. * @param rootUrl The URL of the serialized pipeline.
  130435. * @returns An instantiated pipeline from the serialized object.
  130436. */
  130437. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  130438. }
  130439. }
  130440. declare module BABYLON {
  130441. /** @hidden */
  130442. export var ssaoPixelShader: {
  130443. name: string;
  130444. shader: string;
  130445. };
  130446. }
  130447. declare module BABYLON {
  130448. /**
  130449. * Render pipeline to produce ssao effect
  130450. */
  130451. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  130452. /**
  130453. * @ignore
  130454. * The PassPostProcess id in the pipeline that contains the original scene color
  130455. */
  130456. SSAOOriginalSceneColorEffect: string;
  130457. /**
  130458. * @ignore
  130459. * The SSAO PostProcess id in the pipeline
  130460. */
  130461. SSAORenderEffect: string;
  130462. /**
  130463. * @ignore
  130464. * The horizontal blur PostProcess id in the pipeline
  130465. */
  130466. SSAOBlurHRenderEffect: string;
  130467. /**
  130468. * @ignore
  130469. * The vertical blur PostProcess id in the pipeline
  130470. */
  130471. SSAOBlurVRenderEffect: string;
  130472. /**
  130473. * @ignore
  130474. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  130475. */
  130476. SSAOCombineRenderEffect: string;
  130477. /**
  130478. * The output strength of the SSAO post-process. Default value is 1.0.
  130479. */
  130480. totalStrength: number;
  130481. /**
  130482. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  130483. */
  130484. radius: number;
  130485. /**
  130486. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  130487. * Must not be equal to fallOff and superior to fallOff.
  130488. * Default value is 0.0075
  130489. */
  130490. area: number;
  130491. /**
  130492. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  130493. * Must not be equal to area and inferior to area.
  130494. * Default value is 0.000001
  130495. */
  130496. fallOff: number;
  130497. /**
  130498. * The base color of the SSAO post-process
  130499. * The final result is "base + ssao" between [0, 1]
  130500. */
  130501. base: number;
  130502. private _scene;
  130503. private _depthTexture;
  130504. private _randomTexture;
  130505. private _originalColorPostProcess;
  130506. private _ssaoPostProcess;
  130507. private _blurHPostProcess;
  130508. private _blurVPostProcess;
  130509. private _ssaoCombinePostProcess;
  130510. private _firstUpdate;
  130511. /**
  130512. * Gets active scene
  130513. */
  130514. readonly scene: Scene;
  130515. /**
  130516. * @constructor
  130517. * @param name - The rendering pipeline name
  130518. * @param scene - The scene linked to this pipeline
  130519. * @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 }
  130520. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  130521. */
  130522. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  130523. /**
  130524. * Get the class name
  130525. * @returns "SSAORenderingPipeline"
  130526. */
  130527. getClassName(): string;
  130528. /**
  130529. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  130530. */
  130531. dispose(disableDepthRender?: boolean): void;
  130532. private _createBlurPostProcess;
  130533. /** @hidden */
  130534. _rebuild(): void;
  130535. private _createSSAOPostProcess;
  130536. private _createSSAOCombinePostProcess;
  130537. private _createRandomTexture;
  130538. }
  130539. }
  130540. declare module BABYLON {
  130541. /** @hidden */
  130542. export var standardPixelShader: {
  130543. name: string;
  130544. shader: string;
  130545. };
  130546. }
  130547. declare module BABYLON {
  130548. /**
  130549. * Standard rendering pipeline
  130550. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  130551. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  130552. */
  130553. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  130554. /**
  130555. * Public members
  130556. */
  130557. /**
  130558. * Post-process which contains the original scene color before the pipeline applies all the effects
  130559. */
  130560. originalPostProcess: Nullable<PostProcess>;
  130561. /**
  130562. * Post-process used to down scale an image x4
  130563. */
  130564. downSampleX4PostProcess: Nullable<PostProcess>;
  130565. /**
  130566. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  130567. */
  130568. brightPassPostProcess: Nullable<PostProcess>;
  130569. /**
  130570. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  130571. */
  130572. blurHPostProcesses: PostProcess[];
  130573. /**
  130574. * Post-process array storing all the vertical blur post-processes used by the pipeline
  130575. */
  130576. blurVPostProcesses: PostProcess[];
  130577. /**
  130578. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  130579. */
  130580. textureAdderPostProcess: Nullable<PostProcess>;
  130581. /**
  130582. * Post-process used to create volumetric lighting effect
  130583. */
  130584. volumetricLightPostProcess: Nullable<PostProcess>;
  130585. /**
  130586. * Post-process used to smooth the previous volumetric light post-process on the X axis
  130587. */
  130588. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  130589. /**
  130590. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  130591. */
  130592. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  130593. /**
  130594. * Post-process used to merge the volumetric light effect and the real scene color
  130595. */
  130596. volumetricLightMergePostProces: Nullable<PostProcess>;
  130597. /**
  130598. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  130599. */
  130600. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  130601. /**
  130602. * Base post-process used to calculate the average luminance of the final image for HDR
  130603. */
  130604. luminancePostProcess: Nullable<PostProcess>;
  130605. /**
  130606. * Post-processes used to create down sample post-processes in order to get
  130607. * the average luminance of the final image for HDR
  130608. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  130609. */
  130610. luminanceDownSamplePostProcesses: PostProcess[];
  130611. /**
  130612. * Post-process used to create a HDR effect (light adaptation)
  130613. */
  130614. hdrPostProcess: Nullable<PostProcess>;
  130615. /**
  130616. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  130617. */
  130618. textureAdderFinalPostProcess: Nullable<PostProcess>;
  130619. /**
  130620. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  130621. */
  130622. lensFlareFinalPostProcess: Nullable<PostProcess>;
  130623. /**
  130624. * Post-process used to merge the final HDR post-process and the real scene color
  130625. */
  130626. hdrFinalPostProcess: Nullable<PostProcess>;
  130627. /**
  130628. * Post-process used to create a lens flare effect
  130629. */
  130630. lensFlarePostProcess: Nullable<PostProcess>;
  130631. /**
  130632. * Post-process that merges the result of the lens flare post-process and the real scene color
  130633. */
  130634. lensFlareComposePostProcess: Nullable<PostProcess>;
  130635. /**
  130636. * Post-process used to create a motion blur effect
  130637. */
  130638. motionBlurPostProcess: Nullable<PostProcess>;
  130639. /**
  130640. * Post-process used to create a depth of field effect
  130641. */
  130642. depthOfFieldPostProcess: Nullable<PostProcess>;
  130643. /**
  130644. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  130645. */
  130646. fxaaPostProcess: Nullable<FxaaPostProcess>;
  130647. /**
  130648. * Represents the brightness threshold in order to configure the illuminated surfaces
  130649. */
  130650. brightThreshold: number;
  130651. /**
  130652. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  130653. */
  130654. blurWidth: number;
  130655. /**
  130656. * Sets if the blur for highlighted surfaces must be only horizontal
  130657. */
  130658. horizontalBlur: boolean;
  130659. /**
  130660. * Gets the overall exposure used by the pipeline
  130661. */
  130662. /**
  130663. * Sets the overall exposure used by the pipeline
  130664. */
  130665. exposure: number;
  130666. /**
  130667. * Texture used typically to simulate "dirty" on camera lens
  130668. */
  130669. lensTexture: Nullable<Texture>;
  130670. /**
  130671. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  130672. */
  130673. volumetricLightCoefficient: number;
  130674. /**
  130675. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  130676. */
  130677. volumetricLightPower: number;
  130678. /**
  130679. * Used the set the blur intensity to smooth the volumetric lights
  130680. */
  130681. volumetricLightBlurScale: number;
  130682. /**
  130683. * Light (spot or directional) used to generate the volumetric lights rays
  130684. * The source light must have a shadow generate so the pipeline can get its
  130685. * depth map
  130686. */
  130687. sourceLight: Nullable<SpotLight | DirectionalLight>;
  130688. /**
  130689. * For eye adaptation, represents the minimum luminance the eye can see
  130690. */
  130691. hdrMinimumLuminance: number;
  130692. /**
  130693. * For eye adaptation, represents the decrease luminance speed
  130694. */
  130695. hdrDecreaseRate: number;
  130696. /**
  130697. * For eye adaptation, represents the increase luminance speed
  130698. */
  130699. hdrIncreaseRate: number;
  130700. /**
  130701. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  130702. */
  130703. /**
  130704. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  130705. */
  130706. hdrAutoExposure: boolean;
  130707. /**
  130708. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  130709. */
  130710. lensColorTexture: Nullable<Texture>;
  130711. /**
  130712. * The overall strengh for the lens flare effect
  130713. */
  130714. lensFlareStrength: number;
  130715. /**
  130716. * Dispersion coefficient for lens flare ghosts
  130717. */
  130718. lensFlareGhostDispersal: number;
  130719. /**
  130720. * Main lens flare halo width
  130721. */
  130722. lensFlareHaloWidth: number;
  130723. /**
  130724. * Based on the lens distortion effect, defines how much the lens flare result
  130725. * is distorted
  130726. */
  130727. lensFlareDistortionStrength: number;
  130728. /**
  130729. * Configures the blur intensity used for for lens flare (halo)
  130730. */
  130731. lensFlareBlurWidth: number;
  130732. /**
  130733. * Lens star texture must be used to simulate rays on the flares and is available
  130734. * in the documentation
  130735. */
  130736. lensStarTexture: Nullable<Texture>;
  130737. /**
  130738. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  130739. * flare effect by taking account of the dirt texture
  130740. */
  130741. lensFlareDirtTexture: Nullable<Texture>;
  130742. /**
  130743. * Represents the focal length for the depth of field effect
  130744. */
  130745. depthOfFieldDistance: number;
  130746. /**
  130747. * Represents the blur intensity for the blurred part of the depth of field effect
  130748. */
  130749. depthOfFieldBlurWidth: number;
  130750. /**
  130751. * Gets how much the image is blurred by the movement while using the motion blur post-process
  130752. */
  130753. /**
  130754. * Sets how much the image is blurred by the movement while using the motion blur post-process
  130755. */
  130756. motionStrength: number;
  130757. /**
  130758. * Gets wether or not the motion blur post-process is object based or screen based.
  130759. */
  130760. /**
  130761. * Sets wether or not the motion blur post-process should be object based or screen based
  130762. */
  130763. objectBasedMotionBlur: boolean;
  130764. /**
  130765. * List of animations for the pipeline (IAnimatable implementation)
  130766. */
  130767. animations: Animation[];
  130768. /**
  130769. * Private members
  130770. */
  130771. private _scene;
  130772. private _currentDepthOfFieldSource;
  130773. private _basePostProcess;
  130774. private _fixedExposure;
  130775. private _currentExposure;
  130776. private _hdrAutoExposure;
  130777. private _hdrCurrentLuminance;
  130778. private _motionStrength;
  130779. private _isObjectBasedMotionBlur;
  130780. private _floatTextureType;
  130781. private _camerasToBeAttached;
  130782. private _ratio;
  130783. private _bloomEnabled;
  130784. private _depthOfFieldEnabled;
  130785. private _vlsEnabled;
  130786. private _lensFlareEnabled;
  130787. private _hdrEnabled;
  130788. private _motionBlurEnabled;
  130789. private _fxaaEnabled;
  130790. private _motionBlurSamples;
  130791. private _volumetricLightStepsCount;
  130792. private _samples;
  130793. /**
  130794. * @ignore
  130795. * Specifies if the bloom pipeline is enabled
  130796. */
  130797. BloomEnabled: boolean;
  130798. /**
  130799. * @ignore
  130800. * Specifies if the depth of field pipeline is enabed
  130801. */
  130802. DepthOfFieldEnabled: boolean;
  130803. /**
  130804. * @ignore
  130805. * Specifies if the lens flare pipeline is enabed
  130806. */
  130807. LensFlareEnabled: boolean;
  130808. /**
  130809. * @ignore
  130810. * Specifies if the HDR pipeline is enabled
  130811. */
  130812. HDREnabled: boolean;
  130813. /**
  130814. * @ignore
  130815. * Specifies if the volumetric lights scattering effect is enabled
  130816. */
  130817. VLSEnabled: boolean;
  130818. /**
  130819. * @ignore
  130820. * Specifies if the motion blur effect is enabled
  130821. */
  130822. MotionBlurEnabled: boolean;
  130823. /**
  130824. * Specifies if anti-aliasing is enabled
  130825. */
  130826. fxaaEnabled: boolean;
  130827. /**
  130828. * Specifies the number of steps used to calculate the volumetric lights
  130829. * Typically in interval [50, 200]
  130830. */
  130831. volumetricLightStepsCount: number;
  130832. /**
  130833. * Specifies the number of samples used for the motion blur effect
  130834. * Typically in interval [16, 64]
  130835. */
  130836. motionBlurSamples: number;
  130837. /**
  130838. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  130839. */
  130840. samples: number;
  130841. /**
  130842. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  130843. * @constructor
  130844. * @param name The rendering pipeline name
  130845. * @param scene The scene linked to this pipeline
  130846. * @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)
  130847. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  130848. * @param cameras The array of cameras that the rendering pipeline will be attached to
  130849. */
  130850. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  130851. private _buildPipeline;
  130852. private _createDownSampleX4PostProcess;
  130853. private _createBrightPassPostProcess;
  130854. private _createBlurPostProcesses;
  130855. private _createTextureAdderPostProcess;
  130856. private _createVolumetricLightPostProcess;
  130857. private _createLuminancePostProcesses;
  130858. private _createHdrPostProcess;
  130859. private _createLensFlarePostProcess;
  130860. private _createDepthOfFieldPostProcess;
  130861. private _createMotionBlurPostProcess;
  130862. private _getDepthTexture;
  130863. private _disposePostProcesses;
  130864. /**
  130865. * Dispose of the pipeline and stop all post processes
  130866. */
  130867. dispose(): void;
  130868. /**
  130869. * Serialize the rendering pipeline (Used when exporting)
  130870. * @returns the serialized object
  130871. */
  130872. serialize(): any;
  130873. /**
  130874. * Parse the serialized pipeline
  130875. * @param source Source pipeline.
  130876. * @param scene The scene to load the pipeline to.
  130877. * @param rootUrl The URL of the serialized pipeline.
  130878. * @returns An instantiated pipeline from the serialized object.
  130879. */
  130880. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  130881. /**
  130882. * Luminance steps
  130883. */
  130884. static LuminanceSteps: number;
  130885. }
  130886. }
  130887. declare module BABYLON {
  130888. /** @hidden */
  130889. export var tonemapPixelShader: {
  130890. name: string;
  130891. shader: string;
  130892. };
  130893. }
  130894. declare module BABYLON {
  130895. /** Defines operator used for tonemapping */
  130896. export enum TonemappingOperator {
  130897. /** Hable */
  130898. Hable = 0,
  130899. /** Reinhard */
  130900. Reinhard = 1,
  130901. /** HejiDawson */
  130902. HejiDawson = 2,
  130903. /** Photographic */
  130904. Photographic = 3
  130905. }
  130906. /**
  130907. * Defines a post process to apply tone mapping
  130908. */
  130909. export class TonemapPostProcess extends PostProcess {
  130910. private _operator;
  130911. /** Defines the required exposure adjustement */
  130912. exposureAdjustment: number;
  130913. /**
  130914. * Creates a new TonemapPostProcess
  130915. * @param name defines the name of the postprocess
  130916. * @param _operator defines the operator to use
  130917. * @param exposureAdjustment defines the required exposure adjustement
  130918. * @param camera defines the camera to use (can be null)
  130919. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  130920. * @param engine defines the hosting engine (can be ignore if camera is set)
  130921. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  130922. */
  130923. constructor(name: string, _operator: TonemappingOperator,
  130924. /** Defines the required exposure adjustement */
  130925. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  130926. }
  130927. }
  130928. declare module BABYLON {
  130929. /** @hidden */
  130930. export var depthVertexShader: {
  130931. name: string;
  130932. shader: string;
  130933. };
  130934. }
  130935. declare module BABYLON {
  130936. /** @hidden */
  130937. export var volumetricLightScatteringPixelShader: {
  130938. name: string;
  130939. shader: string;
  130940. };
  130941. }
  130942. declare module BABYLON {
  130943. /** @hidden */
  130944. export var volumetricLightScatteringPassVertexShader: {
  130945. name: string;
  130946. shader: string;
  130947. };
  130948. }
  130949. declare module BABYLON {
  130950. /** @hidden */
  130951. export var volumetricLightScatteringPassPixelShader: {
  130952. name: string;
  130953. shader: string;
  130954. };
  130955. }
  130956. declare module BABYLON {
  130957. /**
  130958. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  130959. */
  130960. export class VolumetricLightScatteringPostProcess extends PostProcess {
  130961. private _volumetricLightScatteringPass;
  130962. private _volumetricLightScatteringRTT;
  130963. private _viewPort;
  130964. private _screenCoordinates;
  130965. private _cachedDefines;
  130966. /**
  130967. * If not undefined, the mesh position is computed from the attached node position
  130968. */
  130969. attachedNode: {
  130970. position: Vector3;
  130971. };
  130972. /**
  130973. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  130974. */
  130975. customMeshPosition: Vector3;
  130976. /**
  130977. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  130978. */
  130979. useCustomMeshPosition: boolean;
  130980. /**
  130981. * If the post-process should inverse the light scattering direction
  130982. */
  130983. invert: boolean;
  130984. /**
  130985. * The internal mesh used by the post-process
  130986. */
  130987. mesh: Mesh;
  130988. /**
  130989. * @hidden
  130990. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  130991. */
  130992. useDiffuseColor: boolean;
  130993. /**
  130994. * Array containing the excluded meshes not rendered in the internal pass
  130995. */
  130996. excludedMeshes: AbstractMesh[];
  130997. /**
  130998. * Controls the overall intensity of the post-process
  130999. */
  131000. exposure: number;
  131001. /**
  131002. * Dissipates each sample's contribution in range [0, 1]
  131003. */
  131004. decay: number;
  131005. /**
  131006. * Controls the overall intensity of each sample
  131007. */
  131008. weight: number;
  131009. /**
  131010. * Controls the density of each sample
  131011. */
  131012. density: number;
  131013. /**
  131014. * @constructor
  131015. * @param name The post-process name
  131016. * @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)
  131017. * @param camera The camera that the post-process will be attached to
  131018. * @param mesh The mesh used to create the light scattering
  131019. * @param samples The post-process quality, default 100
  131020. * @param samplingModeThe post-process filtering mode
  131021. * @param engine The babylon engine
  131022. * @param reusable If the post-process is reusable
  131023. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  131024. */
  131025. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  131026. /**
  131027. * Returns the string "VolumetricLightScatteringPostProcess"
  131028. * @returns "VolumetricLightScatteringPostProcess"
  131029. */
  131030. getClassName(): string;
  131031. private _isReady;
  131032. /**
  131033. * Sets the new light position for light scattering effect
  131034. * @param position The new custom light position
  131035. */
  131036. setCustomMeshPosition(position: Vector3): void;
  131037. /**
  131038. * Returns the light position for light scattering effect
  131039. * @return Vector3 The custom light position
  131040. */
  131041. getCustomMeshPosition(): Vector3;
  131042. /**
  131043. * Disposes the internal assets and detaches the post-process from the camera
  131044. */
  131045. dispose(camera: Camera): void;
  131046. /**
  131047. * Returns the render target texture used by the post-process
  131048. * @return the render target texture used by the post-process
  131049. */
  131050. getPass(): RenderTargetTexture;
  131051. private _meshExcluded;
  131052. private _createPass;
  131053. private _updateMeshScreenCoordinates;
  131054. /**
  131055. * Creates a default mesh for the Volumeric Light Scattering post-process
  131056. * @param name The mesh name
  131057. * @param scene The scene where to create the mesh
  131058. * @return the default mesh
  131059. */
  131060. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  131061. }
  131062. }
  131063. declare module BABYLON {
  131064. interface Scene {
  131065. /** @hidden (Backing field) */
  131066. _boundingBoxRenderer: BoundingBoxRenderer;
  131067. /** @hidden (Backing field) */
  131068. _forceShowBoundingBoxes: boolean;
  131069. /**
  131070. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  131071. */
  131072. forceShowBoundingBoxes: boolean;
  131073. /**
  131074. * Gets the bounding box renderer associated with the scene
  131075. * @returns a BoundingBoxRenderer
  131076. */
  131077. getBoundingBoxRenderer(): BoundingBoxRenderer;
  131078. }
  131079. interface AbstractMesh {
  131080. /** @hidden (Backing field) */
  131081. _showBoundingBox: boolean;
  131082. /**
  131083. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  131084. */
  131085. showBoundingBox: boolean;
  131086. }
  131087. /**
  131088. * Component responsible of rendering the bounding box of the meshes in a scene.
  131089. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  131090. */
  131091. export class BoundingBoxRenderer implements ISceneComponent {
  131092. /**
  131093. * The component name helpfull to identify the component in the list of scene components.
  131094. */
  131095. readonly name: string;
  131096. /**
  131097. * The scene the component belongs to.
  131098. */
  131099. scene: Scene;
  131100. /**
  131101. * Color of the bounding box lines placed in front of an object
  131102. */
  131103. frontColor: Color3;
  131104. /**
  131105. * Color of the bounding box lines placed behind an object
  131106. */
  131107. backColor: Color3;
  131108. /**
  131109. * Defines if the renderer should show the back lines or not
  131110. */
  131111. showBackLines: boolean;
  131112. /**
  131113. * @hidden
  131114. */
  131115. renderList: SmartArray<BoundingBox>;
  131116. private _colorShader;
  131117. private _vertexBuffers;
  131118. private _indexBuffer;
  131119. private _fillIndexBuffer;
  131120. private _fillIndexData;
  131121. /**
  131122. * Instantiates a new bounding box renderer in a scene.
  131123. * @param scene the scene the renderer renders in
  131124. */
  131125. constructor(scene: Scene);
  131126. /**
  131127. * Registers the component in a given scene
  131128. */
  131129. register(): void;
  131130. private _evaluateSubMesh;
  131131. private _activeMesh;
  131132. private _prepareRessources;
  131133. private _createIndexBuffer;
  131134. /**
  131135. * Rebuilds the elements related to this component in case of
  131136. * context lost for instance.
  131137. */
  131138. rebuild(): void;
  131139. /**
  131140. * @hidden
  131141. */
  131142. reset(): void;
  131143. /**
  131144. * Render the bounding boxes of a specific rendering group
  131145. * @param renderingGroupId defines the rendering group to render
  131146. */
  131147. render(renderingGroupId: number): void;
  131148. /**
  131149. * In case of occlusion queries, we can render the occlusion bounding box through this method
  131150. * @param mesh Define the mesh to render the occlusion bounding box for
  131151. */
  131152. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  131153. /**
  131154. * Dispose and release the resources attached to this renderer.
  131155. */
  131156. dispose(): void;
  131157. }
  131158. }
  131159. declare module BABYLON {
  131160. /** @hidden */
  131161. export var depthPixelShader: {
  131162. name: string;
  131163. shader: string;
  131164. };
  131165. }
  131166. declare module BABYLON {
  131167. /**
  131168. * This represents a depth renderer in Babylon.
  131169. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  131170. */
  131171. export class DepthRenderer {
  131172. private _scene;
  131173. private _depthMap;
  131174. private _effect;
  131175. private readonly _storeNonLinearDepth;
  131176. private readonly _clearColor;
  131177. /** Get if the depth renderer is using packed depth or not */
  131178. readonly isPacked: boolean;
  131179. private _cachedDefines;
  131180. private _camera;
  131181. /**
  131182. * Specifiess that the depth renderer will only be used within
  131183. * the camera it is created for.
  131184. * This can help forcing its rendering during the camera processing.
  131185. */
  131186. useOnlyInActiveCamera: boolean;
  131187. /** @hidden */
  131188. static _SceneComponentInitialization: (scene: Scene) => void;
  131189. /**
  131190. * Instantiates a depth renderer
  131191. * @param scene The scene the renderer belongs to
  131192. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  131193. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  131194. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  131195. */
  131196. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  131197. /**
  131198. * Creates the depth rendering effect and checks if the effect is ready.
  131199. * @param subMesh The submesh to be used to render the depth map of
  131200. * @param useInstances If multiple world instances should be used
  131201. * @returns if the depth renderer is ready to render the depth map
  131202. */
  131203. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  131204. /**
  131205. * Gets the texture which the depth map will be written to.
  131206. * @returns The depth map texture
  131207. */
  131208. getDepthMap(): RenderTargetTexture;
  131209. /**
  131210. * Disposes of the depth renderer.
  131211. */
  131212. dispose(): void;
  131213. }
  131214. }
  131215. declare module BABYLON {
  131216. interface Scene {
  131217. /** @hidden (Backing field) */
  131218. _depthRenderer: {
  131219. [id: string]: DepthRenderer;
  131220. };
  131221. /**
  131222. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  131223. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  131224. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  131225. * @returns the created depth renderer
  131226. */
  131227. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  131228. /**
  131229. * Disables a depth renderer for a given camera
  131230. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  131231. */
  131232. disableDepthRenderer(camera?: Nullable<Camera>): void;
  131233. }
  131234. /**
  131235. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  131236. * in several rendering techniques.
  131237. */
  131238. export class DepthRendererSceneComponent implements ISceneComponent {
  131239. /**
  131240. * The component name helpfull to identify the component in the list of scene components.
  131241. */
  131242. readonly name: string;
  131243. /**
  131244. * The scene the component belongs to.
  131245. */
  131246. scene: Scene;
  131247. /**
  131248. * Creates a new instance of the component for the given scene
  131249. * @param scene Defines the scene to register the component in
  131250. */
  131251. constructor(scene: Scene);
  131252. /**
  131253. * Registers the component in a given scene
  131254. */
  131255. register(): void;
  131256. /**
  131257. * Rebuilds the elements related to this component in case of
  131258. * context lost for instance.
  131259. */
  131260. rebuild(): void;
  131261. /**
  131262. * Disposes the component and the associated ressources
  131263. */
  131264. dispose(): void;
  131265. private _gatherRenderTargets;
  131266. private _gatherActiveCameraRenderTargets;
  131267. }
  131268. }
  131269. declare module BABYLON {
  131270. /** @hidden */
  131271. export var outlinePixelShader: {
  131272. name: string;
  131273. shader: string;
  131274. };
  131275. }
  131276. declare module BABYLON {
  131277. /** @hidden */
  131278. export var outlineVertexShader: {
  131279. name: string;
  131280. shader: string;
  131281. };
  131282. }
  131283. declare module BABYLON {
  131284. interface Scene {
  131285. /** @hidden */
  131286. _outlineRenderer: OutlineRenderer;
  131287. /**
  131288. * Gets the outline renderer associated with the scene
  131289. * @returns a OutlineRenderer
  131290. */
  131291. getOutlineRenderer(): OutlineRenderer;
  131292. }
  131293. interface AbstractMesh {
  131294. /** @hidden (Backing field) */
  131295. _renderOutline: boolean;
  131296. /**
  131297. * Gets or sets a boolean indicating if the outline must be rendered as well
  131298. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  131299. */
  131300. renderOutline: boolean;
  131301. /** @hidden (Backing field) */
  131302. _renderOverlay: boolean;
  131303. /**
  131304. * Gets or sets a boolean indicating if the overlay must be rendered as well
  131305. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  131306. */
  131307. renderOverlay: boolean;
  131308. }
  131309. /**
  131310. * This class is responsible to draw bothe outline/overlay of meshes.
  131311. * It should not be used directly but through the available method on mesh.
  131312. */
  131313. export class OutlineRenderer implements ISceneComponent {
  131314. /**
  131315. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  131316. */
  131317. private static _StencilReference;
  131318. /**
  131319. * The name of the component. Each component must have a unique name.
  131320. */
  131321. name: string;
  131322. /**
  131323. * The scene the component belongs to.
  131324. */
  131325. scene: Scene;
  131326. /**
  131327. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  131328. */
  131329. zOffset: number;
  131330. private _engine;
  131331. private _effect;
  131332. private _cachedDefines;
  131333. private _savedDepthWrite;
  131334. /**
  131335. * Instantiates a new outline renderer. (There could be only one per scene).
  131336. * @param scene Defines the scene it belongs to
  131337. */
  131338. constructor(scene: Scene);
  131339. /**
  131340. * Register the component to one instance of a scene.
  131341. */
  131342. register(): void;
  131343. /**
  131344. * Rebuilds the elements related to this component in case of
  131345. * context lost for instance.
  131346. */
  131347. rebuild(): void;
  131348. /**
  131349. * Disposes the component and the associated ressources.
  131350. */
  131351. dispose(): void;
  131352. /**
  131353. * Renders the outline in the canvas.
  131354. * @param subMesh Defines the sumesh to render
  131355. * @param batch Defines the batch of meshes in case of instances
  131356. * @param useOverlay Defines if the rendering is for the overlay or the outline
  131357. */
  131358. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  131359. /**
  131360. * Returns whether or not the outline renderer is ready for a given submesh.
  131361. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  131362. * @param subMesh Defines the submesh to check readyness for
  131363. * @param useInstances Defines wheter wee are trying to render instances or not
  131364. * @returns true if ready otherwise false
  131365. */
  131366. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  131367. private _beforeRenderingMesh;
  131368. private _afterRenderingMesh;
  131369. }
  131370. }
  131371. declare module BABYLON {
  131372. /**
  131373. * Class used to manage multiple sprites of different sizes on the same spritesheet
  131374. * @see http://doc.babylonjs.com/babylon101/sprites
  131375. */
  131376. export class SpritePackedManager extends SpriteManager {
  131377. /** defines the packed manager's name */
  131378. name: string;
  131379. /**
  131380. * Creates a new sprite manager from a packed sprite sheet
  131381. * @param name defines the manager's name
  131382. * @param imgUrl defines the sprite sheet url
  131383. * @param capacity defines the maximum allowed number of sprites
  131384. * @param scene defines the hosting scene
  131385. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  131386. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  131387. * @param samplingMode defines the smapling mode to use with spritesheet
  131388. * @param fromPacked set to true; do not alter
  131389. */
  131390. constructor(
  131391. /** defines the packed manager's name */
  131392. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  131393. }
  131394. }
  131395. declare module BABYLON {
  131396. /**
  131397. * Defines the list of states available for a task inside a AssetsManager
  131398. */
  131399. export enum AssetTaskState {
  131400. /**
  131401. * Initialization
  131402. */
  131403. INIT = 0,
  131404. /**
  131405. * Running
  131406. */
  131407. RUNNING = 1,
  131408. /**
  131409. * Done
  131410. */
  131411. DONE = 2,
  131412. /**
  131413. * Error
  131414. */
  131415. ERROR = 3
  131416. }
  131417. /**
  131418. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  131419. */
  131420. export abstract class AbstractAssetTask {
  131421. /**
  131422. * Task name
  131423. */ name: string;
  131424. /**
  131425. * Callback called when the task is successful
  131426. */
  131427. onSuccess: (task: any) => void;
  131428. /**
  131429. * Callback called when the task is not successful
  131430. */
  131431. onError: (task: any, message?: string, exception?: any) => void;
  131432. /**
  131433. * Creates a new AssetsManager
  131434. * @param name defines the name of the task
  131435. */
  131436. constructor(
  131437. /**
  131438. * Task name
  131439. */ name: string);
  131440. private _isCompleted;
  131441. private _taskState;
  131442. private _errorObject;
  131443. /**
  131444. * Get if the task is completed
  131445. */
  131446. readonly isCompleted: boolean;
  131447. /**
  131448. * Gets the current state of the task
  131449. */
  131450. readonly taskState: AssetTaskState;
  131451. /**
  131452. * Gets the current error object (if task is in error)
  131453. */
  131454. readonly errorObject: {
  131455. message?: string;
  131456. exception?: any;
  131457. };
  131458. /**
  131459. * Internal only
  131460. * @hidden
  131461. */
  131462. _setErrorObject(message?: string, exception?: any): void;
  131463. /**
  131464. * Execute the current task
  131465. * @param scene defines the scene where you want your assets to be loaded
  131466. * @param onSuccess is a callback called when the task is successfully executed
  131467. * @param onError is a callback called if an error occurs
  131468. */
  131469. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131470. /**
  131471. * Execute the current task
  131472. * @param scene defines the scene where you want your assets to be loaded
  131473. * @param onSuccess is a callback called when the task is successfully executed
  131474. * @param onError is a callback called if an error occurs
  131475. */
  131476. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131477. /**
  131478. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  131479. * This can be used with failed tasks that have the reason for failure fixed.
  131480. */
  131481. reset(): void;
  131482. private onErrorCallback;
  131483. private onDoneCallback;
  131484. }
  131485. /**
  131486. * Define the interface used by progress events raised during assets loading
  131487. */
  131488. export interface IAssetsProgressEvent {
  131489. /**
  131490. * Defines the number of remaining tasks to process
  131491. */
  131492. remainingCount: number;
  131493. /**
  131494. * Defines the total number of tasks
  131495. */
  131496. totalCount: number;
  131497. /**
  131498. * Defines the task that was just processed
  131499. */
  131500. task: AbstractAssetTask;
  131501. }
  131502. /**
  131503. * Class used to share progress information about assets loading
  131504. */
  131505. export class AssetsProgressEvent implements IAssetsProgressEvent {
  131506. /**
  131507. * Defines the number of remaining tasks to process
  131508. */
  131509. remainingCount: number;
  131510. /**
  131511. * Defines the total number of tasks
  131512. */
  131513. totalCount: number;
  131514. /**
  131515. * Defines the task that was just processed
  131516. */
  131517. task: AbstractAssetTask;
  131518. /**
  131519. * Creates a AssetsProgressEvent
  131520. * @param remainingCount defines the number of remaining tasks to process
  131521. * @param totalCount defines the total number of tasks
  131522. * @param task defines the task that was just processed
  131523. */
  131524. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  131525. }
  131526. /**
  131527. * Define a task used by AssetsManager to load meshes
  131528. */
  131529. export class MeshAssetTask extends AbstractAssetTask {
  131530. /**
  131531. * Defines the name of the task
  131532. */
  131533. name: string;
  131534. /**
  131535. * Defines the list of mesh's names you want to load
  131536. */
  131537. meshesNames: any;
  131538. /**
  131539. * Defines the root url to use as a base to load your meshes and associated resources
  131540. */
  131541. rootUrl: string;
  131542. /**
  131543. * Defines the filename of the scene to load from
  131544. */
  131545. sceneFilename: string;
  131546. /**
  131547. * Gets the list of loaded meshes
  131548. */
  131549. loadedMeshes: Array<AbstractMesh>;
  131550. /**
  131551. * Gets the list of loaded particle systems
  131552. */
  131553. loadedParticleSystems: Array<IParticleSystem>;
  131554. /**
  131555. * Gets the list of loaded skeletons
  131556. */
  131557. loadedSkeletons: Array<Skeleton>;
  131558. /**
  131559. * Gets the list of loaded animation groups
  131560. */
  131561. loadedAnimationGroups: Array<AnimationGroup>;
  131562. /**
  131563. * Callback called when the task is successful
  131564. */
  131565. onSuccess: (task: MeshAssetTask) => void;
  131566. /**
  131567. * Callback called when the task is successful
  131568. */
  131569. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  131570. /**
  131571. * Creates a new MeshAssetTask
  131572. * @param name defines the name of the task
  131573. * @param meshesNames defines the list of mesh's names you want to load
  131574. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  131575. * @param sceneFilename defines the filename of the scene to load from
  131576. */
  131577. constructor(
  131578. /**
  131579. * Defines the name of the task
  131580. */
  131581. name: string,
  131582. /**
  131583. * Defines the list of mesh's names you want to load
  131584. */
  131585. meshesNames: any,
  131586. /**
  131587. * Defines the root url to use as a base to load your meshes and associated resources
  131588. */
  131589. rootUrl: string,
  131590. /**
  131591. * Defines the filename of the scene to load from
  131592. */
  131593. sceneFilename: string);
  131594. /**
  131595. * Execute the current task
  131596. * @param scene defines the scene where you want your assets to be loaded
  131597. * @param onSuccess is a callback called when the task is successfully executed
  131598. * @param onError is a callback called if an error occurs
  131599. */
  131600. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131601. }
  131602. /**
  131603. * Define a task used by AssetsManager to load text content
  131604. */
  131605. export class TextFileAssetTask extends AbstractAssetTask {
  131606. /**
  131607. * Defines the name of the task
  131608. */
  131609. name: string;
  131610. /**
  131611. * Defines the location of the file to load
  131612. */
  131613. url: string;
  131614. /**
  131615. * Gets the loaded text string
  131616. */
  131617. text: string;
  131618. /**
  131619. * Callback called when the task is successful
  131620. */
  131621. onSuccess: (task: TextFileAssetTask) => void;
  131622. /**
  131623. * Callback called when the task is successful
  131624. */
  131625. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  131626. /**
  131627. * Creates a new TextFileAssetTask object
  131628. * @param name defines the name of the task
  131629. * @param url defines the location of the file to load
  131630. */
  131631. constructor(
  131632. /**
  131633. * Defines the name of the task
  131634. */
  131635. name: string,
  131636. /**
  131637. * Defines the location of the file to load
  131638. */
  131639. url: string);
  131640. /**
  131641. * Execute the current task
  131642. * @param scene defines the scene where you want your assets to be loaded
  131643. * @param onSuccess is a callback called when the task is successfully executed
  131644. * @param onError is a callback called if an error occurs
  131645. */
  131646. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131647. }
  131648. /**
  131649. * Define a task used by AssetsManager to load binary data
  131650. */
  131651. export class BinaryFileAssetTask extends AbstractAssetTask {
  131652. /**
  131653. * Defines the name of the task
  131654. */
  131655. name: string;
  131656. /**
  131657. * Defines the location of the file to load
  131658. */
  131659. url: string;
  131660. /**
  131661. * Gets the lodaded data (as an array buffer)
  131662. */
  131663. data: ArrayBuffer;
  131664. /**
  131665. * Callback called when the task is successful
  131666. */
  131667. onSuccess: (task: BinaryFileAssetTask) => void;
  131668. /**
  131669. * Callback called when the task is successful
  131670. */
  131671. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  131672. /**
  131673. * Creates a new BinaryFileAssetTask object
  131674. * @param name defines the name of the new task
  131675. * @param url defines the location of the file to load
  131676. */
  131677. constructor(
  131678. /**
  131679. * Defines the name of the task
  131680. */
  131681. name: string,
  131682. /**
  131683. * Defines the location of the file to load
  131684. */
  131685. url: string);
  131686. /**
  131687. * Execute the current task
  131688. * @param scene defines the scene where you want your assets to be loaded
  131689. * @param onSuccess is a callback called when the task is successfully executed
  131690. * @param onError is a callback called if an error occurs
  131691. */
  131692. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131693. }
  131694. /**
  131695. * Define a task used by AssetsManager to load images
  131696. */
  131697. export class ImageAssetTask extends AbstractAssetTask {
  131698. /**
  131699. * Defines the name of the task
  131700. */
  131701. name: string;
  131702. /**
  131703. * Defines the location of the image to load
  131704. */
  131705. url: string;
  131706. /**
  131707. * Gets the loaded images
  131708. */
  131709. image: HTMLImageElement;
  131710. /**
  131711. * Callback called when the task is successful
  131712. */
  131713. onSuccess: (task: ImageAssetTask) => void;
  131714. /**
  131715. * Callback called when the task is successful
  131716. */
  131717. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  131718. /**
  131719. * Creates a new ImageAssetTask
  131720. * @param name defines the name of the task
  131721. * @param url defines the location of the image to load
  131722. */
  131723. constructor(
  131724. /**
  131725. * Defines the name of the task
  131726. */
  131727. name: string,
  131728. /**
  131729. * Defines the location of the image to load
  131730. */
  131731. url: string);
  131732. /**
  131733. * Execute the current task
  131734. * @param scene defines the scene where you want your assets to be loaded
  131735. * @param onSuccess is a callback called when the task is successfully executed
  131736. * @param onError is a callback called if an error occurs
  131737. */
  131738. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131739. }
  131740. /**
  131741. * Defines the interface used by texture loading tasks
  131742. */
  131743. export interface ITextureAssetTask<TEX extends BaseTexture> {
  131744. /**
  131745. * Gets the loaded texture
  131746. */
  131747. texture: TEX;
  131748. }
  131749. /**
  131750. * Define a task used by AssetsManager to load 2D textures
  131751. */
  131752. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  131753. /**
  131754. * Defines the name of the task
  131755. */
  131756. name: string;
  131757. /**
  131758. * Defines the location of the file to load
  131759. */
  131760. url: string;
  131761. /**
  131762. * Defines if mipmap should not be generated (default is false)
  131763. */
  131764. noMipmap?: boolean | undefined;
  131765. /**
  131766. * Defines if texture must be inverted on Y axis (default is false)
  131767. */
  131768. invertY?: boolean | undefined;
  131769. /**
  131770. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131771. */
  131772. samplingMode: number;
  131773. /**
  131774. * Gets the loaded texture
  131775. */
  131776. texture: Texture;
  131777. /**
  131778. * Callback called when the task is successful
  131779. */
  131780. onSuccess: (task: TextureAssetTask) => void;
  131781. /**
  131782. * Callback called when the task is successful
  131783. */
  131784. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  131785. /**
  131786. * Creates a new TextureAssetTask object
  131787. * @param name defines the name of the task
  131788. * @param url defines the location of the file to load
  131789. * @param noMipmap defines if mipmap should not be generated (default is false)
  131790. * @param invertY defines if texture must be inverted on Y axis (default is false)
  131791. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131792. */
  131793. constructor(
  131794. /**
  131795. * Defines the name of the task
  131796. */
  131797. name: string,
  131798. /**
  131799. * Defines the location of the file to load
  131800. */
  131801. url: string,
  131802. /**
  131803. * Defines if mipmap should not be generated (default is false)
  131804. */
  131805. noMipmap?: boolean | undefined,
  131806. /**
  131807. * Defines if texture must be inverted on Y axis (default is false)
  131808. */
  131809. invertY?: boolean | undefined,
  131810. /**
  131811. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131812. */
  131813. samplingMode?: number);
  131814. /**
  131815. * Execute the current task
  131816. * @param scene defines the scene where you want your assets to be loaded
  131817. * @param onSuccess is a callback called when the task is successfully executed
  131818. * @param onError is a callback called if an error occurs
  131819. */
  131820. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131821. }
  131822. /**
  131823. * Define a task used by AssetsManager to load cube textures
  131824. */
  131825. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  131826. /**
  131827. * Defines the name of the task
  131828. */
  131829. name: string;
  131830. /**
  131831. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131832. */
  131833. url: string;
  131834. /**
  131835. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131836. */
  131837. extensions?: string[] | undefined;
  131838. /**
  131839. * Defines if mipmaps should not be generated (default is false)
  131840. */
  131841. noMipmap?: boolean | undefined;
  131842. /**
  131843. * Defines the explicit list of files (undefined by default)
  131844. */
  131845. files?: string[] | undefined;
  131846. /**
  131847. * Gets the loaded texture
  131848. */
  131849. texture: CubeTexture;
  131850. /**
  131851. * Callback called when the task is successful
  131852. */
  131853. onSuccess: (task: CubeTextureAssetTask) => void;
  131854. /**
  131855. * Callback called when the task is successful
  131856. */
  131857. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  131858. /**
  131859. * Creates a new CubeTextureAssetTask
  131860. * @param name defines the name of the task
  131861. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131862. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131863. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131864. * @param files defines the explicit list of files (undefined by default)
  131865. */
  131866. constructor(
  131867. /**
  131868. * Defines the name of the task
  131869. */
  131870. name: string,
  131871. /**
  131872. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131873. */
  131874. url: string,
  131875. /**
  131876. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131877. */
  131878. extensions?: string[] | undefined,
  131879. /**
  131880. * Defines if mipmaps should not be generated (default is false)
  131881. */
  131882. noMipmap?: boolean | undefined,
  131883. /**
  131884. * Defines the explicit list of files (undefined by default)
  131885. */
  131886. files?: string[] | undefined);
  131887. /**
  131888. * Execute the current task
  131889. * @param scene defines the scene where you want your assets to be loaded
  131890. * @param onSuccess is a callback called when the task is successfully executed
  131891. * @param onError is a callback called if an error occurs
  131892. */
  131893. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131894. }
  131895. /**
  131896. * Define a task used by AssetsManager to load HDR cube textures
  131897. */
  131898. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  131899. /**
  131900. * Defines the name of the task
  131901. */
  131902. name: string;
  131903. /**
  131904. * Defines the location of the file to load
  131905. */
  131906. url: string;
  131907. /**
  131908. * Defines the desired size (the more it increases the longer the generation will be)
  131909. */
  131910. size: number;
  131911. /**
  131912. * Defines if mipmaps should not be generated (default is false)
  131913. */
  131914. noMipmap: boolean;
  131915. /**
  131916. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131917. */
  131918. generateHarmonics: boolean;
  131919. /**
  131920. * 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)
  131921. */
  131922. gammaSpace: boolean;
  131923. /**
  131924. * Internal Use Only
  131925. */
  131926. reserved: boolean;
  131927. /**
  131928. * Gets the loaded texture
  131929. */
  131930. texture: HDRCubeTexture;
  131931. /**
  131932. * Callback called when the task is successful
  131933. */
  131934. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  131935. /**
  131936. * Callback called when the task is successful
  131937. */
  131938. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  131939. /**
  131940. * Creates a new HDRCubeTextureAssetTask object
  131941. * @param name defines the name of the task
  131942. * @param url defines the location of the file to load
  131943. * @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.
  131944. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131945. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131946. * @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)
  131947. * @param reserved Internal use only
  131948. */
  131949. constructor(
  131950. /**
  131951. * Defines the name of the task
  131952. */
  131953. name: string,
  131954. /**
  131955. * Defines the location of the file to load
  131956. */
  131957. url: string,
  131958. /**
  131959. * Defines the desired size (the more it increases the longer the generation will be)
  131960. */
  131961. size: number,
  131962. /**
  131963. * Defines if mipmaps should not be generated (default is false)
  131964. */
  131965. noMipmap?: boolean,
  131966. /**
  131967. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131968. */
  131969. generateHarmonics?: boolean,
  131970. /**
  131971. * 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)
  131972. */
  131973. gammaSpace?: boolean,
  131974. /**
  131975. * Internal Use Only
  131976. */
  131977. reserved?: boolean);
  131978. /**
  131979. * Execute the current task
  131980. * @param scene defines the scene where you want your assets to be loaded
  131981. * @param onSuccess is a callback called when the task is successfully executed
  131982. * @param onError is a callback called if an error occurs
  131983. */
  131984. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131985. }
  131986. /**
  131987. * Define a task used by AssetsManager to load Equirectangular cube textures
  131988. */
  131989. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  131990. /**
  131991. * Defines the name of the task
  131992. */
  131993. name: string;
  131994. /**
  131995. * Defines the location of the file to load
  131996. */
  131997. url: string;
  131998. /**
  131999. * Defines the desired size (the more it increases the longer the generation will be)
  132000. */
  132001. size: number;
  132002. /**
  132003. * Defines if mipmaps should not be generated (default is false)
  132004. */
  132005. noMipmap: boolean;
  132006. /**
  132007. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  132008. * but the standard material would require them in Gamma space) (default is true)
  132009. */
  132010. gammaSpace: boolean;
  132011. /**
  132012. * Gets the loaded texture
  132013. */
  132014. texture: EquiRectangularCubeTexture;
  132015. /**
  132016. * Callback called when the task is successful
  132017. */
  132018. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  132019. /**
  132020. * Callback called when the task is successful
  132021. */
  132022. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  132023. /**
  132024. * Creates a new EquiRectangularCubeTextureAssetTask object
  132025. * @param name defines the name of the task
  132026. * @param url defines the location of the file to load
  132027. * @param size defines the desired size (the more it increases the longer the generation will be)
  132028. * If the size is omitted this implies you are using a preprocessed cubemap.
  132029. * @param noMipmap defines if mipmaps should not be generated (default is false)
  132030. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  132031. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  132032. * (default is true)
  132033. */
  132034. constructor(
  132035. /**
  132036. * Defines the name of the task
  132037. */
  132038. name: string,
  132039. /**
  132040. * Defines the location of the file to load
  132041. */
  132042. url: string,
  132043. /**
  132044. * Defines the desired size (the more it increases the longer the generation will be)
  132045. */
  132046. size: number,
  132047. /**
  132048. * Defines if mipmaps should not be generated (default is false)
  132049. */
  132050. noMipmap?: boolean,
  132051. /**
  132052. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  132053. * but the standard material would require them in Gamma space) (default is true)
  132054. */
  132055. gammaSpace?: boolean);
  132056. /**
  132057. * Execute the current task
  132058. * @param scene defines the scene where you want your assets to be loaded
  132059. * @param onSuccess is a callback called when the task is successfully executed
  132060. * @param onError is a callback called if an error occurs
  132061. */
  132062. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  132063. }
  132064. /**
  132065. * This class can be used to easily import assets into a scene
  132066. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  132067. */
  132068. export class AssetsManager {
  132069. private _scene;
  132070. private _isLoading;
  132071. protected _tasks: AbstractAssetTask[];
  132072. protected _waitingTasksCount: number;
  132073. protected _totalTasksCount: number;
  132074. /**
  132075. * Callback called when all tasks are processed
  132076. */
  132077. onFinish: (tasks: AbstractAssetTask[]) => void;
  132078. /**
  132079. * Callback called when a task is successful
  132080. */
  132081. onTaskSuccess: (task: AbstractAssetTask) => void;
  132082. /**
  132083. * Callback called when a task had an error
  132084. */
  132085. onTaskError: (task: AbstractAssetTask) => void;
  132086. /**
  132087. * Callback called when a task is done (whatever the result is)
  132088. */
  132089. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  132090. /**
  132091. * Observable called when all tasks are processed
  132092. */
  132093. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  132094. /**
  132095. * Observable called when a task had an error
  132096. */
  132097. onTaskErrorObservable: Observable<AbstractAssetTask>;
  132098. /**
  132099. * Observable called when all tasks were executed
  132100. */
  132101. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  132102. /**
  132103. * Observable called when a task is done (whatever the result is)
  132104. */
  132105. onProgressObservable: Observable<IAssetsProgressEvent>;
  132106. /**
  132107. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  132108. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  132109. */
  132110. useDefaultLoadingScreen: boolean;
  132111. /**
  132112. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  132113. * when all assets have been downloaded.
  132114. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  132115. */
  132116. autoHideLoadingUI: boolean;
  132117. /**
  132118. * Creates a new AssetsManager
  132119. * @param scene defines the scene to work on
  132120. */
  132121. constructor(scene: Scene);
  132122. /**
  132123. * Add a MeshAssetTask to the list of active tasks
  132124. * @param taskName defines the name of the new task
  132125. * @param meshesNames defines the name of meshes to load
  132126. * @param rootUrl defines the root url to use to locate files
  132127. * @param sceneFilename defines the filename of the scene file
  132128. * @returns a new MeshAssetTask object
  132129. */
  132130. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  132131. /**
  132132. * Add a TextFileAssetTask to the list of active tasks
  132133. * @param taskName defines the name of the new task
  132134. * @param url defines the url of the file to load
  132135. * @returns a new TextFileAssetTask object
  132136. */
  132137. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  132138. /**
  132139. * Add a BinaryFileAssetTask to the list of active tasks
  132140. * @param taskName defines the name of the new task
  132141. * @param url defines the url of the file to load
  132142. * @returns a new BinaryFileAssetTask object
  132143. */
  132144. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  132145. /**
  132146. * Add a ImageAssetTask to the list of active tasks
  132147. * @param taskName defines the name of the new task
  132148. * @param url defines the url of the file to load
  132149. * @returns a new ImageAssetTask object
  132150. */
  132151. addImageTask(taskName: string, url: string): ImageAssetTask;
  132152. /**
  132153. * Add a TextureAssetTask to the list of active tasks
  132154. * @param taskName defines the name of the new task
  132155. * @param url defines the url of the file to load
  132156. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132157. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  132158. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  132159. * @returns a new TextureAssetTask object
  132160. */
  132161. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  132162. /**
  132163. * Add a CubeTextureAssetTask to the list of active tasks
  132164. * @param taskName defines the name of the new task
  132165. * @param url defines the url of the file to load
  132166. * @param extensions defines the extension to use to load the cube map (can be null)
  132167. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132168. * @param files defines the list of files to load (can be null)
  132169. * @returns a new CubeTextureAssetTask object
  132170. */
  132171. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  132172. /**
  132173. *
  132174. * Add a HDRCubeTextureAssetTask to the list of active tasks
  132175. * @param taskName defines the name of the new task
  132176. * @param url defines the url of the file to load
  132177. * @param size defines the size you want for the cubemap (can be null)
  132178. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132179. * @param generateHarmonics defines if you want to automatically generate (true by default)
  132180. * @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)
  132181. * @param reserved Internal use only
  132182. * @returns a new HDRCubeTextureAssetTask object
  132183. */
  132184. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  132185. /**
  132186. *
  132187. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  132188. * @param taskName defines the name of the new task
  132189. * @param url defines the url of the file to load
  132190. * @param size defines the size you want for the cubemap (can be null)
  132191. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132192. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  132193. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  132194. * @returns a new EquiRectangularCubeTextureAssetTask object
  132195. */
  132196. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  132197. /**
  132198. * Remove a task from the assets manager.
  132199. * @param task the task to remove
  132200. */
  132201. removeTask(task: AbstractAssetTask): void;
  132202. private _decreaseWaitingTasksCount;
  132203. private _runTask;
  132204. /**
  132205. * Reset the AssetsManager and remove all tasks
  132206. * @return the current instance of the AssetsManager
  132207. */
  132208. reset(): AssetsManager;
  132209. /**
  132210. * Start the loading process
  132211. * @return the current instance of the AssetsManager
  132212. */
  132213. load(): AssetsManager;
  132214. /**
  132215. * Start the loading process as an async operation
  132216. * @return a promise returning the list of failed tasks
  132217. */
  132218. loadAsync(): Promise<void>;
  132219. }
  132220. }
  132221. declare module BABYLON {
  132222. /**
  132223. * Wrapper class for promise with external resolve and reject.
  132224. */
  132225. export class Deferred<T> {
  132226. /**
  132227. * The promise associated with this deferred object.
  132228. */
  132229. readonly promise: Promise<T>;
  132230. private _resolve;
  132231. private _reject;
  132232. /**
  132233. * The resolve method of the promise associated with this deferred object.
  132234. */
  132235. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  132236. /**
  132237. * The reject method of the promise associated with this deferred object.
  132238. */
  132239. readonly reject: (reason?: any) => void;
  132240. /**
  132241. * Constructor for this deferred object.
  132242. */
  132243. constructor();
  132244. }
  132245. }
  132246. declare module BABYLON {
  132247. /**
  132248. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  132249. */
  132250. export class MeshExploder {
  132251. private _centerMesh;
  132252. private _meshes;
  132253. private _meshesOrigins;
  132254. private _toCenterVectors;
  132255. private _scaledDirection;
  132256. private _newPosition;
  132257. private _centerPosition;
  132258. /**
  132259. * Explodes meshes from a center mesh.
  132260. * @param meshes The meshes to explode.
  132261. * @param centerMesh The mesh to be center of explosion.
  132262. */
  132263. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  132264. private _setCenterMesh;
  132265. /**
  132266. * Get class name
  132267. * @returns "MeshExploder"
  132268. */
  132269. getClassName(): string;
  132270. /**
  132271. * "Exploded meshes"
  132272. * @returns Array of meshes with the centerMesh at index 0.
  132273. */
  132274. getMeshes(): Array<Mesh>;
  132275. /**
  132276. * Explodes meshes giving a specific direction
  132277. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  132278. */
  132279. explode(direction?: number): void;
  132280. }
  132281. }
  132282. declare module BABYLON {
  132283. /**
  132284. * Class used to help managing file picking and drag'n'drop
  132285. */
  132286. export class FilesInput {
  132287. /**
  132288. * List of files ready to be loaded
  132289. */
  132290. static readonly FilesToLoad: {
  132291. [key: string]: File;
  132292. };
  132293. /**
  132294. * Callback called when a file is processed
  132295. */
  132296. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  132297. private _engine;
  132298. private _currentScene;
  132299. private _sceneLoadedCallback;
  132300. private _progressCallback;
  132301. private _additionalRenderLoopLogicCallback;
  132302. private _textureLoadingCallback;
  132303. private _startingProcessingFilesCallback;
  132304. private _onReloadCallback;
  132305. private _errorCallback;
  132306. private _elementToMonitor;
  132307. private _sceneFileToLoad;
  132308. private _filesToLoad;
  132309. /**
  132310. * Creates a new FilesInput
  132311. * @param engine defines the rendering engine
  132312. * @param scene defines the hosting scene
  132313. * @param sceneLoadedCallback callback called when scene is loaded
  132314. * @param progressCallback callback called to track progress
  132315. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  132316. * @param textureLoadingCallback callback called when a texture is loading
  132317. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  132318. * @param onReloadCallback callback called when a reload is requested
  132319. * @param errorCallback callback call if an error occurs
  132320. */
  132321. 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);
  132322. private _dragEnterHandler;
  132323. private _dragOverHandler;
  132324. private _dropHandler;
  132325. /**
  132326. * Calls this function to listen to drag'n'drop events on a specific DOM element
  132327. * @param elementToMonitor defines the DOM element to track
  132328. */
  132329. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  132330. /**
  132331. * Release all associated resources
  132332. */
  132333. dispose(): void;
  132334. private renderFunction;
  132335. private drag;
  132336. private drop;
  132337. private _traverseFolder;
  132338. private _processFiles;
  132339. /**
  132340. * Load files from a drop event
  132341. * @param event defines the drop event to use as source
  132342. */
  132343. loadFiles(event: any): void;
  132344. private _processReload;
  132345. /**
  132346. * Reload the current scene from the loaded files
  132347. */
  132348. reload(): void;
  132349. }
  132350. }
  132351. declare module BABYLON {
  132352. /**
  132353. * Defines the root class used to create scene optimization to use with SceneOptimizer
  132354. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132355. */
  132356. export class SceneOptimization {
  132357. /**
  132358. * Defines the priority of this optimization (0 by default which means first in the list)
  132359. */
  132360. priority: number;
  132361. /**
  132362. * Gets a string describing the action executed by the current optimization
  132363. * @returns description string
  132364. */
  132365. getDescription(): string;
  132366. /**
  132367. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132368. * @param scene defines the current scene where to apply this optimization
  132369. * @param optimizer defines the current optimizer
  132370. * @returns true if everything that can be done was applied
  132371. */
  132372. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132373. /**
  132374. * Creates the SceneOptimization object
  132375. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132376. * @param desc defines the description associated with the optimization
  132377. */
  132378. constructor(
  132379. /**
  132380. * Defines the priority of this optimization (0 by default which means first in the list)
  132381. */
  132382. priority?: number);
  132383. }
  132384. /**
  132385. * Defines an optimization used to reduce the size of render target textures
  132386. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132387. */
  132388. export class TextureOptimization extends SceneOptimization {
  132389. /**
  132390. * Defines the priority of this optimization (0 by default which means first in the list)
  132391. */
  132392. priority: number;
  132393. /**
  132394. * 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
  132395. */
  132396. maximumSize: number;
  132397. /**
  132398. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  132399. */
  132400. step: number;
  132401. /**
  132402. * Gets a string describing the action executed by the current optimization
  132403. * @returns description string
  132404. */
  132405. getDescription(): string;
  132406. /**
  132407. * Creates the TextureOptimization object
  132408. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132409. * @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
  132410. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  132411. */
  132412. constructor(
  132413. /**
  132414. * Defines the priority of this optimization (0 by default which means first in the list)
  132415. */
  132416. priority?: number,
  132417. /**
  132418. * 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
  132419. */
  132420. maximumSize?: number,
  132421. /**
  132422. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  132423. */
  132424. step?: number);
  132425. /**
  132426. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132427. * @param scene defines the current scene where to apply this optimization
  132428. * @param optimizer defines the current optimizer
  132429. * @returns true if everything that can be done was applied
  132430. */
  132431. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132432. }
  132433. /**
  132434. * Defines an optimization used to increase or decrease the rendering resolution
  132435. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132436. */
  132437. export class HardwareScalingOptimization extends SceneOptimization {
  132438. /**
  132439. * Defines the priority of this optimization (0 by default which means first in the list)
  132440. */
  132441. priority: number;
  132442. /**
  132443. * Defines the maximum scale to use (2 by default)
  132444. */
  132445. maximumScale: number;
  132446. /**
  132447. * Defines the step to use between two passes (0.5 by default)
  132448. */
  132449. step: number;
  132450. private _currentScale;
  132451. private _directionOffset;
  132452. /**
  132453. * Gets a string describing the action executed by the current optimization
  132454. * @return description string
  132455. */
  132456. getDescription(): string;
  132457. /**
  132458. * Creates the HardwareScalingOptimization object
  132459. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132460. * @param maximumScale defines the maximum scale to use (2 by default)
  132461. * @param step defines the step to use between two passes (0.5 by default)
  132462. */
  132463. constructor(
  132464. /**
  132465. * Defines the priority of this optimization (0 by default which means first in the list)
  132466. */
  132467. priority?: number,
  132468. /**
  132469. * Defines the maximum scale to use (2 by default)
  132470. */
  132471. maximumScale?: number,
  132472. /**
  132473. * Defines the step to use between two passes (0.5 by default)
  132474. */
  132475. step?: number);
  132476. /**
  132477. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132478. * @param scene defines the current scene where to apply this optimization
  132479. * @param optimizer defines the current optimizer
  132480. * @returns true if everything that can be done was applied
  132481. */
  132482. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132483. }
  132484. /**
  132485. * Defines an optimization used to remove shadows
  132486. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132487. */
  132488. export class ShadowsOptimization extends SceneOptimization {
  132489. /**
  132490. * Gets a string describing the action executed by the current optimization
  132491. * @return description string
  132492. */
  132493. getDescription(): string;
  132494. /**
  132495. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132496. * @param scene defines the current scene where to apply this optimization
  132497. * @param optimizer defines the current optimizer
  132498. * @returns true if everything that can be done was applied
  132499. */
  132500. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132501. }
  132502. /**
  132503. * Defines an optimization used to turn post-processes off
  132504. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132505. */
  132506. export class PostProcessesOptimization extends SceneOptimization {
  132507. /**
  132508. * Gets a string describing the action executed by the current optimization
  132509. * @return description string
  132510. */
  132511. getDescription(): string;
  132512. /**
  132513. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132514. * @param scene defines the current scene where to apply this optimization
  132515. * @param optimizer defines the current optimizer
  132516. * @returns true if everything that can be done was applied
  132517. */
  132518. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132519. }
  132520. /**
  132521. * Defines an optimization used to turn lens flares off
  132522. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132523. */
  132524. export class LensFlaresOptimization extends SceneOptimization {
  132525. /**
  132526. * Gets a string describing the action executed by the current optimization
  132527. * @return description string
  132528. */
  132529. getDescription(): string;
  132530. /**
  132531. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132532. * @param scene defines the current scene where to apply this optimization
  132533. * @param optimizer defines the current optimizer
  132534. * @returns true if everything that can be done was applied
  132535. */
  132536. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132537. }
  132538. /**
  132539. * Defines an optimization based on user defined callback.
  132540. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132541. */
  132542. export class CustomOptimization extends SceneOptimization {
  132543. /**
  132544. * Callback called to apply the custom optimization.
  132545. */
  132546. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  132547. /**
  132548. * Callback called to get custom description
  132549. */
  132550. onGetDescription: () => string;
  132551. /**
  132552. * Gets a string describing the action executed by the current optimization
  132553. * @returns description string
  132554. */
  132555. getDescription(): string;
  132556. /**
  132557. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132558. * @param scene defines the current scene where to apply this optimization
  132559. * @param optimizer defines the current optimizer
  132560. * @returns true if everything that can be done was applied
  132561. */
  132562. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132563. }
  132564. /**
  132565. * Defines an optimization used to turn particles off
  132566. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132567. */
  132568. export class ParticlesOptimization extends SceneOptimization {
  132569. /**
  132570. * Gets a string describing the action executed by the current optimization
  132571. * @return description string
  132572. */
  132573. getDescription(): string;
  132574. /**
  132575. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132576. * @param scene defines the current scene where to apply this optimization
  132577. * @param optimizer defines the current optimizer
  132578. * @returns true if everything that can be done was applied
  132579. */
  132580. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132581. }
  132582. /**
  132583. * Defines an optimization used to turn render targets off
  132584. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132585. */
  132586. export class RenderTargetsOptimization extends SceneOptimization {
  132587. /**
  132588. * Gets a string describing the action executed by the current optimization
  132589. * @return description string
  132590. */
  132591. getDescription(): string;
  132592. /**
  132593. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132594. * @param scene defines the current scene where to apply this optimization
  132595. * @param optimizer defines the current optimizer
  132596. * @returns true if everything that can be done was applied
  132597. */
  132598. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132599. }
  132600. /**
  132601. * Defines an optimization used to merge meshes with compatible materials
  132602. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132603. */
  132604. export class MergeMeshesOptimization extends SceneOptimization {
  132605. private static _UpdateSelectionTree;
  132606. /**
  132607. * Gets or sets a boolean which defines if optimization octree has to be updated
  132608. */
  132609. /**
  132610. * Gets or sets a boolean which defines if optimization octree has to be updated
  132611. */
  132612. static UpdateSelectionTree: boolean;
  132613. /**
  132614. * Gets a string describing the action executed by the current optimization
  132615. * @return description string
  132616. */
  132617. getDescription(): string;
  132618. private _canBeMerged;
  132619. /**
  132620. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132621. * @param scene defines the current scene where to apply this optimization
  132622. * @param optimizer defines the current optimizer
  132623. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  132624. * @returns true if everything that can be done was applied
  132625. */
  132626. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  132627. }
  132628. /**
  132629. * Defines a list of options used by SceneOptimizer
  132630. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132631. */
  132632. export class SceneOptimizerOptions {
  132633. /**
  132634. * Defines the target frame rate to reach (60 by default)
  132635. */
  132636. targetFrameRate: number;
  132637. /**
  132638. * Defines the interval between two checkes (2000ms by default)
  132639. */
  132640. trackerDuration: number;
  132641. /**
  132642. * Gets the list of optimizations to apply
  132643. */
  132644. optimizations: SceneOptimization[];
  132645. /**
  132646. * Creates a new list of options used by SceneOptimizer
  132647. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  132648. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  132649. */
  132650. constructor(
  132651. /**
  132652. * Defines the target frame rate to reach (60 by default)
  132653. */
  132654. targetFrameRate?: number,
  132655. /**
  132656. * Defines the interval between two checkes (2000ms by default)
  132657. */
  132658. trackerDuration?: number);
  132659. /**
  132660. * Add a new optimization
  132661. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  132662. * @returns the current SceneOptimizerOptions
  132663. */
  132664. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  132665. /**
  132666. * Add a new custom optimization
  132667. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  132668. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  132669. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132670. * @returns the current SceneOptimizerOptions
  132671. */
  132672. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  132673. /**
  132674. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  132675. * @param targetFrameRate defines the target frame rate (60 by default)
  132676. * @returns a SceneOptimizerOptions object
  132677. */
  132678. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132679. /**
  132680. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  132681. * @param targetFrameRate defines the target frame rate (60 by default)
  132682. * @returns a SceneOptimizerOptions object
  132683. */
  132684. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132685. /**
  132686. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  132687. * @param targetFrameRate defines the target frame rate (60 by default)
  132688. * @returns a SceneOptimizerOptions object
  132689. */
  132690. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132691. }
  132692. /**
  132693. * Class used to run optimizations in order to reach a target frame rate
  132694. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132695. */
  132696. export class SceneOptimizer implements IDisposable {
  132697. private _isRunning;
  132698. private _options;
  132699. private _scene;
  132700. private _currentPriorityLevel;
  132701. private _targetFrameRate;
  132702. private _trackerDuration;
  132703. private _currentFrameRate;
  132704. private _sceneDisposeObserver;
  132705. private _improvementMode;
  132706. /**
  132707. * Defines an observable called when the optimizer reaches the target frame rate
  132708. */
  132709. onSuccessObservable: Observable<SceneOptimizer>;
  132710. /**
  132711. * Defines an observable called when the optimizer enables an optimization
  132712. */
  132713. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  132714. /**
  132715. * Defines an observable called when the optimizer is not able to reach the target frame rate
  132716. */
  132717. onFailureObservable: Observable<SceneOptimizer>;
  132718. /**
  132719. * Gets a boolean indicating if the optimizer is in improvement mode
  132720. */
  132721. readonly isInImprovementMode: boolean;
  132722. /**
  132723. * Gets the current priority level (0 at start)
  132724. */
  132725. readonly currentPriorityLevel: number;
  132726. /**
  132727. * Gets the current frame rate checked by the SceneOptimizer
  132728. */
  132729. readonly currentFrameRate: number;
  132730. /**
  132731. * Gets or sets the current target frame rate (60 by default)
  132732. */
  132733. /**
  132734. * Gets or sets the current target frame rate (60 by default)
  132735. */
  132736. targetFrameRate: number;
  132737. /**
  132738. * Gets or sets the current interval between two checks (every 2000ms by default)
  132739. */
  132740. /**
  132741. * Gets or sets the current interval between two checks (every 2000ms by default)
  132742. */
  132743. trackerDuration: number;
  132744. /**
  132745. * Gets the list of active optimizations
  132746. */
  132747. readonly optimizations: SceneOptimization[];
  132748. /**
  132749. * Creates a new SceneOptimizer
  132750. * @param scene defines the scene to work on
  132751. * @param options defines the options to use with the SceneOptimizer
  132752. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  132753. * @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)
  132754. */
  132755. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  132756. /**
  132757. * Stops the current optimizer
  132758. */
  132759. stop(): void;
  132760. /**
  132761. * Reset the optimizer to initial step (current priority level = 0)
  132762. */
  132763. reset(): void;
  132764. /**
  132765. * Start the optimizer. By default it will try to reach a specific framerate
  132766. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  132767. */
  132768. start(): void;
  132769. private _checkCurrentState;
  132770. /**
  132771. * Release all resources
  132772. */
  132773. dispose(): void;
  132774. /**
  132775. * Helper function to create a SceneOptimizer with one single line of code
  132776. * @param scene defines the scene to work on
  132777. * @param options defines the options to use with the SceneOptimizer
  132778. * @param onSuccess defines a callback to call on success
  132779. * @param onFailure defines a callback to call on failure
  132780. * @returns the new SceneOptimizer object
  132781. */
  132782. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  132783. }
  132784. }
  132785. declare module BABYLON {
  132786. /**
  132787. * Class used to serialize a scene into a string
  132788. */
  132789. export class SceneSerializer {
  132790. /**
  132791. * Clear cache used by a previous serialization
  132792. */
  132793. static ClearCache(): void;
  132794. /**
  132795. * Serialize a scene into a JSON compatible object
  132796. * @param scene defines the scene to serialize
  132797. * @returns a JSON compatible object
  132798. */
  132799. static Serialize(scene: Scene): any;
  132800. /**
  132801. * Serialize a mesh into a JSON compatible object
  132802. * @param toSerialize defines the mesh to serialize
  132803. * @param withParents defines if parents must be serialized as well
  132804. * @param withChildren defines if children must be serialized as well
  132805. * @returns a JSON compatible object
  132806. */
  132807. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  132808. }
  132809. }
  132810. declare module BABYLON {
  132811. /**
  132812. * Class used to host texture specific utilities
  132813. */
  132814. export class TextureTools {
  132815. /**
  132816. * Uses the GPU to create a copy texture rescaled at a given size
  132817. * @param texture Texture to copy from
  132818. * @param width defines the desired width
  132819. * @param height defines the desired height
  132820. * @param useBilinearMode defines if bilinear mode has to be used
  132821. * @return the generated texture
  132822. */
  132823. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  132824. }
  132825. }
  132826. declare module BABYLON {
  132827. /**
  132828. * This represents the different options available for the video capture.
  132829. */
  132830. export interface VideoRecorderOptions {
  132831. /** Defines the mime type of the video. */
  132832. mimeType: string;
  132833. /** Defines the FPS the video should be recorded at. */
  132834. fps: number;
  132835. /** Defines the chunk size for the recording data. */
  132836. recordChunckSize: number;
  132837. /** The audio tracks to attach to the recording. */
  132838. audioTracks?: MediaStreamTrack[];
  132839. }
  132840. /**
  132841. * This can help with recording videos from BabylonJS.
  132842. * This is based on the available WebRTC functionalities of the browser.
  132843. *
  132844. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  132845. */
  132846. export class VideoRecorder {
  132847. private static readonly _defaultOptions;
  132848. /**
  132849. * Returns whether or not the VideoRecorder is available in your browser.
  132850. * @param engine Defines the Babylon Engine.
  132851. * @returns true if supported otherwise false.
  132852. */
  132853. static IsSupported(engine: Engine): boolean;
  132854. private readonly _options;
  132855. private _canvas;
  132856. private _mediaRecorder;
  132857. private _recordedChunks;
  132858. private _fileName;
  132859. private _resolve;
  132860. private _reject;
  132861. /**
  132862. * True when a recording is already in progress.
  132863. */
  132864. readonly isRecording: boolean;
  132865. /**
  132866. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  132867. * @param engine Defines the BabylonJS Engine you wish to record.
  132868. * @param options Defines options that can be used to customize the capture.
  132869. */
  132870. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  132871. /**
  132872. * Stops the current recording before the default capture timeout passed in the startRecording function.
  132873. */
  132874. stopRecording(): void;
  132875. /**
  132876. * Starts recording the canvas for a max duration specified in parameters.
  132877. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  132878. * If null no automatic download will start and you can rely on the promise to get the data back.
  132879. * @param maxDuration Defines the maximum recording time in seconds.
  132880. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  132881. * @return A promise callback at the end of the recording with the video data in Blob.
  132882. */
  132883. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  132884. /**
  132885. * Releases internal resources used during the recording.
  132886. */
  132887. dispose(): void;
  132888. private _handleDataAvailable;
  132889. private _handleError;
  132890. private _handleStop;
  132891. }
  132892. }
  132893. declare module BABYLON {
  132894. /**
  132895. * Class containing a set of static utilities functions for screenshots
  132896. */
  132897. export class ScreenshotTools {
  132898. /**
  132899. * Captures a screenshot of the current rendering
  132900. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132901. * @param engine defines the rendering engine
  132902. * @param camera defines the source camera
  132903. * @param size This parameter can be set to a single number or to an object with the
  132904. * following (optional) properties: precision, width, height. If a single number is passed,
  132905. * it will be used for both width and height. If an object is passed, the screenshot size
  132906. * will be derived from the parameters. The precision property is a multiplier allowing
  132907. * rendering at a higher or lower resolution
  132908. * @param successCallback defines the callback receives a single parameter which contains the
  132909. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  132910. * src parameter of an <img> to display it
  132911. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  132912. * Check your browser for supported MIME types
  132913. */
  132914. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  132915. /**
  132916. * Captures a screenshot of the current rendering
  132917. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132918. * @param engine defines the rendering engine
  132919. * @param camera defines the source camera
  132920. * @param size This parameter can be set to a single number or to an object with the
  132921. * following (optional) properties: precision, width, height. If a single number is passed,
  132922. * it will be used for both width and height. If an object is passed, the screenshot size
  132923. * will be derived from the parameters. The precision property is a multiplier allowing
  132924. * rendering at a higher or lower resolution
  132925. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  132926. * Check your browser for supported MIME types
  132927. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  132928. * to the src parameter of an <img> to display it
  132929. */
  132930. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  132931. /**
  132932. * Generates an image screenshot from the specified camera.
  132933. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132934. * @param engine The engine to use for rendering
  132935. * @param camera The camera to use for rendering
  132936. * @param size This parameter can be set to a single number or to an object with the
  132937. * following (optional) properties: precision, width, height. If a single number is passed,
  132938. * it will be used for both width and height. If an object is passed, the screenshot size
  132939. * will be derived from the parameters. The precision property is a multiplier allowing
  132940. * rendering at a higher or lower resolution
  132941. * @param successCallback The callback receives a single parameter which contains the
  132942. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  132943. * src parameter of an <img> to display it
  132944. * @param mimeType The MIME type of the screenshot image (default: image/png).
  132945. * Check your browser for supported MIME types
  132946. * @param samples Texture samples (default: 1)
  132947. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  132948. * @param fileName A name for for the downloaded file.
  132949. */
  132950. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  132951. /**
  132952. * Generates an image screenshot from the specified camera.
  132953. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132954. * @param engine The engine to use for rendering
  132955. * @param camera The camera to use for rendering
  132956. * @param size This parameter can be set to a single number or to an object with the
  132957. * following (optional) properties: precision, width, height. If a single number is passed,
  132958. * it will be used for both width and height. If an object is passed, the screenshot size
  132959. * will be derived from the parameters. The precision property is a multiplier allowing
  132960. * rendering at a higher or lower resolution
  132961. * @param mimeType The MIME type of the screenshot image (default: image/png).
  132962. * Check your browser for supported MIME types
  132963. * @param samples Texture samples (default: 1)
  132964. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  132965. * @param fileName A name for for the downloaded file.
  132966. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  132967. * to the src parameter of an <img> to display it
  132968. */
  132969. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  132970. /**
  132971. * Gets height and width for screenshot size
  132972. * @private
  132973. */
  132974. private static _getScreenshotSize;
  132975. }
  132976. }
  132977. declare module BABYLON {
  132978. /**
  132979. * Interface for a data buffer
  132980. */
  132981. export interface IDataBuffer {
  132982. /**
  132983. * Reads bytes from the data buffer.
  132984. * @param byteOffset The byte offset to read
  132985. * @param byteLength The byte length to read
  132986. * @returns A promise that resolves when the bytes are read
  132987. */
  132988. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  132989. /**
  132990. * The byte length of the buffer.
  132991. */
  132992. readonly byteLength: number;
  132993. }
  132994. /**
  132995. * Utility class for reading from a data buffer
  132996. */
  132997. export class DataReader {
  132998. /**
  132999. * The data buffer associated with this data reader.
  133000. */
  133001. readonly buffer: IDataBuffer;
  133002. /**
  133003. * The current byte offset from the beginning of the data buffer.
  133004. */
  133005. byteOffset: number;
  133006. private _dataView;
  133007. private _dataByteOffset;
  133008. /**
  133009. * Constructor
  133010. * @param buffer The buffer to read
  133011. */
  133012. constructor(buffer: IDataBuffer);
  133013. /**
  133014. * Loads the given byte length.
  133015. * @param byteLength The byte length to load
  133016. * @returns A promise that resolves when the load is complete
  133017. */
  133018. loadAsync(byteLength: number): Promise<void>;
  133019. /**
  133020. * Read a unsigned 32-bit integer from the currently loaded data range.
  133021. * @returns The 32-bit integer read
  133022. */
  133023. readUint32(): number;
  133024. /**
  133025. * Read a byte array from the currently loaded data range.
  133026. * @param byteLength The byte length to read
  133027. * @returns The byte array read
  133028. */
  133029. readUint8Array(byteLength: number): Uint8Array;
  133030. /**
  133031. * Read a string from the currently loaded data range.
  133032. * @param byteLength The byte length to read
  133033. * @returns The string read
  133034. */
  133035. readString(byteLength: number): string;
  133036. /**
  133037. * Skips the given byte length the currently loaded data range.
  133038. * @param byteLength The byte length to skip
  133039. */
  133040. skipBytes(byteLength: number): void;
  133041. }
  133042. }
  133043. declare module BABYLON {
  133044. /**
  133045. * A cursor which tracks a point on a path
  133046. */
  133047. export class PathCursor {
  133048. private path;
  133049. /**
  133050. * Stores path cursor callbacks for when an onchange event is triggered
  133051. */
  133052. private _onchange;
  133053. /**
  133054. * The value of the path cursor
  133055. */
  133056. value: number;
  133057. /**
  133058. * The animation array of the path cursor
  133059. */
  133060. animations: Animation[];
  133061. /**
  133062. * Initializes the path cursor
  133063. * @param path The path to track
  133064. */
  133065. constructor(path: Path2);
  133066. /**
  133067. * Gets the cursor point on the path
  133068. * @returns A point on the path cursor at the cursor location
  133069. */
  133070. getPoint(): Vector3;
  133071. /**
  133072. * Moves the cursor ahead by the step amount
  133073. * @param step The amount to move the cursor forward
  133074. * @returns This path cursor
  133075. */
  133076. moveAhead(step?: number): PathCursor;
  133077. /**
  133078. * Moves the cursor behind by the step amount
  133079. * @param step The amount to move the cursor back
  133080. * @returns This path cursor
  133081. */
  133082. moveBack(step?: number): PathCursor;
  133083. /**
  133084. * Moves the cursor by the step amount
  133085. * If the step amount is greater than one, an exception is thrown
  133086. * @param step The amount to move the cursor
  133087. * @returns This path cursor
  133088. */
  133089. move(step: number): PathCursor;
  133090. /**
  133091. * Ensures that the value is limited between zero and one
  133092. * @returns This path cursor
  133093. */
  133094. private ensureLimits;
  133095. /**
  133096. * Runs onchange callbacks on change (used by the animation engine)
  133097. * @returns This path cursor
  133098. */
  133099. private raiseOnChange;
  133100. /**
  133101. * Executes a function on change
  133102. * @param f A path cursor onchange callback
  133103. * @returns This path cursor
  133104. */
  133105. onchange(f: (cursor: PathCursor) => void): PathCursor;
  133106. }
  133107. }
  133108. declare module BABYLON {
  133109. /** @hidden */
  133110. export var blurPixelShader: {
  133111. name: string;
  133112. shader: string;
  133113. };
  133114. }
  133115. declare module BABYLON {
  133116. /** @hidden */
  133117. export var pointCloudVertexDeclaration: {
  133118. name: string;
  133119. shader: string;
  133120. };
  133121. }
  133122. // Mixins
  133123. interface Window {
  133124. mozIndexedDB: IDBFactory;
  133125. webkitIndexedDB: IDBFactory;
  133126. msIndexedDB: IDBFactory;
  133127. webkitURL: typeof URL;
  133128. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  133129. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  133130. WebGLRenderingContext: WebGLRenderingContext;
  133131. MSGesture: MSGesture;
  133132. CANNON: any;
  133133. AudioContext: AudioContext;
  133134. webkitAudioContext: AudioContext;
  133135. PointerEvent: any;
  133136. Math: Math;
  133137. Uint8Array: Uint8ArrayConstructor;
  133138. Float32Array: Float32ArrayConstructor;
  133139. mozURL: typeof URL;
  133140. msURL: typeof URL;
  133141. VRFrameData: any; // WebVR, from specs 1.1
  133142. DracoDecoderModule: any;
  133143. setImmediate(handler: (...args: any[]) => void): number;
  133144. }
  133145. interface HTMLCanvasElement {
  133146. requestPointerLock(): void;
  133147. msRequestPointerLock?(): void;
  133148. mozRequestPointerLock?(): void;
  133149. webkitRequestPointerLock?(): void;
  133150. /** Track wether a record is in progress */
  133151. isRecording: boolean;
  133152. /** Capture Stream method defined by some browsers */
  133153. captureStream(fps?: number): MediaStream;
  133154. }
  133155. interface CanvasRenderingContext2D {
  133156. msImageSmoothingEnabled: boolean;
  133157. }
  133158. interface MouseEvent {
  133159. mozMovementX: number;
  133160. mozMovementY: number;
  133161. webkitMovementX: number;
  133162. webkitMovementY: number;
  133163. msMovementX: number;
  133164. msMovementY: number;
  133165. }
  133166. interface Navigator {
  133167. mozGetVRDevices: (any: any) => any;
  133168. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  133169. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  133170. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  133171. webkitGetGamepads(): Gamepad[];
  133172. msGetGamepads(): Gamepad[];
  133173. webkitGamepads(): Gamepad[];
  133174. }
  133175. interface HTMLVideoElement {
  133176. mozSrcObject: any;
  133177. }
  133178. interface Math {
  133179. fround(x: number): number;
  133180. imul(a: number, b: number): number;
  133181. }
  133182. interface WebGLRenderingContext {
  133183. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  133184. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  133185. vertexAttribDivisor(index: number, divisor: number): void;
  133186. createVertexArray(): any;
  133187. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  133188. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  133189. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  133190. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  133191. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  133192. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  133193. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  133194. // Queries
  133195. createQuery(): WebGLQuery;
  133196. deleteQuery(query: WebGLQuery): void;
  133197. beginQuery(target: number, query: WebGLQuery): void;
  133198. endQuery(target: number): void;
  133199. getQueryParameter(query: WebGLQuery, pname: number): any;
  133200. getQuery(target: number, pname: number): any;
  133201. MAX_SAMPLES: number;
  133202. RGBA8: number;
  133203. READ_FRAMEBUFFER: number;
  133204. DRAW_FRAMEBUFFER: number;
  133205. UNIFORM_BUFFER: number;
  133206. HALF_FLOAT_OES: number;
  133207. RGBA16F: number;
  133208. RGBA32F: number;
  133209. R32F: number;
  133210. RG32F: number;
  133211. RGB32F: number;
  133212. R16F: number;
  133213. RG16F: number;
  133214. RGB16F: number;
  133215. RED: number;
  133216. RG: number;
  133217. R8: number;
  133218. RG8: number;
  133219. UNSIGNED_INT_24_8: number;
  133220. DEPTH24_STENCIL8: number;
  133221. MIN: number;
  133222. MAX: number;
  133223. /* Multiple Render Targets */
  133224. drawBuffers(buffers: number[]): void;
  133225. readBuffer(src: number): void;
  133226. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  133227. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  133228. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  133229. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  133230. // Occlusion Query
  133231. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  133232. ANY_SAMPLES_PASSED: number;
  133233. QUERY_RESULT_AVAILABLE: number;
  133234. QUERY_RESULT: number;
  133235. }
  133236. interface WebGLProgram {
  133237. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  133238. }
  133239. interface EXT_disjoint_timer_query {
  133240. QUERY_COUNTER_BITS_EXT: number;
  133241. TIME_ELAPSED_EXT: number;
  133242. TIMESTAMP_EXT: number;
  133243. GPU_DISJOINT_EXT: number;
  133244. QUERY_RESULT_EXT: number;
  133245. QUERY_RESULT_AVAILABLE_EXT: number;
  133246. queryCounterEXT(query: WebGLQuery, target: number): void;
  133247. createQueryEXT(): WebGLQuery;
  133248. beginQueryEXT(target: number, query: WebGLQuery): void;
  133249. endQueryEXT(target: number): void;
  133250. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  133251. deleteQueryEXT(query: WebGLQuery): void;
  133252. }
  133253. interface WebGLUniformLocation {
  133254. _currentState: any;
  133255. }
  133256. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  133257. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  133258. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  133259. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  133260. interface WebGLRenderingContext {
  133261. readonly RASTERIZER_DISCARD: number;
  133262. readonly DEPTH_COMPONENT24: number;
  133263. readonly TEXTURE_3D: number;
  133264. readonly TEXTURE_2D_ARRAY: number;
  133265. readonly TEXTURE_COMPARE_FUNC: number;
  133266. readonly TEXTURE_COMPARE_MODE: number;
  133267. readonly COMPARE_REF_TO_TEXTURE: number;
  133268. readonly TEXTURE_WRAP_R: number;
  133269. readonly HALF_FLOAT: number;
  133270. readonly RGB8: number;
  133271. readonly RED_INTEGER: number;
  133272. readonly RG_INTEGER: number;
  133273. readonly RGB_INTEGER: number;
  133274. readonly RGBA_INTEGER: number;
  133275. readonly R8_SNORM: number;
  133276. readonly RG8_SNORM: number;
  133277. readonly RGB8_SNORM: number;
  133278. readonly RGBA8_SNORM: number;
  133279. readonly R8I: number;
  133280. readonly RG8I: number;
  133281. readonly RGB8I: number;
  133282. readonly RGBA8I: number;
  133283. readonly R8UI: number;
  133284. readonly RG8UI: number;
  133285. readonly RGB8UI: number;
  133286. readonly RGBA8UI: number;
  133287. readonly R16I: number;
  133288. readonly RG16I: number;
  133289. readonly RGB16I: number;
  133290. readonly RGBA16I: number;
  133291. readonly R16UI: number;
  133292. readonly RG16UI: number;
  133293. readonly RGB16UI: number;
  133294. readonly RGBA16UI: number;
  133295. readonly R32I: number;
  133296. readonly RG32I: number;
  133297. readonly RGB32I: number;
  133298. readonly RGBA32I: number;
  133299. readonly R32UI: number;
  133300. readonly RG32UI: number;
  133301. readonly RGB32UI: number;
  133302. readonly RGBA32UI: number;
  133303. readonly RGB10_A2UI: number;
  133304. readonly R11F_G11F_B10F: number;
  133305. readonly RGB9_E5: number;
  133306. readonly RGB10_A2: number;
  133307. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  133308. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  133309. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  133310. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  133311. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  133312. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  133313. 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;
  133314. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  133315. readonly TRANSFORM_FEEDBACK: number;
  133316. readonly INTERLEAVED_ATTRIBS: number;
  133317. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  133318. createTransformFeedback(): WebGLTransformFeedback;
  133319. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  133320. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  133321. beginTransformFeedback(primitiveMode: number): void;
  133322. endTransformFeedback(): void;
  133323. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  133324. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  133325. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  133326. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  133327. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  133328. }
  133329. interface ImageBitmap {
  133330. readonly width: number;
  133331. readonly height: number;
  133332. close(): void;
  133333. }
  133334. interface WebGLQuery extends WebGLObject {
  133335. }
  133336. declare var WebGLQuery: {
  133337. prototype: WebGLQuery;
  133338. new(): WebGLQuery;
  133339. };
  133340. interface WebGLSampler extends WebGLObject {
  133341. }
  133342. declare var WebGLSampler: {
  133343. prototype: WebGLSampler;
  133344. new(): WebGLSampler;
  133345. };
  133346. interface WebGLSync extends WebGLObject {
  133347. }
  133348. declare var WebGLSync: {
  133349. prototype: WebGLSync;
  133350. new(): WebGLSync;
  133351. };
  133352. interface WebGLTransformFeedback extends WebGLObject {
  133353. }
  133354. declare var WebGLTransformFeedback: {
  133355. prototype: WebGLTransformFeedback;
  133356. new(): WebGLTransformFeedback;
  133357. };
  133358. interface WebGLVertexArrayObject extends WebGLObject {
  133359. }
  133360. declare var WebGLVertexArrayObject: {
  133361. prototype: WebGLVertexArrayObject;
  133362. new(): WebGLVertexArrayObject;
  133363. };
  133364. // Type definitions for WebVR API
  133365. // Project: https://w3c.github.io/webvr/
  133366. // Definitions by: six a <https://github.com/lostfictions>
  133367. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  133368. interface VRDisplay extends EventTarget {
  133369. /**
  133370. * Dictionary of capabilities describing the VRDisplay.
  133371. */
  133372. readonly capabilities: VRDisplayCapabilities;
  133373. /**
  133374. * z-depth defining the far plane of the eye view frustum
  133375. * enables mapping of values in the render target depth
  133376. * attachment to scene coordinates. Initially set to 10000.0.
  133377. */
  133378. depthFar: number;
  133379. /**
  133380. * z-depth defining the near plane of the eye view frustum
  133381. * enables mapping of values in the render target depth
  133382. * attachment to scene coordinates. Initially set to 0.01.
  133383. */
  133384. depthNear: number;
  133385. /**
  133386. * An identifier for this distinct VRDisplay. Used as an
  133387. * association point in the Gamepad API.
  133388. */
  133389. readonly displayId: number;
  133390. /**
  133391. * A display name, a user-readable name identifying it.
  133392. */
  133393. readonly displayName: string;
  133394. readonly isConnected: boolean;
  133395. readonly isPresenting: boolean;
  133396. /**
  133397. * If this VRDisplay supports room-scale experiences, the optional
  133398. * stage attribute contains details on the room-scale parameters.
  133399. */
  133400. readonly stageParameters: VRStageParameters | null;
  133401. /**
  133402. * Passing the value returned by `requestAnimationFrame` to
  133403. * `cancelAnimationFrame` will unregister the callback.
  133404. * @param handle Define the hanle of the request to cancel
  133405. */
  133406. cancelAnimationFrame(handle: number): void;
  133407. /**
  133408. * Stops presenting to the VRDisplay.
  133409. * @returns a promise to know when it stopped
  133410. */
  133411. exitPresent(): Promise<void>;
  133412. /**
  133413. * Return the current VREyeParameters for the given eye.
  133414. * @param whichEye Define the eye we want the parameter for
  133415. * @returns the eye parameters
  133416. */
  133417. getEyeParameters(whichEye: string): VREyeParameters;
  133418. /**
  133419. * Populates the passed VRFrameData with the information required to render
  133420. * the current frame.
  133421. * @param frameData Define the data structure to populate
  133422. * @returns true if ok otherwise false
  133423. */
  133424. getFrameData(frameData: VRFrameData): boolean;
  133425. /**
  133426. * Get the layers currently being presented.
  133427. * @returns the list of VR layers
  133428. */
  133429. getLayers(): VRLayer[];
  133430. /**
  133431. * Return a VRPose containing the future predicted pose of the VRDisplay
  133432. * when the current frame will be presented. The value returned will not
  133433. * change until JavaScript has returned control to the browser.
  133434. *
  133435. * The VRPose will contain the position, orientation, velocity,
  133436. * and acceleration of each of these properties.
  133437. * @returns the pose object
  133438. */
  133439. getPose(): VRPose;
  133440. /**
  133441. * Return the current instantaneous pose of the VRDisplay, with no
  133442. * prediction applied.
  133443. * @returns the current instantaneous pose
  133444. */
  133445. getImmediatePose(): VRPose;
  133446. /**
  133447. * The callback passed to `requestAnimationFrame` will be called
  133448. * any time a new frame should be rendered. When the VRDisplay is
  133449. * presenting the callback will be called at the native refresh
  133450. * rate of the HMD. When not presenting this function acts
  133451. * identically to how window.requestAnimationFrame acts. Content should
  133452. * make no assumptions of frame rate or vsync behavior as the HMD runs
  133453. * asynchronously from other displays and at differing refresh rates.
  133454. * @param callback Define the eaction to run next frame
  133455. * @returns the request handle it
  133456. */
  133457. requestAnimationFrame(callback: FrameRequestCallback): number;
  133458. /**
  133459. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  133460. * Repeat calls while already presenting will update the VRLayers being displayed.
  133461. * @param layers Define the list of layer to present
  133462. * @returns a promise to know when the request has been fulfilled
  133463. */
  133464. requestPresent(layers: VRLayer[]): Promise<void>;
  133465. /**
  133466. * Reset the pose for this display, treating its current position and
  133467. * orientation as the "origin/zero" values. VRPose.position,
  133468. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  133469. * updated when calling resetPose(). This should be called in only
  133470. * sitting-space experiences.
  133471. */
  133472. resetPose(): void;
  133473. /**
  133474. * The VRLayer provided to the VRDisplay will be captured and presented
  133475. * in the HMD. Calling this function has the same effect on the source
  133476. * canvas as any other operation that uses its source image, and canvases
  133477. * created without preserveDrawingBuffer set to true will be cleared.
  133478. * @param pose Define the pose to submit
  133479. */
  133480. submitFrame(pose?: VRPose): void;
  133481. }
  133482. declare var VRDisplay: {
  133483. prototype: VRDisplay;
  133484. new(): VRDisplay;
  133485. };
  133486. interface VRLayer {
  133487. leftBounds?: number[] | Float32Array | null;
  133488. rightBounds?: number[] | Float32Array | null;
  133489. source?: HTMLCanvasElement | null;
  133490. }
  133491. interface VRDisplayCapabilities {
  133492. readonly canPresent: boolean;
  133493. readonly hasExternalDisplay: boolean;
  133494. readonly hasOrientation: boolean;
  133495. readonly hasPosition: boolean;
  133496. readonly maxLayers: number;
  133497. }
  133498. interface VREyeParameters {
  133499. /** @deprecated */
  133500. readonly fieldOfView: VRFieldOfView;
  133501. readonly offset: Float32Array;
  133502. readonly renderHeight: number;
  133503. readonly renderWidth: number;
  133504. }
  133505. interface VRFieldOfView {
  133506. readonly downDegrees: number;
  133507. readonly leftDegrees: number;
  133508. readonly rightDegrees: number;
  133509. readonly upDegrees: number;
  133510. }
  133511. interface VRFrameData {
  133512. readonly leftProjectionMatrix: Float32Array;
  133513. readonly leftViewMatrix: Float32Array;
  133514. readonly pose: VRPose;
  133515. readonly rightProjectionMatrix: Float32Array;
  133516. readonly rightViewMatrix: Float32Array;
  133517. readonly timestamp: number;
  133518. }
  133519. interface VRPose {
  133520. readonly angularAcceleration: Float32Array | null;
  133521. readonly angularVelocity: Float32Array | null;
  133522. readonly linearAcceleration: Float32Array | null;
  133523. readonly linearVelocity: Float32Array | null;
  133524. readonly orientation: Float32Array | null;
  133525. readonly position: Float32Array | null;
  133526. readonly timestamp: number;
  133527. }
  133528. interface VRStageParameters {
  133529. sittingToStandingTransform?: Float32Array;
  133530. sizeX?: number;
  133531. sizeY?: number;
  133532. }
  133533. interface Navigator {
  133534. getVRDisplays(): Promise<VRDisplay[]>;
  133535. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  133536. }
  133537. interface Window {
  133538. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  133539. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  133540. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  133541. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  133542. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  133543. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  133544. }
  133545. interface Gamepad {
  133546. readonly displayId: number;
  133547. }
  133548. type XRSessionMode =
  133549. | "inline"
  133550. | "immersive-vr"
  133551. | "immersive-ar";
  133552. type XRReferenceSpaceType =
  133553. | "viewer"
  133554. | "local"
  133555. | "local-floor"
  133556. | "bounded-floor"
  133557. | "unbounded";
  133558. type XREnvironmentBlendMode =
  133559. | "opaque"
  133560. | "additive"
  133561. | "alpha-blend";
  133562. type XRVisibilityState =
  133563. | "visible"
  133564. | "visible-blurred"
  133565. | "hidden";
  133566. type XRHandedness =
  133567. | "none"
  133568. | "left"
  133569. | "right";
  133570. type XRTargetRayMode =
  133571. | "gaze"
  133572. | "tracked-pointer"
  133573. | "screen";
  133574. type XREye =
  133575. | "none"
  133576. | "left"
  133577. | "right";
  133578. interface XRSpace extends EventTarget {
  133579. }
  133580. interface XRRenderState {
  133581. depthNear?: number;
  133582. depthFar?: number;
  133583. inlineVerticalFieldOfView?: number;
  133584. baseLayer?: XRWebGLLayer;
  133585. }
  133586. interface XRInputSource {
  133587. handedness: XRHandedness;
  133588. targetRayMode: XRTargetRayMode;
  133589. targetRaySpace: XRSpace;
  133590. gripSpace: XRSpace | undefined;
  133591. gamepad: Gamepad | undefined;
  133592. profiles: Array<string>;
  133593. }
  133594. interface XRSession {
  133595. addEventListener: Function;
  133596. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  133597. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  133598. requestAnimationFrame: Function;
  133599. end(): Promise<void>;
  133600. renderState: XRRenderState;
  133601. inputSources: Array<XRInputSource>;
  133602. }
  133603. interface XRReferenceSpace extends XRSpace {
  133604. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  133605. onreset: any;
  133606. }
  133607. interface XRFrame {
  133608. session: XRSession;
  133609. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  133610. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  133611. }
  133612. interface XRViewerPose extends XRPose {
  133613. views: Array<XRView>;
  133614. }
  133615. interface XRPose {
  133616. transform: XRRigidTransform;
  133617. emulatedPosition: boolean;
  133618. }
  133619. interface XRWebGLLayerOptions {
  133620. antialias ?: boolean;
  133621. depth ?: boolean;
  133622. stencil ?: boolean;
  133623. alpha ?: boolean;
  133624. multiview ?: boolean;
  133625. framebufferScaleFactor ?: number;
  133626. }
  133627. declare var XRWebGLLayer: {
  133628. prototype: XRWebGLLayer;
  133629. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  133630. };
  133631. interface XRWebGLLayer {
  133632. framebuffer: WebGLFramebuffer;
  133633. framebufferWidth: number;
  133634. framebufferHeight: number;
  133635. getViewport: Function;
  133636. }
  133637. interface XRRigidTransform {
  133638. position: DOMPointReadOnly;
  133639. orientation: DOMPointReadOnly;
  133640. matrix: Float32Array;
  133641. inverse: XRRigidTransform;
  133642. }
  133643. interface XRView {
  133644. eye: XREye;
  133645. projectionMatrix: Float32Array;
  133646. transform: XRRigidTransform;
  133647. }
  133648. interface XRInputSourceChangeEvent {
  133649. session: XRSession;
  133650. removed: Array<XRInputSource>;
  133651. added: Array<XRInputSource>;
  133652. }